liblynx-connect-php
![Software License][ico-license]
![Coverage Status][ico-scrutinizer]
![Total Downloads][ico-downloads], (*1)
This is a PHP client library for the LibLynx Connect identity and
access management API. The API allows a publisher to control access
to electronic resources without being concerned about the method
used, e.g. IP, Shibboleth, SAML, OpenID Connect etc., (*2)
This library is open source, but access to the API requires a
commercial agreement with LibLynx - contact us at info@liblynx.com
to discuss your requirements., (*3)
Install
Via Composer, (*4)
``` bash
$ composer require liblynx-llc/liblynx-connect-php, (*5)
## Setting API credentials
In order to use this, you will need an API client id and client secret from LibLynx. These
can be passed to the API client in one of two ways
### Set API credentials through environment variables
You can set the following environment variables to avoid placing credentials in your code
* LIBLYNX_CLIENT_ID
* LIBLYNX_CLIENT_SECRET
### Set API credentials through code
Alternatively, you can set the credentials directly, e.g.
```php
$liblynx=new Liblynx\Connect\Client;
$liblynx->setCredentials('your client id', 'your client secret');
Caching
To work as efficiently as possible, the client caches API responses such as the entrypoint
resource. Any PSR-16 compatible cache can be used, for example symfony/cache, (*6)
For testing, you could use the ArrayCache from symfony/cache - install as follows:, (*7)
``` bash
$ composer require symfony/cache, (*8)
Then create and use an `ArrayCache` as follows
```php
$cache=new \Symfony\Component\Cache\Simple\ArrayCache;
$liblynx->setCache($cache);
Diagnostic logging
Detailed information on API usage can be obtained by passing a PSR-3 compatible
logger to the client. This package includes a useful DiagnosticLogger class which
can be used to store logs and then output them for console or HTML reading., (*9)
$logger = new \LibLynx\Connect\DiagnosticLogger;
$liblynx->setLogger($logger);
Examples
A simple integration involves obtaining an account from data provided in the current
request superglobals, (*10)
try {
$identification = $liblynx->authorize(IdentificationRequest::fromArray($_SERVER));
if ($identification->isIdentified()) {
//visitor is identified, you can now check their access rights
} elseif ($identification->requiresWAYF()) {
//to find our who the visitor is, redirect to WAYF page
$url = $identification->getWayfUrl();
header("Location: $url");
exit;
} else {
//liblynx failed - check diagnostic logs
}
} catch (LibLynx\Connect\Exception\LibLynxException $e) {
//exceptions are throw for API failures and erroneous integrations
throw $e;
}
See the examples folder for other examples:, (*11)
-
examples\example.php is a console application which prompts for an IP and URL performs an
identification.
Change log
Please see CHANGELOG for more information on what has changed recently., (*12)
Testing
bash
$ composer test, (*13)
Contributing
Please see CONTRIBUTING for details., (*14)
Security
If you discover any security related issues, please email security@liblynx.com instead of using the issue tracker., (*15)
Credits
License
The MIT License (MIT). Please see License File for more information., (*16)
Wallogit.com
