From 5f81ee46c49fd01cc27bc67edd096e96652cb325 Mon Sep 17 00:00:00 2001 From: M3DZIK Date: Thu, 28 Dec 2023 21:55:57 +0100 Subject: [PATCH] Add README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7ba2e7 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# LibCrypto + +**Cryptographic library for Java and JavaScript** + +## Overview + +`libcrypto` is a versatile cryptographic library designed to provide easy-to-use implementations of advanced cryptographic algorithms for both Java and JavaScript environments. The library focuses on three key cryptographic primitives: AES GCM for symmetric encryption, Argon2 for key derivation, and X25519 for elliptic curve Diffie-Hellman key exchange. + +### Features + +- **AES GCM Encryption** + - Secure and efficient symmetric encryption using the AES block cipher in GCM (Galois/Counter Mode) mode. +- **Argon2 Key Derivation** + - A memory-hard key derivation function that provides resistance against both brute-force and side-channel attacks. +- **X25519 Key Exchange** + - Elliptic curve Diffie-Hellman key exchange for a secure key establishment in a public-key cryptography setting. + +## Documentation + +- [Java Documentation](/java#readme) +- [JavaScript Documentation](/javascript#readme) + +## License + +Licensed under the [MIT License](https://github.com/M3DZIK/libcrypto/blob/main/LICENSE)