macfly/yii2-remote-user-rbac

Yii2 module to get user and rbac information from a remote api

yii2-remote-user-rbac

Yii2 User and Rbac provider from another Yii2 instance for sso or cenralized way to manage user and role., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist "macfly/yii2-remote-user-rbac" "*"

or add, _(*4)

"macfly/yii2-remote-user-rbac": "*"

to the require section of your composer.json file., _(*5)

Configure

NOTE: Make sure that you don't have user component configuration in your config files., _(*6)

Configure config/web.php as follows, _(*7)

  'components' => [
    ................
    'authClientCollection' => [
      'class'   => \yii\authclient\Collection::className(),
      'clients' => [
        'oauth2' => [
          'class'           => 'macfly\authclient\OAuth2',
          'authUrl'         => 'http://127.0.0.1:8888/oauth2/authorize',
          'tokenUrl'        => 'http://127.0.0.1:8888/oauth2/token',
          'apiBaseUrl'      => 'http://127.0.0.1:8888/oauth2',
          'clientId'        => 'testclient',
          'clientSecret'    => 'testpass',
          'requestOptions'  => [
            'sslVerifyPeer' => false,
            'sslVerifyPeerName' => false,
          ],
        ],
      ],
    ],
  ................
  'modules' => [
      ................
      'user'  => [
       'class'       => 'macfly\user\client\Module',
             'cacheDuration' => 3600,
       'authclient'  => 'oauth2',
       'rememberFor' => 1209600, # Session life (default: 1209600)
       'identityUrl' => 'http://127.0.0.1:8888/user/api/identity', # (optional)
       'rbacUrl'     => 'http://127.0.0.1:8888/user/api/rbac',     # (optional)
#            'userComponent' => '',
#      'modelMap'    => [],
#      'remoteModelMap' = [
#         'app\models\User' => 'User',
#       ],
      ],
      ................
  ],

Usage

Authentication with HTTP Bearer token

HttpBearerAuth is an action filter that supports the authentication method based on HTTP Bearer token., _(*8)

You may use HttpBearerAuth by attaching it as a behavior to a controller or module, like the following:, _(*9)

public function behaviors()
{
    return [
        'authenticator' => [
            'class' => \macfly\user\client\filters\auth\HttpBearerAuth::className(),
        ],
    ];
}

Example of usage on a controller, _(*10)

curl --header 'Authorization: Bearer 0205ade34ff0b8dab4489059803add3fc9ba5c47' 'http://127.0.0.1:8888/api/publish'

Authentication with HTTP Basic Authentication

HttpBasicAuth is an action filter that supports the HTTP Basic authentication method., _(*11)

You may use HttpBasicAuth by attaching it as a behavior to a controller or module, like the following:, _(*12)

public function behaviors()
{
    return [
        'authenticator' => [
            'class' => \macfly\user\client\filters\auth\HttpBasicAuth::className(),
        ],
    ];
}

Example of usage on a controller, _(*13)

curl 'http://0205ade34ff0b8dab4489059803add3fc9ba5c47:@127.0.0.1:8888/api/publish'

Authentication with Query Parameter Authentication

QueryParamAuth is an action filter that supports the authentication based on the access token passed through a query parameter., _(*14)

You may use QueryParamAuth by attaching it as a behavior to a controller or module, like the following:, _(*15)

public function behaviors()
{
    return [
        'authenticator' => [
            'class' => \macfly\user\client\filters\auth\QueryParamAuth::className(),
        ],
    ];
}

Example of usage on a controller, _(*16)

curl 'http://127.0.0.1:8888/api/publish?access-token=0205ade34ff0b8dab4489059803add3fc9ba5c47'