第三方身份认证接入教程

方法教程

系统预留能力介绍

系统目前支持标准化的接入类型如下:
1、CAS集成
2、OAuth2集成
3、SAML集成
4、WebSEAL集成
5、网关认证集成
6、域单点

本次我们讲如何通过代码的自定义方式实现接入第三方认证

操作路径:
  后台管理中心 > 集成中心 > 统一认证接入管理 > 认证接入管理 > 开启 > 认证方式 > 自定义

PC端认证、移动端认证根据业务场景开启


接入开发逻辑概述:⾃定义实现类接⼊第三⽅认证,类似⼆开的形式,⽬前E10⾃定义接⼊提供⼀下能⼒:
1、私有化单租户场景默认开启全资源拦截,系统级控制
2、私有化多租户场景⽀持团队级控制和系统级控制,⽀持全资源拦截动态配置(仅主团队)
3、⽀持⻚⾯动态配置⾃定义实现类

⾃定义接⼊说明
1、需要在E10的认证服务【weaver-intunifyauth-client-service】下部署你的二次开发逻辑jar文件
    登录运维平台搜索这个服务可以找到所在服务
2、创建⾃定义接⼝实现类
要求:
1、包路径(必须):com.weaver.intunifyauth.client.custom.service.impl.broadsync⽬录下创建
2、该类必须实现并重写接⼝:com.weaver.intunifyauth.client.custom.service.AuthclientCustomService的所有⽅法

接口方法介绍
==========================


描述1:⾃定义登录login接⼝
=================================================================================
⽅法名:Map<String,String>  login(HttpServletRequest request,HttpServletResponse response);
⼊参:
request:HttpServletRequest  客户端浏览器请求
response::HttpServletResponse  服务端响应

返回值Map:
redirectUrl:必填 | String类型 | 重定向地址 | 示例:map.put("redirectUrl","https://www.sso.com/ssologin" )
code:非必填 | String类型 | 异常错误码【900003 ⾃定义登录常,请检查】 | 示例:map.put("code","900003");
=================================================================================


描述2:获取⽤户信息接⼝
=================================================================================
⽅法名::Map<String,String> getUserInfo(HttpServletRequest request,HttpServletResponse response);
request:HttpServletRequest  客户端浏览器请求
response::HttpServletResponse  服务端响应

返回值Map:
accountType:必填 | String类型 | 账号映射规则序号 | 示例:map.put("accountType","6")
          账号规则对应关系:4:⼯号5:电⼦邮箱6:⼿机号码
username:必填 | String类型 | 登录账号 | 示例:map.put("username",13323708622);
langtype:非必填 | String类型 | ⽤户登录语⾔参数 | 示例:map.put("langtype","15" )
          语⾔参数:7:zh_CN简体中⽂ 9:zh_TW繁軆中⽂ 8:en_US英语
code:非必填 | String类型 | 异常错误码【900006 ⽤户信息接⼝异常,请检查】 | 示例:map.put("code","900003");
=================================================================================


描述3:⾃定义登出注销
=================================================================================
⽅法名::Map<String,String>  logout(HttpServletRequest request,HttpServletResponse response);
⼊参:
request:HttpServletRequest  客户端浏览器请求
response::HttpServletResponse  服务端响应

返回值Map:
logoutUrl:必填 | String类型 | 登出重定向地址 | 示例:map.put("logoutUrl","https://www.sso.com/ssologout" )
isLogout:必填 | String类型 | 是否跳转登出URL(0:不登出 1:登出) | 示例:map.put("isLogout","1" )
code:非必填 | String类型 | 异常错误码【900009⾃定义登出异常,请检查】 | 示例:map.put("code","900003");
=================================================================================


描述4:是否跳转第三⽅认证登录⻚
=================================================================================
⽅法名::Boolean isRedirectLogin();
接⼝返回Boolean:
true: 重定向跳转
false:不跳转第三⽅登录⻚,直接调⽤getUserInfo接⼝;
      (此种情况适⽤于请求资源路径带有ticket或授权码参数,已经获取到⽤户接⼝所必须参数,这种情况⽆需跳转登录接⼝验证,
          会直接跳转到获取⽤户信息接⼝,需要客户端重写接⼝实现)
