Add CAS authentication to Symfony2
==================================

-  More informations about CAS_ (Central Authentication Service).
-  Unlike SimpleCasBundle_, it's based on the Symfony2 security component.
-  Proxy features are not yet available.

Install the Bundle
------------------

1. Add the sources from github.com (GIT must be installed ;)

    .. code-block:: text

        // if your you're using git for your project
        git submodule add git://github.com/sensio/CasBundle.git vendor/bundles/Sensio/CasBundle

        // or if your project is not under git control
        mkdir -p vendor/bundles/Sensio/CasBundle
        cd vendor/bundles/Sensio/CasBundle
        git clone git://github.com/sensio/CasBundle.git

2. Add the namespace in the autoloader::

        // app/autoload.php
        $loader->registerNamespaces(array(
            'Sensio' => __DIR__.'/../vendor/bundles',
            // your other namespaces
        );

3. Then add it to your AppKernel class::

        // in AppKernel::registerBundles()
        $bundles = array(
            // ...
            new Sensio\CasBundle\SensioCasBundle(),
            // ...
        );

Configuration
-------------

Deadly simple, here is an example:

.. configuration-block::

    .. code-block:: yaml

        cas.config:
            uri:     https://my.cas.server:443/ # URI of the cas server
            version: 2                          # version of the used CAS protocol
            cert:    /path/to/my/cert.pem       # ssl cert file path (if needed)
            request: curl                       # request adapter (curl, http or file)

    .. code-block:: xml

        <cas:config
            uri="https://my.cas.server:8080/"
            version="2"
            cert="/path/to/my/cert.pem "
            request="curl" />

    .. code-block:: php

        $container->loadFromExtension('cas', 'config', array(
            'uri'     => 'https://my.cas.server:443/',
            'version' => 2,
            'cert'    => '/path/to/my/cert.pem',
            'request' => 'curl',
        ));

In addition, the security component must be aware of the new factory and listeners included in the bundle.
In order to to it, just look at the following example in YAML:

.. configuration-block::

    .. code-block:: yaml

        security:
            factories:
                - "%kernel.root_dir%/../vendor/bundles/Sensio/CasBundle/Resources/config/security_factories.xml"

    .. code-block:: xml

        <security:config>
            <security:factory>%kernel.root_dir%/../vendor/bundles/Sensio/CasBundle/Resources/config/security_factories.xml</security:factory>
        </security:config>

    .. code-block:: php

        $container->loadFromExtension('security', 'config', array(
            'factories' => array(
                '%kernel.root_dir%/../vendor/bundles/Sensio/CasBundle/Resources/config/security_factories.xml'
            )
        ));

Use the firewall
----------------

As usual, here is a simple example (with the template):

.. configuration-block::

    .. code-block:: yaml

        security:
            factories:
                - "%kernel.root_dir%/../vendor/bundles/Sensio/CasBundle/Resources/config/security_factories.xml"
            providers:
                my_provider:
                    id: acme_demo.user_provider
            firewalls:
                my_firewall:
                    pattern:  /regex/to/protected/url
                    cas: { provider: my_provider }

        services:
            acme_demo.user_provider:
                class: My\FooBundle\Security\UserProvider
                arguments:

    .. code-block:: xml

        <security:config>
            <security:factory>%kernel.root_dir%/../vendor/bundles/Sensio/CasBundle/Resources/config/security_factories.xml</security:factory>
            <security:provider name="my_provider" id="acme_demo.user_provider" />
            <security:firewall name="my_firewall" pattern="/regex/to/protected/url">
                <security:cas provider="my_provider" />
            </security:firewall>
        </security:config>

        <services>
            <service id="acme_demo.user_provider" class="My\FooBundle\Security\UserProvider" />
        </services>

    .. code-block:: php

        $container->loadFromExtension('security', 'config', array(
            'factories' => array(
                '%kernel.root_dir%/../vendor/bundles/Sensio/CasBundle/Resources/config/security_factories.xml'
            ),
            'providers' => array(
                'my_provider' => array(
                    'id' => 'acme_demo.user_provider'
                )
            ),
            'firewall'  => array(
                'my_firewall' => array(
                    'pattern' => '/regex/to/protected/url',
                    'cas'     => array(
                        'provider' => 'my_provider'
                    )
                )
            )
        ));

        $container->setDefinition('acme_demo.user_provider', new Definition(
            'My\FooBundle\Security\UserProvider',
            array()
        ));

.. _CAS:             http://www.jasig.org/cas
.. _SimpleCasBundle: https://github.com/jmikola/SimpleCASBundle