Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ronhombre/kyberkotlin
ML-KEM's Kotlin Implementation
https://github.com/ronhombre/kyberkotlin
cryptography crystals-kyber csharp-library java java-library javascript javascript-library kotlin-library kotlin-multiplatform maven npm-package
Last synced: 4 days ago
JSON representation
ML-KEM's Kotlin Implementation
- Host: GitHub
- URL: https://github.com/ronhombre/kyberkotlin
- Owner: ronhombre
- License: apache-2.0
- Created: 2023-12-13T07:19:55.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-08-31T13:48:29.000Z (about 1 month ago)
- Last Synced: 2024-09-29T14:10:42.962Z (4 days ago)
- Topics: cryptography, crystals-kyber, csharp-library, java, java-library, javascript, javascript-library, kotlin-library, kotlin-multiplatform, maven, npm-package
- Language: Kotlin
- Homepage: http://kyber.hombre.asia/
- Size: 454 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# KyberKotlin (1.0.0)
## _Implements ML-KEM (CRYSTALS-Kyber)_
_**Digital security for all, everywhere, no matter who they are, or what they believe in.**_
[](https://github.com/ronhombre/KyberKotlin/actions/workflows/codeql.yml)
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22asia.hombre%22)
[](https://www.apache.org/licenses/LICENSE-2.0)
> **ML-KEM** is a key-encapsulation mechanism based on _CRYSTALS-KYBER_. The security of ML-KEM is based on the presumed
> hardness of the so-called Module Learning with Errors (MLWE) problem, which is a generalization of the Learning With
> Errors (LWE) problem introduced by Regev in 2005. The hardness of the MLWE problem is itself based on the presumed
> hardness of certain computational problems in module lattices. This motivates the name of the scheme ML-KEM.
*This is quoted from
[Section 3.2](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.203.pdf) of the NIST FIPS 203 document.*
## Introduction
This is a 100% Kotlin Multiplatform implementation of ML-KEM.
It depends on [KeccakKotlin](https://github.com/ronhombre/KeccakKotlin) and [secure-random](https://github.com/KotlinCrypto/secure-random) Kotlin libraries in order to implement SHA3, SHAKE, and
Secure Random within the library.
> [!NOTE]
> With the release of the final version of NIST FIPS 203 for ML-KEM, I'm proud to present that my KyberKotlin library is
> ready for production use. In the past months, there have been no reports about any problems.
## Capabilities
* Key Generation (512, 768, 1024)
* Encapsulation (512, 768, 1024)
* Decapsulation (512, 768, 1024)
* Convert to or from bytes.
## Supported & Tested Platforms
* JVM (Java, Kotlin)
* Javascript (NPM)
## Documentation
* [kyber.hombre.asia](https://kyber.hombre.asia)
> [!WARNING]
> Upgrading to 1.x.x from the 0.x.x versions requires a quick read up with the documentation. This is because there have
> been massive improvements and changes in the way the API works.
## Installation
```Kotlin
//Gradle Kotlin DSL (build.gradle.kts)
dependencies {
implementation("asia.hombre:kyber:1.0.0")
}
```
Checkout the Wiki for more installation options.
## API Usage
Checkout the Wiki or the Documentation for more information.
### References
* [NIST FIPS 203](https://csrc.nist.gov/pubs/fips/203/final)
* [CRYSTALS-Kyber Algorithm Specs v3.02](https://pq-crystals.org/kyber/data/kyber-specification-round3-20210804.pdf)
* [kyberJCE](https://github.com/fisherstevenk/kyberJCE)
* [CCTestVectors](https://github.com/C2SP/CCTV/)
* [mlkem768](https://github.com/FiloSottile/mlkem768)
* [kyber (C)](https://github.com/pq-crystals/kyber)
* [kyber (Rust)](https://github.com/Argyle-Software/kyber)
* [Montgomery Algorithm](https://www.ams.org/journals/mcom/1985-44-170/S0025-5718-1985-0777282-X/S0025-5718-1985-0777282-X.pdf)
* [Kyber-K2SO (Go)](https://github.com/symbolicsoft/kyber-k2so)
* [Kyber on ARM64](https://eprint.iacr.org/2021/561.pdf) _Explains the mysterious Qinv value 62209_
### Special Thanks
* IAmDerek for guiding me in NTT.
* grhkm for helping me with implementing NTT.
* versusdkp for providing me a link for intermediates for testing.
* FiloSottile's mlkem768 which gave me clues to fix bugs in my implementation.
* Steven Fisher's kyberJCE which helped me run my first tests and use one of its algorithms.
* and others from CryptoHack community!
### License
```
Copyright 2024 Ron Lauren Hombre
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
and included as LICENSE.txt in this Project.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
Although ML-KEM is declared Public Domain, this implementation is created through the efforts of its contributors. As
such, some form of recognition for their work are required for all users of this library.