[GitHub] vanzin commented on a change in pull request #92: OpenSSL 1.1.0 updates with backward compatibility for OpenSSL 1.0.2 and 1.0.1

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[GitHub] vanzin commented on a change in pull request #92: OpenSSL 1.1.0 updates with backward compatibility for OpenSSL 1.0.2 and 1.0.1

GitBox
vanzin commented on a change in pull request #92: OpenSSL 1.1.0 updates with backward compatibility for OpenSSL 1.0.2 and 1.0.1
URL: https://github.com/apache/commons-crypto/pull/92#discussion_r244818314
 
 

 ##########
 File path: src/main/java/org/apache/commons/crypto/jna/OpenSslNativeJna.java
 ##########
 @@ -20,271 +20,319 @@
 
 import java.nio.ByteBuffer;
 
-import com.sun.jna.Native;
+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;
-
-    static {
-        boolean ok = false;
-        Throwable thrown = null;
-        try {
-            Native.register("crypto");
-            ERR_load_crypto_strings();
-            ok = true;
-        } catch (Exception e) {
-            thrown = e;
-        } catch (UnsatisfiedLinkError e) {
-            thrown = e;
-        } finally {
-            INIT_OK = ok;
-            INIT_ERROR = thrown;
-        }
+  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 {
+    NativeLibrary crypto = NativeLibrary.getInstance("crypto");
+    Function version = null;
+    try {
+      version = crypto.getFunction("SSLeay");
+      } catch (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 = OpenSsl110NativeJna.INIT_OK;
+      } else if (VERSION == VERSION_1_0_X) {
+        INIT_OK = OpenSsl102NativeJna.INIT_OK;
+      } else {
+        INIT_OK = false;
+      }
+
+      if (INIT_OK) {
+        INIT_ERROR = null;
+      } else if (VERSION == VERSION_1_1_X) {
+        INIT_ERROR = OpenSsl110NativeJna.INIT_ERROR;
+      } else if (VERSION == VERSION_1_0_X) {
+        INIT_ERROR = OpenSsl102NativeJna.INIT_ERROR;
+      }  else {
+        INIT_ERROR = null;
+      }
     }
 
-    //misc
-    /**
-     * @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 <a>https://www.openssl.org/docs/manmaster/crypto/ERR_error_string.html</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_);
-    //String ERR_lib_error_string(NativeLong err);
-    //String ERR_func_error_string(NativeLong err);
-
-    //en-/decryption
-    /**
-     * 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 initialised
-     */
-    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();
-
-    //TODO callback multithreading
-    /*public interface Id_function_cb extends Callback {
-        long invoke ();
+  public static PointerByReference ENGINE_by_id(String string) {
+    if (VERSION == VERSION_1_1_X) {
+      return OpenSsl110NativeJna.ENGINE_by_id(string);
+    } else if (VERSION == VERSION_1_0_X) {
+      return OpenSsl102NativeJna.ENGINE_by_id(string);
+    } else {
+      return null;
 
 Review comment:
   This shouldn't really be reachable, right? So maybe throw an exception instead? (Also in other methods.)
   
   The interface-based approach I suggested would make these cleaner, but then I'm not sure how well it plays with JNA.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[hidden email]


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]