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.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;
        }
    }

    
Returns:
OPENSSL_VERSION_NUMBER which is a numeric release version identifier/**
     * @return OPENSSL_VERSION_NUMBER which is a numeric release version identifier
     */
    public static native NativeLong SSLeay();

    
Retrieves version/build information about OpenSSL library.
Params:
type – 
           type can be SSLEAY_VERSION, SSLEAY_CFLAGS, SSLEAY_BUILT_ON...
Returns:
A pointer to a constant string describing the version of the OpenSSL library or
        giving information about the library build./**
     * 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.
/**
     * Registers the error strings for all libcrypto functions.
     */
    public static native void ERR_load_crypto_strings();

    
Returns:
the earliest error code from the thread's error queue without modifying it./**
     * @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.
Params:
err – 
           the error code
null_ – 
           buf is NULL, the error string is placed in a static buffer
See Also:
ERR_error_string
Returns:
the human-readable error messages./**
     * Generates a human-readable string representing the error code e.
     *
     * @see <a href="https://www.openssl.org/docs/man1.0.2/man3/ERR_error_string.html">ERR_error_string</a>
     *
     * @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.
Returns:
a pointer to a newly created EVP_CIPHER_CTX for success and NULL for failure./**
     * 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
Params:
p – 
           cipher context/**
     * 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
Params:
c – 
           cipher context
pad – 
           If the pad parameter is zero then no padding is performed
Returns:
always returns 1/**
     * 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);

    
Returns:
an OpenSSL AES EVP cipher instance with a 128-bit key CBC mode/**
     * @return an OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
     */
    public static native PointerByReference EVP_aes_128_cbc();

    
Returns:
an OpenSSL AES EVP cipher instance with a 128-bit key CTR mode/**
     * @return an OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
     */
    public static native PointerByReference EVP_aes_128_ctr();

    
Returns:
an OpenSSL AES EVP cipher instance with a 192-bit key CBC mode/**
     * @return an OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
     */
    public static native PointerByReference EVP_aes_192_cbc();

    
Returns:
an OpenSSL AES EVP cipher instance with a 192-bit key CTR mode/**
     * @return an OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
     */
    public static native PointerByReference EVP_aes_192_ctr();

    
Returns:
an OpenSSL AES EVP cipher instance with a 256-bit key CBC mode/**
     * @return an OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
     */
    public static native PointerByReference EVP_aes_256_cbc();

    
Returns:
an OpenSSL AES EVP cipher instance with a 256-bit key CTR mode/**
     * @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.
Params:
ctx – 
           cipher context
cipher – 
           evp cipher instance
impl – 
           engine
key – 
           key
iv – 
           iv
enc – 
           1 for encryption, 0 for decryption
Returns:
1 for success and 0 for failure./**
     * 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.
Params:
ctx – 
           cipher context
bout – 
           output byte buffer
outl – 
           output length
in – 
           input byte buffer
inl – 
           input length
Returns:
1 for success and 0 for failure./**
     * 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.
Params:
ctx – 
           cipher context
bout – 
           output byte buffer
outl – 
           output length
Returns:
1 for success and 0 for failure./**
     * 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.
Params:
c – 
           openssl evp cipher/**
     * 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.
Params:
c – 
           openssl evp cipher/**
     * 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
Returns:
pointers to the respective methods/**
     * 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.
Returns:
pointers to the respective methods/**
     * OpenSSL uses for random number generation.
     *
     * @return pointers to the respective methods
     */
    public static native PointerByReference RAND_SSLeay();

    
Generates random data
Params:
buf – 
           the bytes for generated random.
num – 
           buffer length
Returns:
1 on success, 0 otherwise./**
     * 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.
Params:
e – 
           engine reference.
Returns:
0 on success, 1 otherwise./**
     * 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
Params:
e – 
           engine reference.
Returns:
0 on success, 1 otherwise./**
     * 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.
Returns:
0 on success, 1 otherwise./**
     * 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.
Params:
e – 
           engine reference
Returns:
zero if the ENGINE was not already operational and couldn't be successfully
        initialized/**
     * 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.
Params:
e – 
           engine reference
flags – 
           ENGINE_METHOD_RAND
Returns:
zero if failed./**
     * 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
Params:
id – 
           engine id
Returns:
engine instance/**
     * Gets engine by id
     *
     * @param id
     *            engine id
     * @return engine instance
     */
    public static native PointerByReference ENGINE_by_id(String id);

    
Initializes the engine.
/**
     * Initializes the engine.
     */
    public static native void ENGINE_load_rdrand();
}