1 Star 1 Fork 0

王进潮 / wangjc-sso

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

wangjc-sso

分布式单点登陆(记得点个star哦)

一款简单实用的分布式单点登录系统

  1. 单点登录,简称SSO:在多个应用系统中,只需要登录一次,就可以访问其他相互信任的应用系统。
  2. 所以在数据存储的角度来看,相互信任的应用至少共用着一套用户数据,可以分库,但核心验证身份的用户表应该是共享的 在链接的认证与跳转的过程中必然存在数据的传递与读取的过程,我这里采用的方式是:

服务端redis存储登录用户信息;客户端cookie存储认证token,摒弃session的存储

(cookie的存储,token的概念,这个不是很明白的,建议先去自行百度搞清楚。注:该博客站点不会去浪费文笔去解释各种名词与定义)

1.模型如图所示

模型图

2.架构的设计(分3个模块)

idea目录

模块名称 作用
wangjc-sso-core 如截图所示,放定制好的实体,redisService,工具类,返回值,常量……
wangjc-sso-web-autologin 认证中心,主要负责登陆页面,核心业务在于登陆的存储,成功后的重定向
wangjc-sso-web-test 测试实例,主要代码在拦截器里,拦截当前的请求是否已认证,是否需要转发到认证中心
  1. 这里只是为了测试案例,表达思想,追求速度与简洁,真实场景的架构千万被如此随意

3.直接上部分核心代码

public class TUser implements Serializable {
    private static final long serialVersionUID = -6882766758996195727L;
    private Long id = 1L;
    private String userName = "wangjc";
    private String password = "123456";
	//省略getting,setting
}
//这里的实体避开访问数据库的操作,直接写死。。
认证中心的controller
/**
 * 登录请求页面
 * @return
 */
@RequestMapping(value = "/index",method = {RequestMethod.GET,RequestMethod.POST})
public ModelAndView index(String redirect, HttpServletRequest request){

    TUser user = AutoLoginHelp.loginCheck(request, redisService);

    if(user == null){
        ModelAndView view = new ModelAndView("/page/login");
        view.addObject("redirect", redirect);

        logger.info("登录请求,站点[{}]",redirect);
        return view;
    }
    if(redirect == null){
        return new ModelAndView("/index");
    }
    return new ModelAndView("redirect:"+redirect);
}

/**
 * 账号密码登录动作(以此类推,可添加手机验证码,微信……第三方登录接口)
 * @param userName
 * @param password
 * @param request
 * @param response
 * @return
 */
@RequestMapping(value = "/login",method = {RequestMethod.GET,RequestMethod.POST})
@ResponseBody
public ActionResult<String> login(String userName,String password, HttpServletRequest request, HttpServletResponse response){

    // 验证登录是否通过
    TUser user = new TUser();

    if(user.getUserName().equals(userName) && user.getPassword().equals(password)) {
        // 设置登录
        String token = AutoLoginHelp.login(user, redisService,response);
        // 重定向
        String redirectUrl = request.getParameter("redirect");
        if (redirectUrl != null && redirectUrl.trim().length() > 0) {
            redirectUrl = redirectUrl + "?token=" + token;
            logger.info("登录成功,重定向地址[{}]",redirectUrl);
        }
        return ActionResult.ok(redirectUrl);
    }
    return ActionResult.error(ResultEnum.LOGIN_FAIL.getMsgCn());
}
AutoLoginHelp(主要是设置缓存和验证)
/**
 * 单点登录的协助
 * @author com.wangjc
 * @title: AutoLoginHelp
 * @projectName wangjc-blog
 * @description: TODO
 * @date 2020/6/17 19:24
 */
public class AutoLoginHelp {

    private static final Logger logger = LoggerFactory.getLogger(AutoLoginHelp.class);

