1. 概述

1.1. 功能介绍

用于第三方系统集成Smartbi中单点登录加密传输用户信息，安全系数更高，不会暴露用户的真实密码。

1.2. 原理

第三方系统使用密钥对用户登录信息进行AES或DES加密来形成token，当客户端发起的请求携带有令牌登录参数以及目标跳转地址时，Smartbi服务器拦截到请求后，对token信息进行解析和校验，如果成功解析出用户信息并校验成功，则将用户设置为登录状态，再重定向到对应地址，后续访问其他地址无须重新登录。可用于第三方系统集成Smartbi中单点登录加密传输用户信息，安全系数更高，不会暴露用户的真实密码。

1.3. 名词释义

token：token是客户端使用密钥加密用户登录信息形成的一串字符串，以作客户端进行请求的一个令牌。

2. 功能详解

2.1. 令牌登录配置

访问Smartbi的Config配置界面 (地址为 http://IP:PORT/smartbi/vision/config.jsp)，配置令牌登录的信息：密钥、超时时间等

配置项说明
密钥

用来解密token信息。客户端需要用密钥来进行加密用户信息。密钥为默认空，表示不支持令牌登录这种方式。

密钥由用户自定义输入8位或16位字符串，后续生成令牌信息时需要使用相同的密钥

密钥要求：密钥长度固定为8位(DES)或16位(AES)。


令牌超时时间

token有效时间。当【服务器解析请求时间戳 - token的生成的时间戳 > 超时设置 】成立时，则代表token已超时，不能进行登录；

需要校验密码

设置token中是否要包含密码，使用密码来进行登录。

  • 勾选 是 ，则在校验token信息时，解析出密码，再使用账号密码登录；
  • 勾选 否 ，则直接将用户设置为登录状态。

2.2. 生成令牌Token

使用   smartbi-CryptoUtil.jar  的工具类的encrypt方法加密token获得令牌，提供2种不同的加密算法；产品会基于加密串的特征使用不同的解密算法。

  • AES-GCM加密：smartbi.crypto.CryptoUtil.encrypt(token, 密钥)。
  • DES加密：CryptoUtil.encrypt(AlgorithmType.DES, token, 密钥)。

参考示例：

//生成token
  String secretKey = "12345678";// 密钥
  Long timestamp =  new java.util.Date().getTime();// 必需是毫秒数的时间戳
  String userName = "admin";// 用户名
  String password = "admin";// 用户密码（可选）

  //token为json格式	
  String token = "{\"username\":\"" + userName + "\",\"password\":\"" + password + "\",\"timestamp\":" + timestamp + "}";
  String encryptedToken = null;
  try {
    encryptedToken = CryptoUtil.encrypt(token, secretKey);
	//如果选择使用使用des加密，使用接口： CryptoUtil.encrypt(AlgorithmType.DES,token, secretKey);
  } catch(Exception e) {
    //
  }

2.3. 使用token登录

通过连接后加参数的方式传递：http://ip:port/smartbi/vision/loginByToken?smartbiToken=上一个章节生成的encryptedToken &targetPath=目标跳转链接及其参数

链接格式解析

作用

ip:port

Smartbi系统服务器地址及端口

smartbiToken 

2.2章节生成的令牌token。

注意：token信息需要做encode转换，避免token中存在特殊字符导致令牌解密失败。

  • 在js代码中可使用encodeURIComponent转义，
  • java代码中可使用URLEncoder.encode("密文", "UTF-8") 转移


targetPath

目标跳转界面，当token校验结束后，直接重定向到该地址，只接受相对路径。

若该参数值含有特殊符号，需要特殊处理，例如在js代码需要使用encodeURIComponent转义，java代码则需要URLEncoder.encode("密文", "UTF-8")


可选值描述附带其它参数示例
index.jspWeb端首页无
openresource.jsp打开资源resid（资源id）targetPath=openresource.jsp?resid=I2c94ea86298cbe6c01298cfd9ba900fa
openmodule.jsp打开模块id，id的可选值参考：打开Smartbi模块targetPath=openmodule.jsp?id=Analysis&showbanner=false
createresource.jsp创建资源restype，可选值参考：新建Smartbi资源targetPath=createresource.jsp?restype=VISUAL
mobileX/index移动端首页无targetPath=mobileX/index
mobileX/report打开移动端报表resid（资源id）targetPath=mobileX/report?resid=I2c94ea86298cbe6c01298cfd9ba900fa

















4. 示例

web项目使用令牌登录集成Smartbi：使用令牌登录示例.zip

注：该示例只对V11版本2023-10-19之后打包的日期才有效，之前的版本可以沿用V10的示例