forked from openid/php-openid
/
README
136 lines (94 loc) · 4.24 KB
/
README
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
PHP OpenID
----------
This is the PHP OpenID library by JanRain, Inc. You can visit our
website for more information about this package and other OpenID
implementations and tools:
http://www.openidenabled.com/
GETTING STARTED
===============
First, run the 'examples/detect.php' script either from the command
line or via the web. It will generate a report of any system
configuration changes necessary to run the library.
INSTALLATION
============
You will need PHP 4.3.0 or greater to use this library. We have
tested the library Linux on PHP 4.3.0, 4.4.1, 5.0.5, and 5.1.1. We
have tested the library on Windows XP on PHP 4.4.4.
Follow these steps:
1. Install dependencies.
- Enable either the GMP extension or Bcmath extension. (GMP is
STRONGLY recommended because it's MUCH faster!) This is
required.
- Enable the CURL extension.
- If you plan to use SQLite, PostgreSQL, or MySQL to store OpenID
data, you'll need PEAR DB. You can install this by running this
as root:
# pear install DB
You'll also need to install and enable the appropriate PHP
database extension. Alternatively, you can store OpenID data on
the filesystem instead of using a relational database. Nothing
special is required for using the filesystem method.
- Install either the DOM or domxml PHP XML processing extension,
but not both (they are incompatible).
2. Copy the Auth/ directory into your PHP include path.
TESTING YOUR SETUP
==================
You can use the example code to test your setup. To run the example
consumer or server, follow the instructions in the examples/README
file.
USING THE API
=============
The best way to get started using the API is to take a look at the
example consumer and server in the examples/ directory. See the
examples/README file for more details.
TROUBLESHOOTING
===============
* If you're unable to use an OpenID URL with the library, you may want
to try using the discover tool (examples/discover.php). This tool
will perform OpenID discovery on the identifier and give a list of
discovered OpenID services and their types.
* On some systems, PHP basedir restrictions prevent web servers from
opening a source of randomness, such as /dev/urandom. If your PHP
OpenID library has trouble getting a satisfactory source of
randomness, check your Apache and PHP configurations to be sure that
the randomness source is in the list of allowed paths for the
"open_basedir" option.
* In some cases, bugs in the GMP math library will result in signature
validation errors when using this library. Since GMP is preferred
over bcmath (for performance), you will have to define
Auth_OpenID_BUGGY_GMP in your application *before* importing any of
the library code:
define('Auth_OpenID_BUGGY_GMP', true);
* Not all PHP installations support SSL. You can find out if yours
supports SSL by reading the "HTTP Fetching" section of the output of
"examples/detect.php." If your installation does not support SSL,
then https:// identity URLs and server URLs will not be supported by
the library. An attempt to use such an identity URL will be
equivalent to using an invalid OpenID. To enable SSL support,
recompile PHP with OpenSSL support or install the appropriate OpenSSL
module for your platform. If you are using CURL, CURL will need to be
built with OpenSSL support.
GETTING HELP
============
If you have any questions, recommendations, or patches, please tell
us! Subscribe to our OpenID development discussion list at
http://openid.net/developers/dev-mailing-lists/
DOCUMENTATION
=============
You can view the HTML library documentation in the doc/ directory.
This package's documentation is in PhpDoc format. To generate the
documentation, install phpdoc and run the admin/makedoc.sh script.
Phpdoc lives at:
http://www.phpdoc.org/
CONTRIBUTING
============
If you have a bugfix or feature you'd like to contribute, don't
hesitate to send it to us. Post your patch to the development list at
http://openid.net/developers/dev-mailing-lists/
For more detailed information on how to contribute, see
http://openidenabled.com/contribute/
To run the test suite included with this package, install PHPUnit 1.x
and run
php admin/texttest.php
PHPUnit 1.x can be found at
http://pear.phpunit.de/get/