quick-builtin-oauth2

在quick-auth-base的基础上，提供基于OAuth2标准的第三方登录支持。目前支持微信登录以及标准的OAuth2登录。

微信登录配置

quick.auth.wechat.app-id=xxxx
quick.auth.wechat.app-secret=xxxx
quick.auth.wechat.response-type=code
quick.auth.wechat.scope:snsapi_userinfo
quick.auth.wechat.grant-type:authorization_code
quick.auth.wechat.token:quick-wechat

标准OAuth2登录配置

quick.auth.oauth2.endpoint=http://xxxx
quick.auth.oauth2.client-id=xxx
quick.auth.oauth2.secret=xxx
quick.auth.oauth2.scope=xxx

扩展新的登录方式

增加新的登录方式支持，可以通过注入Bean的方式实现。注入实现了接口plus.extvos.auth.service.OAuthProvider的Bean，系统即可获取和使用到该登录方式。

public interface OAuthProvider {

    /**
     * The following constants are for raw map conversion, provider processed extra map info should convert the keys.
     */
    String NICK_NAME_KEY = "nickname";
    String AVATAR_URL_KEY = "avatarUrl";
    String OPEN_ID_KEY = "openid";
    String UNION_ID_KEY = "unionid";
    String SESSION_KEY = "session_key";
    String LANGUAGE_KEY = "language";
    String COUNTRY_KEY = "country";
    String COUNTRY_CODE_KEY = "countryCode";
    String PROVINCE_KEY = "province";
    String CITY_KEY = "city";
    String GENDER_KEY = "gender";
    String PHONE_NUMBER_KEY = "phoneNumber";


    /**
     * A unique identifier for service provider
     *
     * @return string of slug
     */
    String getSlug();

    /**
     * get provider name
     *
     * @return name as String
     */
    String getName();

    /**
     * get if provider support in page redirect.
     *
     * @return true if supported
     */
    default boolean redirectSupported() {
        return false;
    }

    ;

    /**
     * provider notification
     *
     * @param params params from request
     * @param body   request body from request
     * @return result
     * @throws RestletException if errors
     */
    Object notify(Map<String, Object> params, byte[] body) throws RestletException;

    /**
     * get code url for generate QrCode or redirect user browser
     *
     * @param state       a string to identify state of code url
     * @param redirectUri a string to give the redirectUri
     * @return a string of url.
     * @throws RestletException if errors
     */
    String getCodeUrl(String state, String redirectUri) throws RestletException;

    /**
     * run authorization with given code
     *
     * @param code      authorized code from provider
     * @param state     session state identity
     * @param via       parameter
     * @param authState previous state if already exists
     * @return updated authState or new
     * @throws RestletException when error
     */
    OAuthState authorized(String code, String state, String via, OAuthState authState) throws RestletException;

    /**
     * authorization updates for special situation
     *
     * @param params    mapped params
     * @param authState previous state if already exists
     * @return updated authState or new
     * @throws RestletException RestletException when error
     */
    OAuthState authorizeUpdate(Map<String, Object> params, OAuthState authState) throws RestletException;
}

接口列表

第三方登录持列表

接口地址:/auth/oauth2/providers

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	Result«List«OAuthProvider»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
count	integer(int64)	integer(int64)
data	array	OAuthProvider
name	string
slug	string
error	string
msg	string
page	integer(int64)	integer(int64)
pageSize	integer(int64)	integer(int64)
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"count": 0,
	"data": [
		{
			"name": "",
			"slug": ""
		}
	],
	"error": "",
	"msg": "",
	"page": 0,
	"pageSize": 0,
	"total": 0
}

第三方登录跳转URL

接口地址:/auth/oauth2/{provider}/code-url

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
provider	provider	path	true	string
redirectUri	redirectUri	query	false	string

响应状态:

状态码	说明	schema
200	OK	Result«string»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
count	integer(int64)	integer(int64)
data	string
error	string
msg	string
page	integer(int64)	integer(int64)
pageSize	integer(int64)	integer(int64)
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"count": 0,
	"data": "",
	"error": "",
	"msg": "",
	"page": 0,
	"pageSize": 0,
	"total": 0
}

第三方登录跳转QRCODE

