vertx / io.vertx.ext.web.handler / JWTAuthHandler

JWTAuthHandler

interface JWTAuthHandler : AuthHandler

An auth handler that provides JWT Authentication support.

Author
Paulo Lopes

Functions

create

open static fun create(authProvider: JWTAuth): JWTAuthHandler
open static fun create(authProvider: JWTAuth, skip: String): JWTAuthHandler

Create a JWT auth handler

setAudience

abstract fun setAudience(audience: MutableList<String>): JWTAuthHandler

Set the audience list

setIgnoreExpiration

abstract fun setIgnoreExpiration(ignoreExpiration: Boolean): JWTAuthHandler

Set whether expiration is ignored

setIssuer

abstract fun setIssuer(issuer: String): JWTAuthHandler

Set the issuer

Inherited Functions

addAuthorities

abstract fun addAuthorities(authorities: MutableSet<String>): AuthHandler

Add a set of required authorities for this auth handler

addAuthority

abstract fun addAuthority(authority: String): AuthHandler

Add a required authority for this auth handler

authorize

abstract fun authorize(user: User, handler: Handler<AsyncResult<Void>>): Unit

Authorizes the given user against all added authorities.

parseCredentials

abstract fun parseCredentials(context: RoutingContext, handler: Handler<AsyncResult<JsonObject>>): Unit

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.