ktor-auth-jwt
Module Contents
alltypes
Module Contents
typealias
JWTAuthChallengeFunction
=
suspend
PipelineContext
<
*
,
ApplicationCall
>
.
(
defaultScheme
:
String
,
realm
:
String
)
->
Unit
class
JWTAuthenticationProvider
:
AuthenticationProvider
Module Contents
class
Configuration
:
Configuration
Module Contents
fun
authHeader
(
block
:
(
ApplicationCall
)
->
HttpAuthHeader
?
)
:
Unit
fun
authSchemes
(
defaultScheme
:
String
=
"Bearer"
,
vararg
additionalSchemes
:
String
)
:
Unit
fun
challenge
(
block
:
JWTAuthChallengeFunction
)
:
Unit
var
realm
:
String
fun
validate
(
validate
:
suspend
ApplicationCall
.
(
JWTCredential
)
->
Principal
?
)
:
Unit
fun
verifier
(
verifier
:
JWTVerifier
)
:
Unit
fun
verifier
(
verifier
:
(
HttpAuthHeader
)
->
JWTVerifier
?
)
:
Unit
fun
verifier
(
jwkProvider
:
JwkProvider
,
issuer
:
String
,
configure
:
JWTConfigureFunction
=
{}
)
:
Unit
fun
verifier
(
jwkProvider
:
JwkProvider
,
configure
:
JWTConfigureFunction
=
{}
)
:
Unit
fun
verifier
(
issuer
:
String
,
audience
:
String
,
algorithm
:
Algorithm
,
block
:
Verification
.
(
)
->
Unit
=
{}
)
:
Unit
fun
verifier
(
issuer
:
String
,
block
:
JWTConfigureFunction
=
{}
)
:
Unit
typealias
JWTConfigureFunction
=
Verification
.
(
)
->
Unit
class
JWTCredential
:
Credential
,
JWTPayloadHolder
Module Contents
JWTCredential
(
payload
:
Payload
)
abstract
class
JWTPayloadHolder
Module Contents
JWTPayloadHolder
(
payload
:
Payload
)
val
audience
:
List
<
String
>
val
expiresAt
:
Date
?
operator
fun
get
(
name
:
String
)
:
String
?
fun
<
T
:
Any
>
getClaim
(
name
:
String
,
clazz
:
KClass
<
T
>
)
:
T
?
fun
<
T
:
Any
>
getListClaim
(
name
:
String
,
clazz
:
KClass
<
T
>
)
:
List
<
T
>
val
issuedAt
:
Date
?
val
issuer
:
String
?
val
jwtId
:
String
?
val
notBefore
:
Date
?
val
payload
:
Payload
val
subject
:
String
?
class
JWTPrincipal
:
Principal
,
JWTPayloadHolder
Module Contents
JWTPrincipal
(
payload
:
Payload
)
io.ktor.auth.Authentication.Configuration
Module Contents
fun
Configuration
.
jwt
(
name
:
String
?
=
null
,
configure
:
Configuration
.
(
)
->
Unit
)
:
Unit
package
io.ktor.auth.jwt
Module Contents
typealias
JWTAuthChallengeFunction
=
suspend
PipelineContext
<
*
,
ApplicationCall
>
.
(
defaultScheme
:
String
,
realm
:
String
)
->
Unit
class
JWTAuthenticationProvider
:
AuthenticationProvider
Module Contents
class
Configuration
:
Configuration
Module Contents
fun
authHeader
(
block
:
(
ApplicationCall
)
->
HttpAuthHeader
?
)
:
Unit
fun
authSchemes
(
defaultScheme
:
String
=
"Bearer"
,
vararg
additionalSchemes
:
String
)
:
Unit
fun
challenge
(
block
:
JWTAuthChallengeFunction
)
:
Unit
var
realm
:
String
fun
validate
(
validate
:
suspend
ApplicationCall
.
(
JWTCredential
)
->
Principal
?
)
:
Unit
fun
verifier
(
verifier
:
JWTVerifier
)
:
Unit
fun
verifier
(
verifier
:
(
HttpAuthHeader
)
->
JWTVerifier
?
)
:
Unit
fun
verifier
(
jwkProvider
:
JwkProvider
,
issuer
:
String
,
configure
:
JWTConfigureFunction
=
{}
)
:
Unit
fun
verifier
(
jwkProvider
:
JwkProvider
,
configure
:
JWTConfigureFunction
=
{}
)
:
Unit
fun
verifier
(
issuer
:
String
,
audience
:
String
,
algorithm
:
Algorithm
,
block
:
Verification
.
(
)
->
Unit
=
{}
)
:
Unit
fun
verifier
(
issuer
:
String
,
block
:
JWTConfigureFunction
=
{}
)
:
Unit
typealias
JWTConfigureFunction
=
Verification
.
(
)
->
Unit
class
JWTCredential
:
Credential
,
JWTPayloadHolder
Module Contents
JWTCredential
(
payload
:
Payload
)
abstract
class
JWTPayloadHolder
Module Contents
JWTPayloadHolder
(
payload
:
Payload
)
val
audience
:
List
<
String
>
val
expiresAt
:
Date
?
operator
fun
get
(
name
:
String
)
:
String
?
fun
<
T
:
Any
>
getClaim
(
name
:
String
,
clazz
:
KClass
<
T
>
)
:
T
?
fun
<
T
:
Any
>
getListClaim
(
name
:
String
,
clazz
:
KClass
<
T
>
)
:
List
<
T
>
val
issuedAt
:
Date
?
val
issuer
:
String
?
val
jwtId
:
String
?
val
notBefore
:
Date
?
val
payload
:
Payload
val
subject
:
String
?
class
JWTPrincipal
:
Principal
,
JWTPayloadHolder
Module Contents
JWTPrincipal
(
payload
:
Payload
)
io.ktor.auth.Authentication.Configuration
Module Contents
fun
Configuration
.
jwt
(
name
:
String
?
=
null
,
configure
:
Configuration
.
(
)
->
Unit
)
:
Unit