Skip to content

Commit

Permalink
Update README with new key addition API (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
ptoffy authored Jun 10, 2024
1 parent 1737318 commit e4c0670
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The table below shows a list of JWTKit major releases alongside their compatible
Use the SPM string to easily include the dependendency in your `Package.swift` file

```swift
.package(url: "https://github.com/vapor/jwt-kit.git", from: "5.0.0-beta.3")
.package(url: "https://github.com/vapor/jwt-kit.git", from: "5.0.0-beta.4")
```

and add it to your target's dependencies:
Expand Down Expand Up @@ -90,7 +90,7 @@ To add a signing key to the collection, use the `add` method for the respective

```swift
// Registers an HS256 (HMAC-SHA-256) signer.
await keys.addHMAC(key: "secret", digestAlgorithm: .sha256)
await keys.add(hmac: "secret", digestAlgorithm: .sha256)
```

This example uses the _very_ secure key `"secret"`.
Expand All @@ -99,7 +99,7 @@ You can also add an optional key identifier (`kid`) to the key:

```swift
// Registers an HS256 (HMAC-SHA-256) signer with a key identifier.
await keys.addHMAC(key: "secret", digestAlgorithm: .sha256, kid: "my-key")
await keys.add(hmac: "secret", digestAlgorithm: .sha256, kid: "my-key")
```

This is useful when you have multiple keys and need to select the correct one for verification. Based on the `kid` defined in the JWT header, the correct key will be selected for verification.
Expand Down Expand Up @@ -210,7 +210,7 @@ To add an HMAC key to the key collection, use the `addHS256`, `addHS384`, or `ad

```swift
// Add HMAC with SHA-256 signer.
await keys.addHMAC(key: "secret", digestAlgorithm: .sha256)
await keys.add(hmac: "secret", digestAlgorithm: .sha256)
```

> [!IMPORTANT]
Expand Down Expand Up @@ -238,7 +238,7 @@ Once you have an ECDSA key, you can add to the key collection using the followin

```swift
// Add ECDSA with SHA-256 algorithm
await keys.addECDSA(key: key)
await keys.add(ecdsa: key)
```

## EdDSA
Expand All @@ -255,10 +255,10 @@ let publicKey = try EdDSA.PublicKey(x: "...", curve: .ed25519)
let privateKey = try EdDSA.PrivateKey(x: "...", d: "...", curve: .ed25519)

// Add public key to the key collection
await keys.addEdDSA(key: publicKey)
await keys.add(eddsa: publicKey)

// Add private key to the key collection
await keys.addEdDSA(key: privateKey)
await keys.add(eddsa: privateKey)
```

## RSA
Expand Down Expand Up @@ -303,10 +303,10 @@ Once you have an RSA key, you can add to the key collection using the following

```swift
// Add RSA with SHA-256 algorithm
await keys.addRSA(key: key, digestAlgorithm: .sha256)
await keys.add(rsa: key, digestAlgorithm: .sha256)

// Add RSA with SHA-256 and PSS padding algorithm
await keys.addPSS(key: key, digestAlgorithm: .sha256)
await keys.add(pss: key, digestAlgorithm: .sha256)
```

## Claims
Expand Down Expand Up @@ -384,8 +384,8 @@ struct CustomParser: JWTParser {
And then use them like this:

```swift
let keyCollection = await JWTKeyCollection().addHMAC(
key: "secret",
let keyCollection = await JWTKeyCollection().add(
hmac: "secret",
digestAlgorithm: .sha256,
parser: CustomParser(),
serializer: CustomSerializer()
Expand All @@ -407,8 +407,8 @@ let decoder = JSONDecoder(); decoder.dateDecodingStrategy = .iso8601
let parser = DefaultJWTParser(jsonDecoder: decoder)
let serializer = DefaultJWTSerializer(jsonEncoder: encoder)

let keyCollection = await JWTKeyCollection().addHMAC(
key: "secret",
let keyCollection = await JWTKeyCollection().add(
hmac: "secret",
digestAlgorithm: .sha256,
parser: parser,
serializer: serializer
Expand Down

0 comments on commit e4c0670

Please sign in to comment.