25 Star 48 Fork 11

有理想的鱼 / ymate-module-sso

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

YMATE-MODULE-SSO

Maven Central status LICENSE

基于 YMP 框架实现的单点登录模块封装。

Maven包依赖

<dependency>
    <groupId>net.ymate.module</groupId>
    <artifactId>ymate-module-sso</artifactId>
    <version>2.0.1</version>
</dependency>

模块配置参数说明

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

# 在Cookie中存储令牌的名称, 默认值: module.sso_token
ymp.configs.module.sso.token_cookie_name=

# 令牌存储在请求头中的名称, 默认值: X-ModuleSSO-Token
ymp.configs.module.sso.token_header_name=

# 令牌URL参数名称, 默认值: token
ymp.configs.module.sso.token_param_name=

# 令牌生命周期(秒), 默认值为0, 小于等于0表示不启用
ymp.configs.module.sso.token_max_age=

# 令牌有效性验证的时间间隔(秒), 默认值: 0
ymp.configs.module.sso.token_validation_time_interval=

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

# 开启多会话模式(即同一账号允许多处登录), 默认值: false
ymp.configs.module.sso.multi_session_enabled=

# 同一账号最多会话数量,小于等于0表示不限制
ymp.configs.module.sso.multi_session_max_count=

# 开启会话的IP地址检查, 默认值: false
ymp.configs.module.sso.ip_check_enabled=

# 是否为客户端模式, 默认为false
ymp.configs.module.sso.client_mode=

# 指定服务端基准URL路径(若客户端模式开启时则此项必填), 必须以'http://'或'https://'开始并以'/'结束, 如: http://www.ymate.net/service/, 默认值: 空
ymp.configs.module.sso.service_base_url=

# 客户端与服务端之间通讯请求参数签名以及令牌加解密附加密钥, 默认值: ""
ymp.configs.module.sso.service_auth_key=

# 服务请求映射前缀(不允许'/'开始和结束), 默认值: ""
ymp.configs.module.sso.service_prefix=

# 是否注册通用令牌验证控制器, 默认值: false
ymp.configs.module.sso.general_auth_enabled=

# 令牌分析适配器接口实现, 默认值: net.ymate.module.sso.impl.DefaultTokenAdapter
ymp.configs.module.sso.token_adapter_class=

# 令牌存储适配器接口实现, 默认值: net.ymate.module.sso.impl.DefaultTokenStorageAdapter
ymp.configs.module.sso.token_storage_adapter_class=

# 令牌自定义属性加载适配器接口实现, 非客户端模式时有效, 默认值: 空
ymp.configs.module.sso.token_attribute_adapter_class=

# 检测令牌无效时重定向URL地址(用于跳转至用户登录页面, 如: login?redirect_url=${redirect_url}), 默认值: 空
ymp.configs.module.sso.token_invalid_redirect_url=

# 检测令牌已存在时重定向URL地址(用于登录成功后跳转), 默认值: 空
ymp.configs.module.sso.token_already_redirect_url=

# 是否开启会话安全确认, 默认值: false
ymp.configs.module.sso.token_confirm_enabled=

# 会话安全确认处理器接口实现, 默认值: net.ymate.module.sso.impl.DefaultTokenConfirmHandler
ymp.configs.module.sso.token_confirm_handler_class=

# 会话安全确认重定向URL地址, 默认值: confirm?redirect_url=${redirect_url}
ymp.configs.module.sso.token_confirm_redirect_url=

# 会话安全确认超时时间(分钟),小于等于0则使用默认值: 30
ymp.configs.module.sso.token_confirm_timeout=

示例代码

配置用户会话检查拦截器,该拦截器已集成单点登录相关处理逻辑:

@RequestMapping(value = "/user/profile/edit", method = Type.HttpMethod.POST)
@UserSessionCheck
public IView doEditUserProfile(@RequestParam String nickName, ......) throws Exception {
    // ...... 省略
    return WebResult.success().toJsonView();
}

通过代码操作用户的登录授权令牌对象:

ISingleSignOn singleSignOn = SingleSignOn.get();
IToken token = singleSignOn.getCurrentToken();
if (token == null) {
    // 若返回值为空则表示令牌对象不存在
    token = singleSignOn.createToken("uid_xxx", "127.0.0.1", "FireFox");
    // 存储令牌并使其生效
    singleSignOn.saveOrUpdateToken(token);
}
if (token != null) {
    // 令牌唯一标识
    token.getId();
    // 用户唯一标识
    token.getUid();
    // 用户IP地址
    token.getRemoteAddr();
    // 用户代理信息
    token.getUserAgent();
    // 令牌对象创建时间
    token.getCreateTime();
    // 令牌扩展属性
    token.getAttributes();
}

One More Thing

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

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

如果喜欢 YMP,希望得到你的支持和鼓励!

Donation Code

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

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于 YMP 框架实现的单点登录模块封装。 展开 收起
Java
Apache-2.0
取消

发行版 (3)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/suninformation/ymate-module-sso.git
git@gitee.com:suninformation/ymate-module-sso.git
suninformation
ymate-module-sso
ymate-module-sso
master

搜索帮助