Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
701991f0
Commit
701991f0
authored
Aug 12, 2014
by
Vadim Belorussov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add rest-authentication.md to translate into Russian
parent
a2800fe5
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
124 additions
and
0 deletions
+124
-0
rest-authentication.md
docs/guide-ru/rest-authentication.md
+124
-0
No files found.
docs/guide-ru/rest-authentication.md
0 → 100644
View file @
701991f0
Authentication
==============
Unlike Web applications, RESTful APIs are usually stateless, which means sessions or cookies should not
be used. Therefore, each request should come with some sort of authentication credentials because
the user authentication status may not be maintained by sessions or cookies. A common practice is
to send a secret access token with each request to authenticate the user. Since an access token
can be used to uniquely identify and authenticate a user,
**
API requests should always be sent
via HTTPS to prevent from man-in-the-middle (MitM) attacks
**
.
There are different ways to send an access token:
*
[
HTTP Basic Auth
](
http://en.wikipedia.org/wiki/Basic_access_authentication
)
: the access token
is sent as the username. This is should only be used when an access token can be safely stored
on the API consumer side. For example, the API consumer is a program running on a server.
*
Query parameter: the access token is sent as a query parameter in the API URL, e.g.,
`https://example.com/users?access-token=xxxxxxxx`
. Because most Web servers will keep query
parameters in server logs, this approach should be mainly used to serve
`JSONP`
requests which
cannot use HTTP headers to send access tokens.
*
[
OAuth 2
](
http://oauth.net/2/
)
: the access token is obtained by the consumer from an authorization
server and sent to the API server via
[
HTTP Bearer Tokens
](
http://tools.ietf.org/html/rfc6750
)
,
according to the OAuth2 protocol.
Yii supports all of the above authentication methods. You can also easily create new authentication methods.
To enable authentication for your APIs, do the following steps:
1.
Configure the
[
[yii\web\User::enableSession|enableSession
]
] property of the
`user`
application component to be false.
2.
Specify which authentication methods you plan to use by configuring the
`authenticator`
behavior
in your REST controller classes.
3.
Implement
[
[yii\web\IdentityInterface::findIdentityByAccessToken()
]
] in your
[
[yii\web\User::identityClass|user identity class
]
].
Step 1 is not required but is recommended for RESTful APIs which should be stateless. When
[
[yii\web\User::enableSession|enableSession
]
]
is false, the user authentication status will NOT be persisted across requests using sessions. Instead, authentication
will be performed for every request, which is accomplished by Step 2 and 3.
> Tip: You may configure [[yii\web\User::enableSession|enableSession]] of the `user` application component
in application configurations if you are developing RESTful APIs in terms of an application. If you develop
RESTful APIs as a module, you may put the following line in the module's
`init()`
method, like the following:
> ```php
public function init()
{
parent::init();
\Y
ii::$app->user->enableSession = false;
}
```
For example, to use HTTP Basic Auth, you may configure `authenticator` as follows,
```
php
use yii
\f
ilters
\a
uth
\H
ttpBasicAuth;
public function behaviors()
{
$behaviors = parent::behaviors();
$behaviors
[
'authenticator'
]
=
[
'class' => HttpBasicAuth::className(),
];
return $behaviors;
}
```
If you want to support all three authentication methods explained above, you can use `CompositeAuth` like the following,
```
php
use yii
\f
ilters
\a
uth
\C
ompositeAuth;
use yii
\f
ilters
\a
uth
\H
ttpBasicAuth;
use yii
\f
ilters
\a
uth
\H
ttpBearerAuth;
use yii
\f
ilters
\a
uth
\Q
ueryParamAuth;
public function behaviors()
{
$behaviors = parent::behaviors();
$behaviors
[
'authenticator'
]
=
[
'class' => CompositeAuth::className(),
'authMethods' =>
[
HttpBasicAuth::className(),
HttpBearerAuth::className(),
QueryParamAuth::className(),
],
];
return $behaviors;
}
```
Each element in `authMethods` should be an auth method class name or a configuration array.
Implementation of `findIdentityByAccessToken()` is application specific. For example, in simple scenarios
when each user can only have one access token, you may store the access token in an `access_token` column
in the user table. The method can then be readily implemented in the `User` class as follows,
```
php
use yii
\d
b
\A
ctiveRecord;
use yii
\w
eb
\I
dentityInterface;
class User extends ActiveRecord implements IdentityInterface
{
public static function findIdentityByAccessToken($token, $type = null)
{
return static::findOne(
[
'access_token' => $token
]
);
}
}
```
After authentication is enabled as described above, for every API request, the requested controller
will try to authenticate the user in its
`beforeAction()`
step.
If authentication succeeds, the controller will perform other checks (such as rate limiting, authorization)
and then run the action. The authenticated user identity information can be retrieved via
`Yii::$app->user->identity`
.
If authentication fails, a response with HTTP status 401 will be sent back together with other appropriate headers
(such as a
`WWW-Authenticate`
header for HTTP Basic Auth).
## Authorization <a name="authorization"></a>
After a user is authenticated, you probably want to check if he or she has the permission to perform the requested
action for the requested resource. This process is called
*authorization*
which is covered in detail in
the
[
Authorization section
](
security-authorization.md
)
.
If your controllers extend from
[
[yii\rest\ActiveController
]
], you may override
the
[
[yii\rest\Controller::checkAccess()|checkAccess()
]
] method to perform authorization check. The method
will be called by the built-in actions provided by
[
[yii\rest\ActiveController
]
].
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment