A library to help you decode JWTs in Swift
This library will help you check JWT payload
This library doesn't validate the token, any well formed JWT can be decoded from Base64Url.
If you are using Cocoapods, add this line to your Podfile
:
pod 'JWTDecode', '~> 2.6'
Then run pod install
.
For more information on Cocoapods, check their official documentation.
If you are using Carthage, add the following line to your Cartfile
:
github "auth0/JWTDecode.swift" ~> 2.6
Then run carthage bootstrap --use-xcframeworks
.
For more information about Carthage usage, check their official documentation.
If you are using the Swift Package Manager, open the following menu item in Xcode:
File > Add Packages...
In the Search or Enter Package URL search box enter this url:
https://github.com/auth0/JWTDecode.swift.git
Then select the dependency rule and press Add Package.
For further reference on SPM, check its official documentation.
Import the framework
import JWTDecode
Decode the token
let jwt = try decode(jwt: token)
jwt.header
jwt.body
jwt.signature
jwt.audience
jwt.subject
jwt.identifier
jwt.issuer
jwt.notBefore
jwt.issuedAt
jwt.expiresAt
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 boolean: Bool?
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
}
}
If the token is invalid an NSError
will be thrown from the decode(token)
function:
catch let error as NSError {
error.localizedDescription
}
Auth0 helps you to:
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.
This project is licensed under the MIT license. See the LICENSE file for more info.