[commons-crypto] branch master updated: Docco - no code changes

[sebb]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-crypto.git


The following commit(s) were added to refs/heads/master by this push:
     new 0d3fff0  Docco - no code changes
0d3fff0 is described below

commit 0d3fff0a9741c2a7b052c16846a745eef52cebb1
Author: Sebb <s...@apache.org>
AuthorDate: Wed Jun 29 23:35:33 2022 +0100

    Docco - no code changes
    
    [skip ci]
---
 .../java/org/apache/commons/crypto/jna/OpenSsl10XNativeJna.java    | 7 ++++++-
 .../java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java    | 5 ++++-
 src/main/java/org/apache/commons/crypto/jna/OpenSslNativeJna.java  | 4 ++++
 3 files changed, 14 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/crypto/jna/OpenSsl10XNativeJna.java 
b/src/main/java/org/apache/commons/crypto/jna/OpenSsl10XNativeJna.java
index 2823d6e..2cf4354 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSsl10XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSsl10XNativeJna.java
@@ -53,13 +53,14 @@ class OpenSsl10XNativeJna {
 
     /**
      * @see <a 
href="https://www.openssl.org/docs/man1.0.2/man3/SSLeay.html";>Version Number</a>
-     * (does not appear to be used yet)
+     * TODO (does not appear to be used yet)
      * @return OPENSSL_VERSION_NUMBER which is a numeric release version 
identifier
      */
     public static native NativeLong SSLeay();
 
     /**
      * Retrieves version/build information about OpenSSL library.
+     * This is returned by {@link OpenSslNativeJna#OpenSSLVersion(int)}
      *
      * @see <a 
href="https://www.openssl.org/docs/man1.0.2/man3/SSLeay_version.html";>Version 
Info</a>
      *
@@ -70,6 +71,7 @@ class OpenSsl10XNativeJna {
      */
     public static native String SSLeay_version(int type);
 
+    // TODO: NOT USED?
     /**
      * Registers the error strings for all libcrypto functions.
      */
@@ -100,6 +102,7 @@ class OpenSsl10XNativeJna {
      */
     public static native PointerByReference EVP_CIPHER_CTX_new();
 
+    // TODO: NOT USED?
     /**
      * EVP_CIPHER_CTX_init() remains as an alias for EVP_CIPHER_CTX_reset
      *
@@ -245,6 +248,8 @@ class OpenSsl10XNativeJna {
      */
     public static native int RAND_bytes(ByteBuffer buf, int num);
 
+    // ENGINE API: https://www.openssl.org/docs/man1.0.2/man3/engine.html
+
     /**
      * Releases all functional references.
      *
diff --git 
a/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java 
b/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
index a68a7e3..a89a4c7 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
@@ -146,7 +146,7 @@ class OpenSsl11XNativeJna {
      * @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);
+            PointerByReference impl, byte[] key, byte[] iv, int enc);
 
     /**
      * Continues a multiple-part encryption/decryption operation.
@@ -216,6 +216,9 @@ class OpenSsl11XNativeJna {
      */
     public static native int RAND_bytes(ByteBuffer buf, int num);
 
+    // ENGINE API: https://www.openssl.org/docs/man1.1.1/man3/ENGINE_add.html
+    // (The above page includes all the ENGINE functions used below)
+
     /**
      * Releases all functional references.
      *
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslNativeJna.java 
b/src/main/java/org/apache/commons/crypto/jna/OpenSslNativeJna.java
index 035f2f9..cca8b28 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslNativeJna.java
@@ -82,6 +82,7 @@ class OpenSslNativeJna {
         return OpenSsl10XNativeJna.ENGINE_by_id(string);
     }
 
+    // TODO: native method returns int
     public static void ENGINE_finish(final PointerByReference rdrandEngine) {
         if (VERSION == VERSION_1_1_X) {
             OpenSsl11XNativeJna.ENGINE_finish(rdrandEngine);
@@ -90,6 +91,7 @@ class OpenSslNativeJna {
         }
     }
 
+    // TODO: native method returns int
     public static void ENGINE_free(final PointerByReference rdrandEngine) {
         if (VERSION == VERSION_1_1_X) {
             OpenSsl11XNativeJna.ENGINE_free(rdrandEngine);
@@ -183,6 +185,7 @@ class OpenSslNativeJna {
         return OpenSsl10XNativeJna.EVP_CIPHER_CTX_new();
     }
 
+    // TODO: native method returns int
     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);
@@ -254,6 +257,7 @@ class OpenSslNativeJna {
         OpenSsl10XNativeJna.ENGINE_load_rdrand();
     }
 
+    // TODO: native method returns int
     public static void ENGINE_cleanup() {
         if (VERSION == VERSION_1_1_X) {
             return;