Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whyoleg/cryptography-kotlin
Kotlin Multiplatform cryptography / crypto library
https://github.com/whyoleg/cryptography-kotlin
aes crypto cryptography ecdsa encryption kmp kotlin kotlin-multiplatform multiplatform rsa signature
Last synced: 1 day ago
JSON representation
Kotlin Multiplatform cryptography / crypto library
- Host: GitHub
- URL: https://github.com/whyoleg/cryptography-kotlin
- Owner: whyoleg
- License: apache-2.0
- Created: 2022-05-16T16:04:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T21:43:46.000Z (6 months ago)
- Last Synced: 2024-05-22T21:51:34.949Z (6 months ago)
- Topics: aes, crypto, cryptography, ecdsa, encryption, kmp, kotlin, kotlin-multiplatform, multiplatform, rsa, signature
- Language: Kotlin
- Homepage: https://whyoleg.github.io/cryptography-kotlin/
- Size: 1.76 MB
- Stars: 233
- Watchers: 5
- Forks: 10
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin-multiplatform - cryptography-kotlin - Type-safe Multiplatform cryptography library for Kotlin which doesn't implement any cryptography algorithm on its own, but wraps well-known future-proof solutions like [OpenSSL 3.x](https://www.openssl.org), [WebCrypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) or [JCA](https://docs.oracle.com/en/java/javase/17/security/java-cryptography-architecture-jca-reference-guide.html). (Libraries / Utility)
- kmp-awesome - Cryptography-Kotlin - Type-safe Multiplatform cryptography library for Kotlin (Libraries / 🔑 Crypto)
README
# cryptography-kotlin
Type-safe Multiplatform cryptography library for Kotlin
```kotlin
CryptographyProvider.Default
.get(SHA512)
.hasher()
.hash("Kotlin is Awesome".encodeToByteArray())
```
Detailed documentation can be found on
[project website](https://whyoleg.github.io/cryptography-kotlin/) as well as in
[API reference](https://whyoleg.github.io/cryptography-kotlin/api/)
## Overview
cryptography-kotlin provides multiplatform API which consists of multiple components:
* [Secure random][Secure random] with [kotlin.Random][kotlin.Random] like API which can be used independently of other modules
* common API to use different cryptography operations,
like [ciphers][ciphers], [digests][digests], [signatures][signatures], [key derivation][key derivation], [Key agreement][Key agreement]
* multiple algorithms definitions, like [AES][AES], [RSA][RSA], [ECDSA][ECDSA], [ECDH][ECDH], [SHA][SHA256], [HMAC][HMAC]
and [PBKDF2][PBKDF2]
* multiple cryptography [providers][providers], like [OpenSSL][OpenSSL], [WebCrypto][WebCrypto] and [JDK][JDK]
The library doesn't implement any cryptography algorithm on its own, but wraps well-known future-proof solutions
like [OpenSSL 3.x](https://www.openssl.org), [WebCrypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API)
or [JCA](https://docs.oracle.com/en/java/javase/17/security/java-cryptography-architecture-jca-reference-guide.html)
with type-safe multiplatform API providing uniform experience with aligned default behavior,
and same expected results using identical parameters while allowing to use platform-specific capabilities.
For supported algorithms, primitives and targets, please consult [Providers documentation][providers]
## Using in your projects
Make sure that you use Kotlin 2.0.20+.
Using an earlier Kotlin version could still work, but not tested.
Additionally, it's possible to use [BOM][BOM] or [Gradle version catalog][Gradle version catalog] to add dependencies easier.
The library is published to Maven Central, so make sure, that it’s added to repositories.
```kotlin
kotlin {
sourceSets {
commonMain.dependencies {
implementation("dev.whyoleg.cryptography:cryptography-core:0.4.0")
}
// or androidMain
jvmMain.dependencies {
implementation("dev.whyoleg.cryptography:cryptography-provider-jdk:0.4.0")
}
appleMain.dependencies {
implementation("dev.whyoleg.cryptography:cryptography-provider-apple:0.4.0")
// or openssl3 provider with better algorithms coverage and other native targets support
// implementation("dev.whyoleg.cryptography:cryptography-provider-openssl3-prebuilt:0.4.0")
}
wasmJsMain.dependencies {
implementation("dev.whyoleg.cryptography:cryptography-provider-webcrypto:0.4.0")
}
}
}
```
Snapshots of the development version are available in Sonatype's snapshot repository.
```kotlin
repositories {
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
dependencies {
implementation("dev.whyoleg.cryptography:cryptography-core:0.4.1-SNAPSHOT")
}
```
## Bugs and Feedback
For bugs, questions and discussions, please use the [GitHub Issues](https://github.com/whyoleg/cryptography-kotlin/issues)
## License
Copyright 2023 Oleg Yukhnevich.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
[Secure random]: https://whyoleg.github.io/cryptography-kotlin/modules/cryptography-random
[kotlin.Random]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.random/-random/
[ciphers]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.operations/-cipher/index.html
[digests]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.operations/-hasher/index.html
[signatures]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.operations/-signature-generator/index.html
[key derivation]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.operations/-secret-derivation/index.html
[Key agreement]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.operations/-shared-secret-derivation/index.html
[SHA256]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-s-h-a256/index.html
[AES]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-a-e-s/index.html
[HMAC]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-h-m-a-c/index.html
[RSA]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-r-s-a/index.html
[ECDSA]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-e-c-d-s-a/index.html
[ECDH]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-e-c-d-h/index.html
[PBKDF2]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-p-b-k-d-f2/index.html
[HKDF]: https://whyoleg.github.io/cryptography-kotlin/api/cryptography-core/dev.whyoleg.cryptography.algorithms/-h-k-d-f/index.html
[providers]: https://whyoleg.github.io/cryptography-kotlin/providers/
[OpenSSL]: https://whyoleg.github.io/cryptography-kotlin/modules/cryptography-provider-openssl3/
[WebCrypto]: https://whyoleg.github.io/cryptography-kotlin/modules/cryptography-provider-webcrypto/
[JDK]: https://whyoleg.github.io/cryptography-kotlin/modules/cryptography-provider-jdk/
[BOM]: https://whyoleg.github.io/cryptography-kotlin/bom/
[Gradle version catalog]: https://whyoleg.github.io/cryptography-kotlin/gradle-version-catalog/