Update rest-authentication.md

This commit is contained in:
崔亮
2018-11-15 12:51:36 +08:00
committed by GitHub
parent d2410c2d1c
commit 1c3c96a2d6

View File

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