Skip to content

Vapor API Docs

JWTKit

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Leaf LeafKit

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

APNS

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Classes
JWTKeyCollection
Protocols
ECDSACurveType
- Associated Types
- PrivateKey
- Signature
- SigningAlgorithm
- Type Properties
- static var byteRanges: (x: Range<Int>, y: Range<Int>)
- static var curve: ECDSACurve
ECDSAKey
- Associated Types
- Curve
- Instance Properties
- var curve: ECDSACurve
- var parameters: ECDSAParameters?
ECDSAPrivateKey
- Associated Types
- PublicKey
- Signature
- Initializers
- init(compactRepresentable: Bool)
- init<Bytes>(derRepresentation: Bytes) throws
- init(pemRepresentation: String) throws
- init(rawRepresentation: some ContiguousBytes) throws
- init(x963Representation: some ContiguousBytes) throws
- Instance Properties
- var derRepresentation: Data
- var pemRepresentation: String
- var publicKey: Self.PublicKey
- var rawRepresentation: Data
- var x963Representation: Data
- Instance Methods
- func signature(for: some Digest) throws -> Self.Signature
ECDSAPublicKey
ECDSASignature
- Instance Properties
- var rawRepresentation: Data
ECDSASigningAlgorithm
- Type Properties
- static var digestAlgorithm: DigestAlgorithm
- static var name: String
EdDSAKey
JWTAlgorithm
- Instance Properties
- var name: String
- Instance Methods
- func sign(some DataProtocol) throws -> [UInt8]
- func verify(some DataProtocol, signs: some DataProtocol) throws -> Bool
JWTClaim
- Associated Types
- Value
- Initializers
- init(stringLiteral: String)
- init(value: Self.Value)
  - JWTMultiValueClaim Implementations
    - init(value: Self.Value.Element)
- Instance Properties
- var value: Self.Value
JWTJSONDecoder
- Instance Methods
- func decode<T>(T.Type, from: Data) throws -> T
- Type Properties
- static var defaultForJWT: any JWTJSONDecoder
JWTJSONEncoder
- Instance Methods
- func encode<T>(T) throws -> Data
- Type Properties
- static var defaultForJWT: any JWTJSONEncoder
JWTMultiValueClaim
- Initializers
- init(value: Self.Value.Element)
  - JWTMultiValueClaim Implementations
    - init(value: Self.Value.Element)
JWTParser
JWTPayload
- Instance Methods
- func verify(using: some JWTAlgorithm) async throws
JWTSerializer
- Instance Properties
- var jsonEncoder: any JWTJSONEncoder
- Instance Methods
- func makeHeader(from: JWTHeader, key: any JWTAlgorithm) async throws -> JWTHeader
- func serialize(some JWTPayload, header: JWTHeader) throws -> Data
JWTUnixEpochClaim
RSAKey
ValidationTimePayload
- Instance Properties
- var signedDate: Date
Structures
AppleIdentityToken
AudienceClaim
- Initializers
- init(stringLiteral: String)
- init(value: [String])
- Instance Properties
- var value: [String]
- Instance Methods
- func verifyIntendedAudience(includes: String) throws
BoolClaim
- Initializers
- init(booleanLiteral: Bool)
- init(from: any Decoder) throws
- init(stringLiteral: String)
- init(value: Bool)
- Instance Properties
- var value: Bool
DefaultJWTParser
- Initializers
- init(jsonDecoder: any JWTJSONDecoder)
- Instance Properties
- var jsonDecoder: any JWTJSONDecoder
- Instance Methods
- func parse<Payload>(some DataProtocol, as: Payload.Type) throws -> (header: JWTHeader, payload: Payload, signature: Data)
DefaultJWTSerializer
- Initializers
- init(jsonEncoder: any JWTJSONEncoder)
- Instance Properties
- var jsonEncoder: any JWTJSONEncoder
- Instance Methods
- func serialize(some JWTPayload, header: JWTHeader) throws -> Data
DigestAlgorithm
- Type Properties
- static let sha256: DigestAlgorithm
- static let sha384: DigestAlgorithm
- static let sha512: DigestAlgorithm
ECDSACurve
- Initializers
- init(from: any Decoder) throws
- init?(rawValue: String)
- Instance Properties
- var rawValue: String
- Instance Methods
- func encode(to: any Encoder) throws
- Type Properties
- static let p256: ECDSACurve
- static let p384: ECDSACurve
- static let p521: ECDSACurve
EdDSACurve
- Initializers
- init(from: any Decoder) throws
- init?(rawValue: String)
- Instance Properties
- var rawValue: String
- Instance Methods
- func encode(to: any Encoder) throws
- Type Properties
- static let ed25519: EdDSACurve
EmptyPolicy
- Instance Properties
- var verifyingCriticalExtensions: [ASN1ObjectIdentifier]
- Instance Methods
- func chainMeetsPolicyRequirements(chain: UnverifiedCertificateChain) -> PolicyEvaluationResult
ExpirationClaim
- Initializers
- init(value: Date)
- Instance Properties
- var value: Date
- Instance Methods
- func verifyNotExpired(currentDate: Date) throws
FirebaseAuthIdentityToken
GoogleHostedDomainClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
- Instance Methods
- func verify(domain: String) throws
GoogleIdentityToken
HMACKey
IDClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
IssuedAtClaim
- Initializers
- init(value: Date)
- Instance Properties
- var value: Date
IssuerClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
JWK
JWKIdentifier
JWKS
- Initializers
- init(from: any Decoder) throws
- init(keys: [JWK])
- Instance Properties
- var keys: [JWK]
- Instance Methods
- func find(identifier:)
- func find(identifier:type:)
JWTError
JWTHeader
LocaleClaim
- Initializers
- init(from: any Decoder) throws
- init(stringLiteral: String)
- init(value: Locale)
- Instance Properties
- var value: Locale
- Instance Methods
- func encode(to: any Encoder) throws
MicrosoftIdentityToken
NotBeforeClaim
- Initializers
- init(value: Date)
- Instance Properties
- var value: Date
- Instance Methods
- func verifyNotBefore(currentDate: Date) throws
SubjectClaim
- Initializers
- init(value: String)
- Instance Properties
- var value: String
TenantIDClaim
- Initializers
- init(nilLiteral: ())
- init(stringLiteral: String)
- init(value: String?)
- Instance Properties
- var value: String?
X5CVerifier
Type Aliases
ECDSAParameters
ES256PrivateKey
ES256PublicKey
ES384PrivateKey
ES384PublicKey
ES512PrivateKey
ES512PublicKey
Enumerations
ECDSA
EdDSA
Insecure
- Enumerations
- Insecure.RSA
JWTHeaderField
Extended Modules
CryptoKit
Foundation

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Type Method

invalidX5CChain(reason:)

static func invalidX5CChain(reason: String) -> JWTError

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

Twitter
Mastodon
Bsky
GitHub