src/site/xdoc/index.xml - commons-crypto - Git at Google

 <?xml version="1.0"?>
 <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 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.
 -->
 <document>
  <properties>
   <title>Overview</title>
   <author email="dev@commons.apache.org">Apache Commons Team</author>
  </properties>
 <body>
 <!-- ================================================== -->
 <section name="Apache Commons Crypto">
     <p>Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced Encryption
         Standard New Instructions). Commons Crypto provides Java APIs at the cipher level and Java stream
         level. Developers can implement high performance AES encryption/decryption with
         minimum coding and effort. Please note that Commons Crypto doesn't implement the
         cryptographic algorithm such as AES directly, it wraps OpenSSL and JCE.
     </p>
 </section>
 <!-- ================================================== -->
 <section name="Features">
   <p>
     <ul>
       <li>Cipher API for low level cryptographic operations.</li>
       <li>Secure true random number generator.</li>
       <li>Java stream API for high level stream
         encryption/decryption.
       </li>
       <li>High performance AES encryption/decryption optimized with Intel AES-NI.
       </li>
       <li>Portable across various operating systems (currently only Linux/Mac OS/Windows); Apache
           Commons Crypto loads the library according to your machine environment (using system
           properties, os.name and os.arch).
       </li>
       <li>Simple usage. Add the commons-crypto-(version).jar file to your classpath.</li>
     </ul>
   </p>
 </section>
 <!-- ================================================== -->
 <section name="Documentation">
     <p>
         An overview of the functionality is provided in the
         <a href="userguide.html">user guide</a>.
         Various
         <a href="project-reports.html">project reports</a>
         are also available.
     </p>
     <p>
         The Javadoc API documents are available online:
     </p>
     <ul>
         <li>
             <a href="apidocs/index.html">Javadoc</a>
         </li>
     </ul>
     <p>
         The <a href="scm.html">git repository</a> can be
         <a href="https://gitbox.apache.org/repos/asf?p=commons-crypto.git">browsed</a>.
     </p>
 </section>
 <!-- ================================================== -->
 <section name="Releases">
 <ul>
     <li>
         <a href="https://commons.apache.org/proper/commons-crypto/download_crypto.cgi">Crypto 1.2.0 (mirrors)</a>
         requires Java 1.8 and OpenSSL 1.1.x (should also work with 1.0.x)
     </li>
     <li>
         <a href="https://archive.apache.org/dist/commons/crypto/">Crypto 1.1.0 (archives)</a>
         requires Java 1.8, built and tested with:
     </li>
     <ul>
       <li>darwin64-x86_64-cc; OpenSSL 1.1.1g</li>
       <li>debian-amd64; OpenSSL 1.0.1f</li>
       <li>debian-amd64; OpenSSL 1.1.1g</li>
       <li>debian-arm64; OpenSSL 1.1.1f</li>
       <li>linux-aarch64; OpenSSL 1.0.2k-fips</li>
       <li>Linux x86_64; OpenSSL 1.1.1</li>
       <li>Windows 64 (mingw64); OpenSSL 1.1.1d</li>
     </ul>
     <li>
         <a href="https://archive.apache.org/dist/commons/crypto/">Crypto 1.0.0 (archives)</a>
         requires Java 1.7.
     </li>
 </ul>
 <p>
 See the
 <a href="https://commons.apache.org/proper/commons-crypto/download_crypto.cgi">Download Page</a>
 for the latest releases.
 </p>
 <p>
 <a href="changes.html">Change reports</a> are also available.
 </p>
 <p>
 For previous releases, see the <a href="https://archive.apache.org/dist/commons/crypto/">Apache
     Archive</a>
 </p>
 </section>
 <!-- ================================================== -->
 <section name="Support">
 <p>
 The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum.
 The user list is suitable for most library usage queries.
 The dev list is intended for the development discussion.
 Please remember that the lists are shared between all commons components,
 so prefix your email by [crypto].
 </p>
 <p>
 Issues may be reported via <a href="issue-tracking.html">ASF JIRA</a>.
 </p>
 </section>
 <!-- ================================================== -->
  </body>
 </document>
	<?xml version="1.0"?>
	<!--
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	https://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	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.
	-->
	<document>
	<properties>
	<title>Overview</title>
	<author email="dev@commons.apache.org">Apache Commons Team</author>
	</properties>
	<body>
	<!-- ================================================== -->
	<section name="Apache Commons Crypto">
	<p>Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced Encryption
	Standard New Instructions). Commons Crypto provides Java APIs at the cipher level and Java stream
	level. Developers can implement high performance AES encryption/decryption with
	minimum coding and effort. Please note that Commons Crypto doesn't implement the
	cryptographic algorithm such as AES directly, it wraps OpenSSL and JCE.
	</p>
	</section>
	<!-- ================================================== -->
	<section name="Features">
	<p>
	<ul>
	<li>Cipher API for low level cryptographic operations.</li>
	<li>Secure true random number generator.</li>
	<li>Java stream API for high level stream
	encryption/decryption.
	</li>
	<li>High performance AES encryption/decryption optimized with Intel AES-NI.
	</li>
	<li>Portable across various operating systems (currently only Linux/Mac OS/Windows); Apache
	Commons Crypto loads the library according to your machine environment (using system
	properties, os.name and os.arch).
	</li>
	<li>Simple usage. Add the commons-crypto-(version).jar file to your classpath.</li>
	</ul>
	</p>
	</section>
	<!-- ================================================== -->
	<section name="Documentation">
	<p>
	An overview of the functionality is provided in the
	<a href="userguide.html">user guide</a>.
	Various
	<a href="project-reports.html">project reports</a>
	are also available.
	</p>
	<p>
	The Javadoc API documents are available online:
	</p>
	<ul>
	<li>
	<a href="apidocs/index.html">Javadoc</a>
	</li>
	</ul>
	<p>
	The <a href="scm.html">git repository</a> can be
	<a href="https://gitbox.apache.org/repos/asf?p=commons-crypto.git">browsed</a>.
	</p>
	</section>
	<!-- ================================================== -->
	<section name="Releases">
	<ul>
	<li>
	<a href="https://commons.apache.org/proper/commons-crypto/download_crypto.cgi">Crypto 1.2.0 (mirrors)</a>
	requires Java 1.8 and OpenSSL 1.1.x (should also work with 1.0.x)
	</li>
	<li>
	<a href="https://archive.apache.org/dist/commons/crypto/">Crypto 1.1.0 (archives)</a>
	requires Java 1.8, built and tested with:
	</li>
	<ul>
	<li>darwin64-x86_64-cc; OpenSSL 1.1.1g</li>
	<li>debian-amd64; OpenSSL 1.0.1f</li>
	<li>debian-amd64; OpenSSL 1.1.1g</li>
	<li>debian-arm64; OpenSSL 1.1.1f</li>
	<li>linux-aarch64; OpenSSL 1.0.2k-fips</li>
	<li>Linux x86_64; OpenSSL 1.1.1</li>
	<li>Windows 64 (mingw64); OpenSSL 1.1.1d</li>
	</ul>
	<li>
	<a href="https://archive.apache.org/dist/commons/crypto/">Crypto 1.0.0 (archives)</a>
	requires Java 1.7.
	</li>
	</ul>
	<p>
	See the
	<a href="https://commons.apache.org/proper/commons-crypto/download_crypto.cgi">Download Page</a>
	for the latest releases.
	</p>
	<p>
	<a href="changes.html">Change reports</a> are also available.
	</p>
	<p>
	For previous releases, see the <a href="https://archive.apache.org/dist/commons/crypto/">Apache
	Archive</a>
	</p>
	</section>
	<!-- ================================================== -->
	<section name="Support">
	<p>
	The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum.
	The user list is suitable for most library usage queries.
	The dev list is intended for the development discussion.
	Please remember that the lists are shared between all commons components,
	so prefix your email by [crypto].
	</p>
	<p>
	Issues may be reported via <a href="issue-tracking.html">ASF JIRA</a>.
	</p>
	</section>
	<!-- ================================================== -->
	</body>
	</document>