org.apache.commons.crypto.jna.OpenSslNativeJna 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

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

There is a newer version: 1.2.0

Show newest version

/**
 * 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.Function;
import com.sun.jna.NativeLibrary;
import com.sun.jna.NativeLong;
import com.sun.jna.ptr.PointerByReference;

class OpenSslNativeJna {

    static final int OPENSSL_INIT_ENGINE_RDRAND = 0x00000200;

    static final int OOSL_JNA_ENCRYPT_MODE = 1;
    static final int OOSL_JNA_DECRYPT_MODE = 0;

    static final boolean INIT_OK;

    static final Throwable INIT_ERROR;

    public static final long VERSION;
    public static final long VERSION_1_0_X = 0x10000000;
    public static final long VERSION_1_1_X = 0x10100000;

    static {
        final String libraryName = System.getProperty(Crypto.CONF_PREFIX + OpenSslNativeJna.class.getSimpleName(), "crypto");
        OpenSslJna.debug("NativeLibrary.getInstance('%s')%n", libraryName);
        final NativeLibrary crypto = NativeLibrary.getInstance(libraryName);
        Function version = null;
        try {
            version = crypto.getFunction("SSLeay");
        } catch (final UnsatisfiedLinkError e) {
            // Swallow the Error.
        }

        if (version == null) {
            VERSION = VERSION_1_1_X;
        } else {
            VERSION = VERSION_1_0_X;
        }

        if (VERSION == VERSION_1_1_X) {
            INIT_OK = OpenSsl11XNativeJna.INIT_OK;
        } else {
            INIT_OK = OpenSsl10XNativeJna.INIT_OK;
        }

        if (INIT_OK) {
            INIT_ERROR = null;
        } else if (VERSION == VERSION_1_1_X) {
            INIT_ERROR = OpenSsl11XNativeJna.INIT_ERROR;
        } else {
            INIT_ERROR = OpenSsl10XNativeJna.INIT_ERROR;
        }
    }

    public static PointerByReference ENGINE_by_id(final String string) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.ENGINE_by_id(string);
        }
        return OpenSsl10XNativeJna.ENGINE_by_id(string);
    }

    public static void ENGINE_finish(final PointerByReference rdrandEngine) {
        if (VERSION == VERSION_1_1_X) {
            OpenSsl11XNativeJna.ENGINE_finish(rdrandEngine);
        } else {
            OpenSsl10XNativeJna.ENGINE_finish(rdrandEngine);
        }
    }

    public static void ENGINE_free(final PointerByReference rdrandEngine) {
        if (VERSION == VERSION_1_1_X) {
            OpenSsl11XNativeJna.ENGINE_free(rdrandEngine);
        } else {
            OpenSsl10XNativeJna.ENGINE_free(rdrandEngine);
        }
    }

    public static int ENGINE_init(final PointerByReference rdrandEngine) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.ENGINE_init(rdrandEngine);
        }
        return OpenSsl10XNativeJna.ENGINE_init(rdrandEngine);
    }

    public static int ENGINE_set_default(final PointerByReference rdrandEngine, final int eNGINE_METHOD_RAND) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.ENGINE_set_default(rdrandEngine, eNGINE_METHOD_RAND);
        }
        return OpenSsl10XNativeJna.ENGINE_set_default(rdrandEngine, eNGINE_METHOD_RAND);
    }

    public static String ERR_error_string(final NativeLong err, final Object object) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.ERR_error_string(err, null);
        }
        return OpenSsl10XNativeJna.ERR_error_string(err, null);
    }

    public static NativeLong ERR_peek_error() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.ERR_peek_error();
        }
        return OpenSsl10XNativeJna.ERR_peek_error();
    }

    public static PointerByReference EVP_aes_128_cbc() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_aes_128_cbc();
        }
        return OpenSsl10XNativeJna.EVP_aes_128_cbc();
    }

    public static PointerByReference EVP_aes_128_ctr() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_aes_128_ctr();
        }
        return OpenSsl10XNativeJna.EVP_aes_128_ctr();
    }

    public static PointerByReference EVP_aes_192_cbc() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_aes_192_cbc();
        }
        return OpenSsl10XNativeJna.EVP_aes_192_cbc();
    }

    public static PointerByReference EVP_aes_192_ctr() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_aes_192_ctr();
        }
        return OpenSsl10XNativeJna.EVP_aes_192_ctr();
    }

    public static PointerByReference EVP_aes_256_cbc() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_aes_256_cbc();
        }
        return OpenSsl10XNativeJna.EVP_aes_256_cbc();
    }

    public static PointerByReference EVP_aes_256_ctr() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_aes_256_ctr();
        }
        return OpenSsl10XNativeJna.EVP_aes_256_ctr();
    }

    public static void EVP_CIPHER_CTX_free(final PointerByReference context) {
        if (VERSION == VERSION_1_1_X) {
            OpenSsl11XNativeJna.EVP_CIPHER_CTX_free(context);
        } else {
            OpenSsl10XNativeJna.EVP_CIPHER_CTX_free(context);
        }
    }

    public static PointerByReference EVP_CIPHER_CTX_new() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_CIPHER_CTX_new();
        }
        return OpenSsl10XNativeJna.EVP_CIPHER_CTX_new();
    }

    public static void EVP_CIPHER_CTX_set_padding(final PointerByReference context, final int padding) {
        if (VERSION == VERSION_1_1_X) {
            OpenSsl11XNativeJna.EVP_CIPHER_CTX_set_padding(context, padding);
        } else {
            OpenSsl10XNativeJna.EVP_CIPHER_CTX_set_padding(context, padding);
        }
    }

    public static int EVP_CipherFinal_ex(final PointerByReference context, final ByteBuffer outBuffer,
            final int[] outlen) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_CipherFinal_ex(context, outBuffer, outlen);
        }
        return OpenSsl10XNativeJna.EVP_CipherFinal_ex(context, outBuffer, outlen);
    }

    public static int EVP_CipherInit_ex(final PointerByReference context, final PointerByReference algo,
            final Object object, final byte[] encoded, final byte[] iv, final int cipherMode) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_CipherInit_ex(context, algo, null, encoded, iv,
                    cipherMode);
        }
        return OpenSsl10XNativeJna.EVP_CipherInit_ex(context, algo, null, encoded, iv,
                cipherMode);
    }

    public static int EVP_CipherUpdate(final PointerByReference context, final ByteBuffer outBuffer,
            final int[] outlen, final ByteBuffer inBuffer, final int remaining) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.EVP_CipherUpdate(context, outBuffer, outlen, inBuffer,
                    remaining);
        }
        return OpenSsl10XNativeJna.EVP_CipherUpdate(context, outBuffer, outlen, inBuffer,
                remaining);
    }

    public static int RAND_bytes(final ByteBuffer buf, final int length) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.RAND_bytes(buf, length);
        }
        return OpenSsl10XNativeJna.RAND_bytes(buf, length);
    }

    public static PointerByReference RAND_get_rand_method() {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.RAND_get_rand_method();
        }
        return OpenSsl10XNativeJna.RAND_get_rand_method();
    }

    public static PointerByReference RAND_SSLeay() {
        if (VERSION == VERSION_1_1_X) {
            return null;
        }
        return OpenSsl10XNativeJna.RAND_SSLeay();
    }

    public static String OpenSSLVersion(final int i) {
        if (VERSION == VERSION_1_1_X) {
            return OpenSsl11XNativeJna.OpenSSL_version(i);
        }
        return OpenSsl10XNativeJna.SSLeay_version(i);
    }

    public static void ENGINE_load_rdrand() {
        if (VERSION == VERSION_1_1_X) {
            return;
        }
        OpenSsl10XNativeJna.ENGINE_load_rdrand();
    }

    public static void ENGINE_cleanup() {
        if (VERSION == VERSION_1_1_X) {
            return;
        }
        OpenSsl10XNativeJna.ENGINE_cleanup();
    }

    public static void EVP_CIPHER_CTX_cleanup(final PointerByReference context) {
        if (VERSION == VERSION_1_1_X) {
            return;
        }
        OpenSsl10XNativeJna.EVP_CIPHER_CTX_cleanup(context);
    }
}