Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.crypto;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;
import org.apache.commons.crypto.cipher.CryptoCipher;
import org.apache.commons.crypto.cipher.CryptoCipherFactory;
import org.apache.commons.crypto.random.CryptoRandom;
import org.apache.commons.crypto.random.CryptoRandomFactory;
Provides diagnostic information about Commons Crypto and keys for native
class loading
/**
* Provides diagnostic information about Commons Crypto and keys for native
* class loading
*/
public final class Crypto {
private static class ComponentPropertiesHolder {
static final Properties PROPERTIES = getComponentProperties();
Get component properties from component.properties.
Returns: Properties contains project version.
/**
* Get component properties from component.properties.
*
* @return Properties contains project version.
*/
private static Properties getComponentProperties() {
final URL url = Crypto.class.getResource("/org/apache/commons/crypto/component.properties");
final Properties versionData = new Properties();
if (url != null) {
try (InputStream inputStream = url.openStream()) {
versionData.load(inputStream);
return versionData;
} catch (final IOException e) { // NOPMD
}
}
return versionData;
}
}
The prefix of all crypto configuration keys.
/**
* The prefix of all crypto configuration keys.
*/
public static final String CONF_PREFIX = "commons.crypto.";
The configuration key of the file name for loading crypto library.
/**
* The configuration key of the file name for loading crypto library.
*/
public static final String LIB_NAME_KEY = Crypto.CONF_PREFIX + "lib.name";
// native lib related configuration keys
The configuration key of the path for loading crypto library.
/**
* The configuration key of the path for loading crypto library.
*/
public static final String LIB_PATH_KEY = Crypto.CONF_PREFIX + "lib.path";
The configuration key of temp directory for extracting crypto library.
Defaults to "java.io.tempdir" if not found.
/**
* The configuration key of temp directory for extracting crypto library.
* Defaults to "java.io.tempdir" if not found.
*/
public static final String LIB_TEMPDIR_KEY = Crypto.CONF_PREFIX + "lib.tempdir";
Gets the component version of Apache Commons Crypto.
This implementation relies on the VERSION properties file which must be set
up with the correct contents by the build process. This is done automatically
by Maven.
Returns: the version; may be null if not found
/**
* Gets the component version of Apache Commons Crypto.
* <p>
* This implementation relies on the VERSION properties file which must be set
* up with the correct contents by the build process. This is done automatically
* by Maven.
* </p>
*
* @return the version; may be null if not found
*/
public static String getComponentName() {
// Note: the component properties file allows the method to work without needing
// the jar
return ComponentPropertiesHolder.PROPERTIES.getProperty("NAME");
}
Gets the component version of Apache Commons Crypto.
This implementation relies on the VERSION properties file which must be set
up with the correct contents by the build process. This is done automatically
by Maven.
Returns: the version; may be null if not found
/**
* Gets the component version of Apache Commons Crypto.
* <p>
* This implementation relies on the VERSION properties file which must be set
* up with the correct contents by the build process. This is done automatically
* by Maven.
* </p>
*
* @return the version; may be null if not found
*/
public static String getComponentVersion() {
// Note: the component properties file allows the method to work without needing
// the jar
return ComponentPropertiesHolder.PROPERTIES.getProperty("VERSION");
}
The loading error throwable, if loading failed.
Returns: null, unless loading failed.
/**
* The loading error throwable, if loading failed.
*
* @return null, unless loading failed.
*/
public static Throwable getLoadingError() {
return NativeCodeLoader.getLoadingError();
}
Logs info-level messages.
Params: - format – See
String.format(String, Object...). - args – See
String.format(String, Object...).
/**
* Logs info-level messages.
*
* @param format See {@link String#format(String, Object...)}.
* @param args See {@link String#format(String, Object...)}.
*/
private static void info(final String format, final Object... args) {
// TODO Find a better way to do this later.
System.out.println(String.format(format, args));
}
Checks whether the native code has been successfully loaded for the platform.
Returns: true if the native code has been loaded successfully.
/**
* Checks whether the native code has been successfully loaded for the platform.
*
* @return true if the native code has been loaded successfully.
*/
public static boolean isNativeCodeLoaded() {
return NativeCodeLoader.isNativeCodeLoaded();
}
The Main of Crypto.
Params: - args – Not used.
Throws: - Exception – if getCryptoRandom or getCryptoCipher get error.
/**
* The Main of Crypto.
*
* @param args Not used.
* @throws Exception if getCryptoRandom or getCryptoCipher get error.
*/
public static void main(final String args[]) throws Exception {
info("%s %s", getComponentName(), getComponentVersion());
if (isNativeCodeLoaded()) {
info("Native code loaded OK: %s", OpenSslInfoNative.NativeVersion());
info("Native name: %s", OpenSslInfoNative.NativeName());
info("Native built: %s", OpenSslInfoNative.NativeTimeStamp());
info("OpenSSL library loaded OK, version: 0x%s", Long.toHexString(OpenSslInfoNative.OpenSSL()));
info("OpenSSL library info: %s", OpenSslInfoNative.OpenSSLVersion(0));
{ // CryptoRandom
final Properties props = new Properties();
props.setProperty(CryptoRandomFactory.CLASSES_KEY,
CryptoRandomFactory.RandomProvider.OPENSSL.getClassName());
try (CryptoRandom cryptoRandom = CryptoRandomFactory.getCryptoRandom(props)) {
info("Random instance created OK: %s", cryptoRandom);
}
}
{ // CryptoCipher
final Properties props = new Properties();
props.setProperty(CryptoCipherFactory.CLASSES_KEY,
CryptoCipherFactory.CipherProvider.OPENSSL.getClassName());
final String transformation = "AES/CTR/NoPadding";
try (CryptoCipher cryptoCipher = CryptoCipherFactory.getCryptoCipher(transformation, props)) {
info("Cipher %s instance created OK: %s", transformation, cryptoCipher);
}
}
info("Additional OpenSSL_version(n) details:");
for (int j = 1; j < 6; j++) {
info("%s: %s", j, OpenSslInfoNative.OpenSSLVersion(j));
}
} else {
info("Native load failed: %s", getLoadingError());
}
}
}