BREAKING CHANGE: Make JWT Codable and generic on claims #10

Andrew-Lees11 · 2018-10-26T11:14:17Z

This pull request makes JWT Codable instead of using [String: Any] dictionaries.
Since this is a breaking change it also includes major refactoring of the project.
The following changes have been made:

Remove dependency on BlueCryptor, instead use BlueRSA for both mac and linux.
Refactor package.swift to match the layout of our other repos
Refactor Base64URL as a data extension so it matches base64 API and make the functions internal.
Split Algorithm into sign and verify algorithms with corresponding private and public key requirements
Created JWTSigner and JWTVerifier structs as extensible implementations of the sign and verify algorithms.
Added the none algorithm for the case of always accepting/no signing of JWTs
Made ValidateClaimsResult an extensible struct that only checks time based standard claims
Added JWTError struct and made sign and encode functions only throw instead of throwing or returning optional
Removed Hash.swift since hashing is not part of the JWT package
Made Header a codable struct with all the possible fields of a JWT header
Made claims a Codable protocol to represent the claims on a JWT
Made JWT a codable struct containing the headers and generic on claims
removed encode() and replaced it with signing the JWT with none
Made RSAKeyType an internal class
Updates Jazzy docs with descriptions and examples of public API
Updated tests to reflect new API
Update to the Standard README with the new usage examples

djones6

I think we should consider replacing the use of optionals here with throws, so that failures to encode or decode a JWT can be debugged / logged.

djones6 · 2018-11-13T15:18:21Z

Sources/SwiftJWT/Base64URL.swift

