diff --git a/waltid-libraries/crypto/waltid-crypto/README.md b/waltid-libraries/crypto/waltid-crypto/README.md index f4ac04635..ccc3008d2 100644 --- a/waltid-libraries/crypto/waltid-crypto/README.md +++ b/waltid-libraries/crypto/waltid-crypto/README.md @@ -11,36 +11,18 @@ -## Installation - -Add the crypto library as a dependency to your Kotlin or Java project. - -### walt.id Repository - -Add the Maven repository which hosts the walt.id libraries to your build.gradle file. - -```kotlin -repositories { - maven { url = uri("https://maven.waltid.dev/releases") } -} -``` - -### Library Dependency - -Adding the crypto library as dependency. Specify the version that coincides with the latest or required -snapshot for your project. [Latest releases](https://github.com/walt-id/waltid-identity/releases). - -```kotlin -dependencies { - implementation("id.walt.crypto:waltid-crypto:") -} -``` +## What it provides -Replace `version` with the version of the walt.id crypto library you want to use. -Note: As the crypto lib is part of the mono-repo walt.id identity, you need to use the version of -walt.id identity. +The library provides the following key entities to work with: -## What it provides +- [JWKKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/jwk/JWKKey.kt) - + an implementation of a local (in-memory) key (private / public) +- [TSEKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/tse/TSEKey.kt) - + an implementation of a Hashicorp Vault Transit Secrets Engine key (private / public) +- [OCIKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/oci/OCIKeyRestApi.kt) - + an implementation of an OCI key (private / public) +- [AWSKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/aws/AWSKey.kt) - + an implementation of an AWS key (private / public) @@ -48,12 +30,13 @@ walt.id identity. - + + @@ -67,6 +50,11 @@ walt.id identity. + + + + + @@ -84,6 +72,11 @@ walt.id identity. + + + + + @@ -98,6 +91,11 @@ walt.id identity. + + + + + @@ -116,6 +114,11 @@ walt.id identity. + + + + + @@ -130,6 +133,11 @@ walt.id identity. + + + + + @@ -150,6 +158,11 @@ walt.id identity. + + + + + @@ -164,6 +177,11 @@ walt.id identity. + + + + + @@ -180,6 +198,11 @@ walt.id identity. + + + + + @@ -194,6 +217,11 @@ walt.id identity. + + + + + @@ -210,6 +238,11 @@ walt.id identity. + + + + + @@ -224,6 +257,11 @@ walt.id identity. + + + + + @@ -244,6 +282,11 @@ walt.id identity. + + + + + @@ -258,6 +301,11 @@ walt.id identity. + + + + + @@ -274,6 +322,11 @@ walt.id identity. + + + + + @@ -288,6 +341,11 @@ walt.id identity. + + + + + @@ -304,6 +362,11 @@ walt.id identity. + + + + + @@ -318,6 +381,11 @@ walt.id identity. + + + + + @@ -327,6 +395,35 @@ walt.id identity. - ✗ not implemented - ‐ not available +## Installation + +Add the crypto library as a dependency to your Kotlin or Java project. + +### walt.id Repository + +Add the Maven repository which hosts the walt.id libraries to your build.gradle file. + +```kotlin +repositories { + maven { url = uri("https://maven.waltid.dev/releases") } +} +``` + +### Library Dependency + +Adding the crypto library as dependency. Specify the version that coincides with the latest or required +snapshot for your project. [Latest releases](https://github.com/walt-id/waltid-identity/releases). + +```kotlin +dependencies { + implementation("id.walt.crypto:waltid-crypto:") +} +``` + +Replace `version` with the version of the walt.id crypto library you want to use. +Note: As the crypto lib is part of the mono-repo walt.id identity, you need to use the version of +walt.id identity. + ### Signature schemes | Type | ECDSA | JOSE ID | Description | @@ -358,13 +455,6 @@ walt.id identity. ## How to use it -The library provides the following key entities to work with: - -- [JWKKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/jwk/JWKKey.kt) - - an implementation of a local (in-memory) key (private / public) -- [TSEKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/tse/TSEKey.kt) - - an implementation of a Hashicorp Vault Transit Secrets Engine key (private / public) -- [OCIKey](https://github.com/walt-id/waltid-identity/blob/main/waltid-libraries/waltid-crypto/src/commonMain/kotlin/id/walt/crypto/keys/oci/OCIKeyRestApi.kt) - an implementation of an OCI key (private / public) ### Working with JWKKey **Create key** @@ -398,7 +488,7 @@ val verificationResult = key.getPublicKey().verifyJws(signature) - raw ```kotlin -val verificationResult = key.getPublicKey().verifyRaw(signature , payloadString.encodeToByteArray()) +val verificationResult = key.getPublicKey().verifyRaw(signature, payloadString.encodeToByteArray()) ``` **Import key** @@ -429,7 +519,6 @@ val key = JWKKey.importRawPublicKey(KeyType.Ed25519, bytes, JWKKeyMetadata()) val jwkString = key.exportJWK() ``` - - JsonObject ```kotlin @@ -530,5 +619,28 @@ vault secrets enable transit 4. on the 'Enable a secrets engine' page, select 'Transit' from the 'Generic' group 5. click 'Next', then 'Enable Engine' +### Working with AWSKey + +An AWS account is required in order to be able to use an `AWSKey` for signing and verification. This +implies covering the following steps: + +1. [create an AWS account](https://aws.amazon.com/resources/create-account/) +2. [create an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) +3. [create an access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user_manage_add-key.html) + +#### AwsKeyMetadata + +The `AWSKeyMetadata` class is used to specify the AWS access key ID, secret access key, and region. +It is used when creating an `AWSKey` instance. + +```kotlin +@Serializable +data class AWSKeyMetadata( + val accessKeyId: String, + val secretAccessKey: String, + val region: String +) +``` + For usage examples on _create_, _sign_, _verify_, _import_ and _export_ functions see [Working with JWKKey](#working-with-jwkKey).
Feature CategoryKeyKey
Local TSEAWS
secp256k1 secp256r1 rsaed25519secp256k1secp256r1rsa
✓ ✓ ✓✓✓✓✓
✓ ✓ ✓✓✓✓✓
✓ ✓ ✓✓✓✓✓
✓ ✓ ✓✓✓✓✓
‐ ‐ ‐‐‐‐‐
✗ ✗ ✗✓✓✓✓
‐ ‐ ‐‐‐‐‐
‐ ‐ ‐✗‐‐‐
‐ ‐ ‐‐‐‐‐
✗ ✗ ✗✗✗✗✗
‐ ‐ ‐‐‐‐‐
✗ ✗ ✗✗✗✗✗
‐ ‐ ‐‐‐‐‐
✗ ✗ ✗✗✗✗✗
‐ ‐ ‐‐‐‐‐
✗ ✗ ✗✗✗✗✗