Skip to content

Vapor API Docs

Authentication

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

Essentials
Password Hashing
One-Time Passwords
Password Hashing
PasswordHasher
BcryptHasher
- Initializers
- init(cost: Int)
- Instance Methods
- func hash<Password>(Password) throws(BcryptError) -> [UInt8]
- func verify<Password, Digest>(Password, created: Digest) throws(BcryptError) -> Bool
PlaintextHasher
- Initializers
- init()
- Instance Methods
- func hash<Password>(Password) -> [UInt8]
- func verify<Password, Digest>(Password, created: Digest) -> Bool
BcryptError
- Enumeration Cases
- case hashFailure
- case internalError
- case invalidCost
- case invalidHash
- case invalidSalt
- Instance Properties
- var description: String
- var errorDescription: String?
One-Time Passwords
HOTP
- Initializers
- init(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits)
- Instance Methods
- func generate(counter: UInt64) -> String
- func generate(counter: UInt64, range: Int) -> [String]
- Type Methods
- static func generate(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits, counter: UInt64) -> String
TOTP
- Initializers
- init(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits, interval: Int)
- Instance Methods
- func generate(time: Date) -> String
- func generate(time: Date, range: Int) -> [String]
- Type Methods
- static func generate(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits, interval: Int, time: Date) -> String
OTPDigits
- Enumeration Cases
- case eight
- case seven
- case six
- Initializers
- init?(rawValue: Int)
OTPDigest
- Enumeration Cases
- case sha1
- case sha256
- case sha512
Structures
PBKDF2Hasher

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

Instance Property

errorDescription

var errorDescription: String? { get }

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