[117] Allow JWK parameters of type [String] #120
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,12 @@ | |
|
|
||
| import Foundation | ||
|
|
||
| // Common protocol for all types that can be used as JWK parameters. | ||
| public protocol JWKParameterType: Encodable, Decodable { } | ||
|
|
||
| extension String: JWKParameterType { } | ||
| extension Array: JWKParameterType where Element == String { } | ||
|
|
||
| /// Possible common JWK parameters. | ||
| /// See [RFC-7517, Section 4](https://tools.ietf.org/html/rfc7517#section-4) for details. | ||
| public enum JWKParameter: String, CodingKey { | ||
|
|
@@ -36,10 +42,15 @@ public enum JWKParameter: String, CodingKey { | |
| case X509CertificateSHA1Thumbprint = "x5t" | ||
| case X509CertificateSHA256Thumbprint = "x5t#S256" | ||
|
|
||
| var type: Codable.Type { | ||
| switch self { | ||
| case .keyType, .keyUse, .algorithm, .keyIdentifier, | ||
| .X509URL, .X509CertificateSHA1Thumbprint, .X509CertificateSHA256Thumbprint: | ||
| return String.self | ||
| case .keyOperations, .X509CertificateChain: | ||
| return [String].self | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// RSA specific JWK parameters. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,8 +33,14 @@ extension RSAPublicKey: Encodable { | |
| // Other common parameters are optional. | ||
| for parameter in parameters { | ||
| // Only encode known parameters. | ||
| guard let key = JWKParameter(rawValue: parameter.key) else { | ||
| continue | ||
| } | ||
|
|
||
| if let value = parameter.value as? String { | ||
| try commonParameters.encode(value, forKey: key) | ||
| } else if let value = parameter.value as? [String] { | ||
| try commonParameters.encode(value, forKey: key) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -61,11 +67,16 @@ extension RSAPublicKey: Decodable { | |
| } | ||
|
|
||
| // Other common parameters are optional. | ||
| var parameters: [String: JWKParameterType] = [:] | ||
|
|
||
| for key in commonParameters.allKeys where key.type == String.self { | ||
| parameters[key.rawValue] = try commonParameters.decode(String.self, forKey: key) | ||
| } | ||
|
|
||
| for key in commonParameters.allKeys where key.type == [String].self { | ||
| parameters[key.rawValue] = try commonParameters.decode([String].self, forKey: key) | ||
| } | ||
|
|
||
| // RSA public key specific parameters. | ||
| let rsaParameters = try decoder.container(keyedBy: RSAParameter.self) | ||
| let modulus = try rsaParameters.decode(String.self, forKey: .modulus) | ||
|
|
@@ -89,8 +100,14 @@ extension RSAPrivateKey: Encodable { | |
| // Other common parameters are optional. | ||
| for parameter in parameters { | ||
| // Only encode known parameters. | ||
| guard let key = JWKParameter(rawValue: parameter.key) else { | ||
| continue | ||
| } | ||
|
|
||
| if let value = parameter.value as? String { | ||
| try commonParameters.encode(value, forKey: key) | ||
| } else if let value = parameter.value as? [String] { | ||
| try commonParameters.encode(value, forKey: key) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -118,11 +135,16 @@ extension RSAPrivateKey: Decodable { | |
| } | ||
|
|
||
| // Other common parameters are optional. | ||
| var parameters: [String: JWKParameterType] = [:] | ||
|
|
||
| for key in commonParameters.allKeys where key.type == String.self { | ||
| parameters[key.rawValue] = try commonParameters.decode(String.self, forKey: key) | ||
| } | ||
|
|
||
| for key in commonParameters.allKeys where key.type == [String].self { | ||
| parameters[key.rawValue] = try commonParameters.decode([String].self, forKey: key) | ||
| } | ||
|
|
||
| // RSA private key specific parameters. | ||
| let rsaParameters = try decoder.container(keyedBy: RSAParameter.self) | ||
| let modulus = try rsaParameters.decode(String.self, forKey: .modulus) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -94,7 +94,7 @@ public struct RSAPublicKey: JWK { | |
| public let keyType: JWKKeyType | ||
|
|
||
| /// The JWK parameters. | ||
| public let parameters: [String: JWKParameterType] | ||
|
|
||
| /// The modulus value for the RSA public key. | ||
| public let modulus: String | ||
|
|
@@ -113,7 +113,7 @@ public struct RSAPublicKey: JWK { | |
| /// - exponent: The public exponent value for the RSA public key in `base64urlUInt` encoding | ||
| /// as specified in [RFC-7518, Section 2](https://tools.ietf.org/html/rfc7518#section-2). | ||
| /// - parameters: Additional JWK parameters. | ||
| public init(modulus: String, exponent: String, additionalParameters parameters: [String: JWKParameterType] = [:]) { | ||
| self.keyType = .RSA | ||
| self.modulus = modulus | ||
| self.exponent = exponent | ||
|
|
@@ -134,7 +134,8 @@ public struct RSAPublicKey: JWK { | |
| /// - publicKey: The public key that the resulting JWK should represent. | ||
| /// - parameters: Any additional parameters to be contained in the JWK. | ||
| /// - Throws: A `JOSESwiftError` indicating any errors. | ||
| public init(publicKey: ExpressibleAsRSAPublicKeyComponents, | ||
| additionalParameters parameters: [String: JWKParameterType] = [:]) throws { | ||
| guard let components = try? publicKey.rsaPublicKeyComponents() else { | ||
| throw JOSESwiftError.couldNotConstructJWK | ||
| } | ||
|
|
@@ -184,7 +185,7 @@ public struct RSAPrivateKey: JWK { | |
| public let keyType: JWKKeyType | ||
|
|
||
| /// The JWK parameters. | ||
| public let parameters: [String: JWKParameterType] | ||
|
|
||
| /// The modulus value for the RSA private key. | ||
| public let modulus: String | ||
|
|
@@ -205,7 +206,7 @@ public struct RSAPrivateKey: JWK { | |
| // - privateExponent: The private exponent value for the RSA private key in `base64urlUInt` encoding | ||
| /// as specified in [RFC-7518, Section 2](https://tools.ietf.org/html/rfc7518#section-2). | ||
| /// - parameters: Additional JWK parameters. | ||
| public init(modulus: String, exponent: String, privateExponent: String, additionalParameters parameters: [String: JWKParameterType] = [:]) { | ||
| self.keyType = .RSA | ||
| self.modulus = modulus | ||
| self.exponent = exponent | ||
|
|
@@ -228,7 +229,8 @@ public struct RSAPrivateKey: JWK { | |
| /// - privateKey: The private key that the resulting JWK should represent. | ||
| /// - parameters: Any additional parameters to be contained in the JWK. | ||
| /// - Throws: A `JOSESwiftError` indicating any errors. | ||
| public init(privateKey: ExpressibleAsRSAPrivateKeyComponents, | ||
| additionalParameters parameters: [String: JWKParameterType] = [:]) throws { | ||
| guard let (modulus, exponent, privateExponent) = try? privateKey.rsaPrivateKeyComponents() else { | ||
| throw JOSESwiftError.couldNotConstructJWK | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,8 +33,14 @@ extension SymmetricKey: Encodable { | |
| // Other common parameters are optional. | ||
| for parameter in parameters { | ||
| // Only encode known parameters. | ||
| guard let key = JWKParameter(rawValue: parameter.key) else { | ||
| continue | ||
| } | ||
|
|
||
| if let value = parameter.value as? String { | ||
| try commonParameters.encode(value, forKey: key) | ||
| } else if let value = parameter.value as? [String] { | ||
| try commonParameters.encode(value, forKey: key) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -60,12 +66,17 @@ extension SymmetricKey: Decodable { | |
| } | ||
|
|
||
| // Other common parameters are optional. | ||
| var parameters: [String: JWKParameterType] = [:] | ||
|
|
||
| for key in commonParameters.allKeys where key.type == String.self { | ||
| parameters[key.rawValue] = try commonParameters.decode(String.self, forKey: key) | ||
| } | ||
|
|
||
| for key in commonParameters.allKeys where key.type == [String].self { | ||
| parameters[key.rawValue] = try commonParameters.decode([String].self, forKey: key) | ||
| } | ||
|
|
||
| // Symmetric public key specific parameters. | ||
| let symmetricKeyParameters = try decoder.container(keyedBy: SymmetricKeyParameter.self) | ||
| let key = try symmetricKeyParameters.decode(String.self, forKey: .key) | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,7 +57,7 @@ public struct SymmetricKey: JWK { | |
| public let keyType: JWKKeyType | ||
|
|
||
| /// The JWK parameters. | ||
| public let parameters: [String: JWKParameterType] | ||
|
|
||
| /// The symmetric key represented as | ||
| /// base64url encoding of the octet sequence containing the key data. | ||
|
|
@@ -68,7 +68,7 @@ public struct SymmetricKey: JWK { | |
| /// - Parameters: | ||
| /// - key: The octet sequence containing the key data. | ||
| /// - parameters: Additional JWK parameters. | ||
| public init(key: Data, additionalParameters parameters: [String: JWKParameterType] = [:]) { | ||
| self.keyType = .OCT | ||
| self.key = key.base64URLEncodedString() | ||
|
|
||
|
|
@@ -87,7 +87,7 @@ public struct SymmetricKey: JWK { | |
| /// - key: The symmetirc key that the resulting JWK should represent. | ||
| /// - parameters: Any additional parameters to be contained in the JWK. | ||
| /// - Throws: A `JOSESwiftError` indicating any errors. | ||
| public init(key: ExpressibleAsSymmetricKeyComponents, additionalParameters parameters: [String: JWKParameterType] = [:]) throws { | ||
| guard let components = try? key.symmetricKeyComponents() else { | ||
| throw JOSESwiftError.couldNotConstructJWK | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -307,8 +307,6 @@ let publicKey: SecKey = try! jwk.converted(to: SecKey.self) | |
|
|
||
| More details about decoding RSA public keys can be found [in the wiki](../../wiki/jwk). | ||
|
|
||
| ## Security | ||
|
|
||
| JOSESwift uses the [iOS Security framework](https://developer.apple.com/documentation/security) and [Apple’s CommonCrypto](https://opensource.apple.com//source/CommonCrypto/) for cryptography. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why use
Any?here instead ofJWKParameterType?? Are there non[String]?orString?return types?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're right! I'll need to investigate what I did exactly back then but yeah I think you're right. Will update.
The whole parameter stuff in JWK and in the JOSE header is not exactly nice. We'd love to update all of that some time. 🙏