Private Cloud AUTH

1.1 版本

1.1 应用场景

客户的 FineBI 服务器是部署在虚拟机上或者云平台上的，FineBI 服务器的物理信息不固定，这样就没有办法绑定固定的机器信息，所以本地机器信息认证不再适用。

这时，需要找一台物理信息固定的服务器作为授权服务器，然后把授权服务器的机器信息 rif 文件发给商务，生成私有云认证服务器文件FanruanLicenseServer，里面包含一个server.exe文件。

1.2 功能简介

FineBI 服务器物理信息不固定无法进行本地机器认证时，若有一台物理信息固定的服务器，可进行私有云认证。

授权服务器（license Server 端）将这个授权的功能点、授权访问域名、授权访问端口、授权访问应用名、授权访问截止日期等信息返回给 FineBI 服务器（Report Server 端）。

FineBI 服务器（Report Server 端）做校验，如果校验通过，就进入正常的访问程序，如果不通过，则作为未授权服务器。如下图所示：

授权服务器程序是指的是提供授权功能的那个服务器程序（需提供物理信息）， FineBI 服务器是指运行 FineBI 工程的某台服务器（无需提供物理信息）。

1.3 注意事项

1）私有云认证的授权服务器，需要是一台固定物理信息的机器。FineBI 工程服务器所在机器不需要有固定不变的物理信息。

     例如虚拟机环境下物理信息可能变化，造成注册失败，不适合被用作授权服务器。

2）FineBI 服务器即需注册的 FineBI 工程所在服务器，需要跟授权服务器网络互通。

3）一个授权服务器不允许运行两个私有云认证程序。

4）授权服务器运行的认证程序不可关闭超过 24 小时。

• 若关闭时长超过 24 小时，需重新运行认证程序，报表服务器需要重新进行注册操作。

• 若关闭时长小于 24 小时，报表服务器显示注册失败，在 2 小时内将自动重新连接上授权服务器，注册不失效。

5）认证服务器卸载后，如需再次采用此机器作为授权服务器，需重新生成 MachineInfo.rif 文件发送给商务重新注册。

6）在授权个数允许的范围内，一个授权服务器可以给多个 FineBI 服务器授权。

7）集群情况下使用私有云认证，无需每个节点都发送注册信息到商务。

8） FineBI 服务器迁移时，不需要重新申请授权文件，只需保证 FineBI 服务器所在的机器和授权服务器的网络可以连通即可。

9）Linux 情况下支持 i386、arm 和 amd64 位系统 。

10）不支持通过nat访问私有云。

2.1 下载 machine 工具

点击下载 machine 工具，用于获取授权服务器信息文件：Windows.zip

将压缩包上传至授权服务器，并解压。

2.2 导出授权服务器信息

以管理员权限运行解压生成的 machine.exe 文件，在同目录下自动生成 require 文件夹。

require 文件夹下的 MachineInfo.rif 文件，即为导出的授权服务器信息文件。如下图所示：

2.3 获取授权文件

请使用合同中指定的邮箱发送注册信息给 FineBI 商务business@fanruan.com，邮件格式如下： 

商务收到邮件，核实无误后会生成授权文件FanruanLicenseServer.zip，以邮件方式发送给用户。

邮件内容如下表所示：

2.4 启动授权服务器

在授权服务器上，解压商务发送的授权文件压缩包 FanruanLicenseServer.zip。

以管理员权限运行 bin 目录下的 server.exe 文件。如下图所示：

注1：若启动失败，报错的原因是端口被占用，那么使用命令行启动程序的时候，后面加参数-port 端口指定另外端口。

       示例：.server.exe -port 8088

注2：2021-10-13 及之后获取的 server.exe 文件，支持启动认证服务器的时候指定语言，默认简体中文，额外提供英文。

       启动命令示例：.server.exe -port 8088 -language en

2.5 设置服务开机自启动

授权服务器上的运行的可执行文件不能关闭，即 Windows下server.exe不能关闭。如果 Server 关掉，重新打开是未注册的，需要重新操作一次。

下载 SrvanyUI 服务管理工具：SrvanyUI_1.0.rar，解压后，运行SrvanyUI_1.0.exe文件并安装 SrvanyUI。

打开 SrvanyUI 软件，选择「文件>增加」，新增「自建服务」。

服务名称为「私有云授权服务器」，内部标识为「PrivateServer」，程序路径选择上文的\FanruanLicenseServer\bin\server.exe文件，启动方式为「自动」。

如下图所示：

点击确定运行即可，如下图所示：

注：设置成功后，服务会开机自启，若需要更换私有云，需要先把之前的停止。

2.6 BI 服务器验证授权

FineBI 工程部署在 FineBI 服务器上，管理员登录数据决策系统，点击「管理系统>注册信息>版本信息」，点击「立即注册」。

认证方式选择「私有云认证」，服务器地址填写上面授权服务器显示的 IP 和监听端口，例如https://172.16.63.131:8081，点击「提交认证」，如下图所示：

注1：若提供了授权服务器域名，则填写授权服务器域名，若未提供授权服务器域名，则填写 IP 。

注2：请确保 FineBI 服务器可以访问授权服务器。

认证成功后，如下图所示：

注1：这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。

注2：若认证失败，检查防火墙设置，开放对应端口或者关闭防火墙。

3.1 下载 machine 工具

点击下载 machine 工具，用于获取授权服务器信息文件：

注：一般情况下，64 位的 Linux 用 amd64，32 位的 Linux 用 i386。

      极少情况下（当物理机器使用的是 RISC 精简指令集，低功耗 CPU）才使用 arm，具体跟使用硬件有关。

