raphox/alb-open-id-server-bundle

OpenID Provider bundle

AlbOpenIDServerBundle

OpenID Provider bundle., _(*1)

Installation

Step1: Download AlbOpenIDServerBundle

Using the vendors script

Add the following lines in your deps file:, _(*2)

[AlbOpenIDServerBundle]
    git=git://github.com/arnaud-lb/AlbOpenIDServerBundle.git
    target=bundles/Alb/OpenIDServerBundle

[php-openid]
    git=git://github.com/openid/php-openid.git
    target=openid/php-openid

Now, run the vendors script to download the bundle:, _(*3)

``` sh $ php bin/vendors install, <sub>(*4)</sub>

#### Using submodules

If you prefer instead to use git submodules, then run the following:

``` sh
$ git submodule add git://github.com/arnaud-lb/AlbOpenIDServerBundle.git vendor/bundles/Alb/AlbOpenIDServerBundle
$ git submodule add git://github.com/openid/php-openid.git vendor/openid/php-openid
$ git submodule update --init

Using composer

TODO, <sub>(*5)</sub>

Step2: Configure the Autoloader

You can skip this step if you have installed the bundle using composer., <sub>(*6)</sub>

Add the Alb namespace to your autoloader:, <sub>(*7)</sub>

``` php <?php, <sub>(*8)</sub>

// app/autoload.php, <sub>(*9)</sub>

$loader->registerNamespaces(array( // ... 'Alb' => DIR.'/../vendor/bundles', ));, <sub>(*10)</sub>

### Step3: Configure the include path

php-openid relies on his classes to be in the include path:

``` php
<?php

/// app/autoload.php

...

set_include_path(
    get_include_path()
    . PATH_SEPARATOR 
    . __DIR__ . '/../vendor/openid/php-openid'
);

...

Step4: Enable the bundle

Finally, enable the bundle in the kernel:, <sub>(*11)</sub>

``` php <?php // app/AppKernel.php, <sub>(*12)</sub>

public function registerBundles() { $bundles = array( // ... new Alb\OpenIDServerBundle\AlbOpenIDServerBundle(), ); }, <sub>(*13)</sub>

## Creating an Adapter

The bundle relies on an adapter for things that may be specific to your application. The adapter must implement `Alb\OpenIDServerBundle\Adapter\AdapterInterface`.

Here is a simple implementation:

``` php
<?php

namespace <your_namespace>;

use Alb\OpenIDServerBundle\Adapter\AdapterInterface;

class Adapter implements AdapterInterface
{
    public function getUserUnique($user)
    {
        return $user->getId();
    }
}

Declare a service using this class:, <sub>(*14)</sub>

``` yaml, <sub>(*15)</sub>

app/config/config.yml

services: my_open_id_server_adapter: class: \Adapter, <sub>(*16)</sub>

## Configuring

### Bundle configuration

Add this to app/config/config.yml:

``` yaml
# app/config/config.yml

alb_open_id_server_bundle:
    service:
        adapter: my_open_id_server_adapter

Routing

Add this to app/config/routing.yml:, <sub>(*17)</sub>

``` yaml, <sub>(*18)</sub>

app/config/routing.yml

alb_open_id_server: resource: "@AlbOpenIDServerBundle/Resources/config/routing.xml" prefix: /openid, <sub>(*19)</sub>

### Security

For access session security data, add this to app/config/security.yml:

``` yaml
security:
    ...

    firewalls:
        ...

        secured_openid:
            pattern:    ^/openid
            anonymous: ~
            http_basic:
                realm: "Secured OpenID Area"

Usage

The OpenID endpoint is at /openid (depending on the routes prefix), <sub>(*20)</sub>

TODO

• Add tests
• More documentation