OAuth2.0协议 ################# * RFC6749: https://www.rfc-editor.org/rfc/rfc6749 实例:: 有一个"云冲印"的网站，可以将用户储存在Google的照片，冲印出来 用户为了使用该服务，必须让"云冲印"读取自己储存在Google上的照片 名词:: 1. Third-party application 第三方应用程序，本文中又称"客户端"（client），即上一节例子中的"云冲印" 2. HTTP service HTTP服务提供商，本文中简称"服务提供商"，即上一节例子中的Google 3. Resource Owner 资源所有者，本文中又称"用户"（user） 4. User Agent 用户代理，本文中就是指浏览器 5. Authorization server 认证服务器，即服务提供商专门用来处理认证的服务器 6. Resource server 资源服务器，即服务提供商存放用户生成的资源的服务器。 它与认证服务器，可以是同一台服务器，也可以是不同的服务器 步骤:: A. 用户打开客户端以后，客户端要求用户给予授权 B. 用户同意给予客户端授权 C. 客户端使用上一步获得的授权，向认证服务器申请令牌 D. 认证服务器对客户端进行认证以后，确认无误，同意发放令牌 E. 客户端使用令牌，向资源服务器申请获取资源 F. 资源服务器确认令牌无误，同意向客户端开放资源 注:最主要是B步骤 .. figure:: https://img.zhaoweiguo.com/knowledge/images/protocols/protocol_auth2_architecture1.png :width: 80% 客户端获取授权的四种模式:: 1. 授权码模式（authorization code） 2. 简化模式（implicit） 3. 密码模式（resource owner password credentials） 4. 客户端模式（client credentials） 授权码模式 ========== 功能最完整、流程最严密的授权模式。它的特点就是通过客户端的后台服务器，与"服务提供商"的认证服务器进行互动 .. figure:: https://img.zhaoweiguo.com/knowledge/images/protocols/protocol_auth2_authcode1.png :width: 80% 步骤:: A. 用户访问客户端，后者将前者导向认证服务器 B. 用户选择是否给予客户端授权 C. 假设用户给予授权 认证服务器将用户导向客户端事先指定的"重定向URI"（redirection URI），同时附上一个授权码 D. 客户端收到授权码，附上早先的"重定向URI"，向认证服务器申请令牌 这一步是在客户端的后台的服务器上完成的，对用户不可见 E. 认证服务器核对了授权码和重定向URI 确认无误后，向客户端发送访问令牌（access token）和更新令牌（refresh token） A步骤中，客户端申请认证的URI，包含以下参数:: 1. response_type：表示授权类型，必选项，此处的值固定为"code" 2. client_id：表示客户端的ID，必选项 3. redirect_uri：表示重定向URI，可选项 4. scope：表示申请的权限范围，可选项 5. state：表示客户端的当前状态，可以指定任意值，认证服务器会原封不动地返回这个值 实例:: GET /authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1 Host: server.example.com C步骤中，服务器回应客户端的URI，包含以下参数:: 1. code：表示授权码，必选项 该码的有效期应该很短，通常设为10分钟，客户端只能使用该码一次，否则会被授权服务器拒绝 该码与客户端ID和重定向URI，是一一对应关系 2. state：如果客户端的请求中包含这个参数，认证服务器的回应也必须一模一样包含这个参数 实例:: HTTP/1.1 302 Found Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA &state=xyz D步骤中，客户端向认证服务器申请令牌的HTTP请求，包含以下参数:: 1. grant_type：表示使用的授权模式，必选项，此处的值固定为"authorization_code" 2. code：表示上一步获得的授权码，必选项 3. redirect_uri：表示重定向URI，必选项，且必须与A步骤中的该参数值保持一致 4. client_id：表示客户端ID，必选项 实例:: POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb E步骤中，认证服务器发送的HTTP回复，包含以下参数:: 1. access_token：表示访问令牌，必选项 2. token_type：表示令牌类型，该值大小写不敏感，必选项，可以是bearer类型或mac类型 3. expires_in：表示过期时间，单位为秒。如果省略该参数，必须其他方式设置过期时间 4. refresh_token：表示更新令牌，用来获取下一次的访问令牌，可选项 5. scope：表示权限范围，如果与客户端申请的范围一致，此项可省略 实例:: HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA", "example_parameter":"example_value" } // HTTP头信息中明确指定不得缓存 简化模式 ======== * 简化模式（implicit grant type） * 不通过第三方应用程序的服务器，直接在浏览器中向认证服务器申请令牌，跳过了"授权码"这个步骤，因此得名。所有步骤在浏览器中完成，令牌对访问者是可见的，且客户端不需要认证。 .. figure:: https://img.zhaoweiguo.com/knowledge/images/protocols/protocol_auth2_implicit1.png :width: 80% 步骤:: A. 客户端将用户导向认证服务器 B. 用户决定是否给于客户端授权 C. 假设用户给予授权，认证服务器将用户导向客户端指定的"重定向URI"，并在URI的Hash部分包含了访问令牌 D. 浏览器向资源服务器发出请求,其中不包括上一步收到的Hash值 E. 资源服务器返回一个网页,其中包含的代码可以获取Hash值中的令牌 F. 浏览器执行上一步获得的脚本,提取出令牌 G. 浏览器将令牌发给客户端 A步骤中，客户端发出的HTTP请求，包含以下参数:: 1. response_type: 表示授权类型，此处的值固定为"token"，必选项 2. client_id: 表示客户端的ID，必选项 3. redirect_uri: 表示重定向的URI，可选项 4. scope: 表示权限范围,可选项 5. state: 表示客户端的当前状态,可以指定任意值，认证服务器会原封不动地返回这个值 实例:: GET /authorize?response_type=token&client_id=s6BhdRkqt3&state=xyz &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1 Host: server.example.com C步骤中，认证服务器回应客户端的URI，包含以下参数:: 1. access_token：表示访问令牌，必选项。 2. token_type：表示令牌类型，该值大小写不敏感，必选项 3. expires_in：表示过期时间，单位为秒。如果省略该参数，必须其他方式设置过期时间 4. scope：表示权限范围，如果与客户端申请的范围一致，此项可省略 5. state：如果客户端的请求中包含这个参数，认证服务器的回应也必须一模一样包含这个参数 实例:: HTTP/1.1 302 Found Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA &state=xyz&token_type=example&expires_in=3600 密码模式 ======== * Resource Owner Password Credentials Grant 在这种模式中，用户必须把自己的密码给客户端，但是客户端不得储存密码。这通常用在用户对客户端高度信任的情况下，比如客户端是操作系统的一部分，或者由一个著名公司出品。而认证服务器只有在其他授权模式无法执行的情况下，才能考虑使用这种模式。 .. figure:: https://img.zhaoweiguo.com/knowledge/images/protocols/protocol_auth2_password1.png :width: 80% 步骤:: A. 用户向客户端提供用户名和密码 B. 客户端将用户名和密码发给认证服务器，向后者请求令牌 C. 认证服务器确认无误后，向客户端提供访问令牌 B步骤中，客户端发出的HTTP请求，包含以下参数:: grant_type：表示授权类型，此处的值固定为"password"，必选项 username：表示用户名，必选项 password：表示用户的密码，必选项 scope：表示权限范围，可选项 实例:: POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=password&username=johndoe&password=A3ddj3w C步骤中，认证服务器向客户端发送访问令牌，下面是一个例子:: HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA", "example_parameter":"example_value" } 整个过程中，客户端不得保存用户的密码。 客户端模式 ========== * Client Credentials Grant 指客户端以自己的名义，而不是以用户的名义，向"服务提供商"进行认证。严格地说，客户端模式并不属于OAuth框架所要解决的问题。在这种模式中，用户直接向客户端注册，客户端以自己的名义要求"服务提供商"提供服务，其实不存在授权问题 .. figure:: https://img.zhaoweiguo.com/knowledge/images/protocols/protocol_auth2_client1.png :width: 80% 步骤:: A. 客户端向认证服务器进行身份认证，并要求一个访问令牌 B. 认证服务器确认无误后，向客户端提供访问令牌 A步骤中，客户端发出的HTTP请求，包含以下参数:: 1. granttype：表示授权类型，此处的值固定为"clientcredentials"，必选项 2. scope：表示权限范围，可选项 实例:: POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=client_credentials 认证服务器必须以某种方式，验证客户端身份 B步骤中，认证服务器向客户端发送访问令牌，下面是一个例子:: HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "example_parameter":"example_value" } 更新令牌 ======== 如果用户访问的时候，客户端的"访问令牌"已经过期，则需要使用"更新令牌"申请一个新的访问令牌。 客户端发出更新令牌的HTTP请求，包含以下参数:: 1. granttype：表示使用的授权模式，此处的值固定为"refreshtoken"，必选项 2. refresh_token：表示早前收到的更新令牌，必选项 3. scope：表示申请的授权范围，不可以超出上一次申请的范围，如果省略该参数，则表示与上一次一致 实例:: POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA .. rubric:: 参考 * 理解 OAuth 2.0: http://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html