3.2 导出授权服务器信息

注：本节操作必须要使用管理员账号进行，否则会导致启动授权程序报错，机器码不匹配。

以 Linux_amd64 为例：

将压缩包上传至授权服务器，解压生成 machine.exe 文件：

unzip linux_amd64.zip

为 machine.exe 文件添加权限：

chmod 777 machine

运行 machine.exe 文件，自动生成授权服务器信息文件，即 require 目录下的 MachineInfo.rif 文件：

./machine

3.3 获取授权文件

请使用合同中指定的邮箱发送注册信息给 FineBI 商务business@fanruan.com，邮件格式如下： 

商务收到邮件，核实无误后会生成授权文件FanruanLicenseServer.zip，以邮件方式发送给用户。

邮件内容如下表所示：

3.4 启动授权服务器

注：如果是工具连接（xshell），在使用 nohup ./bin/server &命令行后，使用 exit 退出登录。

      重新登录后可使用 ps -ef|grep server 命令查看是否运行在后台，若成功运行则表示私有云后台启动成功，只要服务器不关机则会一直运行 。

1）在授权服务器上，解压商务发送的授权文件压缩包 FanruanLicenseServer.zip

unzip FanruanLicenseServer.zi

2）解压完成后，以管理员权限运行 bin 目录下的 server

nohup ./server &

注：2021-10-13 及之后获取的 server.exe 文件，支持启动认证服务器的时候指定语言，默认简体中文，额外提供英文。

       启动命令示例：./server -language en

3）启动认证服务器成功，如下图所示：

3.5 BI 服务器验证授权

FineBI 工程部署在 FineBI 服务器上，管理员登录数据决策系统，点击「管理系统>注册信息>版本信息」，点击「立即注册」。

认证方式选择「私有云认证」，服务器地址填写上面授权服务器显示的 IP 和监听端口，例如https://172.16.63.131:8081，点击「提交认证」，如下图所示：

注1：若提供了授权服务器域名，则填写授权服务器域名，若未提供授权服务器域名，则填写 IP 。

注2：请确保 FineBI 服务器可以访问授权服务器。

认证成功后，如下图所示：

注1：这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。

注2：若认证失败，检查防火墙设置，开放对应端口或者关闭防火墙。

4.1 下载 machine 工具

点击下载 machine 工具，用于获取授权服务器信息文件：Mac.zip

4.2 导出授权服务器信息

将压缩包上传至授权服务器，解压生成 machine.exe 文件：

unzip Mac.zip

为 machine.exe 文件添加权限：

chmod 777 machine

运行 machine.exe 文件，自动生成授权服务器信息文件，即 require 目录下的 MachineInfo.rif 文件：

./machine

4.3 获取授权文件

请使用合同中指定的邮箱发送注册信息给 FineBI 商务business@fanruan.com，邮件格式如下： 

商务收到邮件，核实无误后会生成授权文件FanruanLicenseServer.zip，以邮件方式发送给用户。

邮件内容如下表所示：

4.4 启动授权服务器

注：授权服务器上运行的可执行文件不要关闭，即 Mac 下 server 不能关闭。

在授权服务器上，解压商务发送的授权文件压缩包 FanruanLicenseServer.zip。

以管理员权限运行 bin 目录下的 server ，如下图所示：

注：2021-10-13 及之后获取的 server.exe 文件，支持启动认证服务器的时候指定语言，默认简体中文，额外提供英文。

       启动命令示例：./server -language en

4.5 BI 服务器验证授权

FineBI 工程部署在 FineBI 服务器上，管理员登录数据决策系统，点击「管理系统>注册信息>版本信息」，点击「立即注册」。

认证方式选择「私有云认证」，服务器地址填写上面授权服务器显示的 IP 和监听端口，例如https://172.16.63.131:8081，点击「提交认证」，如下图所示：

注1：若提供了授权服务器域名，则填写授权服务器域名，若未提供授权服务器域名，则填写 IP 。

注2：请确保 FineBI 服务器可以访问授权服务器。

认证成功后，如下图所示：

注1：这里的最大连接数表示同时能有几个工程向授权服务器申请授权注册。

注2：若认证失败，检查防火墙设置，开放对应端口或者关闭防火墙。

5.1 现象描述

若注册失败，页面将出现提示弹窗，如下图所示：

5.2 失败原因

点击详细信息即可查看注册失败的原因，根据具体失败原因进行排查。

注：除上述外失败原因外，其他统一报错：证书内容不正确。

       有多个失败原因时，平台中会全部显示出来。

6.1 销毁授权

首先，销毁当前认证服务器。以管理员身份进入 bin 目录，再运行。

6.1.1 Windows

在 Windows 中，打开 cmd，切换到 bin 目录下，运行命令如下所示：

.\server.exe -destroy

如下图所示：

6.1.2 Mac 和 Linux

在 Mac 和 Linux中，运行命令如下所示：

./server -destroy

如下图所示：

6.2 获得销毁证据文件

执行销毁命令后，会销毁当前的服务器认证许可，并生成一个销毁信息的证据文件，如下图所示：

注：在 Windows 中，有时候会报错，得在与 bin 同级目录建一个叫 uninstall 的文件夹，卸载文件会在这个文件夹里面出现。

6.3 重新注册

客户通过邮件发送给商务下面两个文件：

receipt.fr 文件和按照申请认证服务器的步骤，重新生成MachineInfo.rif文件。

商务收到receipt.fr文件，验证完成确认销毁后，再给客户发送新的认证服务器文件。

注：销毁授权服务器后，若重启 FineBI 服务器则立即注册失败；若未重启 FineBI 服务器则在约 24 小时后注册失败。