Update rest-authentication.md

This commit is contained in:
cuiliang
2018-06-21 16:03:08 +08:00
committed by GitHub
parent e03df4ef28
commit 5e4905e088

View File

@ -2,43 +2,43 @@
==============
和Web应用不同RESTful APIs 通常是无状态的,
也就意味着不应使用sessions 或 cookies
因此每个请求应附带某种授权凭证因为用户授权状态可能没通过sessions 或 cookies维护
常用的做法是每个请求都发送一个秘密的access token来认证用户
由于access token可以唯一识别和认证用户
**API 请求应通过HTTPS来防止man-in-the-middle (MitM) 中间人攻击**.
也就意味着不应使用 sessions 或 cookies
因此每个请求应附带某种授权凭证,因为用户授权状态可能没通过 sessions 或 cookies 维护,
常用的做法是每个请求都发送一个秘密的 access token来认证用户
由于 access token 可以唯一识别和认证用户,
**API 请求应通过 HTTPS 来防止 man-in-the-middle (MitM) 中间人攻击**
下面有几种方式来发送access token
* [HTTP 基本认证](http://en.wikipedia.org/wiki/Basic_access_authentication): access token
当作用户名发送应用在access token可安全存在API使用端的场景
例如API使用端是运行在一台服务器上的程序。
* 请求参数: access token 当作API URL请求参数发送例如
当作用户名发送,应用在 access token 可安全存在 API 使用端的场景,
例如API 使用端是运行在一台服务器上的程序。
* 请求参数: access token 当作 API URL 请求参数发送,例如
`https://example.com/users?access-token=xxxxxxxx`
由于大多数服务器都会保存请求参数到日志,
这种方式应主要用于`JSONP` 请求因为它不能使用HTTP头来发送access token
* [OAuth 2](http://oauth.net/2/): 使用者从认证服务器上获取基于OAuth2协议的access token
* [OAuth 2](http://oauth.net/2/): 使用者从认证服务器上获取基于 OAuth2 协议的 access token
然后通过[HTTP Bearer Tokens](http://tools.ietf.org/html/rfc6750)
发送到API 服务器。
Yii 支持上述的认证方式,你也可很方便的创建新的认证方式。
为你的APIs启用认证做以下步骤
为你的 APIs 启用认证,做以下步骤:
1. 配置`user` 应用组件:
1. 配置 `user` 应用组件:
- 设置 [[yii\web\User::enableSession|enableSession]] 属性为 `false`.
- 设置 [[yii\web\User::loginUrl|loginUrl]] 属性为`null` 显示一个HTTP 403 错误而不是跳转到登录界面.
2. 在你的REST 控制器类中配置`authenticator`
行为来指定使用哪种认证方式
3. 在你的[[yii\web\User::identityClass|user identity class]] 类中实现 [[yii\web\IdentityInterface::findIdentityByAccessToken()]] 方法.
步骤1不是必要的但是推荐配置因为RESTful APIs应为无状态的
当[[yii\web\User::enableSession|enableSession]]false
请求中的用户认证状态就不能通过session来保持每个请求的认证通过步骤2和3来实现。
步骤 1 不是必要的,但是推荐配置,因为 RESTful APIs 应为无状态的,
[[yii\web\User::enableSession|enableSession]]false
请求中的用户认证状态就不能通过 session 来保持,每个请求的认证通过步骤 2 和 3 来实现。
> Tip: 如果你将RESTful APIs作为应用开发可以设置应用配置中 `user` 组件的
> Tip: 如果你将 RESTful APIs 作为应用开发,可以设置应用配置中 `user` 组件的
> [[yii\web\User::enableSession|enableSession]]
> 如果将RESTful APIs作为模块开发可以在模块的 `init()` 方法中增加如下代码,如下所示:
> 如果将 RESTful APIs 作为模块开发,可以在模块的 `init()` 方法中增加如下代码,如下所示:
> ```php
> public function init()
@ -48,7 +48,7 @@ Yii 支持上述的认证方式,你也可很方便的创建新的认证方式
> }
> ```
例如为使用HTTP Basic Auth可配置`authenticator` 行为,如下所示:
例如,为使用 HTTP Basic Auth可配置 `authenticator` 行为,如下所示:
```php
use yii\filters\auth\HttpBasicAuth;
@ -63,7 +63,7 @@ public function behaviors()
}
```
如果你系那个支持以上3个认证方,可以使用`CompositeAuth`,如下所示:
如果你想支持上面解释的所有三种认证方,可以使用 `CompositeAuth`,如下所示:
```php
use yii\filters\auth\CompositeAuth;
@ -90,8 +90,8 @@ public function behaviors()
`findIdentityByAccessToken()`方法的实现是系统定义的,
例如一个简单的场景当每个用户只有一个access token, 可存储access token 到user表的`access_token`列中,
方法可在`User`类中简单实现,如下所示:
例如,一个简单的场景,当每个用户只有一个 access token可存储 access token 到 user 表的 `access_token` 列中,
方法可在 `User` 类中简单实现,如下所示:
```php
use yii\db\ActiveRecord;
@ -106,14 +106,14 @@ class User extends ActiveRecord implements IdentityInterface
}
```
在上述认证启用后对于每个API请求
请求控制器都会在它的`beforeAction()`步骤中对用户进行认证。
在上述认证启用后,对于每个 API 请求,
请求控制器都会在它的 `beforeAction()` 步骤中对用户进行认证。
如果认证成功,控制器再执行其他检查(如频率限制,操作权限),然后再执行动作,
授权用户信息可使用`Yii::$app->user->identity`获取.
授权用户信息可使用 `Yii::$app->user->identity` 获取.
如果认证失败会发送一个HTTP状态码为401的响应
并带有其他相关信息头(如HTTP 基本认证会有`WWW-Authenticate` 头信息).
如果认证失败,会发送一个 HTTP 状态码为 401 的响应,
并带有其他相关信息头如HTTP 基本认证会有 `WWW-Authenticate` 头信息)。
## 授权 <a name="authorization"></a>
@ -122,6 +122,6 @@ class User extends ActiveRecord implements IdentityInterface
这个过程称为 *authorization*
详情请参考 [Authorization section](security-authorization.md).
如果你的控制器从[[yii\rest\ActiveController]]类继承,
如果你的控制器从 [[yii\rest\ActiveController]] 类继承,
可覆盖 [[yii\rest\Controller::checkAccess()|checkAccess()]] 方法
来执行授权检查,该方法会被[[yii\rest\ActiveController]]内置的操作调用。
来执行授权检查,该方法会被 [[yii\rest\ActiveController]] 内置的操作调用。