middlewares/http-authentication

Middleware to implement Basic and Digest Http authentication

middlewares/http-authentication

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Middleware to implement RFC 2617 Http Authentication. Contains the following components:, _(*2)

• BasicAuthentication
• DigestAuthentication

Requirements

• PHP >= 7.2
• A PSR-7 http library
• A PSR-15 middleware dispatcher

Installation

This package is installable and autoloadable via Composer as middlewares/http-authentication., _(*3)

composer require middlewares/http-authentication

BasicAuthentication

The Basic access authentication is the simplest technique., _(*4)

You have to provide an Array or ArrayAccess with the usernames and passwords of all available users. The keys are the usernames and the values the passwords., _(*5)

Dispatcher::run([
    new Middlewares\BasicAuthentication([
        'username1' => 'password1',
        'username2' => 'password2'
    ])
]);

Optionally, you can provide a Psr\Http\Message\ResponseFactoryInterface as the second argument, that will be used to create the error responses (401). If it's not defined, Middleware\Utils\Factory will be used to detect it automatically., _(*6)

$responseFactory = new MyOwnResponseFactory();

$route = new Middlewares\BasicAuthentication($users, $responseFactory);

realm

The realm value. By default is "Login"., _(*7)

attribute

The attribute name used to save the username of the user. If it's not defined, it wont be saved. Example:, _(*8)

Dispatcher::run([
    (new Middlewares\BasicAuthentication([
        'username1' => 'password1',
        'username2' => 'password2'
    ]))->attribute('username'),

    function ($request) {
        $username = $request->getAttribute('username');

        return new Response('Hello '.$username);
    }
]);

verifyHash

This option verifies the password using password_verify. Useful if you don't want to provide the passwords in plain text., _(*9)

$users = [
    'username' => password_hash('secret-password', PASSWORD_DEFAULT);
]

Dispatcher::run([
    (new Middlewares\BasicAuthentication($users))
        ->attribute('username')
        ->verifyHash(),

    function ($request) {
        $username = $request->getAttribute('username');

        return new Response('Hello '.$username);
    }
]);

DigestAuthentication

The Digest access authentication is more secure than basic., _(*10)

The constructor signature is the same than BasicAuthentication:, _(*11)

$users = [
    'username1' => 'password1',
    'username2' => 'password2'
];
$responseFactory = new MyOwnResponseFactory();

Dispatcher::run([
    new Middlewares\DigestAuthentication($users, $responseFactory)
]);

realm

The realm value. By default is "Login"., _(*12)

attribute

The attribute name used to save the username of the user. If it's not defined, it wont be saved., _(*13)

nonce

To configure the nonce value. If its not defined, it's generated with uniqid, _(*14)

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details., _(*15)

The MIT License (MIT). Please see LICENSE for more information., _(*16)