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

不合群的混子's avatar
不合群的混子 已提交
3 4
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
5
import me.zhyd.oauth.cache.AuthDefaultStateCache;
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
import me.zhyd.oauth.log.Log;
12 13 14 15
import me.zhyd.oauth.model.AuthCallback;
import me.zhyd.oauth.model.AuthResponse;
import me.zhyd.oauth.model.AuthToken;
import me.zhyd.oauth.model.AuthUser;
16
import me.zhyd.oauth.utils.AuthChecker;
不合群的混子's avatar
不合群的混子 已提交
17 18
import me.zhyd.oauth.utils.StringUtils;
import me.zhyd.oauth.utils.UrlBuilder;
19
import me.zhyd.oauth.utils.UuidUtils;
20

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

智布道's avatar
智布道 已提交
33
    public AuthDefaultRequest(AuthConfig config, AuthSource source) {
34 35 36 37
        this(config, source, AuthDefaultStateCache.INSTANCE);
    }

    public AuthDefaultRequest(AuthConfig config, AuthSource source, AuthStateCache authStateCache) {
38
        this.config = config;
39
        this.source = source;
40
        this.authStateCache = authStateCache;
41
        if (!AuthChecker.isSupportedAuth(config, source)) {
智布道's avatar
智布道 已提交
42
            throw new AuthException(AuthResponseStatus.PARAMETER_INCOMPLETE);
智布道's avatar
智布道 已提交
43
        }
44
        // 校验配置合法性
45
        AuthChecker.checkConfig(config, source);
46
    }
47

48 49 50 51 52 53 54 55
    /**
     * 获取access token
     *
     * @param authCallback 授权成功后的回调参数
     * @return token
     * @see AuthDefaultRequest#authorize()
     * @see AuthDefaultRequest#authorize(String)
     */
56
    protected abstract AuthToken getAccessToken(AuthCallback authCallback);
57

58 59 60 61 62 63 64
    /**
     * 使用token换取用户信息
     *
     * @param authToken token信息
     * @return 用户信息
     * @see AuthDefaultRequest#getAccessToken(AuthCallback)
     */
65
    protected abstract AuthUser getUserInfo(AuthToken authToken);
66

67 68 69 70 71 72 73
    /**
     * 统一的登录入口。当通过{@link AuthDefaultRequest#authorize(String)}授权成功后,会跳转到调用方的相关回调方法中
     * 方法的入参可以使用{@code AuthCallback},{@code AuthCallback}类中封装好了OAuth2授权回调所需要的参数
     *
     * @param authCallback 用于接收回调参数的实体
     * @return AuthResponse
     */
74
    @Override
75
    public AuthResponse login(AuthCallback authCallback) {
76
        try {
智布道's avatar
智布道 已提交
77
            AuthChecker.checkCode(source, authCallback);
78
            this.checkState(authCallback.getState());
79 80

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

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

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

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

    /**
     * 返回获取accessToken的url
     *
143
     * @param code 授权码
不合群的混子's avatar
不合群的混子 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
     * @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
     *
159
     * @param refreshToken refreshToken
不合群的混子's avatar
不合群的混子 已提交
160 161 162 163 164
     * @return 返回获取accessToken的url
     */
    protected String refreshTokenUrl(String refreshToken) {
        return UrlBuilder.fromBaseUrl(source.refresh())
            .queryParam("client_id", config.getClientId())
智布道's avatar
智布道 已提交
165 166
            .queryParam("client_secret", config.getClientSecret())
            .queryParam("refresh_token", refreshToken)
不合群的混子's avatar
不合群的混子 已提交
167 168
            .queryParam("grant_type", "refresh_token")
            .queryParam("redirect_uri", config.getRedirectUri())
智布道's avatar
智布道 已提交
169 170
            .build();
    }
不合群的混子's avatar
不合群的混子 已提交
171 172 173 174

    /**
     * 返回获取userInfo的url
     *
175
     * @param authToken token
不合群的混子's avatar
不合群的混子 已提交
176 177 178 179 180 181
     * @return 返回获取userInfo的url
     */
    protected String userInfoUrl(AuthToken authToken) {
        return UrlBuilder.fromBaseUrl(source.userInfo()).queryParam("access_token", authToken.getAccessToken()).build();
    }

智布道's avatar
智布道 已提交
182 183 184
    /**
     * 返回获取revoke authorization的url
     *
185
     * @param authToken token
智布道's avatar
智布道 已提交
186 187 188 189 190 191
     * @return 返回获取revoke authorization的url
     */
    protected String revokeUrl(AuthToken authToken) {
        return UrlBuilder.fromBaseUrl(source.revoke()).queryParam("access_token", authToken.getAccessToken()).build();
    }

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

    /**
     * 通用的 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
智布道 已提交
233
    @Deprecated
不合群的混子's avatar
不合群的混子 已提交
234 235 236 237 238 239 240 241 242 243 244 245
    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();
246
    }
智布道's avatar
智布道 已提交
247 248 249 250 251 252 253

    /**
     * 通用的post形式的取消授权方法
     *
     * @param authToken token封装
     * @return HttpResponse
     */
智布道's avatar
智布道 已提交
254
    @Deprecated
智布道's avatar
智布道 已提交
255 256 257 258 259 260 261 262 263 264 265 266 267
    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();
    }
268 269 270 271 272 273 274 275 276 277 278 279


    /**
     * 校验回调传回的state
     *
     * @param state {@code state}一定不为空
     */
    protected void checkState(String state) {
        if (StringUtils.isEmpty(state) || !authStateCache.containsKey(state)) {
            throw new AuthException(AuthResponseStatus.ILLEGAL_REQUEST);
        }
    }
280
}