Opauth is a multi-provider authentication framework for PHP, inspired by OmniAuth for Ruby.

Opauth enables PHP applications to do user authentication with ease.

Try out Opauth for yourself at http://opauth.org

What is Opauth?

Opauth provides a standardized method for PHP applications to interface with authentication providers.

Opauth as a framework provides a set of API that allows developers to create strategies that work in a predictable manner across PHP frameworks and applications.

Opauth works well with other PHP applications & frameworks. It is currently supported on:

• vanilla (plain) PHP applications (of course)
• CakePHP (maintained by uzyn)
• CodeIgniter (maintained by destinomultimedia)
• CodeIgniter (maintained by mcatm)
• Yii Framework (maintained by kahwee)
• and more to come.
  If your PHP framework of choice is not yet listed, you can still use Opauth like you would a normal PHP component (class).

Quick start

Guide on how to run the bundled example.

1. Set DocumentRoot of your web server to example/.
   (Opauth can be instantiated in your own PHP app, but we will leave that out of this quick start guide)

2. Configure Opauth
   cp example/opauth.conf.php.default example/opauth.conf.php
   and make the necessary changes.

3. Install some Opauth strategies. We recommend that you start with Opauth-Facebook

   Place the strategy files in lib/Opauth/Strategy/.
   For example, for Opauth-Facebook, place the downloaded files at lib/Opauth/Strategy/Facebook/.

4. Send user to http://path_to_opauth/facebook to authenticate.

Check out the wiki for more in-depth details, especially on how to use Opauth with your own PHP application.

Available strategies

A strategy is a set of instructions that interfaces with respective authentication providers and relays it back to Opauth.

Provider-specific:

Strategy	Maintained by
Facebook	uzyn
Google	uzyn
Instagram	muhdazrain
OpenID	uzyn
Twitter	uzyn

Generic strategy: OAuth

See wiki's list of strategies for an updated list of Opauth strategies or to make requests. Also, refer to strategy contribution guide if you would like to contribute a strategy.

Requirements

PHP 5 (>= 5.2)

Contribute

Opauth needs your contributions, especially the following:

• More strategies
  Refer to wiki for contribution guide and inform us when your work is ready.

• Plugins for more PHP frameworks and CMSes
  eg. CodeIgniter, Symfony, WordPress, Drupal, etc.

• Guides & tutorials
  On how to implement Opauth on CakePHP app, etc.

• Unit testing
  Coverage is only average at the moment.

Issues & questions

• Issues: Github Issues
• Discussion group: Google Groups
• Twitter: @uzyn
• Email me: chua@uzyn.com
• IRC: #opauth on Freenode

Used Opauth in your project? Let us know!

Changelog

###v0.3.0 (30 May 2012)

• Some unit testing
• More consistent naming of Strategy's internal properties
• Smarter loading of strategy, able to make a few guesses on where the class file might be at.

###v0.2.0 (23 May 2012)

• Opauth is now Composer compatible and listed on Packagist
  • Opauth now supports autoloaders
  • If a strategy is not autoloaded, Opauth falls back and searches for it at strategy_dir defined in config.
• Class name for strategy Foo should now be FooStrategy instead of Foo.
  • This is to reduce the likelihood of class name collision due to Opauth not requiring the use of namespace.
  • v0.1.0-type class name, ie. Foo, still works, but is now deprecated.

###v0.1.0 (22 May 2012)

• Initial release

License

The MIT License
Copyright © 2012 U-Zyn Chua (http://uzyn.com)

Footnote

U-Zyn Chua is a Principal Consultant at gladlyCode, a premier PHP web development firm.
If you need consultation in web technologies and services, feel free to talk to us.