introduction.md

label	Introduction
title	Intervention HttpAuth
subtitle	HTTP Authentication Management
lead	Intervention HttpAuth: PHP library for HTTP Basic and Digest authentication. Simple installation and configuration for secure resources.
sort	0

The package provides an API that makes these steps as simple as possible.

The workflow is divided into two steps. In the first, an instance of the Authenticator::class class is created and you decide which type of authentication to use. In the second step, the resource is secured with a single call.

First, the library must be installed in the application. It can then be integrated as follows.

1. Create Authenticator Instance

To create authenticator instances you can choose between basic & digest auth. Simply use the static helper methods described below or learn how to instantiate the authenticator in other ways.

Create Authenticator Using HTTP Basic Auth

use Intervention\HttpAuth\Authenticator;

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

Create Authenticator Using HTTP Digest Auth

use Intervention\HttpAuth\Authenticator;

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

2. Ask User for Credentials

After you create an HTTP authentication instance, you need to call secure() to secure the resource. This results in a 401 HTTP response and prompts the browser to ask for credentials.

$auth->secure();

A string can optionally be passed to the method. This is displayed if authentication fails. Output from template engines can also be used here.

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

Read more on how to install or use the package.