Include misc in JWT.Claims struct. Use InMemoryKeyManager() by default in DIDJWK.create()

Sources/Web5/Common/FlatMap.swift

@@ -15,7 +15,12 @@ struct FlatMap: Codable {
         if let mapValue = try? value.decode([String: AnyCodable].self) {
             wrappedValue = mapValue
         } else {
-            throw DecodingError.typeMismatch(Date.self, DecodingError.Context(codingPath: [], debugDescription: "TODO"))
+            throw DecodingError.typeMismatch(
+                FlatMap.self,
+                DecodingError.Context(
+                    codingPath: decoder.codingPath, debugDescription: "TODO"
+                )
+            )
         }
     }
 

Sources/Web5/Credentials/PresentationExchange.swift

@@ -141,7 +141,7 @@ public enum PresentationExchange {
     ) throws -> [InputDescriptorV2: [String]] {
         let vcJWTListMap: [VCDataModel] = try vcJWTList.map { vcJWT in
                 let parsedJWT  = try JWT.parse(jwtString: vcJWT)
-                guard let vcJSON = parsedJWT.payload["vc"]?.value as? [String: Any] else {
+            guard let vcJSON = parsedJWT.payload.miscellaneous?["vc"]?.value as? [String: Any] else {
                     throw Error.missingCredentialObject
                 }
 

Sources/Web5/Crypto/JOSE/JWT.swift

@@ -26,33 +26,38 @@ public struct JWT {
         /// or after which the JWT must not be accepted for processing.
         ///
         /// [Spec](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4)
-        @ISO8601Date private(set) var expiration: Date?
+        let expiration: Int?
 
         /// The "nbf" (not before) claim identifies the time before which the JWT
         /// must not be accepted for processing.
         ///
         /// [Spec](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.5)
-        @ISO8601Date private(set) var notBefore: Date?
+        let notBefore: Int?
 
         /// The "iat" (issued at) claim identifies the time at which the JWT was issued.
         ///
         /// [Spec](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6)
-        @ISO8601Date private(set) var issuedAt: Date?
+        let issuedAt: Int?
 
         /// The "jti" (JWT ID) claim provides a unique identifier for the JWT.
         ///
         /// [Spec](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7)
         let jwtID: String?
 
+        /// "misc" Miscellaneous claim is a map to store any additional claims
+        ///
+        var miscellaneous: [String: AnyCodable]?
+
         // Default Initializer
         public init(
             issuer: String? = nil,
             subject: String? = nil,
             audience: String? = nil,
-            expiration: Date? = nil,
-            notBefore: Date? = nil,
-            issuedAt: Date? = nil,
-            jwtID: String? = nil
+            expiration: Int? = nil,
+            notBefore: Int? = nil,
+            issuedAt: Int? = nil,
+            jwtID: String? = nil,
+            misc: [String: AnyCodable] = [:]
         ) {
             self.issuer = issuer
             self.subject = subject
@@ -61,9 +66,11 @@ public struct JWT {
             self.notBefore = notBefore
             self.issuedAt = issuedAt
             self.jwtID = jwtID
+            self.miscellaneous = misc
         }
 
-        enum CodingKeys: String, CodingKey {
+
+        enum CodingKeys: String, CodingKey, CaseIterable {
             case issuer = "iss"
             case subject = "sub"
             case audience = "aud"
@@ -72,6 +79,63 @@ public struct JWT {
             case issuedAt = "iat"
             case jwtID = "jti"
         }
+
+        public init(from decoder: Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+
+            // Decode the known properties
+            issuer = try container.decodeIfPresent(String.self, forKey: .issuer)
+            subject = try container.decodeIfPresent(String.self, forKey: .subject)
+            audience = try container.decodeIfPresent(String.self, forKey: .audience)
+            expiration = try container.decodeIfPresent(Int.self, forKey: .expiration)
+            notBefore = try container.decodeIfPresent(Int.self, forKey: .notBefore)
+            issuedAt = try container.decodeIfPresent(Int.self, forKey: .issuedAt)
+            jwtID = try container.decodeIfPresent(String.self, forKey: .jwtID)
+
+            // Initialize the miscellaneous dictionary
+            var misc = [String: AnyCodable]()
+
+            // Extract all rawValues from CodingKeys for comparison
+            let knownKeysRawValues = CodingKeys.allCases.map { $0.rawValue }
+
+            // Dynamically decode keys not in CodingKeys
+            let dynamicContainer = try decoder.container(keyedBy: DynamicCodingKey.self)
+            for key in dynamicContainer.allKeys {
+                // Convert DynamicCodingKey to String
+                let keyString = key.stringValue
+
+                // Skip keys that are part of the known CodingKeys
+                if !knownKeysRawValues.contains(keyString) {
+                    if let value = try? dynamicContainer.decode(AnyCodable.self, forKey: key) {
+                        misc[keyString] = value
+                    }
+                }         
+            }
+
+            miscellaneous = misc.isEmpty ? nil : misc
+        }
+
+        public func encode(to encoder: Encoder) throws {
+            var container = encoder.container(keyedBy: CodingKeys.self)
+
+            // Encode known properties
+            try container.encodeIfPresent(issuer, forKey: .issuer)
+            try container.encodeIfPresent(subject, forKey: .subject)
+            try container.encodeIfPresent(audience, forKey: .audience)
+            try container.encodeIfPresent(expiration, forKey: .expiration)
+            try container.encodeIfPresent(notBefore, forKey: .notBefore)
+            try container.encodeIfPresent(issuedAt, forKey: .issuedAt)
+            try container.encodeIfPresent(jwtID, forKey: .jwtID)
+
+            // Dynamically encode the miscellaneous properties at the top level
+            var dynamicContainer = encoder.container(keyedBy: DynamicCodingKey.self)
+            if let misc = miscellaneous {
+                for (key, value) in misc {
+                    let codingKey = DynamicCodingKey(stringValue: key)!
+                    try dynamicContainer.encode(value, forKey: codingKey)
+                }
+            }
+        }
     }
 
     /// Signs the provied JWT claims with the provided BearerDID.
@@ -94,11 +158,11 @@ public struct JWT {
 
     public struct ParsedJWT {
         let header: JWS.Header
-        let payload: [String: AnyCodable]
+        let payload: JWT.Claims
 
         public init(
             header: JWS.Header,
-            payload: [String: AnyCodable]
+            payload: JWT.Claims
         ) {
             self.header = header
             self.payload = payload
@@ -129,9 +193,9 @@ public struct JWT {
         }
 
         let jwtPayload = try JSONDecoder().decode(
-            [String: AnyCodable].self,
-            from: base64urlEncodedJwtPayload.decodeBase64Url()
-        )
+            JWT.Claims.self,
+            from: try base64urlEncodedJwtPayload.decodeBase64Url())
+
 
         return ParsedJWT(header: jwtHeader, payload: jwtPayload)
     }
@@ -151,3 +215,21 @@ extension JWT {
         }
     }
 }
+
+
+// MARK: - DynamicCodingKey
+// Define DynamicCodingKey to use for dynamic encoding
+struct DynamicCodingKey: CodingKey {
+    var stringValue: String
+    var intValue: Int?
+
+    init?(stringValue: String) {
+        self.stringValue = stringValue
+        self.intValue = nil
+    }
+
+    init?(intValue: Int) {
+        self.stringValue = "\(intValue)"
+        self.intValue = intValue
+    }
+}

Sources/Web5/Dids/Methods/DIDJWK.swift

@@ -30,7 +30,7 @@ public enum DIDJWK {
     ///   - options: Options configuring how the DIDJWK is created
     /// - Returns: `BearerDID` that represents the created DIDJWK
     public static func create(
-        keyManager: KeyManager,
+        keyManager: KeyManager = InMemoryKeyManager(),
         options: CreateOptions = .default
     ) throws -> BearerDID {
         let keyAlias = try keyManager.generatePrivateKey(algorithm: options.algorithm)

Tests/Web5TestVectors/Web5TestVectorsPresentationExchange.swift

@@ -49,7 +49,7 @@ final class Web5TestVectorsPresentationExchange: XCTestCase {
                 expectation.fulfill()
             }
 
-            wait(for: [expectation], timeout: 1)
+            wait(for: [expectation], timeout: 10000)
         }
     }
 

Tests/Web5Tests/Crypto/JOSE/JWTTests.swift

@@ -1,15 +1,69 @@
 import XCTest
+import AnyCodable
 
 @testable import Web5
 
 final class JWTTests: XCTestCase {
 
     func test_sign() throws {
-        let did = try DIDJWK.create(keyManager: InMemoryKeyManager())
+        let did = try DIDJWK.create()
+        let future = Int(Date.distantFuture.timeIntervalSince1970)
 
-        let claims = JWT.Claims(issuer: did.identifier)
+        let claims = JWT.Claims(
+            issuer: did.identifier,
+            expiration: future,
+            misc: ["nonce": 123]
+        )
         let jwt = try JWT.sign(did: did, claims: claims)
 
         XCTAssertFalse(jwt.isEmpty)
+
+        let decoded = try JWT.parse(jwtString: jwt)
+        let decodedNonceValue = decoded.payload.miscellaneous?["nonce"]?.value as? Int
+        XCTAssertEqual(decodedNonceValue, 123)
+
+    }
+}
+
+// todo consider adding more tests to verify encode and decode works as intended
+class JWTClaimsTests: XCTestCase {
+
+    func testClaimsEncodingDecoding() {
+        let originalClaims = JWT.Claims(
+            issuer: "issuer",
+            subject: "subject",
+            audience: "audience",
+            expiration: Int(Date.distantFuture.timeIntervalSince1970),
+            notBefore: Int(Date.distantPast.timeIntervalSince1970),
+            issuedAt: Int(Date.now.timeIntervalSince1970),
+            jwtID: "jwtID",
+            misc: ["foo": AnyCodable("bar")]
+        )
+
+        do {
+            let encodedClaims = try JSONEncoder().encode(originalClaims)
+            let decodedClaims = try JSONDecoder().decode(JWT.Claims.self, from: encodedClaims)
+
+            XCTAssertEqual(originalClaims.issuer, decodedClaims.issuer)
+            XCTAssertEqual(originalClaims.subject, decodedClaims.subject)
+            XCTAssertEqual(originalClaims.audience, decodedClaims.audience)
+            XCTAssertEqual(originalClaims.expiration, decodedClaims.expiration)
+            XCTAssertEqual(originalClaims.notBefore, decodedClaims.notBefore)
+            XCTAssertEqual(originalClaims.issuedAt, decodedClaims.issuedAt)
+            XCTAssertEqual(originalClaims.jwtID, decodedClaims.jwtID)
+
+            // Log and compare custom claims
+            let originalMiscValue = originalClaims.miscellaneous?["foo"]?.value as? String
+            let decodedMiscValue = decodedClaims.miscellaneous?["foo"]?.value as? String
+
+            if let originalMiscValue = originalMiscValue, let decodedMiscValue = decodedMiscValue {
+                XCTAssertEqual(originalMiscValue, decodedMiscValue, "Misc claims did not match.")
+            } else {
+                XCTFail("Custom claims could not be found or did not match. Original: \(String(describing: originalMiscValue)), Decoded: \(String(describing: decodedMiscValue))")
+            }
+
+        } catch {
+            XCTFail("Encoding or decoding failed with error: \(error)")
+        }
     }
 }

Tests/Web5Tests/Dids/BearerDIDTests.swift

@@ -6,7 +6,7 @@ import XCTest
 final class BearerDIDTests: XCTestCase {
 
     func test_export() throws {
-        let didJWK = try DIDJWK.create(keyManager: InMemoryKeyManager())
+        let didJWK = try DIDJWK.create()
         let portableDID = try didJWK.export()
 
         XCTAssertNoDifference(portableDID.uri, didJWK.uri)
@@ -18,7 +18,7 @@ final class BearerDIDTests: XCTestCase {
     func test_getSigner() throws {
         let payload = "Hello, world!".data(using: .utf8)!
 
-        let didJWK = try DIDJWK.create(keyManager: InMemoryKeyManager())
+        let didJWK = try DIDJWK.create()
         let signer = try didJWK.getSigner()
 
         let signature = try signer.sign(payload: payload)
@@ -30,7 +30,7 @@ final class BearerDIDTests: XCTestCase {
     func test_getSigner_verificationMethodID() throws {
         let payload = "Hello, world!".data(using: .utf8)!
 
-        let didJWK = try DIDJWK.create(keyManager: InMemoryKeyManager())
+        let didJWK = try DIDJWK.create()
         let verificationMethodID = try XCTUnwrap(didJWK.document.verificationMethod?.first?.id)
 
         let signer = try didJWK.getSigner(verificationMethodID: verificationMethodID)
@@ -41,7 +41,7 @@ final class BearerDIDTests: XCTestCase {
     }
 
     func test_getSigner_invalidVerificationMethodID() throws {
-        let didJWK = try DIDJWK.create(keyManager: InMemoryKeyManager())
+        let didJWK = try DIDJWK.create()
         XCTAssertThrowsError(try didJWK.getSigner(verificationMethodID: "not-real"))
     }
 }