juststeveking / http-auth-strategies

v1.2.0 2020-12-07 12:25 UTC

Requires

• php: ^7.4|^8.0

Requires (Dev)

• phpunit/phpunit: ^9.5@dev
• roave/security-advisories: dev-latest

MIT

• Steve McDougall

Published on Packagist.org on 2020-12-07 12:50 UTC

README

Warning

This package is no longer maintained. It's replaced by juststeveking/sdk-toolbox, whose authenticators cover bearer tokens, Basic auth and API keys in a header or the query string, plus OAuth 2.0, with credentials kept out of exceptions and logs.

Existing versions stay installable, so nothing that depends on this package breaks.

A simple PHP package that is used to create different Http Auth Headers.

This is a simple to use library, to install - all you need to do is:

$ composer require juststeveking/http-auth-strategies

Then to use the library all you need to do is:

$strategy = new BasicStrategy(
    base64_encode("username:password")
);

// Get the Auth header as an array - passing through the required Authorization prefix
$strategy->getHeader('Bearer');
// ['Authorization' => 'Bearer dXNlcm5hbWU6cGFzc3dvcmQ=']

There is also a NullStrategy for when you want to follow a consistent pattern, but do not want to actually use any auth:

$strategy = new NullStrategy();

// Get the Auth header as an array - passing through the required Authorization prefix
$strategy->getHeader('Bearer');
// []

You can now also create your own custom header using the CustomStrategy, for when an API requires something specific that doesn't follow the typical pattern:

$strategy = new CustomStrategy(
    'your-api-key'
);

$strategy->setHeaderName('X-API-KEY');

// Get the Auth header as an array - passing through the required Authorization prefix
$strategy->getHeader('Bearer');
// ['X-API-KEY' => 'Bearer your-api-key']