LightOpenID
Lightweight PHP5 library for easy OpenID authentication., (*1)
Quick start
Sign-on with OpenID in just 2 steps:
-
Authentication with the provider:, (*2)
```php
$openid = new LightOpenID('my-host.example.org');, (*3)
$openid->identity = 'ID supplied by user';, (*4)
header('Location: ' . $openid->authUrl());
```, (*5)
-
Verification:, (*6)
```php
$openid = new LightOpenID('my-host.example.org');, (*7)
if ($openid->mode) {
echo $openid->validate() ? 'Logged in.' : 'Failed!';
}
```, (*8)
Support for AX and SREG extensions:
To use the AX and SREG extensions, specify $openid->required
and/or $openid->optional
before calling $openid->authUrl()
. These are arrays, with values being AX schema paths
(the 'path' part of the URL). For example:, (*9)
php
$openid->required = array('namePerson/friendly', 'contact/email');
$openid->optional = array('namePerson/first');
, (*10)
Note that if the server supports only SREG or OpenID 1.1, these are automaticaly mapped
to SREG names. To get the values use:, (*11)
php
$openid->getAttributes();
, (*12)
For more information see USAGE.md., (*13)
Requirements
This library requires PHP >= 5.1.2 with cURL or HTTP/HTTPS stream wrappers enabled., (*14)
Features
- Easy to use - you can code a functional client in less than ten lines of code.
- Uses cURL if avaiable, PHP-streams otherwise.
- Supports both OpenID 1.1 and 2.0.
- Supports Yadis discovery.
- Supports only stateless/dumb protocol.
- Works with PHP >= 5.
- Generates no errors with
error_reporting(E_ALL | E_STRICT)
.
Links
License
LightOpenID
is an open source software available under the
MIT License., (*15)