=================================================================================


总结和注意事项
=================================================================================
注:以上接⼝中的四个⽅法必须全部实现,根据接⼝说明完成客户端⾃身业务逻辑
针对⾃定义login接⼝的实现,返回值url拼接的回调地址需跳转/papi/iaauthclient/bs/custom/getUserInfo
示例:
⽐如接⼊cas认证,认证登录回调地址需返回如下格式(不然你获取不到cas的登录用户信息):
https://xxxx.com/login?service=https://xxxx/papi/iaauthclient/bs/custom/getUserInfo
=================================================================================


⾃定义接⼊认证常见问题列表
=================================================================================
1.如何获取原始请求地址
    // 添加oa资源地址到cookie中,⽐如请求地址http://www.baidu.com/xxxx/xxxx
    Cookie oaCookie = new Cookie("oaaddress","http://www.baidu.com/xxxx/xxxx");
    response_.addCookie(oaCookie);
2.如何获取租户代码?
    //租户代码保存在cookie中
    Cookie tkCookie = new Cookie("tk",StandardSymmeric.encode(tk));
    response_.addCookie(tkCookie);
    // 租户值加解密⽅法,实现类需要cookie⾃取解密即可
    加密:StandardSymmeric.encode(tk)
    解密:StandardSymmeric.decode(tk)
3.访问OA跳转认证失败,⽆法登录如何处理?
    注意!!!全资源拦截⼀旦开启,认证过程中出现异常,跳转提示⻚⾯碰到登不出去的情况,临时两种⽅
    式解决:
    ⽅式1:可以通过执⾏papi/iaauthclient/bs/custom/config/delCache
    ⽅式2:访问当前域名加上?intunifyauth_client=freepass
4.login⽅法如何根据请求地址获取当前域?
    CustomCommonUtil.getRedirectLogin(request);
5.getUserInfo⽅法如何根据请求地址获取当前域?
    CustomCommonUtil.getRedirectUserInfo(request);
6.logout⽅法如何根据请求地址获取当前域?
    CustomCommonUtil.getRedirectLogout(request);
7.⾃定义实现类开发完成⽂件放在哪个服务下的包?
    需要放在weaver-intunifyauth-client服务下包com.weaver.intunifyauth.client.custom.service.impl路径下,然后重启服务
8.私有化单租户如何开启全资源拦截?
    私有化单租户默认开启全拦截配置,⻚⾯配置不显示
9.私有化多租户如何开启全资源拦截?
    私有化多租户只有主管理租户才可以显示配置全资源拦截开关
10.weaver-intunifyauth-client 1.7.0版本之前⽀持多地址吗?
    不⽀持,1.7.0(包含)之后⽀持,但是前提条件认证服务也⽀持多地址配置
    1.7.0版本之前⽀持系统默认地址跳转
11.如何查询系统默认地址?
    nacos平台搜索*weaver-common-cas-core*配置⽂件,此⽂件配置项地址就是系统默认地址
=================================================================================


系统默认提供的提示⻚⾯信息编码说明
=================================================================================
⾃定义接⼝接⼊认证过程中,如果⾃定义接⼝返回值异常或其他异常情况,将会跳转到提示⻚⾯。
以下列举可能出现的提示:
500:请求服务器失败,请联系管理员 系统错误
10001:登陆失败,请联系管理员passport登录失败
10003:账号信息不存在,请联系管理员user账号信息不存在
10004:⼈员信息不存在,请联系管理员employee⼈员信息不存在
70001:请求参数有误,请联系管理员集成登录请求参数缺失[tenantKey]
70002:请求参数有误,请联系管理员集成登录请求参数缺失[type]
70003:请求参数有误,请联系管理员集成登录请求参数缺失[value]
70004:集成登录请求code校验失败,请联系管理员集成登录请求code校验失败
80038:鉴权参数不完整,请求不合法鉴权参数不完整,请求不合法
80039:鉴权失败,鉴权信息有误鉴权失败,鉴权信息有误
900001:⾃定义登录返回值【Map】为空⾃定义登录返回值【Map】为空
900002:⾃定义登录返回参数【redirectUrl】为空⾃定义登录返回参数【redirectUrl】为空
900003:⾃定义登录异常,请检查⾃定义登录异常,请检查
900004:⽤户信息接⼝返回值【Map】为空⽤户信息接⼝返回值【Map】为空
900005:⽤户信息接⼝返回参数【username】为空⽤户信息接⼝返回参数【username】为空
900006:⽤户信息接⼝异常,请检查⽤户信息接⼝异常,请检查
900007:⾃定义登出返回值【Map】为空⾃定义登出返回值【Map】为空
900008:⾃定义登出返回参数【logoutUrl】为空⾃定义登出返回参数【logoutUrl】为空
900009:⾃定义登出异常,请检查⾃定义登出异常,请检
=================================================================================

