(commons-crypto) branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 7838f06b Javadoc
7838f06b is described below
commit 7838f06b28ea3662f10826f917cef59b418e
Author: Gary Gregory
AuthorDate: Sun Jul 21 11:26:51 2024 -0400
Javadoc
Use HTML 'em' tag instead of 'i' tag
---
.../commons/crypto/cipher/CryptoCipherFactory.java | 2 +-
.../apache/commons/crypto/stream/CryptoInputStream.java | 4 ++--
.../apache/commons/crypto/stream/CryptoOutputStream.java | 4 ++--
.../commons/crypto/stream/CtrCryptoInputStream.java | 4 ++--
.../org/apache/commons/crypto/stream/input/Input.java| 16
.../org/apache/commons/crypto/stream/output/Output.java | 16
src/main/java/org/apache/commons/crypto/utils/Utils.java | 2 +-
7 files changed, 24 insertions(+), 24 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
index f2b44619..6be1c0fe 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -163,7 +163,7 @@ public class CryptoCipherFactory {
* commons.crypto.cipher.transformation
*
* @param transformation the name of the transformation, e.g.,
- * AES/CBC/PKCS5Padding.
+ * AES/CBC/PKCS5Padding.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @return CryptoCipher the cipher object (defaults to OpenSslCipher if
available, else JceCipher)
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index 8f1bee5b..02cdfe09 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -213,7 +213,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
* Constructs a {@link CryptoInputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * AES/CBC/PKCS5Padding.
+ * AES/CBC/PKCS5Padding.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
@@ -234,7 +234,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
* Constructs a {@link CryptoInputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * AES/CBC/PKCS5Padding.
+ * AES/CBC/PKCS5Padding.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
index f63f7ae0..6759c42c 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -137,7 +137,7 @@ public class CryptoOutputStream extends OutputStream
implements
* Constructs a {@link CryptoOutputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * AES/CBC/PKCS5Padding.
+ * AES/CBC/PKCS5Padding.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
@@ -160,7 +160,7 @@ public class CryptoOutputStream extends OutputStream
implements
* Constructs a {@link CryptoOutputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * AES/CBC/PKCS5Padding.
+ * AES/CBC/PKCS5Padding.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
index 12da5122..ce12a2e8 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -384,8 +384,8 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
/**
(commons-crypto) branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 5dde5495 Javadoc
5dde5495 is described below
commit 5dde54954ed20b04990440ed2d3b41fb658a679d
Author: Gary Gregory
AuthorDate: Tue Jun 18 09:14:10 2024 -0400
Javadoc
---
.../java/org/apache/commons/crypto/stream/CryptoInputStream.java| 6 +++---
.../java/org/apache/commons/crypto/stream/CryptoOutputStream.java | 4 ++--
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index 5d32d1dc..f2aa997b 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -469,7 +469,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
}
/**
- * Overrides the {@link java.io.InputStream#read()}. Reads the next byte of
+ * Overrides the {@link InputStream#read()}. Reads the next byte of
* data from the input stream.
*
* @return the next byte of data, or {@code EOS (-1)} if the end of the
@@ -486,7 +486,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
}
/**
- * Overrides the {@link java.io.InputStream#read(byte[], int, int)}.
+ * Overrides the {@link InputStream#read(byte[], int, int)}.
* Decryption is buffer based. If there is data in {@link #outBuffer}, then
* read it out of this buffer. If there is no data in {@link #outBuffer},
* then read more from the underlying stream and do the decryption.
@@ -573,7 +573,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
}
/**
- * Overrides the {@link java.io.InputStream#skip(long)}. Skips over and
+ * Overrides the {@link InputStream#skip(long)}. Skips over and
* discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
index d1128982..f63f7ae0 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -362,7 +362,7 @@ public class CryptoOutputStream extends OutputStream
implements
}
/**
- * Overrides the {@link java.io.OutputStream#write(byte[], int, int)}.
+ * Overrides the {@link OutputStream#write(byte[], int, int)}.
* Encryption is buffer based. If there is enough room in {@link
#inBuffer},
* then write to this buffer. If {@link #inBuffer} is full, then do
* encryption and write data to the underlying stream.
@@ -434,7 +434,7 @@ public class CryptoOutputStream extends OutputStream
implements
}
/**
- * Overrides the {@link java.io.OutputStream#write(byte[])}. Writes the
+ * Overrides the {@link OutputStream#write(byte[])}. Writes the
* specified byte to this output stream.
*
* @param b the data.
(commons-crypto) branch master updated: Javadoc and comments: Use an HTTPS URL
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 67b8448c Javadoc and comments: Use an HTTPS URL
67b8448c is described below
commit 67b8448c9afbc192ef1e369e47620932b0bd976a
Author: Gary Gregory
AuthorDate: Sun Jan 14 10:51:10 2024 -0500
Javadoc and comments: Use an HTTPS URL
---
.../java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java | 4 ++--
.../java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java | 4 ++--
src/main/java/org/apache/commons/crypto/jna/OpenSslMacOS.java | 2 +-
.../java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java | 2 +-
.../java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java | 4 ++--
src/test/java/org/apache/commons/crypto/cipher/GcmCipherTest.java | 6 +++---
6 files changed, 11 insertions(+), 11 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
index c2afe12b..0935517f 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -129,8 +129,8 @@ public class CryptoCipherFactory {
/**
* For AES, the algorithm block is fixed size of 128 bits.
*
- * @see http://en.wikipedia.org/wiki/Advanced_Encryption_Standard";>
- * http://en.wikipedia.org/wiki/Advanced_Encryption_Standard
+ * @see https://en.wikipedia.org/wiki/Advanced_Encryption_Standard";>
+ * https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
*/
public static final int AES_BLOCK_SIZE = 16;
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
index 7ec0353a..0322f3e3 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
@@ -41,8 +41,8 @@ import com.sun.jna.ptr.PointerByReference;
*
* @see https://wiki.openssl.org/index.php/Random_Numbers";>
* https://wiki.openssl.org/index.php/Random_Numbers
- * @see http://en.wikipedia.org/wiki/RdRand";>
- * http://en.wikipedia.org/wiki/RdRand
+ * @see https://en.wikipedia.org/wiki/RdRand";>
+ * https://en.wikipedia.org/wiki/RdRand
*/
final class OpenSslJnaCryptoRandom implements CryptoRandom {
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslMacOS.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslMacOS.java
index 38b3334f..549d23a7 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslMacOS.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslMacOS.java
@@ -29,7 +29,7 @@ class OpenSslMacOS {
/*
* The method is declared as 'bool dlopen_preflight(const char* path)',
which is not a standard
* JNA type, see:
- *
http://java-native-access.github.io/jna/5.13.0/javadoc/overview-summary.html#marshalling
+ *
https://java-native-access.github.io/jna/5.13.0/javadoc/overview-summary.html#marshalling
* bool appears to be closest to a byte, where non-zero is true and zero
is false
*/
static native byte dlopen_preflight(String path);
diff --git
a/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
index e11a8a67..c49bd4e4 100644
--- a/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
@@ -38,7 +38,7 @@ import org.apache.commons.crypto.Crypto;
*
*
* @see https://wiki.openssl.org/index.php/Random_Numbers";>
https://wiki.openssl.org/index.php/Random_Numbers
- * @see http://en.wikipedia.org/wiki/RdRand";>
http://en.wikipedia.org/wiki/RdRand
+ * @see https://en.wikipedia.org/wiki/RdRand";>
https://en.wikipedia.org/wiki/RdRand
*/
final class OpenSslCryptoRandom implements CryptoRandom {
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
index 89c193ae..6b4f4fd1 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -66,8 +66,8 @@ public class CtrCryptoInputStream extends CryptoInputStream {
* a lossless operation (concatenation, addition, or XOR).
*
* @see http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_.28CTR.29";>
- *
http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_.28CTR.29
+ *
href="https://en.wikipedia.org/wiki/Block_cipher_
(commons-crypto) branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 169e57ba Javadoc
169e57ba is described below
commit 169e57bae3c9aac61194c1bb222f59cffbd2bb95
Author: Gary Gregory
AuthorDate: Thu Dec 14 13:49:39 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/crypto/utils/Utils.java | 4 ++--
.../java/org/apache/commons/crypto/cipher/AbstractCipherTest.java | 8
.../commons/crypto/stream/PositionedCryptoInputStreamTest.java| 8
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/utils/Utils.java
b/src/main/java/org/apache/commons/crypto/utils/Utils.java
index 57bfc3da..baa4bd83 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -37,10 +37,10 @@ import org.apache.commons.crypto.cipher.CryptoCipherFactory;
*/
public final class Utils {
-/** mask to keep a byte from a longer number */
+/** Mask to keep a byte from a longer number */
public static final int BYTE_MASK = 0xFF;
-/** maximum number of OpenSslVersion entries to retrieve */
+/** Maximum number of OpenSslVersion entries to retrieve */
public static final int OPENSSL_VERSION_MAX_INDEX = 20; // max seen so far
is 9, but leave some spare
private static final class DefaultPropertiesHolder {
diff --git
a/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
b/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
index 2bca20ef..7b945f3f 100644
--- a/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
+++ b/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
@@ -67,7 +67,7 @@ public abstract class AbstractCipherTest {
private CryptoCipher enc, dec;
- /** test byte array whose data is randomly generated */
+ /** Test byte array whose data is randomly generated */
private void byteArrayTest(final String transformation, final byte[]
key, final byte[] iv) throws Exception {
final int blockSize = enc.getBlockSize();
@@ -116,7 +116,7 @@ public abstract class AbstractCipherTest {
}
}
- /** test byte array whose data is planned in {@link TestData} */
+ /** Test byte array whose data is planned in {@link TestData} */
private void byteArrayTest(final String transformation, final byte[]
key, final byte[] iv, final byte[] input,
final byte[] output) throws Exception {
resetCipher(transformation, key, iv);
@@ -237,7 +237,7 @@ public abstract class AbstractCipherTest {
@Test
public void testCryptoTest() throws Exception {
for (final String tran : transformations) {
- /** uses the small data set in {@link TestData} */
+ /** Uses the small data set in {@link TestData} */
cipherTests = TestData.getTestData(tran);
assertNotNull(cipherTests, "TestData cannot supply data
for: " + tran);
for (int i = 0; i != cipherTests.length; i += 5) {
@@ -258,7 +258,7 @@ public abstract class AbstractCipherTest {
byteArrayTest(tran, key, iv, inputBytes,
outputBytes);
}
- /** uses randomly generated big data set */
+ /** Uses randomly generated big data set */
byteArrayTest(tran, KEY, IV);
}
}
diff --git
a/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
b/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
index d661f29f..637d1d3c 100644
---
a/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
+++
b/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
@@ -157,7 +157,7 @@ public class PositionedCryptoInputStreamTest {
prepareData();
}
-/** compare the data from pos with length and data2 from 0 with length. */
+/** Compares the data from pos with length and data2 from 0 with length. */
private void compareByteArray(final byte[] data1, final int pos, final
byte[] data2,
final int length) {
final byte[] expectedData = new byte[length];
@@ -353,7 +353,7 @@ public class PositionedCryptoInputStreamTest {
}
}
-/** test for the out of index position, eg, -1. */
+/** Tests for the out of index position, eg, -1. */
private void testPositionedReadNone(final String cipherClass, final int
position,
final int length, final int bufferSize) throws Exception {
(commons-crypto) branch master updated: Javadoc
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-crypto.git The following commit(s) were added to refs/heads/master by this push: new 99347bfb Javadoc 99347bfb is described below commit 99347bfb5c1231e20cb8b6c03c099b078e3e4af1 Author: Gary Gregory AuthorDate: Thu Dec 14 10:26:19 2023 -0500 Javadoc --- src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java | 2 +- .../java/org/apache/commons/crypto/stream/CryptoOutputStream.java | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java index e04a855e..5d32d1dc 100644 --- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java +++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java @@ -118,7 +118,7 @@ public class CryptoInputStream extends InputStream implements ReadableByteChanne /** Crypto key for the cipher. */ final Key key; // package protected for access by crypto classes; do not expose further -/** the algorithm parameters */ +/** The algorithm parameters */ private final AlgorithmParameterSpec params; /** Flag to mark whether the input stream is closed. */ diff --git a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java index ecc9da99..d1128982 100644 --- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java +++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java @@ -55,7 +55,7 @@ public class CryptoOutputStream extends OutputStream implements /** The output. */ final Output output; // package protected for access by rypto classes; do not expose further -/** the CryptoCipher instance */ +/** The CryptoCipher instance */ final CryptoCipher cipher; // package protected for access by crypto classes; do not expose further /** The buffer size. */ @@ -64,7 +64,7 @@ public class CryptoOutputStream extends OutputStream implements /** Crypto key for the cipher. */ final Key key; // package protected for access by crypto classes; do not expose further -/** the algorithm parameters */ +/** The algorithm parameters */ private final AlgorithmParameterSpec params; /** Flag to mark whether the output stream is closed. */
(commons-crypto) branch master updated: Javadoc: Remove redundant "java.lang" prefix
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 498067a6 Javadoc: Remove redundant "java.lang" prefix
498067a6 is described below
commit 498067a6d7ac7678d77e861724ee1831852cef43
Author: Gary Gregory
AuthorDate: Sat Dec 9 10:05:59 2023 -0500
Javadoc: Remove redundant "java.lang" prefix
---
src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java | 2 +-
src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java| 2 +-
src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java | 2 +-
src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
index d2575606..7ec0353a 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
@@ -90,7 +90,7 @@ final class OpenSslJnaCryptoRandom implements CryptoRandom {
}
/**
- * Overrides {@link java.lang.AutoCloseable#close()}. Closes OpenSSL
context
+ * Overrides {@link AutoCloseable#close()}. Closes OpenSSL context
* if native enabled.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
index 97afe673..38ed20d1 100644
--- a/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
@@ -51,7 +51,7 @@ final class JavaCryptoRandom implements CryptoRandom {
}
/**
- * Overrides {@link java.lang.AutoCloseable#close()}. For {@link
JavaCryptoRandom}, we don't need to recycle resource.
+ * Overrides {@link AutoCloseable#close()}. For {@link JavaCryptoRandom},
we don't need to recycle resource.
*/
@Override
public void close() {
diff --git
a/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
index 71606d28..e11a8a67 100644
--- a/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
@@ -90,7 +90,7 @@ final class OpenSslCryptoRandom implements CryptoRandom {
}
/**
- * Overrides {@link java.lang.AutoCloseable#close()}.
+ * Overrides {@link AutoCloseable#close()}.
* Does nothing.
*/
@Override
diff --git a/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
index 6e459231..f27199c4 100644
--- a/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
@@ -68,7 +68,7 @@ final class OsCryptoRandom implements CryptoRandom {
}
/**
- * Overrides {@link java.lang.AutoCloseable#close()}. Closes the OS stream.
+ * Overrides {@link AutoCloseable#close()}. Closes the OS stream.
*/
@Override
synchronized public void close() {
(commons-crypto) branch master updated: Javadoc [skip ci]
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 4c5bc130 Javadoc [skip ci]
4c5bc130 is described below
commit 4c5bc130dd331adc4a3dd240b29b6b0ba6c4308c
Author: Sebb
AuthorDate: Thu Nov 30 21:57:18 2023 +
Javadoc [skip ci]
---
src/main/java/org/apache/commons/crypto/Crypto.java | 1 +
src/main/java/org/apache/commons/crypto/utils/Utils.java | 5 -
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/crypto/Crypto.java
b/src/main/java/org/apache/commons/crypto/Crypto.java
index f633f5fb..b73e3597 100644
--- a/src/main/java/org/apache/commons/crypto/Crypto.java
+++ b/src/main/java/org/apache/commons/crypto/Crypto.java
@@ -112,6 +112,7 @@ public final class Crypto {
*/
public static final String MACOS_LIBRARY_NAME_DEFAULT = "libcrypto.dylib";
+/** If true, print some debug output */
public static final boolean IS_DEBUG =
Boolean.getBoolean(Crypto.CONF_PREFIX + "debug");
private static boolean quiet;
diff --git a/src/main/java/org/apache/commons/crypto/utils/Utils.java
b/src/main/java/org/apache/commons/crypto/utils/Utils.java
index fbc61ec2..57bfc3da 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -37,7 +37,10 @@ import org.apache.commons.crypto.cipher.CryptoCipherFactory;
*/
public final class Utils {
-public static final int BYTE_MASK = 0xFF; // mask to keep a byte from a
longer number
+/** mask to keep a byte from a longer number */
+public static final int BYTE_MASK = 0xFF;
+
+/** maximum number of OpenSslVersion entries to retrieve */
public static final int OPENSSL_VERSION_MAX_INDEX = 20; // max seen so far
is 9, but leave some spare
private static final class DefaultPropertiesHolder {
(commons-crypto) branch master updated: Javadoc spelling
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 896a4cbd Javadoc spelling
896a4cbd is described below
commit 896a4cbd95a2eaa3c83723cf0bac3a42b9524e45
Author: Gary Gregory
AuthorDate: Sun Nov 26 15:47:15 2023 -0500
Javadoc spelling
---
src/main/java/org/apache/commons/crypto/NativeCodeLoader.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
index 0f773145..9bb9c0d4 100644
--- a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
+++ b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
@@ -33,7 +33,7 @@ import org.apache.commons.io.IOUtils;
/**
* A helper to load the native code i.e. libcommons-crypto.so. This handles the
* fallback to either the bundled libcommons-crypto-Linux-i386-32.so or the
- * default java implementations where appropriate.
+ * default Java implementations where appropriate.
*/
final class NativeCodeLoader {
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 1f32f54 Javadoc
1f32f54 is described below
commit 1f32f543c8c790b09b1bc99c521fbc801584b0bf
Author: Gary Gregory
AuthorDate: Sat Oct 21 11:24:36 2023 -0400
Javadoc
---
.../org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java | 8 +++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
index e680348..928e58c 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
@@ -25,13 +25,19 @@ import com.sun.jna.ptr.PointerByReference;
/**
* This interface defines the API for the native code.
+ *
* All methods are listed here; individual implementations may not support
them all.
+ *
*/
interface OpenSslInterfaceNativeJna {
PointerByReference _ENGINE_by_id(final String string);
-/** TODO Appears to be deprecated as of OpenSSL 1.1.0. */
+/**
+ * TODO Appears to be deprecated as of OpenSSL 1.1.0.
+ *
+ * @return See OpenSSL.
+ */
int _ENGINE_cleanup();
int _ENGINE_finish(final PointerByReference rdrandEngine);
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 386af8a Javadoc
386af8a is described below
commit 386af8a10b7a3865553097060973337b1c553090
Author: Gary Gregory
AuthorDate: Thu Oct 19 07:29:25 2023 -0400
Javadoc
---
.../java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java| 4 ++--
.../java/org/apache/commons/crypto/random/CryptoRandomFactory.java| 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
index 5da9680..c3fbdf9 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -170,12 +170,12 @@ public class CryptoCipherFactory {
* @param transformation algorithm/mode/padding
* @return CryptoCipher the cipher (defaults to OpenSslCipher)
* @throws GeneralSecurityException if cipher initialize failed
- * @throws IllegalArgumentException if no classname(s) were provided
+ * @throws IllegalArgumentException if no class name(s) were provided
*/
public static CryptoCipher getCryptoCipher(final String transformation,
final Properties properties) throws GeneralSecurityException {
final List names =
Utils.splitClassNames(getCipherClassString(properties), ",");
if (names.isEmpty()) {
-throw new IllegalArgumentException("No classname(s) provided");
+throw new IllegalArgumentException("No class name(s) provided");
}
CryptoCipher cipher = null;
Exception lastException = null;
diff --git
a/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
b/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
index cad051a..75141fd 100644
--- a/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
+++ b/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
@@ -173,7 +173,7 @@ public class CryptoRandomFactory {
* @param props the configuration properties.
* @return CryptoRandom the cryptoRandom object.
* @throws GeneralSecurityException if cannot create the {@link
CryptoRandom} class
- * @throws IllegalArgumentException if no classname(s) are provided
+ * @throws IllegalArgumentException if no class name(s) are provided
*/
public static CryptoRandom getCryptoRandom(final Properties props)
throws GeneralSecurityException {
[commons-crypto] branch master updated: Javadoc/Comments: Remove extra "whitespace"
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new b884c5a Javadoc/Comments: Remove extra "whitespace"
b884c5a is described below
commit b884c5a0faafe0c98a252109a2ddaa4855a1d04d
Author: Gary Gregory
AuthorDate: Sat Mar 25 09:22:40 2023 -0400
Javadoc/Comments: Remove extra "whitespace"
---
src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java | 1 -
src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java | 1 -
src/test/java/org/apache/commons/crypto/CryptoTest.java | 1 -
.../apache/commons/crypto/jna/PositionedCryptoInputStreamJnaTest.java | 2 --
src/test/java/org/apache/commons/crypto/random/AbstractRandom.java | 1 -
src/test/java/org/apache/commons/crypto/random/FailingRandom.java | 1 -
src/test/java/org/apache/commons/crypto/random/NoopRandom.java | 1 -
7 files changed, 8 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
index a892639..44d1974 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
@@ -13,7 +13,6 @@
* 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;
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index 1c422fd..2802911 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -46,7 +46,6 @@ import org.apache.commons.crypto.utils.Utils;
* CryptoInputStream reads input data and decrypts data in stream manner. It
* supports any mode of operations such as AES CBC/CTR/GCM mode in concept.It
is
* not thread-safe.
- *
*/
public class CryptoInputStream extends InputStream implements
ReadableByteChannel {
diff --git a/src/test/java/org/apache/commons/crypto/CryptoTest.java
b/src/test/java/org/apache/commons/crypto/CryptoTest.java
index b64a1be..72cfb45 100644
--- a/src/test/java/org/apache/commons/crypto/CryptoTest.java
+++ b/src/test/java/org/apache/commons/crypto/CryptoTest.java
@@ -13,7 +13,6 @@
* 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;
diff --git
a/src/test/java/org/apache/commons/crypto/jna/PositionedCryptoInputStreamJnaTest.java
b/src/test/java/org/apache/commons/crypto/jna/PositionedCryptoInputStreamJnaTest.java
index feb7bec..2eff596 100644
---
a/src/test/java/org/apache/commons/crypto/jna/PositionedCryptoInputStreamJnaTest.java
+++
b/src/test/java/org/apache/commons/crypto/jna/PositionedCryptoInputStreamJnaTest.java
@@ -13,7 +13,6 @@
* 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;
@@ -24,7 +23,6 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- *
*/
public class PositionedCryptoInputStreamJnaTest extends
PositionedCryptoInputStreamTest {
diff --git a/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
b/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
index 3399b11..6207bcf 100644
--- a/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
+++ b/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
@@ -13,7 +13,6 @@
* 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.random;
diff --git a/src/test/java/org/apache/commons/crypto/random/FailingRandom.java
b/src/test/java/org/apache/commons/crypto/random/FailingRandom.java
index 01c8cdf..49ccc62 100644
--- a/src/test/java/org/apache/commons/crypto/random/FailingRandom.java
+++ b/src/test/java/org/apache/commons/crypto/random/FailingRandom.java
@@ -13,7 +13,6 @@
* 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.random;
diff --git a/src/test/java/org/apache/commons/crypto/random/NoopRandom.java
b/src/test/java/org/apache/commons/crypto/rand
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 054b9e0 Javadoc
054b9e0 is described below
commit 054b9e017a0ccfac13272872e025ad6263d35ef1
Author: Gary Gregory
AuthorDate: Sun Dec 18 16:59:50 2022 -0500
Javadoc
---
src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
index b213e97..dc62706 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
@@ -20,8 +20,8 @@ package org.apache.commons.crypto.cipher;
import java.nio.ByteBuffer;
/**
- * JNI interface of {@link OpenSsl} implementation. The native method in this
- * class is defined in OpenSslNative.h (generated by javah).
+ * JNI implementation for OpenSSL 1.x called from {@link OpenSsl}. The native
methods in this
+ * class are defined in OpenSslNative.h (generated by javah).
*/
final class OpenSslNative {
@@ -154,7 +154,7 @@ final class OpenSslNative {
ByteBuffer output, int
outputOffset, int maxOutputLength);
/**
- * Hides private constructor from external access.
+ * Hides this constructor from external access.
*/
private OpenSslNative() {
}
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new fe7241d Javadoc
fe7241d is described below
commit fe7241de2e3aab2832168082103c025f5c2bbf53
Author: Gary Gregory
AuthorDate: Sun Dec 18 08:19:49 2022 -0500
Javadoc
---
src/main/java/org/apache/commons/crypto/utils/AES.java | 17 +
1 file changed, 17 insertions(+)
diff --git a/src/main/java/org/apache/commons/crypto/utils/AES.java
b/src/main/java/org/apache/commons/crypto/utils/AES.java
index d7b6256..684b580 100644
--- a/src/main/java/org/apache/commons/crypto/utils/AES.java
+++ b/src/main/java/org/apache/commons/crypto/utils/AES.java
@@ -29,10 +29,27 @@ public class AES {
/** The AES algorithm name. */
public static final String ALGORITHM = "AES";
+/**
+ * Defines {@value}.
+ */
public static final String CBC_NO_PADDING = "AES/CBC/NoPadding";
+
+/**
+ * Defines {@value}.
+ */
public static final String CBC_PKCS5_PADDING = "AES/CBC/PKCS5Padding";
+
+/**
+ * Defines {@value}.
+ */
public static final String CTR_NO_PADDING = "AES/CTR/NoPadding";
+/**
+ * Creates a new SecretKeySpec for the given key and {@link #ALGORITHM}.
+ *
+ * @param key a key.
+ * @return a new SecretKeySpec.
+ */
public static SecretKeySpec newSecretKeySpec(final byte[] key) {
return new SecretKeySpec(key, ALGORITHM);
}
[commons-crypto] branch master updated: Javadoc tweak
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 6ea1717 Javadoc tweak
6ea1717 is described below
commit 6ea1717967ef497275632c0dd55f461c772468e3
Author: Gary Gregory
AuthorDate: Sun Dec 18 06:24:49 2022 -0500
Javadoc tweak
---
src/main/java/org/apache/commons/crypto/utils/Utils.java | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/crypto/utils/Utils.java
b/src/main/java/org/apache/commons/crypto/utils/Utils.java
index 93a9dad..1e9a06d 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -76,7 +76,6 @@ public final class Utils {
/**
* The file name of configuration file.
- *
*/
private static final String SYSTEM_PROPERTIES_FILE = Crypto.CONF_PREFIX +
"properties";
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new b922636 Javadoc
b922636 is described below
commit b922636fe96f7ca653d9054c50747803826bb2ae
Author: Gary Gregory
AuthorDate: Thu Dec 15 15:56:31 2022 -0500
Javadoc
---
src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
index f116a7e..b213e97 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
@@ -154,7 +154,7 @@ final class OpenSslNative {
ByteBuffer output, int
outputOffset, int maxOutputLength);
/**
- * The private constructor of {@link OpenSslNative}.
+ * Hides private constructor from external access.
*/
private OpenSslNative() {
}
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 2ad9665 Javadoc
2ad9665 is described below
commit 2ad9665b5267736bedf0c942cc56f2938118703f
Author: Gary Gregory
AuthorDate: Wed Dec 14 07:44:30 2022 -0500
Javadoc
---
src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
index 8b8a85b..f116a7e 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
@@ -33,7 +33,7 @@ final class OpenSslNative {
public static native void clean(long context);
/**
- * allows various cipher specific parameters to be determined and set.
+ * Allows various cipher specific parameters to be determined and set.
*
* it will call OpenSSL's API
* int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void
*ptr)
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 89e9666 Javadoc
89e9666 is described below
commit 89e9666bc268ee56f224e3b639d1db87428a3613
Author: Gary Gregory
AuthorDate: Mon Dec 12 21:50:20 2022 -0500
Javadoc
---
.../java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java| 1 +
1 file changed, 1 insertion(+)
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
index 97d3d4a..010e70d 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
@@ -84,6 +84,7 @@ interface OpenSslInterfaceNativeJna {
void _ENGINE_load_rdrand();
+/** TODO Appears to be deprecated as of OpenSSL 1.1.0. */
int _ENGINE_cleanup();
void _EVP_CIPHER_CTX_cleanup(final PointerByReference context);
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 8a0abcd Javadoc
8a0abcd is described below
commit 8a0abcd267a0847a58ca773c474b6473134c324c
Author: Gary Gregory
AuthorDate: Mon Dec 12 13:27:17 2022 -0500
Javadoc
---
src/test/java/org/apache/commons/crypto/random/AbstractRandom.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
b/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
index cd40350..3399b11 100644
--- a/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
+++ b/src/test/java/org/apache/commons/crypto/random/AbstractRandom.java
@@ -20,7 +20,7 @@ package org.apache.commons.crypto.random;
import java.util.Properties;
/**
- * For testing class creation. An abstract class cannot be instantiated.
+ * Only provides a constructor.
*/
abstract class AbstractRandom implements CryptoRandom {
[commons-crypto] branch master updated: Javadoc
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 7b4d5be Javadoc
7b4d5be is described below
commit 7b4d5bee79c8ef5c0463fc4b820ea407c6b223ca
Author: Gary Gregory
AuthorDate: Sun Dec 11 20:10:30 2022 -0500
Javadoc
---
.../org/apache/commons/crypto/stream/input/ChannelInput.java | 8 +---
.../java/org/apache/commons/crypto/stream/input/Input.java | 10 +++---
.../org/apache/commons/crypto/stream/input/StreamInput.java| 6 --
.../org/apache/commons/crypto/stream/output/ChannelOutput.java | 6 --
.../java/org/apache/commons/crypto/stream/output/Output.java | 10 +++---
.../org/apache/commons/crypto/stream/output/StreamOutput.java | 6 --
6 files changed, 31 insertions(+), 15 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
index b2f26c0..e820e25 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
@@ -21,10 +21,12 @@ import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
+import org.apache.commons.crypto.stream.CryptoInputStream;
+
/**
- * The ChannelInput class takes a {@code ReadableByteChannel} object and
- * wraps it as {@code Input} object acceptable by
- * {@code CryptoInputStream}.
+ * The ChannelInput class takes a {@link ReadableByteChannel} object and
+ * wraps it as {@link Input} object acceptable by
+ * {@link CryptoInputStream}.
*/
public class ChannelInput implements Input {
private static final int SKIP_BUFFER_SIZE = 2048;
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
index b7d6f92..8e1b605 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
@@ -19,14 +19,18 @@ package org.apache.commons.crypto.stream.input;
import java.io.Closeable;
import java.io.IOException;
+import java.io.InputStream;
import java.nio.ByteBuffer;
+import java.nio.channels.ReadableByteChannel;
+
+import org.apache.commons.crypto.stream.CryptoInputStream;
/**
* The Input interface abstract the input source of
- * {@code CryptoInputStream} so that different implementation of input can
+ * {@link CryptoInputStream} so that different implementation of input can
* be used. The implementation Input interface will usually wraps an input
- * mechanism such as {@code InputStream} or
- * {@code ReadableByteChannel}.
+ * mechanism such as {@link InputStream} or
+ * {@link ReadableByteChannel}.
*/
public interface Input extends Closeable {
/**
diff --git
a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
index 38d542c..9dce567 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
@@ -23,9 +23,11 @@ import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
+import org.apache.commons.crypto.stream.CryptoInputStream;
+
/**
- * The StreamInput class takes a {@code InputStream} object and wraps it as
- * {@code Input} object acceptable by {@code CryptoInputStream}.
+ * The StreamInput class takes a {@link InputStream} object and wraps it as
+ * {@link Input} object acceptable by {@link CryptoInputStream}.
*/
public class StreamInput implements Input {
diff --git
a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
index 8f517c8..9fcf3a3 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
@@ -21,10 +21,12 @@ import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.WritableByteChannel;
+import org.apache.commons.crypto.stream.CryptoOutputStream;
+
/**
- * The ChannelOutput class takes a {@code WritableByteChannel} object and
+ * The ChannelOutput class takes a {@link WritableByteChannel} object and
* wraps it as {@code Output} object acceptable by
- * {@code CryptoOutputStream} as the output target.
+ * {@link CryptoOutputStream} as the output target.
*/
public class ChannelOutput implements Output {
diff --git a/src/main/java/org/apache/commons/crypto/stream/output/Output.java
b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
index 7df87fa..d5ecc35 100644
--- a/src/main/java/org/apache/commons/cryp
[commons-crypto] branch master updated: Javadoc.
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new e58cc27 Javadoc.
e58cc27 is described below
commit e58cc27f74173771f3eec3d2a1590b1b045569f9
Author: Gary Gregory
AuthorDate: Thu Mar 17 09:47:52 2022 -0400
Javadoc.
---
.../commons/crypto/cipher/OpenSslGaloisCounterMode.java | 15 ++-
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
index cb3e23c..d8b8de4 100644
---
a/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
+++
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
@@ -292,18 +292,23 @@ class OpenSslGaloisCounterMode extends
OpenSslFeedbackCipher {
}
/**
- * a wrapper of OpenSslNative.ctrl(long context, int type, int arg, byte[]
data)
+ * Wraps of OpenSslNative.ctrl(long context, int type, int arg, byte[]
data)
* Since native interface EVP_CIPHER_CTX *ctx, int type, int arg, void
*ptr) is generic,
* it may set/get any native char or long type to the data buffer(ptr).
* Here we use ByteBuffer and set nativeOrder to handle the endianness.
+ *
+ * @param context The cipher context address
+ * @param type CtrlValues
+ * @param arg argument like a tag length
+ * @param data byte buffer or null
*/
-private void evpCipherCtxCtrl(final long context, final int type, final
int arg, final ByteBuffer bb) {
+private void evpCipherCtxCtrl(final long context, final int type, final
int arg, final ByteBuffer data) {
checkState();
try {
-if (bb != null) {
-bb.order(ByteOrder.nativeOrder());
-OpenSslNative.ctrl(context, type, arg, bb.array());
+if (data != null) {
+data.order(ByteOrder.nativeOrder());
+OpenSslNative.ctrl(context, type, arg, data.array());
} else {
OpenSslNative.ctrl(context, type, arg, null);
}
[commons-crypto] branch master updated: Javadoc: Fix spelling.
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new d430d92 Javadoc: Fix spelling.
d430d92 is described below
commit d430d92f059895b7857af9327cc65ae9068243d6
Author: Gary Gregory
AuthorDate: Sun Aug 23 14:08:20 2020 -0400
Javadoc: Fix spelling.
---
.../org/apache/commons/crypto/stream/CryptoInputStream.java| 10 +-
.../org/apache/commons/crypto/stream/CryptoOutputStream.java | 10 +-
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index 7490180..fc0225b 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -60,13 +60,13 @@ public class CryptoInputStream extends InputStream
implements
+ "stream.buffer.size";
/** The CryptoCipher instance. */
-final CryptoCipher cipher; // package protected for access by crypto
classes; do not expose futher
+final CryptoCipher cipher; // package protected for access by crypto
classes; do not expose further
/** The buffer size. */
private final int bufferSize;
/** Crypto key for the cipher. */
-final Key key; // package protected for access by crypto classes; do not
expose futher
+final Key key; // package protected for access by crypto classes; do not
expose further
/** the algorithm parameters */
private final AlgorithmParameterSpec params;
@@ -80,19 +80,19 @@ public class CryptoInputStream extends InputStream
implements
private boolean finalDone = false;
/** The input data. */
-Input input; // package protected for access by crypto classes; do not
expose futher
+Input input; // package protected for access by crypto classes; do not
expose further
/**
* Input data buffer. The data starts at inBuffer.position() and ends at to
* inBuffer.limit().
*/
-ByteBuffer inBuffer; // package protected for access by crypto classes; do
not expose futher
+ByteBuffer inBuffer; // package protected for access by crypto classes; do
not expose further
/**
* The decrypted data buffer. The data starts at outBuffer.position() and
* ends at outBuffer.limit().
*/
-ByteBuffer outBuffer; // package protected for access by crypto classes;
do not expose futher
+ByteBuffer outBuffer; // package protected for access by crypto classes;
do not expose further
// stream related configuration keys
/**
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
index b581356..8394ff6 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -56,16 +56,16 @@ public class CryptoOutputStream extends OutputStream
implements
private final byte[] oneByteBuf = new byte[1];
/** The output. */
-Output output; // package protected for access by crypto classes; do not
expose futher
+Output output; // package protected for access by rypto classes; do not
expose further
/** the CryptoCipher instance */
-final CryptoCipher cipher; // package protected for access by crypto
classes; do not expose futher
+final CryptoCipher cipher; // package protected for access by crypto
classes; do not expose further
/** The buffer size. */
private final int bufferSize;
/** Crypto key for the cipher. */
-final Key key; // package protected for access by crypto classes; do not
expose futher
+final Key key; // package protected for access by crypto classes; do not
expose further
/** the algorithm parameters */
private final AlgorithmParameterSpec params;
@@ -77,13 +77,13 @@ public class CryptoOutputStream extends OutputStream
implements
* Input data buffer. The data starts at inBuffer.position() and ends at
* inBuffer.limit().
*/
-ByteBuffer inBuffer; // package protected for access by crypto classes; do
not expose futher
+ByteBuffer inBuffer; // package protected for access by crypto classes; do
not expose further
/**
* Encrypted data buffer. The data starts at outBuffer.position() and ends
* at outBuffer.limit().
*/
-ByteBuffer outBuffer; // package protected for access by crypto classes;
do not expose futher
+ByteBuffer outBuffer; // package protected for access by crypto classes;
do not expose further
/**
* Constructs a {@link CryptoOutputStream}.
[commons-crypto] branch master updated: Javadoc fix (Java 11): Replace Foo with {@code Foo}
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 51fa279 Javadoc fix (Java 11): Replace Foo with {@code Foo}
51fa279 is described below
commit 51fa279fd5f1168e10f299b3c079da6069843cb7
Author: Gary Gregory
AuthorDate: Fri Jul 31 11:41:49 2020 -0400
Javadoc fix (Java 11): Replace Foo with {@code Foo}
---
.../org/apache/commons/crypto/stream/CryptoInputStream.java| 4 ++--
.../org/apache/commons/crypto/stream/CryptoOutputStream.java | 2 +-
.../org/apache/commons/crypto/stream/CtrCryptoInputStream.java | 4 ++--
.../java/org/apache/commons/crypto/stream/input/Input.java | 10 +-
.../java/org/apache/commons/crypto/stream/output/Output.java | 10 +-
5 files changed, 15 insertions(+), 15 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index 66aa0c1..0a74578 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -388,7 +388,7 @@ public class CryptoInputStream extends InputStream
implements
/**
* Overrides the {@link java.nio.channels.Channel#isOpen()}.
*
- * @return true if, and only if, this channel is open.
+ * @return {@code true} if, and only if, this channel is open.
*/
@Override
public boolean isOpen() {
@@ -401,7 +401,7 @@ public class CryptoInputStream extends InputStream
implements
* sequence of bytes from this channel into the given buffer.
*
* @param dst The buffer into which bytes are to be transferred.
- * @return The number of bytes read, possibly zero, or -1 if the
+ * @return The number of bytes read, possibly zero, or {@code -1} if the
* channel has reached end-of-stream.
* @throws IOException if an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
index e9228c4..343f5eb 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -284,7 +284,7 @@ public class CryptoOutputStream extends OutputStream
implements
* Overrides the {@link java.nio.channels.Channel#isOpen()}. Tells whether
or not this channel
* is open.
*
- * @return true if, and only if, this channel is open
+ * @return {@code true} if, and only if, this channel is open
*/
@Override
public boolean isOpen() {
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
index d27837d..5d79dac 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -295,7 +295,7 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
* sequence of bytes from this channel into the given buffer.
*
* @param buf The buffer into which bytes are to be transferred.
- * @return The number of bytes read, possibly zero, or -1 if the
+ * @return The number of bytes read, possibly zero, or {@code -1} if the
* channel has reached end-of-stream.
* @throws IOException if an I/O error occurs.
*/
@@ -441,7 +441,7 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
/**
* Does the decryption using inBuffer as input and buf as output. Upon
* return, inBuffer is cleared; the buf's position will be equal to
- * p + n where p is the position
+ * p {@code +} n where p is the position
* before decryption, n is the number of bytes decrypted. The buf's
* limit will not have changed.
*
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
index 54c17ae..28ec22c 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
@@ -34,17 +34,17 @@ public interface Input {
*
* An attempt is made to read up to r bytes from the input, where
* r is the number of bytes remaining in the buffer, that is,
- * dst.remaining(), at the moment this method is invoked.
+ * {@code dst.remaining()}, at the moment this method is invoked.
*
*
- * Suppose that a byte sequence of length n is read, where
0
- * <= n <= r.
+ * Suppose that a byte sequence of length n is read, where {@code 0}
+ * {@code <=} n {@code <=
[commons-crypto] branch master updated: Javadoc: Replace HTML tags with Javadoc {@code} notation.
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 3b5c553 Javadoc: Replace HTML tags with Javadoc {@code}
notation.
3b5c553 is described below
commit 3b5c553f936b2d95100c990ea7238f62ddc9e47f
Author: Gary Gregory
AuthorDate: Tue Dec 10 00:19:00 2019 -0500
Javadoc: Replace HTML tags with Javadoc {@code} notation.
---
.../apache/commons/crypto/NativeCodeLoader.java| 2 +-
.../apache/commons/crypto/cipher/CryptoCipher.java | 6 +++---
.../commons/crypto/cipher/CryptoCipherFactory.java | 2 +-
.../apache/commons/crypto/cipher/JceCipher.java| 6 +++---
.../org/apache/commons/crypto/cipher/OpenSsl.java | 24 +++---
.../commons/crypto/cipher/OpenSslCipher.java | 4 ++--
.../commons/crypto/jna/OpenSslJnaCipher.java | 4 ++--
.../commons/crypto/jna/OpenSslJnaCryptoRandom.java | 4 ++--
.../commons/crypto/random/CryptoRandomFactory.java | 2 +-
.../commons/crypto/random/OpenSslCryptoRandom.java | 4 ++--
.../commons/crypto/stream/CryptoInputStream.java | 10 -
.../commons/crypto/stream/CryptoOutputStream.java | 4 ++--
.../crypto/stream/CtrCryptoInputStream.java| 10 -
.../crypto/stream/CtrCryptoOutputStream.java | 8
.../crypto/stream/PositionedCryptoInputStream.java | 2 +-
.../commons/crypto/stream/input/ChannelInput.java | 16 +++
.../apache/commons/crypto/stream/input/Input.java | 24 +++---
.../commons/crypto/stream/input/StreamInput.java | 14 ++---
.../crypto/stream/output/ChannelOutput.java| 6 +++---
.../commons/crypto/stream/output/Output.java | 8
.../commons/crypto/stream/output/StreamOutput.java | 4 ++--
.../org/apache/commons/crypto/utils/Utils.java | 2 +-
22 files changed, 83 insertions(+), 83 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
index ea4f35d..edb1973 100644
--- a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
+++ b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
@@ -255,7 +255,7 @@ final class NativeCodeLoader {
/**
* Checks whether native code is loaded for this platform.
*
- * @return true if native is loaded, else false.
+ * @return {@code true} if native is loaded, else {@code false}.
*/
static boolean isNativeCodeLoaded() {
return nativeCodeLoaded;
diff --git a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
index 722bc6c..ea1edfd 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
@@ -70,7 +70,7 @@ public interface CryptoCipher extends Closeable {
* policy files).
* @throws InvalidAlgorithmParameterException if the given algorithm
* parameters are inappropriate for this cipher, or this cipher
- * requires algorithm parameters and params is null,
or
+ * requires algorithm parameters and {@code params} is null, or
* the given algorithm parameters imply a cryptographic strength
* that would exceed the legal limits (as determined from the
* configured jurisdiction policy files).
@@ -84,7 +84,7 @@ public interface CryptoCipher extends Closeable {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in output
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if there is insufficient space in the
output
* buffer
*/
@@ -113,7 +113,7 @@ public interface CryptoCipher extends Closeable {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in output
+ * @return int number of bytes stored in {@code output}
* @throws BadPaddingException if this cipher is in decryption mode, and
* (un)padding has been requested, but the decrypted data is not
* bounded by the appropriate padding bytes
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
index 7de06ce..669a001 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -195,7 +195,7 @@ public class CryptoCipherFactory {
/**
* Gets the cipher class.
*
- * @param props The Properties class represents a se
[commons-crypto] branch master updated: Javadoc: Use "file name" instead of "filename".
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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new aeec456 Javadoc: Use "file name" instead of "filename".
aeec456 is described below
commit aeec456c7e828fdd6f9252f9bc358347fdbdfba1
Author: Gary Gregory
AuthorDate: Thu May 30 15:18:12 2019 -0400
Javadoc: Use "file name" instead of "filename".
---
src/main/java/org/apache/commons/crypto/utils/Utils.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/crypto/utils/Utils.java
b/src/main/java/org/apache/commons/crypto/utils/Utils.java
index 0bef9ba..66c17c3 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -39,7 +39,7 @@ public final class Utils {
}
/**
- * The filename of configuration file.
+ * The file name of configuration file.
* TODO is there any need for it to have the CONF_PREFIX?
*/
private static final String SYSTEM_PROPERTIES_FILE = Crypto.CONF_PREFIX
