io.ktor.auth.jwt

Class JWTAuthenticationProvider

io.ktor.auth.jwt.JWTAuthenticationProvider

public class JWTAuthenticationProvider

JWT authentication provider that will be registered with the specified name

Constructor Summary

Constructors

Constructor and Description
JWTAuthenticationProvider(java.lang.String name) JWT authentication provider that will be registered with the specified name

Method Summary

Modifier and Type	Method and Description
void	authSchemes(java.lang.String defaultScheme, java.lang.String additionalSchemes)
java.lang.String	getRealm() JWT realm name that will be used during auth challenge
void	setRealm(java.lang.String p) JWT realm name that will be used during auth challenge
void	validate(kotlin.jvm.functions.Function3<? super io.ktor.application.ApplicationCall,? super io.ktor.auth.jwt.JWTCredential,? super kotlin.coroutines.experimental.Continuation<? super io.ktor.auth.Principal>,? extends java.lang.Object> validate) Apply validate function to every call with class JWTCredential
void	verifier(com.auth0.jwt.JWTVerifier verifier)
void	verifier(kotlin.jvm.functions.Function1<? super io.ktor.auth.HttpAuthHeader,com.auth0.jwt.JWTVerifier> verifier)
void	verifier(com.auth0.jwk.JwkProvider jwkProvider, java.lang.String issuer)
void	verifier(com.auth0.jwk.JwkProvider jwkProvider)

Constructor Detail

JWTAuthenticationProvider

public JWTAuthenticationProvider(java.lang.String name)

JWT authentication provider that will be registered with the specified name

Method Detail

getRealm

public java.lang.String getRealm()

JWT realm name that will be used during auth challenge

setRealm

public void setRealm(java.lang.String p)

JWT realm name that will be used during auth challenge

authSchemes

public void authSchemes(java.lang.String defaultScheme,
                        java.lang.String additionalSchemes)

Parameters:

defaultScheme - default scheme that will be used to challenge the client when no valid auth is provided

additionalSchemes - additional schemes that will be accepted when validating the authentication

verifier

public void verifier(com.auth0.jwt.JWTVerifier verifier)

Parameters:

verifier - verifies token format and signature

verifier

public void verifier(kotlin.jvm.functions.Function1<? super io.ktor.auth.HttpAuthHeader,com.auth0.jwt.JWTVerifier> verifier)

Parameters:

verifier - verifies token format and signature

verifier

public void verifier(com.auth0.jwk.JwkProvider jwkProvider,
                     java.lang.String issuer)

Parameters:

jwkProvider - provides the JSON Web Key

issuer - the issuer of the JSON Web Token

verifier

public void verifier(com.auth0.jwk.JwkProvider jwkProvider)

Parameters:

jwkProvider - provides the JSON Web Key

validate

public void validate(kotlin.jvm.functions.Function3<? super io.ktor.application.ApplicationCall,? super io.ktor.auth.jwt.JWTCredential,? super kotlin.coroutines.experimental.Continuation<? super io.ktor.auth.Principal>,? extends java.lang.Object> validate)

Apply validate function to every call with class JWTCredential

See Also:

class JWTCredential