详细可以参考下面的文档
=================================================================================

统一认证接入-接口自定义开发手册.PDF

作代码案列

package com.weaver.intunifyauth.client.custom.service.impl.broadsync;

import com.weaver.intunifyauth.client.custom.service.AuthclientCustomService;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

@Slf4j
public class SSOTest implements AuthclientCustomService {

    /**
     统⼀认证接⼊
     登录接⼝⾃定义实现     * @param request
     客户端浏览器请求     * @return Map<String,String>
     返回认证登录地址跳转
     */
    @Override
    public Map<String, String> login(HttpServletRequest request, HttpServletResponse response) {
        Map<String, String> result = new HashMap<>();
        //需要重定向的sso地址
        String url = "https://www.sso.com/ssologin";
        result.put("redirectUrl", url);
        return result;
    }
    /**
     统⼀认证接⼊
     ⽤户校验接⼝⾃定义实现     * @param request
     客户端浏览器请求     * @return  Map<String,String>
     返回 map 集合
     */
    @Override
    public Map<String, String> getUserInfo(HttpServletRequest request, HttpServletResponse response) {
        // 创建一个新的 Cookie 对象
        /*
        Cookie cookie = new Cookie("sso", "token");
        cookie.setPath("/");
        response.addCookie(cookie);*/

        //请根据第三方的要求实现用户获取逻辑

        String userName = "sso的用户标识";
        Map<String, String> result = new HashMap<>();
        //账号映射规则 账号规则对应关系:4:⼯号5:电⼦邮箱6:⼿机号码
        result.put("accountType", "4");
        result.put("username", userName);//登录账号(和OA一致)
        return result;
    }
    /**
     统⼀认证接⼊
     登出注销接⼝⾃定义实现     * @param request
     客户端浏览器请求     * @return Map<String,String>
     返回map集合
     重定向url地址     */
    @Override
    public Map<String, String> logout(HttpServletRequest request, HttpServletResponse response) {

        //登出之后需要实现你特定的业务代码

        // 清除 Cookie 信息
        /*
        // 创建一个新的 Cookie 对象,名称设置为要删除的 cookie 的名称
        Cookie cookieToDelete = new Cookie(cookie_name, "");
        // 设置 maxAge 为 0,这会导致浏览器删除这个 cookie
        cookieToDelete.setMaxAge(0);
        // 添加路径,确保 cookie 被删除
        cookieToDelete.setPath("/");
        // 将 cookie 添加到响应中,这会发送给客户端,客户端随后会删除这个 cookie
        response.addCookie(cookieToDelete);
        */

        Map<String, String> result = new HashMap<>();
        //登出之后需要重定向的sso地址
        String logoutUrl = "https://www.sso.com/ssologout";
        result.put("logoutUrl", logoutUrl);
        result.put("isLogout", "1");
        return result;
    }
    /**
     统⼀认证接⼊
     控制是否跳登录接⼝     * @return String
     重定向url地址
     */
    @Override
    public Boolean isRedirectLogin() {
        //true:重定向跳转;false:不跳转第三⽅登录⻚,直接调⽤ getUserInfo 接⼝;
        return true;
    }
}