intervention/httpauth

HTTP authentication (Basic & Digest) including ServiceProviders for easy Laravel integration

Intervention HttpAuth

HTTP Authentication Management, _(*1)

, _(*2)

Installation

You can easily install this library using Composer. Just request the package with the following command:, _(*3)

composer require intervention/httpauth

Documentation

Read the full documentation for this library., _(*4)

Usage

The workflow is easy. Just create an instance of Authenticator::class in the first step and secure your resource in the second step., _(*5)

1. Create Authenticator Instance

To create authenticator instances you can choose between different methods., _(*6)

Create Instance by Using Static Factory Method

use Intervention\HttpAuth\Authenticator;

// create http basic auth
$auth = Authenticator::basic(
    'myUsername',
    'myPassword',
    'Secured Area',
);

// create http digest auth
$auth = Authenticator::digest(
    'myUsername',
    'myPassword',
    'Secured Area',
);

Create Instance by Using Class Constructor

use Intervention\HttpAuth\Authenticator;

// alternatively choose DigestVault::class
$vault = new BasicVault(
    'myUsername',
    'myPassword',
    'Secured Area',
);

$auth = new Authenticator($vault);

Create Instance by Static Factory Method

use Intervention\HttpAuth\Authenticator;

// alternatively choose DigestVault::class
$vault = new BasicVault(
    'myUsername',
    'myPassword',
    'Secured Area',
);

$auth = Authenticator::withVault($vault);

2. Ask User for Credentials

After you created a HTTP authentication instance, you have to call secure() to secure the resource. This results in a 401 HTTP response and the browser asking for credentials., _(*7)

$auth->secure();

A character string can optionally be passed to the method. This is displayed if authentication fails. Output from template engines can also be used here., _(*8)

$auth->secure('Sorry, you can not access this resource!');

Server Configuration

Apache

If you are using Apache and running PHP with CGI/FastCGI, check the server configuration to make sure the authorization headers are passed correctly to PHP:, _(*9)

https://support.deskpro.com/en/kb/articles/missing-authorization-headers-with-apache, _(*10)

Authors

This library is developed and maintained by Oliver Vogel, _(*11)

Thanks to the community of contributors who have helped to improve this project., _(*12)

License

Intervention HttpAuth is licensed under the MIT License., _(*13)