内容脱敏处理

介绍如何调用内容审查接口进行数据脱敏处理。

内容审查接口中的数据脱敏字段用于检测用户上传或发送的内容中所包含的敏感信息，并将脱敏后的内容按照指定方式返回。

安全管理员为企业或组织制定了适当的脱敏策略后，调用API接口的操作人员仅需在其发送的内容审查请求中，添加sendBack字段，即可检测用户上传或发送内容中的敏感信息，并对检测到的敏感信息进行脱敏处理。关于脱敏策略的更多详细信息，请参考脱敏策略。

如无法检测用户上传或发送的内容，系统将返回具体的错误提示。

字段要求输入一个必选的type属性，表示返回文件的方式，Type属性支持以下选项：
API接口支持脱敏操作的文档类型包括：
  • Microsoft Word文档
  • Microsoft PowerPoint文档
  • Microsoft Excel文档
  • 纯文本文档
  • 等常见办公文档
限制： 截止当前系统版本，对邮件通道中的内容进行脱敏处理时，系统仅支持对邮件正文内容的正常脱敏返还，无法对邮件中包含的附件执行脱敏操作，并返还附件文件。

将脱敏后的内容返回至当前路径

在内容审查请求中增加如下字段，即可设置按照脱敏策略，对文件同时执行脱敏处理，并将脱敏后的内容返回至当前路径。

{
    "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
    ......
    "sendBack": {
        "type": "response"  # 将脱敏后的内容返回至当前路径
  },
   "redaction": {
        "enable": true  # 当enable的值为True时，该请求才生效。
  }
}

将脱敏后的内容发送至指定URL

在内容审查请求中增加如下字段，即可设置按照脱敏策略，对文件同时执行脱敏处理，并将脱敏后的文件上传到指定的文件服务器。
注： 脱敏策略的通道支持HTTPS。
{
    "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
    ......
   "sendBack": {
    "type": "httpUpload",
    "url": "http://172.11.11.6/callback"  # 将脱敏后的内容返发送至该url
  },
   "redaction": {
    "enable": true  # 当enable的值为True时，该请求才生效。
  }
}

将脱敏后的内容上传至s3

在内容审查请求中增加如下字段，即可设置按照脱敏策略，对文件同时执行脱敏处理，并将脱敏后的文件上传到s3对象存储的指定位置。

{
    "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
    ......
    "sendBack": {
        "type": "s3",
        "s3Bucket": "test",
        "s3Region": "", # 将脱敏后的文件上传到该位置。此处的值为使用s3时的region name，如果运行在EC2上并使用AWS IAM role，则以下三项可省略
        "accessKey": "aws_accessKey",
        "secretKey": "aws_secretKey",
        "endpointUrl": ""
  },
   "redaction": {
        "enable": true # 当enable的值为true时，该请求才生效
  }
}

将脱敏后的内容上传至swift

在内容审查请求中增加以下字段，即可设置按照脱敏策略，对文件同时执行脱敏处理，并将脱敏后的文件上传到swift对象存储的指定位置。

{
    "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
    ......
    "sendBack": {
        "type": "swift",
        "X-Auth-Token": "AUTH_tkbdac2a3474ee4d6396133c99cfd962c8",  # 使用swift时的认证token，如果提供的X-Auth-Token经验证有效，则以下三项可省略。
        "authUrl": "http://172.22.117.120:8080/auth/v1.0",
        "X-Auth-User": "test",
        "X-Auth-Key": "test",
        "objectUrl": "http://172.22.117.120:8080/auth/v1.0/AUTH_test/container1/1.txt",  # 将脱敏后的文件上传到swift对象存储的该对象URL位置。objectUrl与ContainterUrl二选一。
        "containerUrl": "", # 将脱敏后的文件上传到swift对象存储的该容器URL位置。objectUrl与ContainterUrl二选一。
    },
     "redaction":{
        "enable": true   # 当enable的值为True时，该请求才生效。
    }
}