Developed with love by KnpLabs Hire us for your project!
0

SwitchUserStatelessBundle

by lafourchette

SwitchUserStatelessBundle

Scrutinizer Code Quality
Code Coverage
Build Status
Dependency Status
SensioLabsInsight

This bundle provides impersonating feature (switch user) for API use.

Install

Install this bundle through Composer:

composer require lafourchette/switch-user-stateless-bundle

Then, update your application kernel:

// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new LaFourchette\SwitchUserStatelessBundle\SwitchUserStatelessBundle(),
        ];

        // ...
    }
}

Finally, update your firewalls as following:

# app/config/security.yml

security:
    firewalls:
        main:
            # ...
            stateless: true
            switch_user_stateless: true

Configuration

You can configure the parameter used in HTTP request and role of user who switch in your config.yml. The examples below are the default values.

# app/config/config.yml

switch_user_stateless:
    parameter: 'X-Switch-User'
    role: 'ROLE_ALLOWED_TO_SWITCH'

Usage

To use this feature, you need to add a X-Switch-User header to issued HTTP request containing the username of the
user you want to switch:

X-Switch-User: johndoe

For security reasons, this feature is only accessible for users with ROLE_ALLOWED_TO_SWITCH permission. Admin users
have this permission by default.

Troubleshooting

Solving problems here

The MIT license

Copyright (c) 2016 LaFourchette

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.