PHPackages                             symfonycorp/connect-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. symfonycorp/connect-bundle

Abandoned → [symfonycorp/connect](/?search=symfonycorp%2Fconnect)ArchivedSymfony-bundle[Authentication & Authorization](/categories/authentication)

symfonycorp/connect-bundle
==========================

Official bundle for the SymfonyConnect SDK

v6.2.0(5y ago)348.2k18MITPHPPHP >=7.1.3

Since Feb 15Pushed 4y ago13 watchersCompare

[ Source](https://github.com/symfonycorp/connect-bundle)[ Packagist](https://packagist.org/packages/symfonycorp/connect-bundle)[ Docs](https://github.com/symfonycorp/connect-bundle)[ Fund](https://tidelift.com/funding/github/packagist/symfonycorp/connect)[ RSS](/packages/symfonycorp-connect-bundle/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (3)Versions (41)Used By (0)

symfony/connect-bundle
======================

[](#symfonyconnect-bundle)

About
-----

[](#about)

This is the official bundle of the [SymfonyConnect SDK](https://github.com/symfonycorp/connect).

Installation
------------

[](#installation)

### Step 1: Install symfony/connect-bundle using [Composer](http://getcomposer.org)

[](#step-1-install-symfonyconnect-bundle-using-composer)

```
$ composer require symfonycorp/connect-bundle
```

If you're not using Symfony Flex, please take inspiration from [this bundle's recipe](https://github.com/symfony/recipes-contrib/blob/master/symfonycorp/connect-bundle/)to enable it.

### Step 2: Configure your `.env.local` file

[](#step-2-configure-your-envlocal-file)

```
SYMFONY_CONNECT_APP_ID='Your app id'
SYMFONY_CONNECT_APP_SECRET='Your app secret'
```

Usage
-----

[](#usage)

### Use SymfonyConnect to authenticate your user

[](#use-symfonyconnect-to-authenticate-your-user)

#### Step 1: Configure the security

[](#step-1-configure-the-security)

> **Note:** If you want to persist your users, read the *Cookbooks* section.

If you don't want to persist your users, you can use `ConnectInMemoryUserProvider`:

```
# config/packages/security.yaml
security:
    providers:
        symfony_connect:
            connect_memory: ~
    firewalls:
        # [...]

        secured_area:
            pattern: ^/
            symfony_connect:
                check_path: symfony_connect_callback
                login_path: symfony_connect_login
                failure_path: home # need to be adapted to your config, see step 4
                remember_me: false
                provider: symfony_connect
            anonymous: true
```

You can also load specific roles for some users:

```
# config/packages/security.yaml
security:
    providers:
        symfony_connect:
            connect_memory:
                users:
                    90f28e69-9ce9-4a42-8b0e-e8c7fcc27713: "ROLE_CONNECT_USER ROLE_ADMIN"
```

**Note:** The `username` is the user uuid.

#### Step 2: Add some link to your templates

[](#step-2-add-some-link-to-your-templates)

You can generate a link to the SymfonyConnect login page:

```
Connect
```

You can also specify the target URL after connection:

```
Connect
```

#### Step 3: Play with the user

[](#step-3-play-with-the-user)

The API user is available through the token storage, which you can get by autowiring `Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface $tokenStorage`.

```
$user = $tokenStorage->getToken()->getApiUser();
```

If you use the built-in security component, you can access to the root api directly by autowiring `SymfonyCorp\Connect\Api\Api $api`:

```
$user = $api->getRoot()->getCurrentUser();

```

You can also get access to the API root object by providing an access token explicitly:

```
$accessToken = $tokenStorage->getToken()->getAccessToken();
$api->setAccessToken($accessToken);
$root = $api->getRoot();
$user = $root->getCurrentUser();
```

#### Step 4: Handling Failures

[](#step-4-handling-failures)

Several errors can occur during the OAuth dance, for example the user can deny your application or the scope you defined in `symfony_connect.yaml` can be different from what you selected while creating your application on SymfonyConnect. Theses failures arehandled by the default Symfony failure handling.

Therefore, if an error occurred, the error is stored in the session (with a fallback on query attributes) and the user is redirected to the route/path specificed in `failure_path` node of the `symfony_connect` section of your firewall in `security.yaml`.

> **Warning**: You **need** to specifiy `failure_path`. If you don't, the user will be redirected back to `login_path`, meaning that will launch the SymfonyConnect authentication and redirect the user to SymfonyConnect which can lead to a redirection loop.

This means you need to fetch the authentication error if there is one and display it in the view. This is similar to what you do for a typical login form on Symfony (here we assume you have a `home` route pointing to the following controller):

```
// src/Controller/HomeController.php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Core\Security;

class HomeController extends AbstractController
{
    /**
     * @Route("/", name="home")
     */
    public function home(Request $request)
    {
        $session = $request->hasSession() ? $request->getSession() : null;

        // get the authentication error if there is one
        if ($request->attributes->has(Security::AUTHENTICATION_ERROR)) {
            $error = $request->attributes->get(Security::AUTHENTICATION_ERROR);
        } elseif (null !== $session && $session->has(Security::AUTHENTICATION_ERROR)) {
            $error = $session->get(Security::AUTHENTICATION_ERROR);
            $session->remove(Security::AUTHENTICATION_ERROR);
        } else {
            $error = '';
        }

        return $this->render('home.html.twig', ['error' => $error]);
    }
}
```

And then adapt your twig template:

```
{# templates/home.html.twig #}

{% if app.user %}
    Congrats! You are authenticated with SymfonyConnect
{% elseif error %}
    {{ error.messageKey | trans(error.messageData, 'security') }}
{% else %}
    Log in with SymfonyConnect
{% endif %}
```

Cookbooks
---------

[](#cookbooks)

### How to persist users

[](#how-to-persist-users)

#### Step 1 - Create a `User` entity

[](#step-1---create-a-user-entity)

```