    /**
     * 登录检查
     * @param request
     * @param request
     * @return
     */
    public static TUser loginCheck(HttpServletRequest request, RedisService redisService){

        String token = CookieUtil.getCookieValue(request,"token");

        if(StringUtil.isNullOrEmpty(token)){
            return null;
        }

        TUser user= (TUser) redisService.hget(SystemConstant.REDIS_KEY.LOGIN, token);
        if(user != null){
            redisService.hset(SystemConstant.REDIS_KEY.LOGIN,token,user,SystemConstant.REDIS_TIME.LOGIN);//刷新redis
            return user;
        }

        logger.info("redis已过期,需重新登录。");
        return null;
    }

    /**
     * 登录,
     * @param user
     * @param redisService
     * @return token
     */
    public static String login(TUser user, RedisService redisService, HttpServletResponse response){

        if(user != null){
            String token = JWTUtil.sign(user.getId(),user.getPassword());
            // 设置token到cookie,user到redis
            CookieUtil.set(response,"token",token);
            redisService.hset(SystemConstant.REDIS_KEY.LOGIN,token,user,SystemConstant.REDIS_TIME.LOGIN);
            return token;
        }
        return null;
    }

    /**
     * 注销,注销user,token可能在请求头,也有可能设置参数传递
     * @param request
     * @param redisService
     */
    public static void logout(HttpServletRequest request,RedisService redisService){

        String token = StringUtil.isNullOrEmpty(request.getParameter("token"))?request.getHeader("Authorization"):request.getParameter("token");
        Long deleteHashKey = redisService.hashDeleteHashKey(SystemConstant.REDIS_KEY.LOGIN, token);
        logger.info("注销成功!删除redis存储条目[{}]", deleteHashKey);
    }
}
测试应用的拦截器
    /**
     * 核心过滤,资源放行
     * @param request
     * @param response
     * @param chain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletResponse res = (HttpServletResponse) response;
        HttpServletRequest req = (HttpServletRequest) request;

        String path = req.getServletPath();//获取访问的地址

        // 初始认证登陆的放行
        String token = request.getParameter("token");
        if(!StringUtil.isNullOrEmpty(token)){

            // 设置token到cookie
            CookieUtil.set(res,"token",token);

            TUser user = (TUser) redisService.hget(SystemConstant.REDIS_KEY.LOGIN,token);
            if(user == null){
                res.sendRedirect(loginURL+"?redirect="+redirectServer);//定向到登录
                return;
            }

            // 重定向,隐藏token
            if("/".equals(path)){
                res.sendRedirect(redirectServer);
                return;
            }
            chain.doFilter(request,response);
            return;
        }

        // 静态资源放行
        if(staticResource(path)){
            chain.doFilter(request,response);
            return;
        }
        ///这里一段业务逻辑(注销,分享,重置……)的放行,自定义

        TUser user = AutoLoginHelp.loginCheck(req,redisService);
        if(user == null){
            res.sendRedirect(loginURL+"?redirect="+redirectServer);//定向到登录
            return;
        }
        chain.doFilter(request,response);
    }
测试案例的properties配置文件
wangjc.sso.autologin=http://127.0.0.1:8090/wangjc-sso-autologin/autoLogin/index
wangjc.sso.redirect-server=http://127.0.0.1:8091/wangjc-sso-test

4.应用,测试

  1. 开启本地的redis后,分别启动wangjc-sso-web-autologin 和 wangjc-sso-web-test两个应用,然后初次访问http://127.0.0.1:8091/wangjc-sso-test/
  2. 会看到自动跳转到认证中心,并携带重定向的地址,认证成功后自动跳转回来。再次访问时登陆的状态正常。重测可以手动清除浏览器的cookie或者是服务端的redis,则登陆状态失效。在maven父节点上再次新增web-test2,按照web-test的方式定义拦截器,会发现登陆状态是共享的,因为摒弃了session,每个应用都能按照指定的key读取到缓存信息
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

分布式单点登陆 展开 收起
JavaScript
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/helloxiaochao/wangjc-sso.git
git@gitee.com:helloxiaochao/wangjc-sso.git
helloxiaochao
wangjc-sso
wangjc-sso
master

搜索帮助