webthink/guzzle-jwt

This package contains useful classes and interfaces for requiring a JWT token

A guzzle middleware for JWT authentication.

, _(*1)

Goal of this package is to provide a set of useful classes in order to use a JWT authentication with Guzzle., _(*2)

Install

You can install the package using composer, _(*3)

composer require webthink/guzzle-jwt, _(*4)

Usage

Basic Usage

As a first step you need to implement your own Authenticator., _(*5)

``` php class MyAuthenticator implements AuthenticatorInterface { public function authenticate($username, $password) { // code.. and return a TokenInterface. } }, <sub>(*6)</sub>

Then you need to append into your handler stack the middleware provided by the package.

``` php
// Your handler stack
$stack = HandlerStack::create();

// Add middleware
$stack->append(new Middleware($myAuthenticator));

$httpClient = new Client([
    'handler' => $stack,
    'jwt' => [
        'username' => 'username',
        'password' => 'password',
    ],
]);

$response = $httClient->get('/my_api_that_requires_jwt_token');

NOTE, <sub>(*7)</sub>

I will not proceed with creating classes that implement the AuthenticatorInterface. The AuthenticatorInterface can be implemented by the developer who uses the package., <sub>(*8)</sub>

Storages

Storages are a way of caching JWT between multiple requests. Depending on the storage the token can for using it for more than one HTTP Request., <sub>(*9)</sub>

In order to use the storage you will need either to implement an Authenticator of your own that will use the storage or use the StoreAuthenticator, <sub>(*10)</sub>

php $myAuthenticator = new MyAuthenticator(); $storeAuthenticator = new StoreAuthenticator($myAuthenticator, new MemoryStorage());, <sub>(*11)</sub>

Then you can pass the store authenticator in the middleware and follow the procedure described above., <sub>(*12)</sub>

Contributing

Feel free to comment on anything you might believe it's going in the wrong direction or even better contribute with a PR., <sub>(*13)</sub>

Todo

• Increase UnitTests.
• Investigate the possibility of including some authenticators.

Credits

• George Mponos

License

The MIT License (MIT). Please see License File for more information., <sub>(*14)</sub>