Skip to content

Commit

Permalink
docs : updated crypto README.md file with aws
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperBatata committed Dec 17, 2024
1 parent 0a46390 commit 8dbb90b
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions waltid-libraries/crypto/waltid-crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@ vault secrets enable transit

### Working with AWSKey

An AWS account is required in order to be able to use an `AWSKey` for signing and verification. This
An AWS account is required in order to be able to use an `AWSKeyRestAPI` for signing and verification. This
implies covering the following steps:

1. [create an AWS account](https://aws.amazon.com/resources/create-account/)
Expand All @@ -715,16 +715,24 @@ implies covering the following steps:

#### 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.
The `AWSKeyMetadata` class is used to specify the AWS access key ID, secret access key, roleName and region.
It is used when creating an `AWSKeyRestAPI` instance.




```kotlin
@Serializable
data class AWSKeyMetadata(
val accessKeyId: String,
val secretAccessKey: String,
val region: String
)
val auth: AWSAuth,
) {
constructor(
accessKeyId: String? = null,
secretAccessKey: String? = null,
region: String? = null,
roleName: String? = null,
) : this(AWSAuth(accessKeyId, secretAccessKey, region, roleName))
}
```

For usage examples on _create_, _sign_, _verify_, _import_ and _export_ functions see
Expand Down

0 comments on commit 8dbb90b

Please sign in to comment.