接口说明
数据安全模块本身并不关心数据是存在哪里的,只提供保存和获取加密和脱敏的配置,以及将输入的数据按照我们接口约定的格式应用加密和脱敏规则以后返回。应该主要包括以下几个接口
1.获取表的脱敏设置接口
2.获取字段的脱敏设置接口
3.获取表的加密设置接口
4.获取字段的加密设置接口
5.获取表的混合设置
6.获取字段的混合设置
7.数据加密接口
8.数据脱敏接口
9.数据解密接口(对通过接口进行加密的数据可以解密)
外部接口
接口改动:接口现在增加了状态码和返回信息,返回数据结构部分不变动,返回结构如下:{"status":200,"msg":"接口调用正常!","data":[XXX]};
获取表的脱敏设置
获取表的脱敏设置 | ||
接口地址 | http://localhost:8080/edsc/api/gettablemaskoption.do?secsytemid={secsystemid}&datasetid={datasetid} | |
接口描述 | 获取安全数据源下某个表/视图的脱敏字段设置 | |
接口请求方式 | Get | |
参数说明 | secsystemid是安全数据源的地方配置的安全数据源唯一标识 datasetid是表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名 | |
接口参数格式 | secsytemid={secsystemid}&datasetid={datasetid} | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | fieldname:字段名 maskoption:脱敏设置 rulename:脱敏规则英文 rulecaption:规则中文描述 filter:脱敏条件 filtertype:脱敏条件类型 |
获取字段的脱敏设置
获取字段的脱敏设置 | ||
接口地址 | http://localhost:8080/edsc/api/getfieldmaskoption.do?secsytemid={secsystemid}&datasetid={datasetid}&field={fieldname} | |
接口描述 | 获取安全数据源下表的某个字段的脱敏设置 | |
接口请求方式 | Get | |
参数说明 | secsystemid是安全数据源的地方配置的安全数据源唯一标识 datasetid是表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名。 field:字段名 | |
接口参数格式 | secsytemid={secsystemid}&datasetid={datasetid}&field={fieldname} | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | fieldname:字段名 maskoption:脱敏设置 rulename:脱敏规则英文 rulecaption:规则中文描述 filter:脱敏条件 filtertype:脱敏条件类型 |
获取表的加密设置
获取表的加密设置 | ||
接口地址 | http://localhost:8080/edsc/api/gettableencryptoption.do?secsytemid={secsystemid}&datasetid={datasetid} | |
接口描述 | 获取安全数据源下某个表/视图的加密字段设置 | |
接口请求方式 | Get | |
参数说明 | secsystemid是安全数据源的地方配置的安全数据源唯一标识 datasetid是表的id,是表/视图在secsystemid中的唯一名称,这个值在设置加密字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名 | |
接口参数格式 | secsytemid={secsystemid}&datasetid={datasetid} | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | fieldname:字段名 encryptoption:加设置 method:加密算法 filter:加密条件 filtertype:加密条件类型 |
获取字段的加密设置
获取字段的加密设置 | ||
接口地址 | http://localhost:8080/edsc/api/getfieldencryptoption.do?secsytemid={secsystemid}&datasetid={datasetid}&field={fieldname} | |
接口描述 | 获取安全数据源下表的某个字段的加密设置 | |
接口请求方式 | Get | |
参数说明 | secsystemid是安全数据源的地方配置的安全数据源唯一标识 datasetid是表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名。 field:字段名 | |
接口参数格式 | secsytemid={secsystemid}&datasetid={datasetid}&field={fieldname} | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | fieldname:字段名 encryptoption:加设置 method:加密算法 filter:加密条件 filtertype:加密条件类型 |
获取表的混合设置接口
获取表的混合设置 | ||
接口地址 | http://localhost:8080/edsc/api/gettablemixoption.do?secsytemid={secsystemid}&datasetid={datasetid} | |
接口描述 | 获取安全数据源下某个表/视图的加密和脱敏设置 | |
接口请求方式 | Get | |
参数说明 | secsystemid是安全数据源的地方配置的安全数据源唯一标识 datasetid是表的id,是表/视图在secsystemid中的唯一名称,这个值在设置加密字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名 | |
接口参数格式 | secsytemid={secsystemid}&datasetid={datasetid} | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | fieldname:字段名 encryptoption:加密设置 method:加密算法 filter:加密条件 filtertype:加密条件类型 maskoption:脱敏设置 rulename:脱敏规则英文 rulecaption:规则中文描述 filter:脱敏条件 filtertype:脱敏条件类型 |
获取字段的混合设置接口
获取字段的混合设置 | ||
接口地址 | http://localhost:8080/edsc/api/getfieldmixoption.do?secsytemid={secsystemid}&datasetid={datasetid}&field={fieldname} | |
接口描述 | 获取安全数据源下表的某个字段的加密设置 | |
接口请求方式 | Get | |
参数说明 | secsystemid是安全数据源的地方配置的安全数据源唯一标识 datasetid:表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名。 field:字段名 | |
接口参数格式 | secsytemid={secsystemid}&datasetid={datasetid}&field={fieldname} | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | fieldname:字段名 encryptoption:加设置 method:加密算法 filter:加密条件 filtertype:加密条件类型 maskoption:脱敏设置 rulename:脱敏规则英文 rulecaption:规则中文描述 filter:脱敏条件 filtertype:脱敏条件类型 |
数据加密接口
数据加密接口 | ||
接口地址 | ||
接口描述 | 数据加密 | |
接口请求方式 | POST | |
接口参数格式 |
| |
参数说明 | loginid:当前调用数据加密接口的人,根据其身份判断是否满足加密条件决定是否需要加密 secsystemid:安全数据源唯一标识 datasetid:表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名。 data:待加密数据数组 | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | loginid:传入的loginid secsystemid:传入的安全数据源唯一标识 datasetid:传入的datasetid resultid:每一次加都会生成一个uuid,并记录日志,日志同时记录这一次加密时各个加密算法的秘钥,以及各个字段使用的加密方式。以便用于后面的解密。 timestamp:执行加密时的时间戳 costtime:执行加密耗费的时间 data:数据加密以后的数据 |
数据解密接口
数据加密接口 | ||
接口地址 | ||
接口描述 | 数据解密 | |
接口请求方式 | POST | |
接口参数格式 |
| |
参数说明 | loginid:当前调用数据加密接口的人,用于记录日志 secsystemid:安全数据源唯一标识 datasetid:表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名。 secsystemid:传入的安全数据源唯一标识 resultid:对这条数进行加密时返回的resultid。 data:加密的数据 | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | loginid:传入的loginid secsystemid:传入的安全数据源唯一标识 dataset:传入的datasetid timestamp:执行解密时的时间戳 costtime:执行解密耗费的时间 data:解密以后的数据 |
数据脱敏接口
数据加密接口 | ||
接口地址 | ||
接口描述 | 数据脱敏 | |
接口请求方式 | POST | |
接口参数格式 |
| |
参数说明 | loginid:当前调用数据脱敏接口的人,根据其身份判断是否满足脱敏条件决定是否需要脱敏 secsystemid:安全数据源唯一标识 datasetid:表的id,是表/视图在secsystemid中的唯一名称,这个值在设置脱敏字段的时候由具体的安全数据源实现的获取表/视图的接口,譬如对元数据来说,就是Schema.表名。 data:待脱敏数据数组 | |
接口返回值格式 | JSON | |
接口返回值样例 |
| |
接口返回值说明 | loginid:传入的loginid secsystemid:传入的安全数据源唯一标识 dataset:传入的datasetid timestamp:执行加密时的时间戳 costtime:执行加密耗费的时间 data:数据脱敏以后的数据 |
请先登录