https://github.com/ballerina-platform/module-ballerina-crypto
Ballerina crypto Module
https://github.com/ballerina-platform/module-ballerina-crypto
ballerina crypto cryptography encryption hacktoberfest integration security wso2
Last synced: 3 months ago
JSON representation
Ballerina crypto Module
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerina-crypto
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2020-08-19T02:38:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-18T03:29:46.000Z (4 months ago)
- Last Synced: 2025-06-18T04:28:20.022Z (4 months ago)
- Topics: ballerina, crypto, cryptography, encryption, hacktoberfest, integration, security, wso2
- Language: Ballerina
- Homepage:
- Size: 1.75 MB
- Stars: 113
- Watchers: 72
- Forks: 37
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Ballerina Crypto Library
===================
[](https://github.com/ballerina-platform/module-ballerina-crypto/actions/workflows/build-timestamped-master.yml)
[](https://codecov.io/gh/ballerina-platform/module-ballerina-crypto)
[](https://github.com/ballerina-platform/module-ballerina-crypto/actions/workflows/trivy-scan.yml)
[](https://github.com/ballerina-platform/module-ballerina-crypto/actions/workflows/build-with-bal-test-graalvm.yml)
[](https://github.com/ballerina-platform/module-ballerina-crypto/commits/master)
[](https://github.com/ballerina-platform/ballerina-standard-library/labels/module%2Fcrypto)
This library provides common cryptographic mechanisms based on different algorithms.
The Ballerina `crypto` library facilitates APIs to do operations like hashing, HMAC generation, checksum generation, encryption, decryption, signing data digitally, verifying digitally signed data, etc., with different cryptographic algorithms.
### Hashes
The `crypto` library supports generating hashes with 6 different hash algorithms MD5, SHA1, SHA256, SHA384, SHA512, and Keccak256. Also, it supports generating the CRC32B checksum.
### HMAC
The `crypto` library supports generating HMAC with 5 different hash algorithms: MD5, SHA1, SHA256, SHA384, and SHA512.
### Decode private/public key
The `crypto` library supports decoding the RSA private key from a `.p12` file and a key file in the `PEM` format. Also, it supports decoding a public key from a `.p12` file and a certificate file in the `X509` format. Additionally, this supports building an RSA public key with the modulus and exponent parameters.
### Encrypt and decrypt
The `crypto` library supports both symmetric key encryption/decryption and asymmetric key encryption/decryption. The RSA algorithm can be used for asymmetric-key encryption/decryption with the use of private and public keys. The AES algorithm can be used for symmetric-key encryption/decryption with the use of a shared key.
### Sign and verify
The `crypto` library supports signing data using the RSA private key and verification of the signature using the RSA public key. This supports MD5, SHA1, SHA256, SHA384, and SHA512 digesting algorithms, and ML-DSA-65 post-quantum signature algorithm as well.
### Key Derivation Function (KDF)
The `crypto` module supports HMAC-based Key Derivation Function (HKDF). HKDF is a key derivation function that uses a Hash-based Message Authentication Code (HMAC) to derive keys.
### Key Exchange Mechanism (KEM)
The `crypto` module supports Key Exchange Mechanisms (KEM). It includes RSA-KEM and post-quantum ML-KEM-768 for both encapsulation and decapsulation.
### Hybrid Public Key Encryption (HPKE)
The `crypto` module supports Hybrid Public Key Encryption (HPKE). It supports post-quantum ML-KEM-768-HPKE and RSA-KEM-ML-KEM-768-HPKE for encryption and decryption.
## Issues and projects
Issues and Projects tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina Standard Library parent repository](https://github.com/ballerina-platform/ballerina-standard-library).
This repository only contains the source code for the module.
## Build from the source
### Set up the prerequisites
1. Download and install Java SE Development Kit (JDK) version 21 (from one of the following locations).
* [Oracle](https://www.oracle.com/java/technologies/downloads/)
* [OpenJDK](https://adoptium.net)
> **Note:** Set the `JAVA_HOME` environment variable to the path name of the directory into which you installed JDK.
2. Export your GitHub Personal Access Token (PAT) with the `read package` permission as follows:
```
export packageUser=
export packagePAT=
```
### Build the source
Execute the commands below to build from the source.
1. To build the package:
```
./gradlew clean build
```
2. To run the tests:
```
./gradlew clean test
```
3. To run a group of tests
```
./gradlew clean test -Pgroups=
```
4. To build the without the tests:
```
./gradlew clean build -x test
```
5. To debug package implementation:
```
./gradlew clean build -Pdebug=
```
6. To debug with Ballerina language:
```
./gradlew clean build -PbalJavaDebug=
```
7. Publish the generated artifacts to the local Ballerina central repository:
```
./gradlew clean build -PpublishToLocalCentral=true
```
8. Publish the generated artifacts to the Ballerina central repository:
```
./gradlew clean build -PpublishToCentral=true
```
## Contribute to Ballerina
As an open source project, Ballerina welcomes contributions from the community.
For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
## Code of conduct
All contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
## Useful links
* For more information go to the [`crypto` library](https://lib.ballerina.io/ballerina/crypto/latest).
* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
* Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.