Framework

JWT

JWT provides integrations between JWTKit and Vapor to make it easy to work with JWTs in your Vapor application.

Overview

For more details, see the Vapor Docs.

Topics

Classes

class Dimension
class DispatchGroup
class DispatchIO
class DispatchObject
class DispatchQueue
class DispatchSemaphore
class DispatchSource
class DispatchSpecificKey
class DispatchWorkItem
class ECDSAKey
class FileManager
class JSONDecoder
An object that decodes instances of a data type from JSON objects.
class JSONEncoder
An object that encodes instances of a data type as JSON objects.
class JWTSigner
A JWT signer.
class JWTSigners
A collection of signers labeled by kid.
class NotificationCenter
class ProcessInfo
A collection of information about the current process.
class ProgressManager
An object that conveys ongoing progress to the user for a specified task.
class ProgressReporter
ProgressReporter is a wrapper for ProgressManager that carries information about ProgressManager.
class PropertyListDecoder
An object that decodes instances of data types from a property list.
class PropertyListEncoder
An object that encodes instances of data types to a property list.
class RSAKey
class UnitDuration
class X5CVerifier
An object for verifying JWS tokens that contain the x5c header parameter with a set of known root certificates.

Protocols

protocol AsyncJWTAuthenticator
protocol AttributeScope
A type that organizes attributes into a grouping, and supports dynamic member lookup and serialization of attribute keys.
protocol AttributedStringAttributeMutation
A protocol that defines in-place mutations for attributes in an attributed string.
protocol AttributedStringKey
A type that defines an attribute’s name and type.
protocol AttributedStringProtocol
A protocol that provides common functionality to attributed strings and attributed substrings.
protocol ContiguousBytes
A protocol that declares the type offers direct access to the underlying raw bytes in a contiguous manner.
protocol DataProtocol
A protocol that provides consistent data access to the bytes underlying contiguous and noncontiguous data buffers.
protocol DecodableAttributedStringKey
A protocol that defines how an attribute key decodes its value.
protocol DecodableWithConfiguration
A protocol for types that support decoding when supplied with an additional configuration type.
protocol DecodingConfigurationProviding
A protocol whose conformers provide a configuration instance to help decode types that don’t support encoding by themselves.
protocol DiscreteFormatStyle
A format style that transforms a continuous input into a discrete output and provides information about its discretization boundaries.
protocol DispatchSourceProtocol
protocol DispatchSourceRead
protocol DispatchSourceSignal
protocol DispatchSourceTimer
protocol DispatchSourceUserDataAdd
protocol DispatchSourceUserDataOr
protocol DispatchSourceUserDataReplace
protocol DispatchSourceWrite
protocol EncodableAttributedStringKey
A protocol that defines how an attribute key encodes its value.
protocol EncodableWithConfiguration
A protocol for types that support encoding when supplied with an additional configuration type.
protocol EncodingConfigurationProviding
A protocol whose conformers provide a configuration instance to help encode types that don’t support encoding by themselves.
protocol FileManagerDelegate
protocol FormatStyle
A type that converts a given data type into a representation in another type, such as a string.
protocol JWTAlgorithm
Algorithm powering a JWTSigner.
protocol JWTAuthenticator
protocol JWTClaim
A claim is a codable, top-level property of a JWT payload. Multiple claims form a payload. Some claims, such as expiration claims, are inherently verifiable. Each claim able to verify itself provides an appropriate method for doing so, depending on the specific claim.
protocol JWTJSONDecoder
protocol JWTJSONEncoder
protocol JWTMultiValueClaim
protocol JWTPayload
A JWT payload is a Publically Readable set of claims Each variable represents a claim.
protocol JWTUnixEpochClaim
protocol LocalizedError
A specialized error that provides localized messages describing the error and why it occurred.
protocol MarkdownDecodableAttributedStringKey
A protocol that defines how an attribute key decodes a value that corresponds to Markdown syntax.
protocol MutableDataProtocol
A protocol that provides consistent data access to the bytes underlying contiguous and noncontiguous mutable data buffers.
protocol ParseStrategy
A type that parses an input representation, such as a formatted string, into a provided data type.
protocol ParseableFormatStyle
A type that can convert a given input data type into a representation in an output type.
protocol PredicateExpression
A component expression that makes up part of a predicate.
protocol SortComparator
A comparison algorithm for a specified type.
protocol StandardPredicateExpression
A component expression that makes up part of a predicate, and that’s supported by the standard predicate type.

