A library to help you decode JWTs in Swift
Clone or download
cocojoe Merge pull request #69 from auth0/added-claim-access
Added rawValue accessor for Claims
Latest commit 5f0f838 Oct 17, 2018

README.md

JWTDecode.swift

CI Status Coverage Status Version License Platform Carthage compatible Swift 3.1

This library will help you check JWT payload

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

Requirements

  • iOS 9 or later
  • Xcode 8.3 / 9.0
  • Swift 3.1+

Installation

Carthage

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

github "auth0/JWTDecode.swift" ~> 2.1

Then run carthage bootstrap.

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

Cocoapods

If you are using Cocoapods, add these lines to your Podfile:

use_frameworks!
pod 'JWTDecode', '~> 2.1'

Then, run pod install.

For further reference on Cocoapods, check their 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 authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont 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 if you have a feature request, please report them at this repository issues section. 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.