API Documentation
Back to top  

HtpasswdAuth

An extension of AuthProvider which is using htpasswd file as store

package

Default

Methods

__construct

__construct()

Authenticate a user.

authenticate( $arg0,  $arg1) : void

The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure: 

  {
    "username": "tim",
    "password": "mypassword"
  }
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

If the user is successfully authenticated a object is passed to the handler in an \io.vertx.core.AsyncResult. The user object can then be used for authorisation.

Arguments

$arg0

array

$arg1

callable

param $vertx [Vertx] <b> create($vertx) </b>

create( $arg0,  $arg1 = null) : \io\vertx\jphp\ext\auth\htpasswd\HtpasswdAuth
static

param $vertx [Vertx] param $htpasswdAuthOptions [HtpasswdAuthOptions | array] create($vertx, $htpasswdAuthOptions)

Arguments

$arg0

Vertx

$arg1

HtpasswdAuthOptions | array

Response

\io\vertx\jphp\ext\auth\htpasswd\HtpasswdAuth