Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/commons-crypto
Apache Commons Crypto
https://github.com/apache/commons-crypto
commons
Last synced: 3 days ago
JSON representation
Apache Commons Crypto
- Host: GitHub
- URL: https://github.com/apache/commons-crypto
- Owner: apache
- License: apache-2.0
- Created: 2016-04-13T07:00:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-01T12:54:16.000Z (17 days ago)
- Last Synced: 2025-01-08T04:17:30.775Z (10 days ago)
- Topics: commons
- Language: Java
- Homepage: https://commons.apache.org/crypto/
- Size: 2.82 MB
- Stars: 119
- Watchers: 40
- Forks: 96
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Apache Commons Crypto
===================
[](https://github.com/apache/commons-crypto/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/org.apache.commons/commons-crypto)
[](https://javadoc.io/doc/org.apache.commons/commons-crypto/1.2.0)
[](https://github.com/apache/commons-crypto/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-crypto)
Apache Commons Crypto is a cryptographic library optimized with AES-NI (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 Crypto doesn't implement the cryptographic algorithm such as
AES directly. It wraps to OpenSSL or JCE which implement the algorithms.
Features
--------
1. Cipher API for low level cryptographic operations.
2. Java stream API (CryptoInputStream/CryptoOutputStream) for high level stream encryption/decryption.
3. Both optimized with high performance AES encryption/decryption. (1400 MB/s - 1700 MB/s throughput in modern Xeon processors).
4. JNI-based implementation to achieve comparable performance to the native C/C++ version based on OpenSsl.
5. Portable across various operating systems (currently only Linux/MacOSX/Windows);
Apache Commons Crypto loads the library according to your machine environment (it checks system properties, `os.name` and `os.arch`).
6. Simple usage. Add the commons-crypto-(version).jar file to your classpath.
Export restrictions
-------------------
This distribution includes cryptographic software.
The country in which you currently reside may have restrictions
on the import, possession, use, and/or re-export to another country,
of encryption software. BEFORE using any encryption software,
please check your country's laws, regulations and policies
concerning the import, possession, or use, and re-export of
encryption software, to see if this is permitted.
See for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS),
has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1,
which includes information security software using or performing
cryptographic functions with asymmetric algorithms.
The form and manner of this Apache Software Foundation distribution makes
it eligible for export under the License Exception
ENC Technology Software Unrestricted (TSU) exception
(see the BIS Export Administration Regulations, Section 740.13)
for both object code and source code.
The following provides more details on the included cryptographic software:
* Commons Crypto use [Java Cryptography Extension](http://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) provided by Java
* Commons Crypto link to and use [OpenSSL](https://www.openssl.org/) ciphers
Documentation
-------------
More information can be found on the [Apache Commons Crypto homepage](https://commons.apache.org/proper/commons-crypto).
The [Javadoc](https://commons.apache.org/proper/commons-crypto/apidocs) can be browsed.
Questions related to the usage of Apache Commons Crypto should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).
Where can I get the latest release?
-----------------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-crypto/download_crypto.cgi).
Alternatively, you can pull it from the central Maven repositories:
```xml
org.apache.commons
commons-crypto
1.2.0
```
Contributing
------------
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the code style.
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
License
-------
This code is under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
You like Apache Commons Crypto? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CRYPTO)
+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
Apache Commons Components
-------------------------
Please see the [list of components](https://commons.apache.org/components.html)