A library to help you decode and parse JWTs
Swift Shell Objective-C Ruby
Pull request Compare This branch is 1 commit ahead, 23 commits behind auth0:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
JWTDecode.playground
JWTDecode.xcodeproj
JWTDecode
JWTDecodeTests
script
.gitignore
.travis.yml
CHANGELOG.md
Cartfile.private
Cartfile.resolved
Gemfile
Gemfile.lock
JWTDecode.podspec
LICENSE.txt
README.md

README.md

JWTDecode.swift

CI Status Version License Platform Carthage compatible

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 8+ and at least Xcode 7 (for Swift 2.0).

Installation

CocoaPods

JWTDecode is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "JWTDecode", '~> 1.0'

Carthage

In your Cartfile add this line

github "auth0/JWTDecode.swift"

Manual installation

Download JWTDecode.framework from Releases and add it to your project in Xcode.

Usage

Just import the framework

import JWTDecode

and decode the token

let jwt = try decode(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<T>(name: String) -> T? where T is the value type of the claim, e.g.: a String

let custom: String? = jwt.claim("email")

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.