-            return base64URLEncodedString
-        }
-        return nil
+extension Data {


Should we rename this source file to reflect the new contents?

djones6 · 2018-11-13T16:53:51Z

Sources/SwiftJWT/JWT.swift

+    /// - Parameter jwt: A String with the encoded and signed JWT.
+    /// - Parameter verifier: The `JWTVerifier` used to verify the JWT.
+    /// - Returns: An instance of `JWT` if the decoding succeeds.
+    public init?(jwtString: String, verifier: JWTVerifier = .none ) {


Why optional initializer versus a failable initializer? There's no way to communicate back the reason for initialization failing (decode error etc)

djones6 · 2018-11-13T16:55:05Z

Sources/SwiftJWT/JWT.swift

    ///
-    /// - Note: Sets header.alg with the name of the signing algorithm.
+    /// - Note: This function will set header.alg field to the name of the signing algorithm.
    ///
    /// - Parameter using algorithm: The algorithm to sign with.
    /// - Returns: A String with the encoded and signed JWT.
    /// - Throws: An error thrown during the encoding or signing.


This no longer throws

djones6 · 2018-11-13T16:56:00Z

Sources/SwiftJWT/JWT.swift

@@ -98,73 +98,18 @@ public struct JWT {
    /// - Parameter using algorithm: The algorithm to verify with.
    /// - Returns: A Bool indicating whether the verification was successful.
    /// - Throws: An error thrown during the verification.


This no longer throws

djones6 · 2018-11-15T17:34:19Z

Sources/SwiftJWT/JWT.swift

+    /// - Parameter verifier: The `JWTVerifier` used to verify the JWT.
+    /// - Returns: An instance of `JWT` if the decoding succeeds.
+    /// - Throws: `JWTError.invalidJWTString` if the jwtString is not base64urlEncoded sections seperated by either 2 or 3 full stops.
+    /// - Throws: `JWTError.iailedVerification` if the verifier fails to verify the jwtString.


djones6 · 2018-11-16T10:47:49Z

Sources/SwiftJWT/BlueRSA.swift

@@ -20,7 +20,8 @@ import LoggerAPI

 import Foundation

-class BlueRSA: EncryptionAlgorithm {
+class BlueRSA: SignerAlgorithm, VerifierAlgorithm {


Does BlueRSA now provide enough Linux support that we could use this code on Linux and get rid of the Linux-specific RSA type?

djones6 · 2018-11-16T10:48:58Z

Sources/SwiftJWT/Data+Base64URL.swift

@@ -0,0 +1,37 @@
+/**


Maybe call this file Data+Base64URLEncoded.swift?

Sources/SwiftJWT/JWTError.swift

djones6 · 2018-11-16T10:56:29Z

Sources/SwiftJWT/BlueRSA.swift

+        let unsignedJWT = header + "." + claims
+        guard let unsignedData = unsignedJWT.data(using: .utf8) else {
+            // replace with custom error
+            throw NSError(domain: "sign", code: 500, userInfo: [:])


This should be a JWTError

djones6 · 2018-11-19T16:17:48Z

Package.swift

@@ -18,16 +18,6 @@

 import PackageDescription

-var listDependencies: [Package.Dependency] = [
-    .package(url: "https://github.com/IBM-Swift/HeliumLogger.git", from: "1.7.1"),


I think we do still want to log errors, but this import should be LoggerAPI instead.

djones6

🎉

Andrew-Lees11 requested review from ianpartridge and djones6 October 26, 2018 11:14

djones6 suggested changes Nov 13, 2018

View reviewed changes

This was referenced Nov 14, 2018

SwiftJWT example Kitura/Kitura-Sample#113

Closed

JWTEncoder/JWTDecoder JWT #14

Closed

Andrew-Lees11 added 10 commits November 15, 2018 15:34

BREAKING CHANGE: Make JWT Codable and generic on claims

60a102b

CodableJWT removing unneeded API's

5760c1a

remove extra algoithm functions

490ec0c

minor base64URL refactor

d3122d9

update README

17c5b0d

remove issuer check in test

64561dc

make none algorithm constant instead of function

a1afaa1

Update docs and minor refactoring

7600f62

Make functions throw and add Error class

1dfbd3b

Update Jazzy docs examples

ebc3f6a

Andrew-Lees11 force-pushed the codableJWT branch from b1e9bbd to ebc3f6a Compare November 15, 2018 15:35

djones6 reviewed Nov 15, 2018

View reviewed changes

djones6 reviewed Nov 16, 2018

View reviewed changes

djones6 suggested changes Nov 16, 2018

View reviewed changes

Andrew-Lees11 added 3 commits November 16, 2018 11:18

Use BlueRSA for linux

2f2c46c

Added JWTError.InternalError for faster comparisons

b97ee07

Added default value for equatable array in tests

bb5cced

Andrew-Lees11 mentioned this pull request Nov 19, 2018

project lacks a clear installation process #15

Closed

Removed Helium logger

748475c

djones6 reviewed Nov 19, 2018

View reviewed changes

Added loggerAPI to replace Helium logger

9cb24d4

djones6 approved these changes Nov 19, 2018

View reviewed changes

Added missing comma in dependencies

1fa856d

djones6 merged commit f246142 into master Nov 19, 2018

Andrew-Lees11 deleted the codableJWT branch November 30, 2018 11:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BREAKING CHANGE: Make JWT Codable and generic on claims #10

BREAKING CHANGE: Make JWT Codable and generic on claims #10

Andrew-Lees11 commented Oct 26, 2018 •

edited

Loading

djones6 left a comment

djones6 Nov 13, 2018

djones6 Nov 13, 2018

djones6 Nov 13, 2018

djones6 Nov 13, 2018

djones6 Nov 15, 2018

djones6 Nov 16, 2018

djones6 Nov 16, 2018

djones6 Nov 16, 2018

djones6 Nov 19, 2018

djones6 left a comment

BREAKING CHANGE: Make JWT Codable and generic on claims #10

BREAKING CHANGE: Make JWT Codable and generic on claims #10

Conversation

Andrew-Lees11 commented Oct 26, 2018 • edited Loading

djones6 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djones6 left a comment

Choose a reason for hiding this comment

Andrew-Lees11 commented Oct 26, 2018 •

edited

Loading