码云推荐 | OAuth2 授权服务模块 ymate-module-oauth

栏目: 后端 · 前端 · 发布时间: 6年前

内容简介:码云推荐 | OAuth2 授权服务模块 ymate-module-oauth

YMP-OAuth:

OAuth2授权服务模块,特性如下:

  • 支持客户端模式 grant_type=client_credentials
  • 支持授权码模式 grant_type=authorization_code
  • 支持密码模式 grant_type=password
  • 支持 scope 权限范围: snsapi_basesnsapi_userinfo
  • 支持令牌更新: grant_type=refresh_token
  • 支持令牌有效性验证;
  • 支持拦截器限制接口请求的 scope 权限:

    • 客户端授权拦截器:ClientAccessTokenCheckInterceptor.class
    • 用户网页授权拦截器:SnsAccessTokenCheckInterceptor.class

Maven包依赖

<dependency>
    <groupId>net.ymate.module</groupId>
    <artifactId>ymate-module-oauth</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

模块配置参数说明

#-------------------------------------
# module.oauth 模块初始化参数
#-------------------------------------

# AccessToken访问凭证超时时间, 单位(秒), 默认值: 7200(两小时)
ymp.configs.module.oauth.access_token_expire_in=

# 缓存名称前缀, 默认值: ""
ymp.configs.module.oauth.cache_name_prefix=

# 用户确认授权JSP视图文件路径, 默认值: _views/oauth2/sns-authorization
ymp.configs.module.oauth.authorization_view=

# Token生成器接口实现, 默认值: net.ymate.module.oauth.impl.DefaultTokenGenerator
ymp.configs.module.oauth.token_generator_class=

# 用户身份信息适配器接口实现, 默认值: 空
ymp.configs.module.oauth.userinfo_adapter_class=

# OAuth令牌存储适配器接口实现, 默认值: 空
ymp.configs.module.oauth.oauth_storage_class=

示例代码

  • 通过拦截器限制接口请求 scope 的权限必须是 snsapi_userinfo

    @RequestMapping("/sns/userinfo")
    @Before(SnsAccessTokenCheckInterceptor.class)
    @ContextParam(@ParamItem(key = IOAuth.Const.SCOPE, value = IOAuth.Scope.SNSAPI_USERINFO))
    public IView userinfo(@RequestParam(IOAuth.Const.ACCESS_TOKEN) String accountToken, @RequestParam(IOAuth.Const.OPEN_ID) String openId) throws Exception {
        try {
            return View.jsonView(OAuth.get().getModuleCfg().getUserInfoAdapter().getUserInfo(OAuth.get().bindAccessResourceHelper(accountToken, openId).getOAuthClientUser().getUid()));
        } catch (Exception e) {
            OAuthResponse _response = __responseBadRequest(IOAuth.Const.INVALID_USER);
            return new HttpStatusView(_response.getResponseStatus(), false).writeBody(_response.getBody());
        }
    }
  • 客户端模式:

    • 以POST方式请求URL地址:

      http://localhost:8080/oauth2/token
    • POST请求报文:

      POST /oauth2/token HTTP/1.1
      Host: localhost:8080
      Content-Type: application/x-www-form-urlencoded
      
      client_id=default&client_secret=7890123&grant_type=client_credentials
  • 授权码模式:

    • 获取授权码,以GET方式请求URL地址,成功则重定向并携带 code 授权码:

      http://localhost:8080/oauth2/sns/authorize?client_id=default&response_type=code&redirect_uri=http://localhost:8080/oauth2/sns/redirect&scope=snsapi_base&state=Helloworld
    • 接收到 code 授权码后,获取 access_token 令牌,以POST方式请求URL地址:

      http://localhost:8080/oauth2/sns/access_token
    • POST请求报文:

      POST /oauth2/sns/access_token HTTP/1.1
      Host: localhost:8080
      Content-Type: application/x-www-form-urlencoded
      
      code=f32ab01222936356e5a8352b9beeacc3&client_id=default&client_secret=7890123&grant_type=authorization_code&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Foauth2%2Fsns%2Fredirect
  • 密码模式:

    • 以POST方式请求URL地址:

      http://localhost:8080/oauth2/sns/access_token
    • POST请求报文:

      POST /oauth2/sns/access_token HTTP/1.1
      Host: localhost:8080
      Content-Type: application/x-www-form-urlencoded
      
      client_id=default&client_secret=7890123&grant_type=password&username=suninformation&password=8fa6adcdaa9e50635c5bf54eacfca83a&scope=snsapi_userinfo
  • 令牌更新:

    • 以POST方式请求URL地址:

      http://localhost:8080/oauth2/sns/refresh_token
    • POST请求报文:

      POST /oauth2/sns/refresh_token HTTP/1.1
      Host: localhost:8080
      Content-Type: application/x-www-form-urlencoded
      
      grant_type=refresh_token&refresh_token=207f2a5de46198dc8b42ba175e75cac1&client_id=default&client_secret=7890123
  • 令牌有效性验证:

    • 以GET方式请求URL地址:

      http://localhost:8080/oauth2/sns/auth?access_token=39ec0af0b9f5f7ebe2877389bb2919b4&open_id=6bf18fa2f9a136273fb90e58dff4a964
  • 获取授权用户基本信息:

    • 以GET方式请求URL地址:

      http://localhost:8080/oauth2/sns/userinfo?access_token=8fec1e7eca5d6e18b48d33f1725f6082&open_id=6bf18fa2f9a136273fb90e58dff4a964

One More Thing

YMP不仅提供便捷的Web及其它 Java 项目的快速开发体验,也将不断提供更多丰富的项目实践经验。

感兴趣的小伙伴儿们可以加入 官方QQ群480374360,一起交流学习,帮助YMP成长!

了解更多有关YMP框架的内容,请访问官网: http://www.ymate.net/


以上所述就是小编给大家介绍的《码云推荐 | OAuth2 授权服务模块 ymate-module-oauth》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

R Cookbook

R Cookbook

Paul Teetor / O'Reilly Media / 2011-3-22 / USD 39.99

With more than 200 practical recipes, this book helps you perform data analysis with R quickly and efficiently. The R language provides everything you need to do statistical work, but its structure ca......一起来看看 《R Cookbook》 这本书的介绍吧!

HTML 编码/解码
HTML 编码/解码

HTML 编码/解码

Markdown 在线编辑器
Markdown 在线编辑器

Markdown 在线编辑器

HEX CMYK 转换工具
HEX CMYK 转换工具

HEX CMYK 互转工具