vertx / io.vertx.ext.web.handler / BasicAuthHandler

BasicAuthHandler

interface BasicAuthHandler : AuthHandler

An auth handler that provides HTTP Basic Authentication support.

Author
Tim Fox

Properties

DEFAULT_REALM

static val DEFAULT_REALM: String

The default realm to use

Functions

create

open static fun create(authProvider: AuthProvider): AuthHandler

Create a basic auth handler

open static fun create(authProvider: AuthProvider, realm: String): AuthHandler

Create a basic auth handler, specifying realm

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.