|
| 1 | +PHP client library to implement Authwave in your application |
| 2 | +============================================================ |
| 3 | + |
| 4 | +Authwave is an open source Authentication-as-a-Service product that can be self-hosted. Using Authwave allows your application to offer authentication with great user experience and security, without you having to program any of the authentication yourself. |
| 5 | + |
| 6 | +To use this repository, your application must be registered to obtain a client key and secret. This can be done from https://www.authwave.com or from your own instance of [Authwave Provider](https://github.com/Authwave/provider) if you are self-hosting. |
| 7 | + |
| 8 | +Basic usage |
| 9 | +----------- |
| 10 | + |
| 11 | +With the following PHP code below, you can display a log in button that, when clicked, changes to a log out button and displays a greeting to the logged in user. |
| 12 | + |
| 13 | +```php |
| 14 | +<?php |
| 15 | +use Authwave\Authenticator; |
| 16 | +require __DIR__ . "/vendor/autoload.php"; |
| 17 | + |
| 18 | +// These constants can be loaded from your application's configuration |
| 19 | +// or environment variables. |
| 20 | +define("CLIENT_KEY", "1234567890abcdef"); |
| 21 | +define("CLIENT_SECRET", "aaaa-bbbb-cccc-dddd-eeee-ffff"); |
| 22 | + |
| 23 | +// Construct the Authenticator class as soon as possible, as this handles the |
| 24 | +// Authentication steps passed via the query string from Authwave. |
| 25 | +$auth = new Authenticator( |
| 26 | + $_SERVER["REQUEST_URI"], |
| 27 | + CLIENT_KEY, |
| 28 | + CLIENT_SECRET |
| 29 | +); |
| 30 | + |
| 31 | +// Handle authentication login/logout action via the querystring: |
| 32 | +if(isset($_GET["login"])) { |
| 33 | + $auth->login(); |
| 34 | +} |
| 35 | +elseif(isset($_GET["logout"])) { |
| 36 | + $auth->logout(); |
| 37 | +} |
| 38 | + |
| 39 | +// Authentication is handled by Authwave, so you can trust "isLoggedIn" |
| 40 | +// as a mechanism for protecting your sensitive information. |
| 41 | +if($auth->isLoggedIn()) { |
| 42 | + $email = $auth->getEmail(); |
| 43 | + echo <<<HTML |
| 44 | + <p>You are logged in as <strong>{$auth->getEmail()}</strong></p> |
| 45 | + <p><a href="?logout">Log out</a></p> |
| 46 | + HTML; |
| 47 | +} |
| 48 | +else { |
| 49 | + echo <<<HTML |
| 50 | + <p>You are not logged in!</p> |
| 51 | + <p><a href="?login">Log in</a></p> |
| 52 | + HTML; |
| 53 | +} |
| 54 | +``` |
0 commit comments