[Summary view] [Print] [Text view]

   1  
   2  PHP OpenID
   3  ----------
   4  
   5  This is the PHP OpenID library by JanRain, Inc.  You can visit our
   6  website for more information about this package and other OpenID
   7  implementations and tools:
   8  
   9    http://www.openidenabled.com/
  10  
  11  GETTING STARTED
  12  ===============
  13  
  14  First, run the 'examples/detect.php' script either from the command
  15  line or via the web.  It will generate a report of any system
  16  configuration changes necessary to run the library.
  17  
  18  INSTALLATION
  19  ============
  20  
  21  You will need PHP 4.3.0 or greater to use this library.  We have
  22  tested the library Linux on PHP 4.3.0, 4.4.1, 5.0.5, and 5.1.1.  We
  23  have tested the library on Windows XP on PHP 4.4.4.
  24  
  25  Follow these steps:
  26  
  27  1. Install dependencies.
  28  
  29     - Enable either the GMP extension or Bcmath extension. (GMP is
  30       STRONGLY recommended because it's MUCH faster!)  This is
  31       required.
  32  
  33     - Enable the CURL extension.
  34  
  35     - If you plan to use SQLite, PostgreSQL, or MySQL to store OpenID
  36       data, you'll need PEAR DB.  You can install this by running this
  37       as root:
  38  
  39       # pear install DB
  40  
  41       You'll also need to install and enable the appropriate PHP
  42       database extension.  Alternatively, you can store OpenID data on
  43       the filesystem instead of using a relational database.  Nothing
  44       special is required for using the filesystem method.
  45  
  46     - Install either the DOM or domxml PHP XML processing extension,
  47       but not both (they are incompatible).
  48  
  49  2. Copy the Auth/ directory into your PHP include path.
  50  
  51  TESTING YOUR SETUP
  52  ==================
  53  
  54  You can use the example code to test your setup.  To run the example
  55  consumer or server, follow the instructions in the examples/README
  56  file.
  57  
  58  USING THE API
  59  =============
  60  
  61  The best way to get started using the API is to take a look at the
  62  example consumer and server in the examples/ directory.  See the
  63  examples/README file for more details.
  64  
  65  TROUBLESHOOTING
  66  ===============
  67  
  68  * If you're unable to use an OpenID URL with the library, you may want
  69  to try using the discover tool (examples/discover.php).  This tool
  70  will perform OpenID discovery on the identifier and give a list of
  71  discovered OpenID services and their types.
  72  
  73  * On some systems, PHP basedir restrictions prevent web servers from
  74  opening a source of randomness, such as /dev/urandom.  If your PHP
  75  OpenID library has trouble getting a satisfactory source of
  76  randomness, check your Apache and PHP configurations to be sure that
  77  the randomness source is in the list of allowed paths for the
  78  "open_basedir" option.
  79  
  80  * In some cases, bugs in the GMP math library will result in signature
  81  validation errors when using this library.  Since GMP is preferred
  82  over bcmath (for performance), you will have to define
  83  Auth_OpenID_BUGGY_GMP in your application *before* importing any of
  84  the library code:
  85  
  86    define('Auth_OpenID_BUGGY_GMP', true);
  87  
  88  * Not all PHP installations support SSL.  You can find out if yours
  89  supports SSL by reading the "HTTP Fetching" section of the output of
  90  "examples/detect.php."  If your installation does not support SSL,
  91  then https:// identity URLs and server URLs will not be supported by
  92  the library.  An attempt to use such an identity URL will be
  93  equivalent to using an invalid OpenID.  To enable SSL support,
  94  recompile PHP with OpenSSL support or install the appropriate OpenSSL
  95  module for your platform.  If you are using CURL, CURL will need to be
  96  built with OpenSSL support.
  97  
  98  GETTING HELP
  99  ============
 100  
 101  If you have any questions, recommendations, or patches, please tell
 102  us!  Subscribe to our OpenID development discussion list at
 103  
 104    http://lists.openidenabled.com/mailman/listinfo/dev
 105  
 106  DOCUMENTATION
 107  =============
 108  
 109  You can view the HTML library documentation in the doc/ directory.
 110  You can also find it on the web at
 111  
 112    http://www.openidenabled.com/resources/docs/openid/php/
 113  
 114  This package's documentation is in PhpDoc format.  To generate the
 115  documentation, install phpdoc and run the admin/makedoc.sh script.
 116  Phpdoc lives at:
 117  
 118    http://www.phpdoc.org/
 119  
 120  CONTRIBUTING
 121  ============
 122  
 123  If you have a bugfix or feature you'd like to contribute, don't
 124  hesitate to send it to us.  Post your patch to the development list at
 125  
 126    http://lists.openidenabled.com/mailman/listinfo/dev
 127  
 128  For more detailed information on how to contribute, see
 129  
 130    http://openidenabled.com/contribute/
 131  
 132  To run the test suite included with this package, install PHPUnit 1.x
 133  and run
 134  
 135    php admin/texttest.php
 136  
 137  PHPUnit 1.x can be found at
 138  
 139    http://pear.phpunit.de/get/