接口地址:/auth/oauth2/{provider}/code-img

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:image/png

接口描述:

获取图片QRCODE，直接输出图片

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
provider	provider	path	true	string
redirectUri	redirectUri	query	false	string
size	size	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	ModelAndView
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

png格式的Qr-Code图片

跳转第三方登录URL

接口地址:/auth/oauth2/{provider}/login-redirect

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
provider	provider	path	true	string
failureUri	failureUri	query	false	string
redirectUri	redirectUri	query	false	string
state	state	query	false	string

响应状态:

状态码	说明	schema
200	OK	Result«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
count	integer(int64)	integer(int64)
data	object
error	string
msg	string
page	integer(int64)	integer(int64)
pageSize	integer(int64)	integer(int64)
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"count": 0,
	"data": {},
	"error": "",
	"msg": "",
	"page": 0,
	"pageSize": 0,
	"total": 0
}

第三方登录状态

接口地址:/auth/oauth2/{provider}/auth-refresh

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
provider	provider	path	true	string

响应状态:

状态码	说明	schema
200	OK	Result«OAuthResult»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
count	integer(int64)	integer(int64)
data	OAuthResult	OAuthResult
openId	string
session	string
status	integer(int32)
username	string
error	string
msg	string
page	integer(int64)	integer(int64)
pageSize	integer(int64)	integer(int64)
total	integer(int64)	integer(int64)

响应示例:

{
	"code": 0,
	"count": 0,
	"data": {
		"openId": "",
		"session": "",
		"status": 0,
		"username": ""
	},
	"error": "",
	"msg": "",
	"page": 0,
	"pageSize": 0,
	"total": 0
}

第三方登录回调

接口地址:/auth/oauth2/{provider}/authorized

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

via should be 'SESSIONKEY' when calling via Session Key mode

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
code	code	query	true	string
provider	provider	path	true	string
state	state	query	false	string
via	via	query	false	string

响应状态:

状态码	说明	schema
200	OK	Result«OAuthResult»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
count	integer(int64)	integer(int64)
data	OAuthResult	OAuthResult
extraInfo	object
openId	string
session	string
status	integer(int32)
username	string
error	string
msg	string

响应示例:

{
	"code": 0,
	"count": 0,
	"data": {
		"extraInfo": {},
		"openId": "",
		"session": "",
		"status": 0,
		"username": ""
	},
	"error": "",
	"msg": "",
}

第三方会话更新

接口地址:/auth/oauth2/{provider}/session-update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

在第三方认证调用authorized接口没有完成登录时，通过更新数据完成注册登录流程，目前用于小程序认证登录

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
provider	provider	path	true	string

支持以form以及JSON的方式提交数据，根据provider的不同提交不同的数据。微信小程序登录则需提供:

raw 加密数据
iv AES加密的初始向量数据
signature 数据签名

响应状态:

状态码	说明	schema
200	OK	Result«OAuthResult»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
count	integer(int64)	integer(int64)
data	OAuthResult	OAuthResult
extraInfo	object
openId	string
session	string
status	integer(int32)
username	string
error	string
msg	string

响应示例:

{
	"code": 0,
	"count": 0,
	"data": {
		"extraInfo": {},
		"openId": "",
		"session": "",
		"status": 0,
		"username": ""
	},
	"error": "",
	"msg": "",
}

Name		Name	Last commit message	Last commit date
Latest commit History 92 Commits
doc		doc
src/main		src/main
.gitignore		.gitignore
README.md		README.md
pom.xml		pom.xml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

quick-builtin-oauth2

微信登录配置

标准OAuth2登录配置

扩展新的登录方式

接口列表

第三方登录持列表

第三方登录跳转URL

第三方登录跳转QRCODE

跳转第三方登录URL

第三方登录状态

第三方登录回调

第三方会话更新

About

Releases

Packages

Languages

extvos/quick-auth-oauth2

Folders and files

Latest commit

History

Repository files navigation

quick-builtin-oauth2

微信登录配置

标准OAuth2登录配置

扩展新的登录方式

接口列表

第三方登录持列表

第三方登录跳转URL

第三方登录跳转QRCODE

跳转第三方登录URL

第三方登录状态

第三方登录回调

第三方会话更新

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages