oauth2.0受权码模式详解

时间 2019-11-12

标签 oauth2.0 oauth 受权模式详解繁體版

原文原文链接

受权码模式原理

受权码模式（authorization code）是功能最完整、流程最严密的受权模式。它的特色就是经过客户端的后台服务器，与"服务提供商"的认证服务器进行互动。git

它的步骤以下：github

（A）用户访问客户端，后者将前者导向认证服务器。json

（B）用户选择是否给予客户端受权。缓存

（C）假设用户给予受权，认证服务器将用户导向客户端事先指定的"重定向URI"（redirection URI），同时附上一个受权码。服务器

（D）客户端收到受权码，附上早先的"重定向URI"，向认证服务器申请令牌。这一步是在客户端的后台的服务器上完成的，对用户不可见。app

（E）认证服务器核对了受权码和重定向URI，确认无误后，向客户端发送访问令牌（access token）和更新令牌（refresh token）。ide

下面是上面这些步骤所须要的参数。测试

A步骤中，客户端申请认证的URI，包含如下参数：ui

response_type：表示受权类型，必选项，此处的值固定为"code"
client_id：表示客户端的ID，必选项
redirect_uri：表示重定向URI，可选项
scope：表示申请的权限范围，可选项
state：表示客户端的当前状态，能够指定任意值，可选项.认证服务器会原封不动地返回这个值。(若是是你本身实现的oauth2.0服务端，能够不校验这个参数，client端就能够无论这个参数)

下面是一个例子。url

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，包含如下参数：

code：表示受权码，必选项。该码的有效期应该很短，一般设为10分钟，客户端只能使用该码一次，不然会被受权服务器拒绝。该码与客户端ID和重定向URI，是一一对应关系。
state：若是客户端的请求中包含这个参数，认证服务器的回应也必须如出一辙包含这个参数。

下面是一个例子。

HTTP/1.1 302 Found
Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA &state=xyz

D步骤中，客户端向认证服务器申请令牌的HTTP请求，包含如下参数：

grant_type：表示使用的受权模式，必选项，此处的值固定为"authorization_code"。
code：表示上一步得到的受权码，必选项。
redirect_uri：表示重定向URI，必选项，且必须与A步骤中的该参数值保持一致。
client_id：表示客户端ID，必选项。
client_secret:客户端密钥

下面是一个例子。

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回复，包含如下参数：

access_token：表示访问令牌，必选项。
token_type：表示令牌类型，该值大小写不敏感，必选项，能够是bearer类型或mac类型。
expires_in：表示过时时间，单位为秒。若是省略该参数，必须其余方式设置过时时间。
refresh_token：表示更新令牌，用来获取下一次的访问令牌，可选项。
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" }

从上面代码能够看到，相关参数使用JSON格式发送（Content-Type: application/json）。此外，HTTP头信息中明确指定不得缓存。

OAuth 角色

若是上面没好理解，下面是我从《跟我学shiro》这本书里看到的，可能比较容易理解

资源拥有者（resource owner）：能受权访问受保护资源的一个实体，能够是一我的，那咱们称之为最终用
户；如新浪微博用户 zhangsan；
资源服务器（resource server）：存储受保护资源，客户端经过 access token 请求资源，资源服务器响应受
保护资源给客户端；存储着用户 zhangsan 的微博等信息。
受权服务器（authorization server）：成功验证资源拥有者并获取受权以后，受权服务器颁发受权令牌（Acce
ss Token）给客户端。
客户端（client）：如新浪微博客户端 weico、微格等第三方应用，也能够是它本身的官方应用；其自己不存储资
源，而是资源拥有者受权经过后，使用它的受权（受权令牌）访问受保护资源，而后客户端把相应的数据展现出
来 / 提交到服务器。“客户端” 术语不表明任何特定实现（如应用运行在一台服务器、桌面、手机或其余设
备）。

1. 客户端从资源拥有者那请求受权。受权请求能够直接发给资源拥有者，或间接的经过受权服务器这种中
介，后者更可取。
2. 客户端收到一个受权许可，表明资源服务器提供的受权。(获取受权码)
3. 客户端使用它本身的私有证书及受权许可到受权服务器验证。
4. 若是验证成功，则下发一个访问令牌。(获取access_token访问令牌)
5. 客户端使用访问令牌向资源服务器请求受保护资源。
6. 资源服务器会验证访问令牌的有效性，若是成功则下发受保护资源。(获取访问的受保护资源)

受权码模式开发

服务端

oauth2.0服务端实现主要涉及参数配置以下:
受权码设置(code)
第三方经过code进行获取 access_token的时候须要用到，code的超时时间为10分钟，一个code只能成功换取一次access_token即失效。
受权做用域(scope)
做用域表明用户受权给第三方的接口权限，第三方应用须要向服务端申请使用相应scope的权限后，通过用户受权，获取到相应access_token后方可对接口进行调用。
令牌有效期(access_token)
access_token是调用受权关系接口的调用凭证，因为access_token有效期（目前为2个小时）较短，当access_token超时后，能够使用refresh_token进行刷新，access_token刷新结果有两种： s
1. 若access_token已超时，那么进行refresh_token会获取一个新的access_token，新的超时时间；
2. 若access_token未超时，那么进行refresh_token不会改变access_token，但超时时间会刷新，至关于续期access_token。
refresh_token拥有较长的有效期（30天），当refresh_token失效的后，须要用户从新受权。

客户端

oauth2.0客户端实现主要涉及传参以下:

得到受权码
http://localhost:8080/oauth2/authorize?client_id=fbed1d1b4b1449daa4bc49397cbe2350&response_type=code&redirect_uri=http://localhost:8080/oauth_callback
得到令牌(POST)
http://localhost:8080/oauth2/access_token?client_id=fbed1d1b4b1449daa4bc49397cbe2350&client_secret=fbed1d1b4b1449daa4bc49397cbe2350&grant_type=authorization_code&redirect_uri=http://localhost:8080/oauth_callback&code={code}

刷新令牌

http://localhost:8080/oauth2/refresh_token?client_id={AppKey}&grant_type=refresh_token&refresh_token={refresh_token}

client_id和client_secret是经过申请的，假如你要请求qq的oauth2.0服务，你得提早申请。若是是你本身的ouath服务，则须要在服务端对请求的client_id和client_secret验证经过。