Structures

struct ACTION
struct AppleIdentityToken
struct AttributeContainer
A container for attribute keys and values.
struct AttributeScopeCodableConfiguration
A configuration type for encoding and decoding attributed strings.
struct AttributedString
A value type for a string with associated attributes for portions of its text.
struct AttributedSubstring
A portion of an attributed string.
struct AudienceClaim
The “aud” (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the “aud” claim when this claim is present, then the JWT MUST be rejected. In the general case, the “aud” value is an array of case- sensitive strings, each containing a StringOrURI value. In the special case when the JWT has one audience, the “aud” value MAY be a single case-sensitive string containing a StringOrURI value. The interpretation of audience values is generally application specific. Use of this claim is OPTIONAL.
struct BoolClaim
A claim which represents a bool
struct ByteCountFormatStyle
A format style that provides string representations of byte counts.
struct Calendar
A definition of the relationships between calendar units and absolute points in time, providing features for calculation and comparison of dates.
struct CocoaError
Describes errors within the Cocoa error domain, including errors that Foundation throws.
struct CodableConfiguration
A property wrapper that makes a type codable, by supplying a configuration that provides additional information for serialization.
struct ComparableComparator
A comparator that compares types according to their conformance to the comparable protocol.
struct Data
A byte buffer in memory.
struct Date
A specific point in time, independent of any calendar or time zone.
struct DateComponents
A date or time specified in terms of units (such as year, month, day, hour, minute) to be evaluated in a calendar system and time zone.
struct DateInterval
The span of time between a specific start date and end date.
struct Decimal
A structure representing a base-10 number.
struct DiscontiguousAttributedSubstring
A discontiguous portion of an attributed string.
struct DispatchData
struct DispatchDataIterator
struct DispatchQoS
qos_class_t
struct DispatchTime
struct DispatchWallTime
struct DispatchWorkItemFlags
struct EdDSAKey
struct Elf32_Chdr
struct Elf32_Dyn
struct Elf32_Ehdr
struct Elf32_Lib
struct Elf32_Move
struct Elf32_Nhdr
struct Elf32_Phdr
struct Elf32_RegInfo
struct Elf32_Rel
struct Elf32_Rela
struct Elf32_Shdr
struct Elf32_Sym
struct Elf32_Syminfo
struct Elf32_Verdaux
struct Elf32_Verdef
struct Elf32_Vernaux
struct Elf32_Verneed
struct Elf32_auxv_t
struct Elf32_gptab
struct Elf64_Chdr
struct Elf64_Dyn
struct Elf64_Ehdr
struct Elf64_Lib
struct Elf64_Move
struct Elf64_Nhdr
struct Elf64_Phdr
struct Elf64_Rel
struct Elf64_Rela
struct Elf64_Shdr
struct Elf64_Sym
struct Elf64_Syminfo
struct Elf64_Verdaux
struct Elf64_Verdef
struct Elf64_Vernaux
struct Elf64_Verneed
struct Elf64_auxv_t
struct Elf_MIPS_ABIFlags_v0
struct Elf_Options
struct Elf_Options_Hw
struct ExpirationClaim
The “exp” (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. The processing of the “exp” claim requires that the current date/time MUST be before the expiration date/time listed in the “exp” claim. Implementers MAY provide for some small leeway, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a NumericDate value. Use of this claim is OPTIONAL.
struct Expression
struct FileAttributeKey
Keys in dictionaries used to get and set file attributes.
struct FileAttributeType
Values representing a file’s type attribute.
struct FileProtectionType
Protection level values that can be associated with a file attribute key.
struct FloatingPointFormatStyle
A structure that converts between floating-point values and their textual representations.
struct FloatingPointParseStrategy
A parse strategy for creating floating-point values from formatted strings.
struct FormatStyleCapitalizationContext
The capitalization formatting context used when formatting dates and times.
struct GoogleHostedDomainClaim
struct GoogleIdentityToken
struct IDClaim
The “jti” (JWT ID) claim provides a unique identifier for the JWT. The identifier value MUST be assigned in a manner that ensures that there is a negligible probability that the same value will be accidentally assigned to a different data object; if the application uses multiple issuers, collisions MUST be prevented among values produced by different issuers as well. The “jti” claim can be used to prevent the JWT from being replayed. The “jti” value is a case- sensitive string. Use of this claim is OPTIONAL.
struct IndexPath
A list of indexes that together represent the path to a specific location in a tree of nested arrays.
struct IntegerFormatStyle
A structure that converts between integer values and their textual representations.
struct IntegerParseStrategy
A parse strategy for creating integer values from formatted strings.
struct IssuedAtClaim
The “iat” (issued at) claim identifies the time at which the JWT was issued. This claim can be used to determine the age of the JWT. Its value MUST be a number containing a NumericDate value. Use of this claim is OPTIONAL.
struct IssuerClaim
The “iss” (issuer) claim identifies the principal that issued the JWT. The processing of this claim is generally application specific. The “iss” value is a case-sensitive string containing a StringOrURI value. Use of this claim is OPTIONAL.
struct JWK
A JSON Web Key.
struct JWKIdentifier
struct JWKS
A JSON Web Key Set.
struct KeyPathComparator
A comparator that uses another sort comparator to provide the comparison of values at a key path.
struct La_x86_64_regs
struct La_x86_64_retval
struct La_x86_64_vector
struct ListFormatStyle
A type that formats lists of items with a separator and conjunction appropriate for a given locale.
struct Locale
Information about linguistic, cultural, and technological conventions for use in formatting data for presentation.
struct LocaleClaim
struct Measurement
struct MicrosoftIdentityToken
struct NotBeforeClaim
The “nbf” (not before) claim identifies the time before which the JWT MUST NOT be accepted for processing. The processing of the “nbf” claim requires that the current date/time MUST be after or equal to the not-before date/time listed in the “nbf” claim. Implementers MAY provide for some small leeway, usually no more than a few minutes, to account for clock skew. Its value MUST be a number containing a NumericDate value. Use of this claim is OPTIONAL.
struct OperatingSystemVersion
A structure that contains version information about the currently executing operating system, including major, minor, and patch version numbers.
struct POSIXError
Describes an error in the POSIX error domain.
struct Predicate
A logical condition used to test a set of input values for searching or filtering.
struct PredicateBindings
A mapping from a predicates’s input variables to their values.
struct PredicateError
An error thrown while evaluating a predicate.
struct ScopedAttributeContainer
An attribute container that allows dynamic member lookup of its contents within the specified attribute scope.
struct SortDescriptor
A serializable description of how to sort numerics and strings.
struct StringStyle
struct SubjectClaim
The “sub” (subject) claim identifies the principal that is the subject of the JWT. The claims in a JWT are normally statements about the subject. The subject value MUST either be scoped to be locally unique in the context of the issuer or be globally unique. The processing of this claim is generally application specific. The “sub” value is a case-sensitive string containing a StringOrURI value. Use of this claim is OPTIONAL.
struct Subprogress
Subprogress is used to establish parent-child relationship between two instances of ProgressManager.
struct TimeZone
Information about standard time conventions associated with a specific geopolitical region.
struct URL
A value that identifies the location of a resource, such as an item on a remote server or the path to a local file.
struct URLComponents
A structure that parses URLs into and constructs URLs from their constituent parts.
struct URLQueryItem
A single name-value pair from the query portion of a URL.
struct URLResourceKey
struct UUID
A universally unique value to identify types, interfaces, and other items.
struct VISIT
struct addrinfo
struct aiocb
struct dirent
struct div_t
struct drand48_data
struct entry
struct exit_status
struct fenv_t
struct flock
struct fsconfig_command
struct glob_t
struct group
struct group_req
struct group_source_req
struct hostent
struct idtype_t
struct if_nameindex
struct ifaddr
struct ifaddrs
struct ifconf
struct ifmap
struct ifreq
struct imaxdiv_t
struct in_pktinfo
struct inotify_event
struct ip_mreq
struct ip_mreq_source
struct ip_mreqn
struct ip_opts
struct ipc_perm
struct ipv6_mreq
struct itimerspec
struct itimerval
struct lastlog
struct lconv
struct ldiv_t
struct linger
struct link_map
struct lldiv_t
struct mcontext_t
struct mnt_id_req
struct mount_attr
struct msginfo
struct msqid_ds
struct netent
struct osockaddr
struct passwd
struct pollfd
struct posix_spawn_file_actions_t
struct posix_spawnattr_t
struct protoent
struct pthread_barrier_t
struct pthread_barrierattr_t
struct pthread_condattr_t
struct pthread_mutexattr_t
struct pthread_rwlockattr_t
struct r_debug
struct r_debug_extended
struct random_data
struct re_pattern_buffer
struct reg_errcode_t
struct regmatch_t
struct rlimit
struct rpcent
struct rusage
struct sched_param
struct sem_t
struct sembuf
struct semid_ds
struct seminfo
struct servent
struct shm_info
struct shmid_ds
struct shminfo
struct sigaction
struct sigcontext
struct sigevent
struct siginfo_t
struct sigstack
struct sigval
struct sockaddr_in
struct sockaddr_in6
struct sockaddr_un
struct stack_t
struct stat
struct statmount
struct statvfs
struct tcp_ca_state
struct tcp_cookie_transactions
struct tcp_info
struct tcp_md5sig
struct tcp_repair_opt
struct tcp_repair_window
struct tcp_zerocopy_receive
struct tcphdr
struct termio
struct termios
struct timespec
struct timeval
struct timezone
struct tm
struct tms
struct ucontext_t
struct user
struct user_fpregs_struct
struct user_regs_struct
struct utimbuf
struct utmp
struct utmpx
struct utsname
struct winsize
struct wordexp_t

Variables

Functions

Operators

Macros

Type Aliases

typealias CodableAttributedStringKey
A type alias for attribute keys that are both encodable and decodable.
typealias CodableWithConfiguration
A type that can convert itself into and out of an external representation with the help of a configuration that handles encoding contained types.
typealias DispatchSourceHandler
typealias ENTRY
typealias Elf32_Addr
typealias Elf32_Conflict
typealias Elf32_Half
typealias Elf32_Off
typealias Elf32_Relr
typealias Elf32_Section
typealias Elf32_Sword
typealias Elf32_Sxword
typealias Elf32_Versym
typealias Elf32_Word
typealias Elf32_Xword
typealias Elf64_Addr
typealias Elf64_Half
typealias Elf64_Off
typealias Elf64_Relr
typealias Elf64_Section
typealias Elf64_Sword
typealias Elf64_Sxword
typealias Elf64_Versym
typealias Elf64_Word
typealias Elf64_Xword
typealias Elf_Symndx
typealias JWKSCache
A thread-safe and atomic class for retrieving JSON Web Key Sets which honors the HTTP Cache-Control, Expires and Etag headers.
typealias La_x86_64_xmm
typealias La_x86_64_ymm
typealias La_x86_64_zmm
typealias Semaphore
typealias TimeInterval
A number of seconds.
typealias active_reg_t
typealias cookie_close_function_t
typealias cookie_read_function_t
typealias cookie_seek_function_t
typealias cookie_write_function_t
typealias iconv_t
typealias id_t
typealias in_addr_t
typealias in_port_t
typealias key_t
typealias msglen_t
typealias msgqnum_t
typealias nl_catd
typealias nl_item
typealias reg_syntax_t
typealias regex_t
typealias regoff_t
typealias rlim_t
typealias s_reg_t
typealias shmatt_t
typealias sighandler_t
typealias sigset_t
typealias ssize_t
typealias tcflag_t
typealias tcp_seq
typealias uintptr_t
typealias uuid_string_t
typealias uuid_t

Enumerations

enum AttributeDynamicLookup
A type to support dynamic member lookup of attributes and containers.
enum AttributeScopes
Collections of attributes that system frameworks define.
enum ComparisonResult
Constants that indicate sort order.
enum CurrencyFormatStyleConfiguration
Configuration settings for formatting currency values.
enum DescriptiveNumberFormatConfiguration
enum DispatchPredicate
dispatch_assert
enum DispatchTimeInterval
Represents a time interval that can be used as an offset from a DispatchTime or DispatchWallTime.
enum DispatchTimeoutResult
enum JWTError
enum NumberFormatStyleConfiguration
Configuration settings for formatting numbers of different types.
enum POSIXErrorCode
Enumeration describing POSIX error codes.
enum PredicateExpressions
The expressions that make up a predicate.
enum SortOrder
The orderings that you can perform sorts with.

Overview

Topics

Classes

Protocols

Structures

Variables

Functions

Operators

Macros

Type Aliases

Enumerations

Extended Modules