docs(changeset): feat: add kid to the JwtSigner interface

Signed-off-by: Timo Glastra <[email protected]>

Author: TimoGlastra

.changeset/three-clouds-return.md

@@ -0,0 +1,5 @@
+---
+"@openid4vc/oauth2": patch
+---
+
+feat: add `kid` to the JwtSigner interface

packages/oauth2/src/common/jwt/decode-jwt.ts

@@ -124,6 +124,7 @@ export function jwtSignerFromJwt({
         alg: header.alg,
         method: 'x5c',
         x5c: header.x5c,
+        kid: header.kid,
       },
     })
   }
@@ -208,6 +209,7 @@ export function jwtSignerFromJwt({
     return {
       method: 'custom',
       alg: header.alg,
+      kid: header.kid,
     }
   }
 

packages/oauth2/src/common/jwt/z-jwt.ts

@@ -7,31 +7,62 @@ export type JwtSignerDid = {
   method: 'did'
   didUrl: string
   alg: string
+
+  /**
+   * The key id that should be used for signing. You need to make sure the kid actuall matches
+   * with the key associated with the didUrl.
+   */
+  kid?: string
 }
 
 export type JwtSignerJwk = {
   method: 'jwk'
   publicJwk: Jwk
   alg: string
+
+  /**
+   * The key id that should be used for signing. You need to make sure the kid actuall matches
+   * with the key associated with the jwk.
+   *
+   * If not provided the kid can also be extracted from the `publicJwk`. Providing it here means the `kid` won't
+   * be included in the JWT header.
+   */
+  kid?: string
 }
 
 export type JwtSignerX5c = {
   method: 'x5c'
   x5c: string[]
   alg: string
+
+  /**
+   * The key id that should be used for signing. You need to make sure the kid actuall matches
+   * with the key associated with the leaf certificate.
+   */
+  kid?: string
 }
 
 export type JwtSignerFederation = {
   method: 'federation'
   trustChain?: [string, ...string[]]
   alg: string
+
+  /**
+   * The key id that should be used for signing. You need to make sure the kid actuall matches
+   * with a key present in the federation.
+   */
   kid: string
 }
 
 // In case of custom nothing will be added to the header
 export type JwtSignerCustom = {
   method: 'custom'
   alg: string
+
+  /**
+   * The key id that should be used for signing.
+   */
+  kid?: string
 }
 
 export type JwtSigner = JwtSignerDid | JwtSignerJwk | JwtSignerX5c | JwtSignerFederation | JwtSignerCustom