You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2022/06/17 22:19:34 UTC
[commons-crypto] branch master updated: Fix up some docs
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 e8677e9 Fix up some docs
e8677e9 is described below
commit e8677e989df5b8b1d688358de160cdb9b35ff193
Author: Sebb <se...@apache.org>
AuthorDate: Fri Jun 17 23:19:28 2022 +0100
Fix up some docs
---
BUILDING.txt | 8 ++++----
src/site/xdoc/userguide.xml | 20 ++++++++++++++------
2 files changed, 18 insertions(+), 10 deletions(-)
diff --git a/BUILDING.txt b/BUILDING.txt
index 6b5da97..d7a1c6d 100644
--- a/BUILDING.txt
+++ b/BUILDING.txt
@@ -8,9 +8,9 @@ Requirements:
* Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy
Files (if running unit tests)
* export JAVA_HOME
-* Maven 3.0 or above
+* Maven 3.3.9 or above
* Make
-* OpenSSL devel 1.1.1 or above (OpenSSL library header files are required)
+* OpenSSL devel 1.1.1 (OpenSSL library header files are required)
* GCC
* G++
@@ -46,7 +46,7 @@ Check OpenSSL version:
$ openssl version
-If it is not 1.0.1c or above, upgrade OpenSSL version to 1.0.1c or above:
+If it is not 1.1.1, upgrade OpenSSL version to 1.1.1:
Upgrade OpenSSL in Linux:
@@ -54,7 +54,7 @@ You can follow your OS distribution instructions to upgrade OpenSSL to a proper
Upgrade OpenSSL in Mac:
- $ brew install openssl101
+ $ brew install openssl111
$ brew link openssl --force
Get OpenSSL headers: sudo apt -y install libssl-dev
diff --git a/src/site/xdoc/userguide.xml b/src/site/xdoc/userguide.xml
index 2755004..b99c1bd 100644
--- a/src/site/xdoc/userguide.xml
+++ b/src/site/xdoc/userguide.xml
@@ -20,8 +20,12 @@
(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. Please note that Apache Commons Crypto doesn't implement the cryptographic
- algorithm such as AES directly. It wraps to Openssl or JCE which implement the algorithms.
+ the minimum code and effort.
+ </p>
+ <p>
+ Please note that Apache Commons Crypto doesn't implement the cryptographic
+ algorithm such as AES directly. It wraps Openssl or JCE which implement the algorithms.
+ OpenSSL 1.1.1 is required for building and running.
</p>
<subsection name="Interfaces Overview">
<p>Interfaces and classes used by the various implementation in the sub-packages.</p>
@@ -61,8 +65,12 @@
<subsection name ="Usage">
<h4>Prerequisites</h4>
<p>
- Commons Crypto relies on standard JDK 1.7 (or above) and OpenSSL 1.0.1c (or above) for production
- deployment.
+ Commons Crypto relies on standard JDK 1.8 (or above) and OpenSSL 1.1.1 for production
+ 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
+ <a href="https://www.openssl.org/">OpenSSL.org</a> for information on installation.
</p>
<h4>Using Commons Crypto in your Apache Maven build</h4>
<p>
@@ -78,7 +86,7 @@
<h4>Usage of Random API</h4>
<p>
CryptoRandom provides a cryptographically strong random number generators.
- The default implementation will use Intel� Digital Random Number Generator (DRNG)
+ The default implementation will use Intel® Digital Random Number Generator (DRNG)
for accelerating the random generation.
</p>
@@ -89,7 +97,7 @@
Cipher provides an cryptographic interface for encryption and decryption.
We provide two kind of implementations: JCE Cipher and Openssl Cipher. The
JCE implementation uses JCE provider and the Openssl implementation uses
- Intel� AES New Instructions (Intel� AES NI).
+ Intel® AES New Instructions (Intel® AES NI).
</p>
<h5>Usage of Byte Array Encryption/Decryption</h5>