也能够使用以下客户端测试代码，访问 http://localhost:8080/client 测试

 
         /*  
       
        * Created by Irving on 2014/11/24. 
       
        * OAuth2 客户端实现 
       
        */ 
       
        @Controller 
       
        @RequestMapping( 
        "/client" 
        ) 
       
        public  
        class  
        ClientController { 
       
        private  
        static  
        Logger logger = LoggerFactory.getLogger(ClientController. 
        class 
        ); 
       
        /* 
       
        response_type：表示受权类型，必选项，此处的值固定为"code" 
       
        client_id：表示客户端的ID，必选项 
       
        redirect_uri：表示重定向URI，可选项 
       
        scope：表示申请的权限范围，可选项 
       
        state：表示客户端的当前状态，能够指定任意值，认证服务器会原封不动地返回这个值 
       
        */ 
       
        /** 
       
        * 得到受权码 
       
        * @return 
       
        */ 
       
        @RequestMapping(method = RequestMethod.GET) 
       
        public  
        String client() { 
       
        try  
        { 
       
        OAuthClientRequest oauthResponse = OAuthClientRequest 
       
        .authorizationLocation(ConstantKey.OAUTH_CLIENT_AUTHORIZE) 
       
        .setResponseType(OAuth.OAUTH_CODE) 
       
        .setClientId(ConstantKey.OAUTH_CLIENT_ID) 
       
        .setRedirectURI(ConstantKey.OAUTH_CLIENT_CALLBACK) 
       
        .setScope(ConstantKey.OAUTH_CLIENT_SCOPE) 
       
        .buildQueryMessage(); 
       
        return  
        "redirect:" 
        +oauthResponse.getLocationUri(); 
       
        }  
        catch  
        (OAuthSystemException e) { 
       
        e.printStackTrace(); 
       
        } 
       
        return  
        "redirect:/home" 
        ; 
       
        } 
       
        /* 
       
        grant_type：表示使用的受权模式，必选项，此处的值固定为"authorization_code" 
       
        code：表示上一步得到的受权码，必选项。 
       
        redirect_uri：表示重定向URI，必选项，且必须与A步骤中的该参数值保持一致 
       
         　　　　　　　　client_secret:客户端密钥,必选项 
       
        client_id：表示客户端ID，必选项 
       
        */ 
       
        /** 
       
        * 得到令牌 
       
        * @return oauth_callback?code=1234 
       
        */ 
       
        @RequestMapping(value =  
        "/oauth_callback"  
        ,method = RequestMethod.GET) 
       
        public  
        String getToken(HttpServletRequest request,Model model) throws OAuthProblemException { 
       
        OAuthAuthzResponse oauthAuthzResponse =  
        null 
        ; 
       
        try  
        { 
       
        oauthAuthzResponse = OAuthAuthzResponse.oauthCodeAuthzResponse(request); 
       
        String code = oauthAuthzResponse.getCode(); 
       
        OAuthClientRequest oauthClientRequest = OAuthClientRequest 
       
        .tokenLocation(ConstantKey.OAUTH_CLIENT_ACCESS_TOKEN) 
       
        .setGrantType(GrantType.AUTHORIZATION_CODE) 
       
        .setClientId(ConstantKey.OAUTH_CLIENT_ID) 
       
        .setClientSecret(ConstantKey.OAUTH_CLIENT_SECRET) 
       
        .setRedirectURI(ConstantKey.OAUTH_CLIENT_CALLBACK) 
       
        .setCode(code) 
       
        .buildQueryMessage(); 
       
        OAuthClient oAuthClient =  
        new  
        OAuthClient( 
        new  
        URLConnectionClient()); 
       
        //Facebook is not fully compatible with OAuth 2.0 draft 10, access token response is 
       
        //application/x-www-form-urlencoded, not json encoded so we use dedicated response class for that 
       
        //Custom response classes are an easy way to deal with oauth providers that introduce modifications to 
       
        //OAuth 2.0 specification 
       
        //获取access token 
       
        OAuthJSONAccessTokenResponse oAuthResponse = oAuthClient.accessToken(oauthClientRequest, OAuth.HttpMethod.POST); 
       
        String accessToken = oAuthResponse.getAccessToken(); 
       
        String refreshToken= oAuthResponse.getRefreshToken(); 
       
        Long expiresIn = oAuthResponse.getExpiresIn(); 
       
        //得到资源服务 
       
        OAuthClientRequest bearerClientRequest =  
        new  
        OAuthBearerClientRequest(ConstantKey.OAUTH_CLIENT_GET_RESOURCE) 
       
        .setAccessToken(accessToken).buildQueryMessage(); 
       
        OAuthResourceResponse resourceResponse = oAuthClient.resource(bearerClientRequest, OAuth.HttpMethod.GET, OAuthResourceResponse. 
        class 
        ); 
       
        String resBody = resourceResponse.getBody(); 
       
        logger.info( 
        "accessToken: " 
        +accessToken + 
        " refreshToken: " 
        +refreshToken + 
        " expiresIn: " 
        +expiresIn + 
        " resBody: " 
        +resBody); 
       
        model.addAttribute( 
        "accessToken" 
        ,   
        "accessToken: " 
        +accessToken +  
        " resBody: " 
        +resBody); 
       
        return  
        "oauth2/token" 
        ; 
       
        }  
        catch  
        (OAuthSystemException ex) { 
       
        logger.error( 
        "getToken OAuthSystemException : "  
        + ex.getMessage()); 
       
        model.addAttribute( 
        "errorMsg" 
        ,  ex.getMessage()); 
       
        return   
        "/oauth2/error" 
        ; 
       
        } 
       
        } 
       
        }

项目介绍

项目结构以下：
AuthzController:获取受权码 (resource owner)
TokenController:得到令牌 (authorization server)
ResourceController:资源服务 (resource server)
ClientController:客户端 (client)

前三个Controller相前于服务端最后一个为客户端

基础代码放到github:https://github.com/peterowang/oauth2.0