1. 简介

更新日期: 2024.06.30

文档在线查看地址: https://bbs.sangfor.com.cn/atrustdeveloper/pcsdk

1.1 PC端CSSDK介绍

aTrust CSSDK通过提供SDK接口库，PC端上第三方应用程序通过集成SDK接口库，在安装aTurst客户端的情况下， 通过SDK接口和aTrust客户端后台进程进行通信,在aTrust客户端和SDPC控制中心完成登录认证后，共享隧道接入能力。 整体结构图：

• 应用主体：主集成方，客户自身的办公平台，需要将aTrustSDK集成到其程序中。
• aTrustSDK：本质上是一个接口适配层，作用是和aTrust客户端后台核心服务进行建立https通信通道。统一封装了核心业务接口（认证登录、注销、隧道状态查询等）供外部调用，应用主体通过调用aTrustSDK中的接口函数，驱动aTrust客户端执行相关的业务流程，从而共享对应的aTrust安全接入、隧道代理等能力。
• aTrust客户端：承载具体的安全接入和隧道代理功能，CSSDK集成的场景，需要再PC上安装好aTrust客户端，一般由应用主体将aTrust客户端和应用主体打成一个安装包，静默安装aTrust客户端。

目前提供了两个版本安装包，供客户按需选择：

• Full安装包（推荐）：就是标准的aTrust客户端，安装之后有桌面快捷方式，右下角托盘、程序启动栏等UI功能，以及沙箱模块。

• Lite安装包：不带托盘UI及沙箱模块的标准客户端，隧道功能和标准客户端一致，但是安装之后无桌面快捷方式，无右下角托盘、无程序启动栏。由于不带托盘UI，因此UI相关的功能不支持，比如应用防护ACL弹窗（阻拦/提示/增强）、版本升级、用户超时注销提示等，另外诊断修复工具和沙箱功能也未包含。

1.2 CSSDK获取方式

aTrust客户端下载:

请于 下载地址 选择 aTrust客户端安装包 下载对应平台的aTrust客户端安装包

aTurstSDK集成库下载：

请于 下载地址 选择 aTrust SDK包 中的aTrust PC端 SDK集成包下载

1.3 典型集成流程

1.3.1 集成安装aTrust客户端

场景一：集成程序安装的时候一并安装aTrust客户端

此类场景用于集成程序必须要依赖aTrust一并使用的场景，安装集成程序的时候，无需判断当前aTrust客户端是否已经安装，将aTrust客户端随集成程序一并安装，后续aTrust客户端有更新，也可以随集成程序一并重新安装。

• 将aTurst客户端集成到应用程序安装包中
• 安装集成程序的时候静默安装aTrust客户端

场景二：集成程序打包aTrust客户端，在真正使用的时候按需安装

此类场景用于集成程序仅仅将aTrust作为一个工具进行按需使用，安装集成程序的时候只将aTrust客户端释放出来，在真正需要使用的时候再执行安装。

• 将aTurst客户端集成到应用程序安装包中
• 安装集成程序的时候仅将aTurst客户端释放到对应目录
• 在需要使用aTrust客户端的场景时，可以判断本地是否安装了aTrust客户端, 再按需安装。如何判断aTrust客户端是否安装

应用程序集成aTrust客户端安装包和静默安装的参数说明，见各个平台集成指南中的开发准备章节说明

1.3.2 集成aTrustSDK接口库

• 集成aTrustSDK进行认证登录可参考集成指南中的认证登录章节说明
• 认证成功之后此时隧道还并不能使用,aTrustSDK提供了两种方式方式来获取隧道状态。推荐使用方式二。 方式一：主动轮询的查询隧道状态 方式二：注册事件监听器响应隧道状态变化

1.3.3 卸载aTrust客户端

• 卸载应用程序的时候调用aTrust客户端的卸载程序进行静默卸载

1.4 平台支持情况

1.5 功能概述

1.5.1 支持的功能:

主认证方式:

• 用户名密码认证:

  用户登录上线成功之后，即可以使用aTrust隧道服务，使用浏览器等访问相关资源。

辅助认证方式:

• 短信辅助认证:

  管理员可以配置短信辅认证，用户在完成密码认证后要求短信认证成功后才能成功上线。

• Radius认证:

  管理员可以配置Radius辅认证，用户在完成密码认证后要求Radius认证成功后才能成功上线。

• TOTP令牌认证:

  管理员可以配置TOTP令牌认证，用户在完成密码认证后要求TOTP认证成功后才能上线，注意当前SDK支持TOTP认证，绑定流程需要在浏览器上完成

详细功能接口请查看 接口和相关流程说明 所述。

1.5.2 不支持的功能

主认证方式:

• 短信主认证:

  不支持短信主认证, 只支持 短信辅认证

• 证书/KEY认证:

  通过提供证书或者KEY文件来进行相关校验认证，暂不支持该功能。

其他:

• 图形校验码验证:

  通过图形校验码（例如数字，字母）进行验证，需要依赖工作台显示图形校验码，暂不支持该功能。

• SPA一人一码:

  需要依赖aTrust工作台设置安全码，暂未提供相关接口调用。

1.5.3 集成Lite安装包功能差异

选择Full安装包进行集成和Lite安装包集成，也会在功能上存在一定的差异。主要原因是Lite客户端未包含客户端UI模块和沙箱模块，对应的功能项将会存在影响。