Download the PHP package rob006/yii2-simple-auth without Composer
On this page you can find all versions of the php package rob006/yii2-simple-auth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rob006/yii2-simple-auth
More information about rob006/yii2-simple-auth
Files in rob006/yii2-simple-auth
Package yii2-simple-auth
Short Description Yii 2 extension that provides simple authentication based on a secret key.
License MIT
Informations about the package yii2-simple-auth
Simple authentication extension for Yii 2
Yii 2 extension that provides simple authentication based on a secret key.
The extension provides components for easy authenticate and validate the HTTP request. Each request gets its own unique token with the expiration time, so no passwords or keys are sent with the request - it should be safer than basic access authentication when you don't use https.
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json
file.
Usage
Configuration
You can configure default secret key used by this extension by setting param in your config in
config/web.php
and/or in config/console.php
:
This is optional - you can always explicitly specify the key for authentication/validation.
Authentication (client side)
Authentication when using official yii2-httpclient
extension
You can simply authenticate Request
object from official Yii 2 httpclient
by using yii2-simple-auth-yii-authenticator
extension.
Authentication any request
You can use Authenticator
to authenticate any request, even if you don't use yii2-httpclient
package. For example, authentication cURL request by GET param:
Authentication cURL request by header:
Validation (server side)
To check whether the request has a valid token simply add action filter to your controller:
You can also configure some settings for ActionFilter
:
Final comments
Make sure that you generate token for final URL and no redirections are performed for the request. Token is generated for the exact address, so tokens for:
http://example.com/user/list/
https://example.com/user/list/
http://www.example.com/user/list/
http://example.com/user/list
will be completely different.
Be careful when using POST request. Authenticator
and ActionFilter
takes into account only the
URL, all POST data is ignored during the authentication and validation. This means that one token
may be used many times for different requests with different POST data if refer to the same URL.