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 cbb3433a Trailing blanks [skip ci]
cbb3433a is described below
commit cbb3433ab77b72010f9e278e14706605bae024ab
Author: Sebb <[email protected]>
AuthorDate: Wed Nov 1 11:12:29 2023 +0000
Trailing blanks [skip ci]
---
.github/workflows/benchmarkadhoc.yml | 2 +-
.github/workflows/coverage.yml | 2 +-
.github/workflows/maven_adhoc.yml | 2 +-
PROPOSAL.html | 56 +++++++++++-----------
RELEASE-NOTES.txt | 6 +--
pom.xml | 14 +++---
src/changes/changes.xml | 8 ++--
src/docker/README.md | 2 +-
.../java/org/apache/commons/crypto/Crypto.java | 2 +-
.../crypto/jna/OpenSslInterfaceNativeJna.java | 6 +--
.../org/apache/commons/crypto/jna/OpenSslJna.java | 2 +-
.../java/org/apache/commons/crypto/utils/AES.java | 2 +-
.../random/org_apache_commons_crypto_random.h | 2 +-
src/site/xdoc/proposal.xml | 6 +--
src/site/xdoc/userguide.xml | 4 +-
.../org/apache/commons/crypto/CryptoBenchmark.java | 2 +-
16 files changed, 59 insertions(+), 59 deletions(-)
diff --git a/.github/workflows/benchmarkadhoc.yml
b/.github/workflows/benchmarkadhoc.yml
index 064f9f6d..541749f2 100644
--- a/.github/workflows/benchmarkadhoc.yml
+++ b/.github/workflows/benchmarkadhoc.yml
@@ -35,7 +35,7 @@ jobs:
java: [ 8, 21 ]
experimental: [false]
fail-fast: false
-
+
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
index 65463b40..d7d0bb40 100644
--- a/.github/workflows/coverage.yml
+++ b/.github/workflows/coverage.yml
@@ -15,7 +15,7 @@
name: Coverage
-on:
+on:
# allow direct trigger
workflow_dispatch:
push:
diff --git a/.github/workflows/maven_adhoc.yml
b/.github/workflows/maven_adhoc.yml
index 82a0d9de..6ca2d76b 100644
--- a/.github/workflows/maven_adhoc.yml
+++ b/.github/workflows/maven_adhoc.yml
@@ -37,7 +37,7 @@ jobs:
# java: [ 8, 11, 17, 21 ]
java: [ 8 ]
experimental: [false]
-
+
steps:
# - name: Search
# run: |
diff --git a/PROPOSAL.html b/PROPOSAL.html
index ef839003..eb0ef7fe 100644
--- a/PROPOSAL.html
+++ b/PROPOSAL.html
@@ -40,38 +40,38 @@
<body bgcolor="white">
-
-<div align="center">
+
+<div align="center">
<h1>Proposal for <em>Apache Commons Crypto</em> Package</h1>
</div>
-
+
<h3>(0) Rationale</h3>
-
-<p>Providing Java based optimized and high performance cryptographic IO
streams for
+
+<p>Providing Java based optimized and high performance cryptographic IO
streams for
the applications that want to implement the data encryption. It also provides
cipher
-level API to use. It does provide the openssl API integration and provide the
fallback
+level API to use. It does provide the openssl API integration and provide the
fallback
mechanism to use JCE when openssl library unavailable.</p>
-<p>(Note: Please note that Commons Crypto doesn’t
+<p>(Note: Please note that Commons Crypto doesn’t
-implement the cryptographic algorithm such as AES directly. It wraps to
OpenSSL or JCE
+implement the cryptographic algorithm such as AES directly. It wraps to
OpenSSL or JCE
which implement algorithms.)</p>
-
+
<h3>(1) Scope of the Package</h3>
-
-<p>This proposal is to create a package of cryptographic IO classes with the
integration
+
+<p>This proposal is to create a package of cryptographic IO classes with the
integration
of OpenSSL library. </p>
@@ -79,42 +79,42 @@ of OpenSSL library. </p>
based on demand from the users later.</p>
-
+
<h3>(1.5) Interaction With Other Packages</h3>
-
-<p><em>IO</em> Commons Crypto relies on standard JDK 7 (or later) APIs for
production
-deployment and on OpenSSL 1.0.1c devl libraries. It utilizes the JUnit unit
testing
+<p><em>IO</em> Commons Crypto relies on standard JDK 7 (or later) APIs for
production
+
+deployment and on OpenSSL 1.0.1c devl libraries. It utilizes the JUnit unit
testing
framework, but this is of interest only to developers of the component.
- The functionality provided by Commons Crypto is currently in use by Apache
Hadoop
-
- and Apache Spark, and both of those communities have expressed interest in
changing
-
+ The functionality provided by Commons Crypto is currently in use by Apache
Hadoop
+
+ and Apache Spark, and both of those communities have expressed interest in
changing
+
their dependency to be on the central Commons Crypto package once it
exists.</p>
-
+
<h3>(2) Initial Source of the Package</h3>
-
+
<p>The initial classes came from the Apache Hadoop.</p>
-
+
<p>The proposed package name for the new component is
<code>org.apache.commons.crypto</code>.</p>
-
+
<h3>(3) Required Apache Commons Resources</h3>
-
+
<ul>
@@ -122,7 +122,7 @@ framework, but this is of interest only to developers of
the component.
<li>Mailing List - Discussions will take place on the general
<em>[email protected]</em>
-mailing list.
+mailing list.
<br>To help list subscribers identify messages of interest,
it is suggested that the message subject of messages about this component
@@ -133,15 +133,15 @@ be prefixed with [Crypto]. </br></li>
<li>Confluence FAQ - New category “commons-crypto" (when available).</li>
-
+
</ul>
-
+
<h3>(4) Initial Committers</h3>
-
+
<ul>
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 62313bdf..505387d3 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -3,10 +3,10 @@
The Apache Commons Crypto team is pleased to announce the release of Apache
Commons Crypto 1.2.0.
-Apache Commons Crypto is a cryptographic library optimized with AES-NI
(Advanced Encryption Standard New Instructions).
+Apache Commons Crypto is a cryptographic library optimized with AES-NI
(Advanced Encryption Standard New Instructions).
It provides Java API for both the cipher level and Java stream level.
-Developers can use it to implement high-performance AES encryption/decryption
with minimum code and effort.
-Please note that Crypto doesn't implement the cryptographic algorithm such as
AES directly.
+Developers can use it to implement high-performance AES encryption/decryption
with minimum code and effort.
+Please note that Crypto doesn't implement the cryptographic algorithm such as
AES directly.
It wraps OpenSSL and JCE which implements the algorithms.
Features
diff --git a/pom.xml b/pom.xml
index 7b2c5dd6..cdb99e9a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -27,10 +27,10 @@
<name>Apache Commons Crypto</name>
<description>
-Apache Commons Crypto is a cryptographic library optimized with AES-NI
(Advanced Encryption Standard New Instructions).
+Apache Commons Crypto is a cryptographic library optimized with AES-NI
(Advanced Encryption Standard New Instructions).
It provides Java API for both the cipher level and Java stream level.
-Developers can use it to implement high-performance AES encryption/decryption
with minimum code and effort.
-Please note that Crypto doesn't implement the cryptographic algorithm such as
AES directly.
+Developers can use it to implement high-performance AES encryption/decryption
with minimum code and effort.
+Please note that Crypto doesn't implement the cryptographic algorithm such as
AES directly.
It wraps OpenSSL and JCE which implements the algorithms.
Features
@@ -131,7 +131,7 @@ The following provides more details on the included
cryptographic software:
<checkstyle.resourceExcludes>LICENSE.txt, NOTICE.txt,
**/maven-archiver/pom.properties</checkstyle.resourceExcludes>
<japicmp.skip>false</japicmp.skip>
-
+
<commons.release.isDistModule>true</commons.release.isDistModule>
<jna.version>5.13.0</jna.version>
@@ -335,7 +335,7 @@ The following provides more details on the included
cryptographic software:
<version>2.3.8</version>
</dependency>
</dependencies>
- </profile>
+ </profile>
</profiles>
<build>
@@ -413,7 +413,7 @@ The following provides more details on the included
cryptographic software:
<ruleset>${basedir}/src/conf/pmd/pmd-ruleset.xml</ruleset>
</rulesets>
</configuration>
- </plugin>
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
@@ -708,7 +708,7 @@ The following provides more details on the included
cryptographic software:
<email>ggregory at apache.org</email>
<url>https://www.garygregory.com</url>
<organization>The Apache Software Foundation</organization>
- <organizationUrl>https://www.apache.org/</organizationUrl>
+ <organizationUrl>https://www.apache.org/</organizationUrl>
<roles>
<role>PMC Member</role>
</roles>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 1e2f167c..93c3de1f 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -30,9 +30,9 @@
property to the number of days since the last release.
To generate the release notes from this file:
-
+
mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nnn]
-
+
then tweak the formatting if necessary
and commit
@@ -68,8 +68,8 @@
<action type="fix" dev="ggregory" due-to="Martin
Wittlinger">Refactor: Unnecessary toString() call #224.</action>
<action dev="ggregory" type="fix" due-to="step-security-bot, Gary
Gregory">[StepSecurity] Harden GitHub builds #228, #234.</action>
<action dev="ggregory" type="fix" due-to="Martin Wiesner">Fixes
grammar and typos in Javadoc #233.</action>
- <action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate
OpenSslJna.OpenSslJna().</action>
- <action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate
Crypto.Crypto().</action>
+ <action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate
OpenSslJna.OpenSslJna().</action>
+ <action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate
Crypto.Crypto().</action>
<action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate
AES.AES().</action>
<action dev="ggregory" type="fix" issue="CRYPTO-169" due-to="L. C.
Hsieh, Yang Jie, Gary Gregory">Add protection for the
ExceptionInInitializerError scenario to the
CryptoRandomFactory#getCryptoRandom(Properties) method #258.</action>
<action dev="ggregory" type="fix" due-to="Gary
Gregory">ChannelInput.ChannelInput(ReadableByteChannel) now throws
NullPointerException on null input.</action>
diff --git a/src/docker/README.md b/src/docker/README.md
index 176fb97d..1551e472 100644
--- a/src/docker/README.md
+++ b/src/docker/README.md
@@ -67,7 +67,7 @@ Now perform the release (don't run mvn clean!)
# Creating a release candidate using another OS
If the Release Manager (RM) does not have access to a macOS system, they will
need to obtain a copy
-of the macOS native binary from another Commons developer.
+of the macOS native binary from another Commons developer.
The process starts as above, but just before using the host system to build
the release,
add the macOS binary to the workspace at:
diff --git a/src/main/java/org/apache/commons/crypto/Crypto.java
b/src/main/java/org/apache/commons/crypto/Crypto.java
index fe224bba..d2ba24b1 100644
--- a/src/main/java/org/apache/commons/crypto/Crypto.java
+++ b/src/main/java/org/apache/commons/crypto/Crypto.java
@@ -55,7 +55,7 @@ public final class Crypto {
return versionData;
}
}
-
+
/**
* The prefix of all crypto configuration keys.
*/
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 928e58cc..a9c895fc 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslInterfaceNativeJna.java
@@ -33,10 +33,10 @@ interface OpenSslInterfaceNativeJna {
PointerByReference _ENGINE_by_id(final String string);
- /**
+ /**
* TODO Appears to be deprecated as of OpenSSL 1.1.0.
*
- * @return See OpenSSL.
+ * @return See OpenSSL.
*/
int _ENGINE_cleanup();
@@ -94,4 +94,4 @@ interface OpenSslInterfaceNativeJna {
PointerByReference _RAND_get_rand_method();
PointerByReference _RAND_SSLeay();
-}
\ No newline at end of file
+}
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 c4d7659b..afe370c0 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
@@ -41,7 +41,7 @@ public final class OpenSslJna {
System.out.println(String.format(Objects.toString(format), args));
}
}
-
+
/**
* Gets the cipher class of JNA implementation.
*
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 93e08211..bb83bdec 100644
--- a/src/main/java/org/apache/commons/crypto/utils/AES.java
+++ b/src/main/java/org/apache/commons/crypto/utils/AES.java
@@ -54,7 +54,7 @@ public class AES {
return new SecretKeySpec(key, ALGORITHM);
}
-
+
/**
* Constructs a new instance.
*
diff --git
a/src/main/native/org/apache/commons/crypto/random/org_apache_commons_crypto_random.h
b/src/main/native/org/apache/commons/crypto/random/org_apache_commons_crypto_random.h
index 7040f0a0..41e5cf37 100644
---
a/src/main/native/org/apache/commons/crypto/random/org_apache_commons_crypto_random.h
+++
b/src/main/native/org/apache/commons/crypto/random/org_apache_commons_crypto_random.h
@@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
#ifndef ORG_APACHE_COMMONS_CRYPTO_RANDOM_H
#define ORG_APACHE_COMMONS_CRYPTO_RANDOM_H
diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.xml
index 2a46436f..bc73e85b 100644
--- a/src/site/xdoc/proposal.xml
+++ b/src/site/xdoc/proposal.xml
@@ -22,12 +22,12 @@ limitations under the License.
</properties>
<body>
-
+
<section name="Proposal for Apache Commons Crypto Package"><br/>
<h4>March 24, 2016</h4>
-
-
+
+
<subsection name="(0) Rationale">
<p>
Providing Java based optimized and high performance cryptographic IO
streams for
diff --git a/src/site/xdoc/userguide.xml b/src/site/xdoc/userguide.xml
index 7d7f30b2..fb6514c4 100644
--- a/src/site/xdoc/userguide.xml
+++ b/src/site/xdoc/userguide.xml
@@ -20,7 +20,7 @@
(Advanced Encryption
Standard New Instructions). It provides Java API for both cipher level
and Java stream
level. Developers can use it to implement high performance AES
encryption/decryption with
- the minimum code and effort.
+ the minimum code and effort.
</p>
<p>
Please note that Apache Commons Crypto doesn't implement the
cryptographic
@@ -66,7 +66,7 @@
<h4>Prerequisites</h4>
<p>
Commons Crypto relies on standard JDK 1.8 (or above) and OpenSSL
1.1.1 for production
- deployment.
+ deployment.
If it is installed, the command <code>openssl version</code> can
be used to show the version.
</p>
<p>OpenSSL may already be installed on your system; if not, please
visit
diff --git a/src/test/java/org/apache/commons/crypto/CryptoBenchmark.java
b/src/test/java/org/apache/commons/crypto/CryptoBenchmark.java
index 73ed6613..70b9423d 100644
--- a/src/test/java/org/apache/commons/crypto/CryptoBenchmark.java
+++ b/src/test/java/org/apache/commons/crypto/CryptoBenchmark.java
@@ -79,7 +79,7 @@ public class CryptoBenchmark extends AbstractBenchmark {
getRandom(RANDOM_OPENSSL);
}
-
+
@Benchmark
public void RandomCreateOS() throws Exception {
getRandom(RANDOM_OS);
