需求背景

在很多的应用项目中，客户会采用Windows域登录认证平台，使用本扩展包后， Smartbi 也能使用Windows域账号密码进行验证。

使用说明

扩展包部署

扩展包：Smartbi_Special_ADAuth

详细说明请参考Wiki链接：扩展包部署

配置说明

1、获取ad.properties文件：ad.properties

2、打开ad.properties文件，修改参数。

配置文件中的参数如下：

3、启动Smartbi 系统后进入http://localhost:18080/smartbi/vision/config.jsp 配置界面

3.1、配置为ad.properties存放在服务器上的位置

3.2、修改"用户管理"配置段中的"加密类型"为CLASS，"登录验证类"请按需填写，具体如下图所示。

• LDAP：smartbi.usermanager.auth.impl.ADAuthentication
• LDAPS：smartbi.ext.adauth.auth.LDAPSAuthenication

4、配置完成后，点击右下角的"保存"按钮，根据提示再重启Smartbi 后，即可使用AD域用户的用户名和密码登录Smartbi。

注意事项

使用LDAPS证书配置

当在ad.properties中配置了security_protocol=ssl，在config.jsp中配置了LDAPS支持的登录验证类LDAPSAuthenication后，不设置相关证书会在登录时报错：

在已经获取到证书文件（.cer或.crt后缀的文件）后，通过命令行将证书导入到Java信任库

自行获取到目标服务器的证书文件

先备份Java的信任库cacerts，信任库位置：

$JAVA_HOME/jre/lib/security/cacerts

一般是

Smartbi/jdk/jre/ilb/security/cacerts

然后在上述证书所在的目录下进入cmd，使用keytool命令导入证书到Java的信任库中：

keytool -import -alias baseName -file server.crt -keystore $JAVA_HOME/jre/lib/security/cacerts

如：

keytool -import -alias 域名 -file 上述证书文件（包含后缀） -keystore $JAVA_HOME/jre/lib/security/cacerts

即：

keytool -import -alias baidu.com -file XXX.cer -keystore Smartbi/jdk/jre/lib/security/cacerts

即可实现导入证书，注意名字只能使用域名，不可自定义，否则在登录时会报会报如下错误：

至此证书导入Java信任库完成，即可正常登录。

附：

用这个命令查看已经导入到Java信任库中的证书，看看名字有没有改对

keytool -list -keystore $JAVA_HOME/jre/lib/security/cacerts

移除证书，通过指定别名来移除Java信任库中的证书

Keytool -delete -alias mycert -keystore $JAVA_HOME/jre/lib/security/cacerts

同步AD用户到Smartbi

场景：运维人员要提前对特定账户进行权限的设置（例如：领导），这时最好的方式是提前把AD域相关的用户全部同步到Smartbi上

配置：default_create_user = false

说明：扩展包支持使用计划任务，使用“全量”的形式同步AD用户到Smartbi。

自定义计划任务：

var paramMap = {

    //分页大小（一次查询用户信息条数），若小于等于0，则不分页，当为空时默认分页10

    pageSize : 800,

    //“用户名”应该使用的AD域属性字段

    usernameKey : "sAMAccountName",

    //“用户别名”应该使用的AD域属性字段

    userAliasKey : "displayName",

    //“用户描述”应该使用的AD域属性字段

    userDesKey : "mobile",

    //同步时的默认密码

    defaultPassword : "123456"

}

//以下内容不需要配置

var paramStr = JSON.stringify(paramMap);

connector.remoteInvoke("LDAPSAuthenicationModule", "synchronizeUser", [paramStr]);

在任务脚本中粘贴上述内容，脚本的参数参考注释。保存，然后测试运行。

同步过来时，对于禁用的用户，只是状态禁用，不会放置在上面提到的禁用组中。上面的禁用组只是针对于Smartbi中有但是AD中没有的用户的。对于没有部门的用户，将会默认保存在DEPARTMENT根组下。

白名单配置

场景一

场景：在一些大型的集团，AD域只是管理集团员工，而集团的外包团队其实是没有AD域账号的，那对于这些外包人员登录Smartbi，就需要通过白名单的设置来避开AD域的验证。

配置：配置项 white_show_setting = true

入口：在【运维设置】- 【系统选项】 - 【用户管理】中，会增加【AD账号白名单】选项，可以把不需要AD域验证的 ”用户“，添加到 ”AD账号白名单“ 中

场景二

场景：客户安全要求很高，不允许任何人可以通过白名单的方式登录（必须要走AD域验证）。当AD域宕机后，要保证Smartbi可以继续使用，就可以临时用SQL插入用户的方式，当AD域恢复后，直接用SQL把t_ext_ad_whiteinfo表的数据清空即可。

配置：white_show_setting = false

方式：通过SQL的方式来设置白名单

INSERT INTO t_ext_ad_whiteinfo (c_id, c_type, c_is_descend, c_extend) VALUES ("ADMIN", "USER", "0", "");

参考：使用该扩展包后，会在知识库中加一张物理表来记录相关的信息

t_ext_ad_whiteinfo（用于记录白名单的用户)

问题排查

若是配置后发现不能正常使用，可以通过下面方法来获取错误信息，以便定位到问题原因。

1、下载 testldap.jsp 文件，并根据实际情况进行修改，相关参数配置，请参考 参数配置

      其中域名的获取方法可见下图：

     

     

      异常访问的截图：

4、最后根据异常页面中的信息来判断哪里设置有误。