chippyash/authentication-manager

Generic authentication management of identities

chippyash/authentication-manager

Quality Assurance

, _(*1)

End of life notice

In March 2018, developer support will be withdrawn from this library for PHP <5.6. Older versions of PHP are now in such little use that the added effort of maintaining compatibility is not effort effective. See PHP Version Stats for the numbers., _(*2)

What?

Provides base for creating managers that manage identity entries in some back end authentication system., _(*3)

The single one provided at present is an HTTP Basic Digest Manager., _(*4)

The library is released under the GNU GPL V3 or later license, _(*5)

When?

If you want more, either suggest it, or better still, fork it and provide a pull request., _(*6)

How?

You can find the API documentation here, _(*7)

You will find the Test Contract in the docs directory alongside an example Symfony DI container definition., _(*8)

Coding Basics

Construction

, _(*9)

    use Chippyash\Authentication\Manager\DigestManager;
    use Chippyash\Authentication\Manager\Encoder\BasicEncoder;
    use Chippyash\Authentication\Manager\Digest\BasicDigestCollection;
    use Chippyash\Type\String\StringType;

$realm = new StringType('realm');
$digestFileName = new StringType('/path/to/my/file');

$encoder = new BasicEncoder();
$encoder->setRealm($realm);

$collection = new BasicDigestCollection($encoder, $digestFileName);
$collection->setRealm($realm);

$this->authManager = new DigestManager($collection);

, (*10)

Adding new manager types

Implement the Chippyash\Authentication\Manager\ManagerInterface to create new types of Authentication Managers., _(*11)

Changing the library

1. fork it
2. write the test
3. amend it
4. do a pull request

Found a bug you can't figure out?, _(*12)

1. fork it
2. write the test
3. do a pull request

NB. Make sure you rebase to HEAD before your pull request, _(*13)

Where?

The library is hosted at Github. It is available at Packagist.org, _(*14)

Installation

Install Composer, _(*15)

For production

    "chippyash/authentication-manager": "~2.0"

to your composer.json "requires" section, _(*16)

For development

Clone this repo, and then run Composer in local repo root to pull in dependencies, _(*17)

    git clone git@github.com:chippyash/Authentication-Manager.git AuthMan
    cd AuthMan
    composer install

To run the tests:, _(*18)

    cd AuthMan
    vendor/bin/phpunit -c test/phpunit.xml test/

If you have Testdox Converter installed you can rebuild the Test Contract by running build.sh on *nix systems., _(*19)

Other stuff

Check out ZF4 Packages for more packages, _(*20)

License

This software library is released under the GNU GPL V3 or later license, _(*21)

This software library is Copyright (c) 2014-2016, Ashley Kitson, UK, _(*22)

A commercial license is available for this software library, please contact the author. It is normally free to deserving causes, but gets you around the limitation of the GPL license, which does not allow unrestricted inclusion of this code in commercial works., _(*23)

History

V0... pre releases, _(*24)

V1.0.0 Initial version tagged, _(*25)

V1.0.1 Amends for CI, _(*26)

V1.0.2 Typos in dic example, _(*27)

V1.0.3 Self initialise the manager, _(*28)

V2.0.0 BC Break: change namespace from chippyash\Authentication to Chippyash\Authentication, _(*29)

V2.0.1 Add link to packages, _(*30)

V2.0.2 Verify PHP7 compatibility, _(*31)

V2.0.3 Move coverage to codeclimate, _(*32)

V2.0.4 Update travis build script, _(*33)

V2.0.5 update composer - forced by packagist composer.json format change, _(*34)