Download the PHP package yidas/yii2-access-router without Composer

On this page you can find all versions of the php package yidas/yii2-access-router. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package yii2-access-router

   

Yii 2 Access Router


Yii 2 user authentication & authorization router

Latest Stable Version Latest Unstable Version License

FEATURES

Access Router is a simple user access filtered on route level which supports authentication and authorization. Different from Yii2 Access Control Filter (ACF), this User Authorization can specify routes but not only in controller-actions level.


OUTLINE


REQUIREMENTS

This library requires the following:


INSTALLATION

Install via Composer in your Yii2 project:


CONFIGURATION

Setup a Access Router component and then add it into bootstrap for your application configuration:

  1. Create a component called access which uses yidas\filters\AccessRouter as class with configuration.

  2. Add this access component into bootstrap list.

Options

Key Type Default Description
except array ['*'] Excepted routes for identity verification check. ['{controller}/{action}', '{d}/{c}/{a}']
denyCallback callable null DenyCallback for HTTP authentication
httpAuth array HTTP authentication framework feature
httpLogin array HTTP request method login feature
exceptErrorAction boolean true Error action would be excepted through filter while turning on

USAGE

Except

Access Router implements Access Control Filter (ACF) for routes that the user is must in login status to pass through the filter from any routes except specified ones.

You can setup excepted routes that skip the user authorization. The except setting with [*] value means that the user authorization is disabled:

HTTP Authentication

Access Router supports automatically authenticating client's request by HTTP Authentication with bearer schemes (RFC 6750), you can enable it by setting up httpAuth configuration:

HTTP Authentication login will disable session for one time access uasge, which equals to \Yii::$app->user->enableSession = false;

Options

Key Type Default Description
enable boolean false Enable HTTP authentication
denyCallback callable null DenyCallback for HTTP authentication
forced boolean true Force to authorize by HTTP authentication
key string 'AUTHORIZATION' The header key

Request Method Login

Access Router also supports automatically login client's request by HTTP GET/POST parameter by giving access token, you can enable it by setting up httpLogin configuration:

For above configuration, you could login by accessing route site/login with correct access_token body value (Content-Type: application/x-www-form-urlencoded).

Request Method Login is same as form login that the session is enable, and the duration time could be customized.

For GET method, If you setup 'method' => 'get' with 'only' => ['*'], then you can login by any routes with correct access_token parameter. For example: //example.com/?access_token={valid-user-access-token}

For security reasons, it's not recommended to use GET method that passes access token in parameter.

Options

Key Type Default Description
enable boolean false Enable HTTP request method login
method string 'post' Parameter's Methods of get/post
only array ['*'] Allowed routes for login. ['{controller}/{action}', '{d}/{c}/{a}']
duration integer 3600 24 30 Seconds of login duration
key string 'access_token' Parameter's key
forced boolean true Force to authorize by HTTP authentication

POST Method without CSRF

If you uses post method and want to disable global CSRF validatiob, you can set enableCsrfValidation to false for request configuration:

If you just want to disable CSRF for some controllers/actions, dynamically setting enableCsrfValidation for controller.


ADDITIONS

ACF for Global

If you want to use original Yii 2 Access Control Filter (ACF) for global route instead of Access Router's User Authorization, just comment out the except of Access Router and add ACF rules into 'as beforeRequest' in config:

Warning: ACF could only defines actions but not routes, which the actions could be applied by every controllers.

For above setting example, login excepted action could be matched by any controller such as site/login, controller/login.


REFERENCE

Yii 2 - Application Structure > Application Events

RFC7617 - The 'Basic' HTTP Authentication Scheme


All versions of yii2-access-router with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
yiisoft/yii2 Version ~2.0.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package yidas/yii2-access-router contains the following files

Loading the files please wait ....