AuthDefaultRequest.java 8.3 KB
Newer Older
1 2
package me.zhyd.oauth.request;

不合群的混子's avatar
不合群的混子 已提交
3 4
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
智布道's avatar
智布道 已提交
5
import lombok.extern.slf4j.Slf4j;
6
import me.zhyd.oauth.cache.AuthStateCache;
7
import me.zhyd.oauth.config.AuthConfig;
8
import me.zhyd.oauth.config.AuthSource;
9
import me.zhyd.oauth.enums.AuthResponseStatus;
智布道's avatar
智布道 已提交
10
import me.zhyd.oauth.exception.AuthException;
11 12 13 14
import me.zhyd.oauth.model.AuthCallback;
import me.zhyd.oauth.model.AuthResponse;
import me.zhyd.oauth.model.AuthToken;
import me.zhyd.oauth.model.AuthUser;
15
import me.zhyd.oauth.utils.AuthChecker;
不合群的混子's avatar
不合群的混子 已提交
16 17
import me.zhyd.oauth.utils.StringUtils;
import me.zhyd.oauth.utils.UrlBuilder;
18
import me.zhyd.oauth.utils.UuidUtils;
19

20
/**
智布道's avatar
智布道 已提交
21 22
 * 默认的request处理类
 *
23
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
不合群的混子's avatar
不合群的混子 已提交
24
 * @author yangkai.shen (https://xkcoding.com)
智布道's avatar
智布道 已提交
25
 * @since 1.0.0
26
 */
智布道's avatar
智布道 已提交
27
@Slf4j
智布道's avatar
智布道 已提交
28
public abstract class AuthDefaultRequest implements AuthRequest {
29
    protected AuthConfig config;
30
    protected AuthSource source;
31

智布道's avatar
智布道 已提交
32
    public AuthDefaultRequest(AuthConfig config, AuthSource source) {
33
        this.config = config;
34
        this.source = source;
35
        if (!AuthChecker.isSupportedAuth(config, source)) {
智布道's avatar
智布道 已提交
36
            throw new AuthException(AuthResponseStatus.PARAMETER_INCOMPLETE);
智布道's avatar
智布道 已提交
37
        }
38
        // 校验配置合法性
39
        AuthChecker.checkConfig(config, source);
40
    }
41

42 43 44 45 46 47 48 49
    /**
     * 获取access token
     *
     * @param authCallback 授权成功后的回调参数
     * @return token
     * @see AuthDefaultRequest#authorize()
     * @see AuthDefaultRequest#authorize(String)
     */
50
    protected abstract AuthToken getAccessToken(AuthCallback authCallback);
51

52 53 54 55 56 57 58
    /**
     * 使用token换取用户信息
     *
     * @param authToken token信息
     * @return 用户信息
     * @see AuthDefaultRequest#getAccessToken(AuthCallback)
     */
59
    protected abstract AuthUser getUserInfo(AuthToken authToken);
60

61 62 63 64 65 66 67
    /**
     * 统一的登录入口。当通过{@link AuthDefaultRequest#authorize(String)}授权成功后,会跳转到调用方的相关回调方法中
     * 方法的入参可以使用{@code AuthCallback},{@code AuthCallback}类中封装好了OAuth2授权回调所需要的参数
     *
     * @param authCallback 用于接收回调参数的实体
     * @return AuthResponse
     */
68
    @Override
69
    public AuthResponse login(AuthCallback authCallback) {
70
        try {
71 72 73
            if (!AuthStateCache.containsKey(authCallback.getState())) {
                throw new AuthException(AuthResponseStatus.ILLEGAL_REQUEST);
            }
智布道's avatar
智布道 已提交
74
            AuthChecker.checkCode(source == AuthSource.ALIPAY ? authCallback.getAuth_code() : authCallback.getCode());
75
            AuthChecker.checkState(authCallback);
76 77

            AuthToken authToken = this.getAccessToken(authCallback);
78
            AuthUser user = this.getUserInfo(authToken);
智布道's avatar
智布道 已提交
79
            return AuthResponse.builder().code(AuthResponseStatus.SUCCESS.getCode()).data(user).build();
80
        } catch (Exception e) {
智布道's avatar
智布道 已提交
81
            log.error("Failed to login with oauth authorization.", e);
82
            return this.responseError(e);
83
        }
84 85
    }

86 87 88 89 90 91
    /**
     * 处理{@link AuthDefaultRequest#login(AuthCallback)} 发生异常的情况,统一响应参数
     *
     * @param e 具体的异常
     * @return AuthResponse
     */
92
    private AuthResponse responseError(Exception e) {
智布道's avatar
智布道 已提交
93
        int errorCode = AuthResponseStatus.FAILURE.getCode();
94 95 96 97 98 99
        if (e instanceof AuthException) {
            errorCode = ((AuthException) e).getErrorCode();
        }
        return AuthResponse.builder().code(errorCode).msg(e.getMessage()).build();
    }

100
    /**
101
     * 返回授权url,可自行跳转页面
102 103 104
     * <p>
     * 不建议使用该方式获取授权地址,不带{@code state}的授权地址,容易受到csrf攻击。
     * 建议使用{@link AuthDefaultRequest#authorize(String)}方法生成授权地址,在回调方法中对{@code state}进行校验
105 106
     *
     * @return 返回授权地址
智布道's avatar
智布道 已提交
107
     * @see AuthDefaultRequest#authorize(String)
108
     */
109
    @Deprecated
110
    @Override
111
    public String authorize() {
112 113 114 115
        return this.authorize(null);
    }

    /**
116
     * 返回带{@code state}参数的授权url,授权回调时会带上这个{@code state}
117 118 119
     *
     * @param state state 验证授权流程的参数,可以防止csrf
     * @return 返回授权地址
智布道's avatar
智布道 已提交
120
     * @since 1.9.3
121 122 123
     */
    @Override
    public String authorize(String state) {
不合群的混子's avatar
不合群的混子 已提交
124 125 126 127
        return UrlBuilder.fromBaseUrl(source.authorize())
            .queryParam("response_type", "code")
            .queryParam("client_id", config.getClientId())
            .queryParam("redirect_uri", config.getRedirectUri())
128
            .queryParam("state", getRealState(state))
不合群的混子's avatar
不合群的混子 已提交
129 130 131 132 133 134
            .build();
    }

    /**
     * 返回获取accessToken的url
     *
135
     * @param code 授权码
不合群的混子's avatar
不合群的混子 已提交
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
     * @return 返回获取accessToken的url
     */
    protected String accessTokenUrl(String code) {
        return UrlBuilder.fromBaseUrl(source.accessToken())
            .queryParam("code", code)
            .queryParam("client_id", config.getClientId())
            .queryParam("client_secret", config.getClientSecret())
            .queryParam("grant_type", "authorization_code")
            .queryParam("redirect_uri", config.getRedirectUri())
            .build();
    }

    /**
     * 返回获取accessToken的url
     *
151
     * @param refreshToken refreshToken
不合群的混子's avatar
不合群的混子 已提交
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
     * @return 返回获取accessToken的url
     */
    protected String refreshTokenUrl(String refreshToken) {
        return UrlBuilder.fromBaseUrl(source.refresh())
            .queryParam("client_id", config.getClientId())
            .queryParam("client_secret", config.getClientSecret())
            .queryParam("refresh_token", refreshToken)
            .queryParam("grant_type", "refresh_token")
            .queryParam("redirect_uri", config.getRedirectUri())
            .build();
    }

    /**
     * 返回获取userInfo的url
     *
167
     * @param authToken token
不合群的混子's avatar
不合群的混子 已提交
168 169 170 171 172 173
     * @return 返回获取userInfo的url
     */
    protected String userInfoUrl(AuthToken authToken) {
        return UrlBuilder.fromBaseUrl(source.userInfo()).queryParam("access_token", authToken.getAccessToken()).build();
    }

智布道's avatar
智布道 已提交
174 175 176
    /**
     * 返回获取revoke authorization的url
     *
177
     * @param authToken token
智布道's avatar
智布道 已提交
178 179 180 181 182 183
     * @return 返回获取revoke authorization的url
     */
    protected String revokeUrl(AuthToken authToken) {
        return UrlBuilder.fromBaseUrl(source.revoke()).queryParam("access_token", authToken.getAccessToken()).build();
    }

不合群的混子's avatar
不合群的混子 已提交
184
    /**
185
     * 获取state,如果为空, 则默认取当前日期的时间戳
不合群的混子's avatar
不合群的混子 已提交
186 187 188 189 190
     *
     * @param state 原始的state
     * @return 返回不为null的state
     */
    protected String getRealState(String state) {
191 192 193 194 195 196
        if (StringUtils.isEmpty(state)) {
            state = UuidUtils.getUUID();
        }
        // 缓存state
        AuthStateCache.cache(state, state);
        return state;
不合群的混子's avatar
不合群的混子 已提交
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    }

    /**
     * 通用的 authorizationCode 协议
     *
     * @param code code码
     * @return HttpResponse
     */
    protected HttpResponse doPostAuthorizationCode(String code) {
        return HttpRequest.post(accessTokenUrl(code)).execute();
    }

    /**
     * 通用的 authorizationCode 协议
     *
     * @param code code码
     * @return HttpResponse
     */
    protected HttpResponse doGetAuthorizationCode(String code) {
        return HttpRequest.get(accessTokenUrl(code)).execute();
    }

    /**
     * 通用的 用户信息
     *
     * @param authToken token封装
     * @return HttpResponse
     */
智布道's avatar
智布道 已提交
225
    @Deprecated
不合群的混子's avatar
不合群的混子 已提交
226 227 228 229 230 231 232 233 234 235 236 237
    protected HttpResponse doPostUserInfo(AuthToken authToken) {
        return HttpRequest.post(userInfoUrl(authToken)).execute();
    }

    /**
     * 通用的 用户信息
     *
     * @param authToken token封装
     * @return HttpResponse
     */
    protected HttpResponse doGetUserInfo(AuthToken authToken) {
        return HttpRequest.get(userInfoUrl(authToken)).execute();
238
    }
智布道's avatar
智布道 已提交
239 240 241 242 243 244 245

    /**
     * 通用的post形式的取消授权方法
     *
     * @param authToken token封装
     * @return HttpResponse
     */
智布道's avatar
智布道 已提交
246
    @Deprecated
智布道's avatar
智布道 已提交
247 248 249 250 251 252 253 254 255 256 257 258 259
    protected HttpResponse doPostRevoke(AuthToken authToken) {
        return HttpRequest.post(revokeUrl(authToken)).execute();
    }

    /**
     * 通用的post形式的取消授权方法
     *
     * @param authToken token封装
     * @return HttpResponse
     */
    protected HttpResponse doGetRevoke(AuthToken authToken) {
        return HttpRequest.get(revokeUrl(authToken)).execute();
    }
260
}