14a09168
 Alex Savenko
init commit
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# LightOpenID
Lightweight PHP5 library for easy OpenID authentication.
* `Version....:` [**1.1.2** :arrow_double_down:][1]
( *see [the change log][2] for details* )
* `Released on:` January 15, 2013
* `Source code:` [Gitorious :link:][3]
[GitHub :octocat:][4]
* `Homepage...:` http://code.google.com/p/lightopenid/
* `Author.....:` Mewp (http://mewp.s4w.pl/)
[1]: https://github.com/iignatov/LightOpenID/archive/master.zip
[2]: http://github.com/iignatov/LightOpenID/blob/master/CHANGELOG.md
[3]: http://gitorious.org/lightopenid
[4]: http://github.com/iignatov/LightOpenID
## Quick start
### Sign-on with OpenID in just 2 steps:
1. Authentication with the provider:
```php
$openid = new LightOpenID('my-host.example.org');
$openid->identity = 'ID supplied by user';
header('Location: ' . $openid->authUrl());
```
2. Verification:
```php
$openid = new LightOpenID('my-host.example.org');
if ($openid->mode) {
echo $openid->validate() ? 'Logged in.' : 'Failed!';
}
```
### 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:
```php
$openid->required = array('namePerson/friendly', 'contact/email');
$openid->optional = array('namePerson/first');
```
Note that if the server supports only SREG or OpenID 1.1, these are automaticaly mapped
to SREG names. To get the values use:
```php
$openid->getAttributes();
```
For more information see [USAGE.md](http://github.com/iignatov/LightOpenID/blob/master/USAGE.md).
## Requirements
This library requires PHP >= 5.1.2 with cURL or HTTP/HTTPS stream wrappers enabled.
## 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
* [JavaScript OpenID Selector](http://code.google.com/p/openid-selector/) -
simple user interface that can be used with LightOpenID.
* [HybridAuth](http://hybridauth.sourceforge.net/) -
easy to install and use social sign on PHP library, which uses LightOpenID.
* [OpenID Dev Specifications](http://openid.net/developers/specs/) -
documentation for the OpenID extensions and related topics.
## License
[LightOpenID](http://github.com/iignatov/LightOpenID)
is an open source software available under the
[MIT License](http://opensource.org/licenses/mit-license.php).
|
