You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/08/09 20:45:31 UTC

[commons-codec] branch master updated: Javadoc existing behavior

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 4ef99468 Javadoc existing behavior
4ef99468 is described below

commit 4ef99468e6a321d22fa88c484885c9aba048ccee
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Aug 9 16:45:26 2023 -0400

    Javadoc existing behavior
---
 .../java/org/apache/commons/codec/digest/Md5Crypt.java     |  8 ++++----
 .../java/org/apache/commons/codec/digest/Sha2Crypt.java    | 14 +++++++-------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java b/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
index de65e34c..aeb4a3ff 100644
--- a/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
@@ -105,7 +105,7 @@ public class Md5Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext string to hash.
+     *            plaintext string to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            An APR1 salt. The salt may be null, in which case a salt is generated for you using
      *            {@link ThreadLocalRandom}; for more secure salts consider using {@link SecureRandom} to generate your
@@ -216,7 +216,7 @@ public class Md5Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext string to hash.
+     *            plaintext string to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            salt string including the prefix and optionally garbage at the end. The salt may be null, in which
      *            case a salt is generated for you using {@link ThreadLocalRandom}; for more secure salts consider using
@@ -239,7 +239,7 @@ public class Md5Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext string to hash.
+     *            plaintext string to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
      *            is generated for you using {@link ThreadLocalRandom}; for more secure salts consider
@@ -263,7 +263,7 @@ public class Md5Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext string to hash.
+     *            plaintext string to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
      *            is generated for you using {@link ThreadLocalRandom}; for more secure salts consider
diff --git a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
index 86abd586..03d6ac66 100644
--- a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
@@ -83,7 +83,7 @@ public class Sha2Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @return complete hash value
      * @throws IllegalArgumentException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
@@ -98,7 +98,7 @@ public class Sha2Crypt {
      * See {@link Crypt#crypt(String, String)} for details.
      * </p>
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
      *            is generated for you using {@link SecureRandom}. If one does not want to use {@link SecureRandom},
@@ -122,7 +122,7 @@ public class Sha2Crypt {
      * See {@link Crypt#crypt(String, String)} for details.
      * </p>
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds=".
      * @param random
@@ -153,7 +153,7 @@ public class Sha2Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds="; may not be null
      * @param saltPrefix
@@ -556,7 +556,7 @@ public class Sha2Crypt {
      * </p>
      *
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @return complete hash value
      * @throws IllegalArgumentException
      *             when a {@link java.security.NoSuchAlgorithmException} is caught.
@@ -571,7 +571,7 @@ public class Sha2Crypt {
      * See {@link Crypt#crypt(String, String)} for details.
      * </p>
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated
      *            for you using {@link SecureRandom}; if you want to use a {@link Random} object other than
@@ -598,7 +598,7 @@ public class Sha2Crypt {
      * See {@link Crypt#crypt(String, String)} for details.
      * </p>
      * @param keyBytes
-     *            plaintext to hash
+     *            plaintext to hash. Each array element is set to {@code 0} before returning.
      * @param salt
      *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
      *            is generated for you using {@link ThreadLocalRandom}; for more secure salts consider using