org.apache.commons.crypto.jna.OpenSsl10XNativeJna Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-crypto Show documentation
Show all versions of commons-crypto Show documentation
Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced Encryption
Standard New Instructions). It provides Java API for both cipher level and Java stream level.
Developers can use it to implement high performance AES encryption/decryption with the minimum
code and effort. Please note that Crypto doesn't implement the cryptographic algorithm such as
AES directly. It wraps to Openssl or JCE which implement the algorithms.
Features
--------
1. Cipher API for low level cryptographic operations.
2. Java stream API (CryptoInputStream/CryptoOutputStream) for high level stream encyrption/decryption.
3. Both optimized with high performance AES encryption/decryption. (1400 MB/s - 1700 MB/s throughput in modern Xeon processors).
4. JNI-based implementation to achieve comparable performance to the native C++ version based on OpenSsl.
5. Portable across various operating systems (currently only Linux/MacOSX/Windows);
Apache Commons Crypto loads the library according to your machine environment (it checks system properties, `os.name` and `os.arch`).
6. Simple usage. Add the commons-crypto-(version).jar file to your classpath.
Export restrictions
-------------------
This distribution includes cryptographic software.
The country in which you currently reside may have restrictions
on the import, possession, use, and/or re-export to another country,
of encryption software. BEFORE using any encryption software,
please check your country's laws, regulations and policies
concerning the import, possession, or use, and re-export of
encryption software, to see if this is permitted.
See <http://www.wassenaar.org/> for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS),
has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1,
which includes information security software using or performing
cryptographic functions with asymmetric algorithms.
The form and manner of this Apache Software Foundation distribution makes
it eligible for export under the License Exception
ENC Technology Software Unrestricted (TSU) exception
(see the BIS Export Administration Regulations, Section 740.13)
for both object code and source code.
The following provides more details on the included cryptographic software:
* Commons Crypto use [Java Cryptography Extension](http://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) provided by Java
* Commons Crypto link to and use [OpenSSL](https://www.openssl.org/) ciphers
/**
* 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.jna;
import java.nio.ByteBuffer;
import org.apache.commons.crypto.Crypto;
import com.sun.jna.Native;
import com.sun.jna.NativeLong;
import com.sun.jna.ptr.PointerByReference;
class OpenSsl10XNativeJna {
static final boolean INIT_OK;
static final Throwable INIT_ERROR;
static {
boolean ok = false;
Throwable thrown = null;
try {
final String libName = System.getProperty(Crypto.CONF_PREFIX + OpenSsl10XNativeJna.class.getSimpleName(),
"crypto");
OpenSslJna.debug("Native.register('%s')%n", libName);
Native.register(libName);
ok = true;
} catch (final Exception e) {
thrown = e;
} catch (final UnsatisfiedLinkError e) {
thrown = e;
} finally {
INIT_OK = ok;
INIT_ERROR = thrown;
}
}
/**
* @return OPENSSL_VERSION_NUMBER which is a numeric release version identifier
*/
public static native NativeLong SSLeay();
/**
* Retrieves version/build information about OpenSSL library.
*
* @param type
* type can be SSLEAY_VERSION, SSLEAY_CFLAGS, SSLEAY_BUILT_ON...
* @return A pointer to a constant string describing the version of the OpenSSL library or
* giving information about the library build.
*/
public static native String SSLeay_version(int type);
/**
* Registers the error strings for all libcrypto functions.
*/
public static native void ERR_load_crypto_strings();
/**
* @return the earliest error code from the thread's error queue without modifying it.
*/
public static native NativeLong ERR_peek_error();
/**
* Generates a human-readable string representing the error code e.
*
* @see ERR_error_string
*
* @param err
* the error code
* @param null_
* buf is NULL, the error string is placed in a static buffer
* @return the human-readable error messages.
*/
public static native String ERR_error_string(NativeLong err, char[] null_);
/**
* Creates a cipher context.
*
* @return a pointer to a newly created EVP_CIPHER_CTX for success and NULL for failure.
*/
public static native PointerByReference EVP_CIPHER_CTX_new();
/**
* EVP_CIPHER_CTX_init() remains as an alias for EVP_CIPHER_CTX_reset
*
* @param p
* cipher context
*/
public static native void EVP_CIPHER_CTX_init(PointerByReference p);
/**
* Enables or disables padding
*
* @param c
* cipher context
* @param pad
* If the pad parameter is zero then no padding is performed
* @return always returns 1
*/
public static native int EVP_CIPHER_CTX_set_padding(PointerByReference c, int pad);
/**
* @return an OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
*/
public static native PointerByReference EVP_aes_128_cbc();
/**
* @return an OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
*/
public static native PointerByReference EVP_aes_128_ctr();
/**
* @return an OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
*/
public static native PointerByReference EVP_aes_192_cbc();
/**
* @return an OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
*/
public static native PointerByReference EVP_aes_192_ctr();
/**
* @return an OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
*/
public static native PointerByReference EVP_aes_256_cbc();
/**
* @return an OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
*/
public static native PointerByReference EVP_aes_256_ctr();
/**
* Init a cipher.
*
* @param ctx
* cipher context
* @param cipher
* evp cipher instance
* @param impl
* engine
* @param key
* key
* @param iv
* iv
* @param enc
* 1 for encryption, 0 for decryption
* @return 1 for success and 0 for failure.
*/
public static native int EVP_CipherInit_ex(PointerByReference ctx, PointerByReference cipher,
PointerByReference impl, byte key[], byte iv[], int enc);
/**
* Continues a multiple-part encryption/decryption operation.
*
* @param ctx
* cipher context
* @param bout
* output byte buffer
* @param outl
* output length
* @param in
* input byte buffer
* @param inl
* input length
* @return 1 for success and 0 for failure.
*/
public static native int EVP_CipherUpdate(PointerByReference ctx, ByteBuffer bout, int[] outl,
ByteBuffer in, int inl);
/**
* Finishes a multiple-part operation.
*
* @param ctx
* cipher context
* @param bout
* output byte buffer
* @param outl
* output length
* @return 1 for success and 0 for failure.
*/
public static native int EVP_CipherFinal_ex(PointerByReference ctx, ByteBuffer bout,
int[] outl);
/**
* Clears all information from a cipher context and free up any allocated memory associate with
* it, including ctx itself.
*
* @param c
* openssl evp cipher
*/
public static native void EVP_CIPHER_CTX_free(PointerByReference c);
/**
* Clears all information from a cipher context and free up any allocated * memory associate
* with it.
*
* @param c
* openssl evp cipher
*/
public static native void EVP_CIPHER_CTX_cleanup(PointerByReference c);
// Random generator
/**
* OpenSSL uses for random number generation
*
* @return pointers to the respective methods
*/
public static native PointerByReference RAND_get_rand_method();
/**
* OpenSSL uses for random number generation.
*
* @return pointers to the respective methods
*/
public static native PointerByReference RAND_SSLeay();
/**
* Generates random data
*
* @param buf
* the bytes for generated random.
* @param num
* buffer length
* @return 1 on success, 0 otherwise.
*/
public static native int RAND_bytes(ByteBuffer buf, int num);
/**
* Releases all functional references.
*
* @param e
* engine reference.
* @return 0 on success, 1 otherwise.
*/
public static native int ENGINE_finish(PointerByReference e);
/**
* Frees the structural reference
*
* @param e
* engine reference.
* @return 0 on success, 1 otherwise.
*/
public static native int ENGINE_free(PointerByReference e);
/**
* Cleanups before program exit, it will avoid memory leaks.
*
* @return 0 on success, 1 otherwise.
*/
public static native int ENGINE_cleanup();
/**
* Obtains a functional reference from an existing structural reference.
*
* @param e
* engine reference
* @return zero if the ENGINE was not already operational and couldn't be successfully
* initialized
*/
public static native int ENGINE_init(PointerByReference e);
/**
* Sets the engine as the default for random number generation.
*
* @param e
* engine reference
* @param flags
* ENGINE_METHOD_RAND
* @return zero if failed.
*/
public static native int ENGINE_set_default(PointerByReference e, int flags);
/**
* Gets engine by id
*
* @param id
* engine id
* @return engine instance
*/
public static native PointerByReference ENGINE_by_id(String id);
/**
* Initializes the engine.
*/
public static native void ENGINE_load_rdrand();
}