uzyn/cakephp-opauth

Opauth plugin for CakePHP v2.x, allowing simple plug-n-play 3rd-party authentication with CakePHP

CakePHP plugin for Opauth

CakePHP 2.x plugin for Opauth., _(*1)

Opauth is a multi-provider authentication framework., _(*2)

Requirements

CakePHP v2.x
Opauth >= v0.2 (submoduled with this package), _(*3)

Using Composer?

You can install CakePHP-Opauth plugin directly from Composer at uzyn/cakephp-opauth.
It works for Opauth strategies too!, _(*4)

View notes and Composer-enabled plugin code at composer branch., _(*5)

Tutorial & sample app

Check out CakePHP bakery for tutorial and the sample branch for a quick sample app., _(*6)

How to use

1. Install this plugin for your CakePHP app.
   Assuming APP is the directory where your CakePHP app resides, it's usually app/ from the base of CakePHP., _(*7)

   cd APP/Plugin
   git clone git://github.com/uzyn/cakephp-opauth.git Opauth
   

2. Download Opauth library as a submodule., _(*8)

   git submodule init
   git submodule update
   

3. Add this line to the bottom of your app's Config/bootstrap.php:, _(*9)

   <?php
   CakePlugin::load('Opauth', array('routes' => true, 'bootstrap' => true));
   

   Overwrite any Opauth configurations you want after the above line., _(*10)

4. Load strategies onto Strategy/ directory., _(*11)

   Append configuration for strategies at your app's Config/bootstrap.php as follows:, _(*12)

   <?php
   CakePlugin::load('Opauth', array('routes' => true, 'bootstrap' => true));
   
   // Using Facebook strategy as an example
   Configure::write('Opauth.Strategy.Facebook', array(
      'app_id' => 'YOUR FACEBOOK APP ID',
      'app_secret' => 'YOUR FACEBOOK APP SECRET'
   ));
   

5. Go to http://path_to_your_cake_app/auth/facebook to authenticate with Facebook, and similarly for other strategies that you have loaded., _(*13)

6. After validation, user will be redirected to Router::url('/opauth-complete') with validated auth response data retrievable available at $this->data., _(*14)

   To route a controller to handle the response, at your app's Config/routes.php, add a connector, for example:, _(*15)

   <?php
   Router::connect(
      '/opauth-complete/*', 
      array('controller' => 'users', 'action' => 'opauth_complete')
   );
   

   You can then work with the authentication data at, say APP/Controller/UsersController.php as follows:, _(*16)

   <?php // APP/Controller/UsersController.php:
   class UsersController extends AppController {
      public function opauth_complete() {
          debug($this->data);
      }
   }
   

   Note that this CakePHP Opauth plugin already does auth response validation for you with its results available as a boolean value at $this->data['validated']., _(*17)

7. (optional) The submoduled Opauth core library may not be of the latest build, to update to the latest:, _(*18)

   git submodule foreach git pull origin master
   

Note:

If your CakePHP app does not reside at DocumentRoot (eg. http://localhost), but at a directory below DocumentRoot (eg. http://localhost/your-cake-app),
add this line to your app's APP/Config/bootstrap.php, replacing your-cake-app with your actual path :, _(*19)

<?php // APP/Config/bootstrap.php
Configure::write('Opauth.path', '/your-cake-app/auth/');

Issues & questions

• Discussion group: Google Groups
  This is the primary channel for support, especially for user questions.
• Issues: Github Issues
• Twitter: @uzyn
• Email me: chua@uzyn.com
• IRC: #opauth on Freenode

Used this plugin in your CakePHP project? Let us know!, _(*20)

License

The MIT License
Copyright © 2012-2013 U-Zyn Chua (http://uzyn.com), _(*21)

Package building instructions

Instructions for making into a nice zipped package for download., _(*22)

git checkout master
git submodule update --init --recursive

rm -rf `find . -type d -name .git`

cd ..
mv cakephp-opauth Opauth

zip -mr Opauth-CakePHP-plugin-X.Y.Z.zip Opauth

Consultation

U-Zyn Chua is the Principal Consultant at Zynesis Consulting, specializing in CakePHP.
Looking for PHP web development solutions or consultation? Drop me a mail., _(*23)