Merge pull request #541 from hwupathum/master

Update README.md
ballerina-platform · Mar 28, 2024 · c8cc19f · c8cc19f
2 parents 41b5a35 + 81a9efd
commit c8cc19f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,19 @@ The `crypto` library supports both symmetric key encryption/decryption and asymm
 
 ### 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 as well.
+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
 

diff --git a/ballerina/Module.md b/ballerina/Module.md
@@ -34,5 +34,5 @@ The `crypto` module supports Key Exchange Mechanisms (KEM). It includes RSA-KEM
 
 ### Hybrid Public Key Encryption (HPKE)
 
-The `crypto` module supports Hybrid Public Key Encryption (HPKE). It supportspost-quantum ML-KEM-768-HPKE and RSA-KEM-ML-KEM-768-HPKE for encryption and decryption.
+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.
 
diff --git a/ballerina/Package.md b/ballerina/Package.md
@@ -34,7 +34,7 @@ The `crypto` package supports Key Exchange Mechanisms (KEM). It includes RSA-KEM
 
 ### Hybrid Public Key Encryption (HPKE)
 
-The `crypto` package supports Hybrid Public Key Encryption (HPKE). It supportspost-quantum ML-KEM-768-HPKE and RSA-KEM-ML-KEM-768-HPKE for encryption and decryption.
+The `crypto` package 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.
 
 ## Report issues
 

diff --git a/docs/spec/spec.md b/docs/spec/spec.md
@@ -945,7 +945,7 @@ byte[] sharedSecret = check crypto:decapsulateRsaKemMlKem768(encapsulatedSecret,
 
 ## 9. [Hybrid Public Key Encryption (HPKE)](#9-hybrid-public-key-encryption-hpke)
 
-The `crypto` module supports Hybrid Public Key Encryption (HPKE). It supportspost-quantum ML-KEM-768-HPKE and RSA-KEM-ML-KEM-768-HPKE for encryption and decryption.
+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.
 
 ### 9.1. [Encrypt](#91-encrypt)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,5 +34,5 @@ The `crypto` module supports Key Exchange Mechanisms (KEM). It includes RSA-KEM

		### Hybrid Public Key Encryption (HPKE)

		The `crypto` module supports Hybrid Public Key Encryption (HPKE). It supportspost-quantum ML-KEM-768-HPKE and RSA-KEM-ML-KEM-768-HPKE for encryption and decryption.
		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.