Swiftpack.co - Package - auth0/JWTDecode.swift

JWTDecode.swift

CircleCI Coverage Status Version License Platform Swift 5.3

This library will help you check JWT payload

This library doesn't validate the token, any well formed JWT can be decoded from Base64Url.

Table of Contents

Requirements

  • iOS 9+ / macOS 10.11+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 11.4+ / 12.x
  • Swift 4.x / 5.x

Installation

Cocoapods

If you are using Cocoapods, add this line to your Podfile:

pod 'JWTDecode', '~> 2.4'

Then run pod install.

For more information on Cocoapods, check their official documentation.

Carthage

If you are using Carthage, add the following line to your Cartfile:

github "auth0/JWTDecode.swift" ~> 2.4

Then run carthage bootstrap.

For more information about Carthage usage, check their official documentation.

SPM

If you are using the Swift Package Manager, open the following menu item in Xcode:

File > Swift Packages > Add Package Dependency...

In the Choose Package Repository prompt add this url:

https://github.com/auth0/JWTDecode.swift.git

Then press Next and complete the remaining steps.

For further reference on SPM, check its official documentation.

Usage

Import the framework

import JWTDecode

Decode the token

let jwt = try decode(jwt: token)    

JWT Parts

Header dictionary

jwt.header

Claims in token body

jwt.body

Token signature

jwt.signature

Registered Claims

  • "aud" (Audience)
jwt.audience
  • "sub" (Subject)
jwt.subject
  • "jti" (JWT ID)
jwt.identifier
  • "iss" (Issuer)
jwt.issuer
  • "nbf" (Not Before)
jwt.notBefore
  • "iat" (Issued At)
jwt.issuedAt
  • "exp" (Expiration Time)
jwt.expiresAt

Custom Claims

If we also have our custom claims we can retrive them calling claim(name: String) -> Claim then you can try converting the value like:

let claim = jwt.claim(name: "email")
if let email = claim.string {
    print("Email in jwt was \(email)")
}

The supported conversions are:

var string: String?
var integer: Int?
var double: Double?
var date: NSDate?
var array: [String]?

You can easily add a convenience accessor for a custom claim by adding an extension:

extension JWT {
    var myClaim: String? {
        return claim(name: "my_claim").string
    }
}

Error Handling

If the token is invalid an NSError will be thrown from the decode(token) function:

catch let error as NSError {
    error.localizedDescription
}

What is Auth0?

Auth0 helps you to:

  • Add authentication with multiple sources, either social identity providers such as Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce (amongst others), or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML Identity Provider.
  • Add authentication through more traditional username/password databases.
  • Add support for linking different user accounts with the same user.
  • Support for generating signed JSON Web Tokens to call your APIs and flow the user identity securely.
  • Analytics of how, when, and where users are logging in.
  • Pull data from other sources and add it to the user profile through JavaScript rules.

Create a Free Auth0 Account

  1. Go to Auth0 and click Sign Up.
  2. Use Google, GitHub, or Microsoft Account to login.

Issue Reporting

If you have found a bug or to request a feature, please raise an issue. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.

Github

link
Stars: 363

Dependencies

Used By

Total: 1

Releases

2.5.0 - 2020-10-16 13:02:16

⚠️ This release adds support for Xcode 12 and drops support for Xcode < 11.4

Changed

2.4.1 - 2020-01-13 17:47:32

Changed

  • Lowered tvOS deployment target to 9.0 #100 (Widcket)
  • Added SPM instructions to the README #99 (Widcket)

2.4.0 - 2019-11-27 14:49:07

Added

  • Added Swift Package Manager Support [SDK-1181] #97 (Widcket)
  • Added watchOS support #91 (jklp)

2.3.1 - 2019-09-24 15:40:17

Added

  • Multiple Swift version support in CocoaPods #94 (ericbuehl)

2.3.0 - 2019-07-17 10:58:59

Added

  • Added Swift 5 / Xcode 10.2 support #88 (cocojoe)

2.2.0 - 2018-12-17 18:01:53

Added

Changed

2.1.1 - 2017-10-03 09:54:22

Added

2.1.0 - 2017-09-27 15:59:18

Added

2.0.0 - 2016-09-14 22:28:23

Full Changelog

Support for Xcode 8 & Swift 3.

Following Swift API Guidelines, all functions and methods requires a parameter label.

So now to decode a token

try JWTDecode.decode(jwt: "token")

Also now JWTDecode errors conforms the protocol LocalizableError

public enum DecodeError: LocalizedError {
    case invalidBase64Url(String)
    case invalidJSON(String)
    case invalidPartCount(String, Int)

    public var localizedDescription: String {
        switch self {
        case .invalidJSON(let value):
            return NSLocalizedString("Malformed jwt token, failed to parse JSON value from base64Url \(value)", comment: "Invalid JSON value inside base64Url")
        case .invalidPartCount(let jwt, let parts):
            return NSLocalizedString("Malformed jwt token \(jwt) has \(parts) parts when it should have 3 parts", comment: "Invalid amount of jwt parts")
        case .invalidBase64Url(let value):
            return NSLocalizedString("Malformed jwt token, failed to decode base64Url value \(value)", comment: "Invalid JWT token base64Url value")
        }
    }
}

1.2.0 - 2016-09-13 12:45:44

Full Changelog

Support for Xcode 8 & Swift 2.3.

1.1.0 - 2016-08-17 15:10:36

Full Changelog

Changed:

  • Rework how claims are decoded #35 (hzalaz)
  • Add expired method to A0JWT #25 (wkoszek)
  • Require only App Extension Safe API (in iOS) #20 (hzalaz)

Added:

Deprecated:

To provide a better experience while dealing with claims and converting their values to Swift types, we deprecated the following method to retrive JWT claims

public func claim<T>(name: String) -> T?

In favor of the following method to retrieve the claim

let claim = jwt.claim(name: "claim_name")

and then you can try converting it's value to the proper type like

if let email = claim.string {
    print("JWT had email \(email)")
}

The supported conversions are:

var string: String?
var integer: Int?
var double: Double?
var date: NSDate?
var array: [String]?

1.0.0 - 2015-09-16 19:47:45

Full Changelog

Fixed bugs:

  • Can this target 8.0 instead of 8.3? #10

Merged pull requests:

0.3.2 - 2015-08-21 20:57:38

0.3.1 - 2015-07-25 15:00:09

Full Changelog

Closed issues:

  • Failing to install via carthage #6

Merged pull requests:

  • Carthage with submodules #8 (hzalaz)
  • Build test only when running tests #7 (hzalaz)

0.3.0 - 2015-07-25 15:00:07

Full Changelog

Merged pull requests:

0.2.2 - 2015-07-25 15:00:05

Full Changelog

Closed issues:

  • Issue with time of expiration. #3

0.2.1 - 2015-07-25 15:00:03

Full Changelog

Closed issues:

  • Invalid id_token claims part. Failed to decode base64 #1

Merged pull requests:

0.2.0 - 2015-07-25 15:00:02

0.1.0 - 2015-07-25 14:59:59

* This Change Log was automatically generated by github_changelog_generator