JustAuth/docs/oauth/aliyun.md

6.1 KiB
Raw Blame History

1. 授权流程

  1. 用户通过浏览器登录Web应用。
  2. Web应用重定向到阿里云OAuth 2.0服务并将URL返回给浏览器。 注:如果用户还未登录,则会进一步重定向到阿里云登录服务。
  3. 用户通过浏览器登录阿里云OAuth 2.0服务并申请授权码。
  4. 阿里云OAuth 2.0服务重定向到Web应用并返回授权码给浏览器。
  5. 浏览器通过Web应用使用授权码向阿里云OAuth 2.0服务申请代表用户身份的令牌。
  6. 阿里云OAuth 2.0服务向Web应用返回令牌。
  7. Web应用通过获取的令牌向阿里云发起访问API的请求。

2. 配置应用

2.1 创建应用

  1. 云账号登录RAM控制台
  2. 在左侧导航栏单击OAuth应用管理。
  3. 单击创建应用。
  4. 输入应用名称和应用显示名称。
  5. 选择应用类型。(这儿选择 WebApp 即可)
    • WebApp 指基于浏览器交互的网络应用。
    • NativeApp指操作系统中运行的本地应用主要为运行在桌面操作系统或移动操作系统中的应用。
    • ServerApp指直接访问阿里云服务而无需依赖用户登录的应用目前仅支持基于SCIM协议的用户同步应用。示例请参见通过SCIM协议将企业内部账号同步到阿里云RAM
  6. 根据需要修改访问令牌有效期时长。
    有效期可设置范围为15分钟至3小时默认为3600秒。
  7. 根据需要修改刷新令牌有效期时长。
    有效期可设置范围为2小时至1年默认为2592000秒。
  8. 输入回调地址。
  9. 单击确定完成应用创建。

2.2 配置应用 OAuth 范围

如上,除了默认的 openid 外,再单独增加两条 scope

  • aliuid阿里云颁发的唯一用户标志符
  • profile用户的名称等个人信息

scope 对应获取的用户信息关系表如下:

2.3 配置密钥

应用创建完成后,进入应用详情:

切换到 “应用密钥” 选项页,创建密钥

注:密钥创建完成后记得要保存,因为密钥只能在创建完成后明文显示一次,如丢失或者忘记,请重新创建。

3. 集成JustAuth

2.1 引入依赖

<dependency>
  <groupId>me.zhyd.oauth</groupId>
  <artifactId>JustAuth</artifactId>
  <version>${latest.version}</version>
</dependency>

${latest.version}表示当前最新的版本,可以在这儿获取最新的版本信息。

2.2 创建Request

AuthRequest authRequest = new AuthAliyunRequest(AuthConfig.builder()
                .clientId("APPID")
                .clientSecret("应用私钥")
                .alipayPublicKey("支付宝公钥")
                .redirectUri("https://www.zhyd.me/oauth/callback/alipay")
                .build());

2.3 生成授权地址

我们可以直接使用以下方式生成第三方平台的授权链接:

String authorizeUrl = authRequest.authorize(AuthStateUtils.createState());

这个链接我们可以直接后台重定向跳转也可以返回到前端后前端控制跳转。前端控制的好处就是可以将第三方的授权页嵌入到iframe中适配网站设计。

2.4 以上完整代码如下

import me.zhyd.oauth.config.AuthConfig;
import me.zhyd.oauth.request.AuthAliyunRequest;
import me.zhyd.oauth.model.AuthCallback;
import me.zhyd.oauth.request.AuthRequest;
import me.zhyd.oauth.utils.AuthStateUtils;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;


@RestController
@RequestMapping("/oauth")
public class RestAuthController {

    @RequestMapping("/render")
    public void renderAuth(HttpServletResponse response) throws IOException {
        AuthRequest authRequest = getAuthRequest();
        response.sendRedirect(authRequest.authorize(AuthStateUtils.createState()));
    }

    @RequestMapping("/callback")
    public Object login(AuthCallback callback) {
        AuthRequest authRequest = getAuthRequest();
        return authRequest.login(callback);
    }

    private AuthRequest getAuthRequest() {
        return new AuthAliyunRequest(AuthConfig.builder()
                   .clientId("APPID")
                   .clientSecret("应用私钥")
                   .redirectUri("回调地址")
                   .build());
    }
}

3. 授权结果

{
    "code": 2000,
    "msg": null,
    "data": {
        "uuid": "lmwxxxw==",
        "username": "yadong.zhang0415@gmail.com",
        "nickname": "root",
        "avatar": null,
        "blog": null,
        "company": null,
        "location": null,
        "email": null,
        "remark": null,
        "gender": "UNKNOWN",
        "source": "ALIYUN",
        "token": {
            "accessToken": "xxxx",
            "expireIn": 3599,
            "refreshToken": null,
            "uid": null,
            "openId": null,
            "accessCode": null,
            "unionId": null,
            "scope": null,
            "tokenType": "Bearer",
            "idToken": "xxxxx",
            "macAlgorithm": null,
            "macKey": null,
            "code": null,
            "oauthToken": null,
            "oauthTokenSecret": null,
            "userId": null,
            "screenName": null,
            "oauthCallbackConfirmed": null
        },
        "rawUserInfo": {
            "sub": "lmwtxxxZ9ezw==",
            "uid": "193xxx",
            "login_name": "yadong.zhang0415@gmail.com",
            "requestid": "544effc2-f7ba-4ac7-8af4-da2739e50e04",
            "name": "root",
            "bid": "2xxx42",
            "aid": "193xxx"
        }
    }
}