CINXE.COM
Apache Commons Crypto – Overview
<!DOCTYPE html> <!-- | Generated by Apache Maven Doxia at 23 January 2023 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="author" content="Commons Documentation Team" /> <meta name="Date-Revision-yyyymmdd" content="20230123" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache Commons Crypto – Overview</title> <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" /> <link rel="stylesheet" href="./css/site.css" type="text/css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> <script type="text/javascript" src="./js/jquery.min.js"></script> <script type="text/javascript" src="./js/bootstrap.min.js"></script> <script type="text/javascript" src="./js/prettify.min.js"></script> <script type="text/javascript" src="./js/site.js"></script> </head> <body class="composite"> <a href="https://commons.apache.org/" id="bannerLeft" title="Apache Commons logo"> <img class="logo-left" src=" ./images/commons-logo.png " alt="Apache Commons logo"/> </a> <a href="index.html" id="bannerRight" title="Commons Crypto™ logo"> <img class="logo-right" src=" images/logo.png " alt="Commons Crypto™ logo"/> </a> <div class="clear"></div> <div class="navbar"> <div class="navbar-inner"> <div class="container-fluid"> <a class="brand" href="https://commons.apache.org/proper/commons-crypto/">Apache Commons Crypto ™</a> <ul class="nav"> <li id="publishDate">Last Published: 23 January 2023</li> <li class="divider">|</li> <li id="projectVersion">Version: 1.2.0</li> </ul> <div class="pull-right"> <ul class="nav"> <li> <a href="https://www.apachecon.com/" class="externalLink" title="ApacheCon"> ApacheCon</a> </li> <li> <a href="https://www.apache.org" class="externalLink" title="Apache"> Apache</a> </li> <li> <a href="../../" title="Commons"> Commons</a> </li> </ul> </div> </div> </div> </div> <div class="container-fluid"> <table class="layout-table"> <tr> <td class="sidebar"> <div class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">Documentation</li> <li class="none active"> <a href="index.html" title="Overview"> Overview</a> </li> <li class="none"> <a href="download_crypto.cgi" title="Download"> Download</a> </li> <li class="none"> <a href="userguide.html" title="User Guide"> User Guide</a> </li> <li class="none"> <a href="faq.html" title="FAQ"> FAQ</a> </li> <li class="none"> <a href="apidocs/index.html" title="Javadoc"> Javadoc</a> </li> <li class="none"> <a href="https://javadoc.io/doc/org.apache.commons/commons-crypto/" class="externalLink" title="Javadoc Archive"> Javadoc Archive</a> </li> <li class="none"> <a href="security.html" title="Security"> Security</a> </li> </ul> <ul class="nav nav-list"> <li class="nav-header"><i class="icon-cog"></i>Development</li> <li class="none"> <a href="mail-lists.html" title="Mailing Lists"> Mailing Lists</a> </li> <li class="none"> <a href="issue-tracking.html" title="Issue Tracking"> Issue Tracking</a> </li> <li class="none"> <a href="scm.html" title="Source Repository"> Source Repository</a> </li> </ul> <ul class="nav nav-list"> <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li> <li class="expanded"> <a href="project-info.html" title="Project Information"> Project Information</a> <ul> <li class="none active"> <a href="index.html" title="About"> About</a> </li> <li class="none"> <a href="summary.html" title="Summary"> Summary</a> </li> <li class="none"> <a href="team.html" title="Team"> Team</a> </li> <li class="none"> <a href="scm.html" title="Source Code Management"> Source Code Management</a> </li> <li class="none"> <a href="issue-management.html" title="Issue Management"> Issue Management</a> </li> <li class="none"> <a href="mailing-lists.html" title="Mailing Lists"> Mailing Lists</a> </li> <li class="none"> <a href="dependency-info.html" title="Dependency Information"> Dependency Information</a> </li> <li class="none"> <a href="dependency-management.html" title="Dependency Management"> Dependency Management</a> </li> <li class="none"> <a href="dependencies.html" title="Dependencies"> Dependencies</a> </li> <li class="none"> <a href="dependency-convergence.html" title="Dependency Convergence"> Dependency Convergence</a> </li> <li class="none"> <a href="ci-management.html" title="CI Management"> CI Management</a> </li> <li class="none"> <a href="distribution-management.html" title="Distribution Management"> Distribution Management</a> </li> </ul> </li> <li class="collapsed"> <a href="project-reports.html" title="Project Reports"> Project Reports</a> </li> </ul> <ul class="nav nav-list"> <li class="nav-header">Commons</li> <li class="none"> <a href="../../" title="Home"> Home</a> </li> <li class="none"> <a href="https://www.apache.org/licenses/" class="externalLink" title="License"> License</a> </li> <li class="collapsed"> <a href="../../components.html" title="Components"> Components</a> </li> <li class="collapsed"> <a href="../../sandbox/index.html" title="Sandbox"> Sandbox</a> </li> <li class="collapsed"> <a href="../../dormant/index.html" title="Dormant"> Dormant</a> </li> </ul> <ul class="nav nav-list"> <li class="nav-header">General Information</li> <li class="none"> <a href="../../security.html" title="Security"> Security</a> </li> <li class="none"> <a href="../../volunteering.html" title="Volunteering"> Volunteering</a> </li> <li class="none"> <a href="../../patches.html" title="Contributing Patches"> Contributing Patches</a> </li> <li class="none"> <a href="../../building.html" title="Building Components"> Building Components</a> </li> <li class="none"> <a href="../../commons-parent-pom.html" title="Commons Parent POM"> Commons Parent POM</a> </li> <li class="none"> <a href="../../build-plugin/index.html" title="Commons Build Plugin"> Commons Build Plugin</a> </li> <li class="none"> <a href="/release-plugin/index.html" title="Commons Release Plugin"> Commons Release Plugin</a> </li> <li class="none"> <a href="/site-publish.html" title="Site Publication"> Site Publication</a> </li> <li class="none"> <a href="../../releases/index.html" title="Releasing Components"> Releasing Components</a> </li> <li class="none"> <a href="https://cwiki.apache.org/confluence/display/commons/FrontPage" class="externalLink" title="Wiki"> Wiki</a> </li> </ul> <ul class="nav nav-list"> <li class="nav-header">ASF</li> <li class="none"> <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works"> How the ASF works</a> </li> <li class="none"> <a href="https://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved"> Get Involved</a> </li> <li class="none"> <a href="https://www.apache.org/dev/" class="externalLink" title="Developer Resources"> Developer Resources</a> </li> <li class="none"> <a href="https://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct"> Code of Conduct</a> </li> <li class="none"> <a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Privacy"> Privacy</a> </li> <li class="none"> <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"> Sponsorship</a> </li> <li class="none"> <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"> Thanks</a> </li> </ul> </div> <div id="poweredBy"> <a href="https://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy"> <img class="builtBy" alt="ApacheCon" src="https://www.apache.org/events/current-event-125x125.png" /> </a> <a href="https://maven.apache.org/" title="Maven" class="builtBy"> <img class="builtBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> </a> </div> </td> <td class="content"> <section> <h2><a name="Apache_Commons_Crypto"></a>Apache Commons Crypto</h2> <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> <h2><a name="Features"></a>Features</h2> <p> </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> </section> <section> <h2><a name="Documentation"></a>Documentation</h2> <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 class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-crypto.git">browsed</a>. </p> </section> <section> <h2><a name="Releases"></a>Releases</h2> <ul> <li> <a class="externalLink" 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 class="externalLink" 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 class="externalLink" href="https://archive.apache.org/dist/commons/crypto/">Crypto 1.0.0 (archives)</a> requires Java 1.7. </li> </ul> <p> See the <a class="externalLink" href="https://commons.apache.org/proper/commons-crypto/download_crypto.cgi">Download Page</a> for the latest releases.<br /> </p> <p> <a href="changes-report.html">Change reports</a> are also available. </p> <p> For previous releases, see the <a class="externalLink" href="https://archive.apache.org/dist/commons/crypto/">Apache Archive</a> </p> </section> <section> <h2><a name="Support"></a>Support</h2> <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> </td> </tr> </table> </div> <div class="footer"> <p>Copyright © 2016-2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</p> <div class="center">Apache Commons, Apache Commons Crypto, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> </div> </body> </html>