Safeline Open Platform 服务器控制配置API详解

概述

Safeline Open Platform 提供了一套完善的服务器控制配置API，允许开发者获取和管理平台的各种安全配置选项。本文将详细介绍 /api/ServerControlledConfigAPI 接口的功能和使用方法，帮助开发者更好地理解和使用这些配置选项。

API基础信息

请求方式

• GET 请求

功能描述

该API用于获取服务器控制的配置详情，支持通过 ?type=xx 参数获取单项配置。

主要配置项解析

1. 攻击类型列表 (attack_type)

该列表定义了平台支持检测的所有攻击类型，每种攻击类型都有一个数值标识(value)和对应的英文描述(translation)。攻击类型包括但不限于：

• 常见Web攻击：SQL注入(0)、XSS(1)、CSRF(2)、SSRF(3)等
• 文件相关攻击：文件上传(10)、文件包含(11)、文件写入(24)等
• 权限相关攻击：弱权限(13)、未授权访问(15)、权限绕过(22)等
• 其他类型攻击：反序列化(6)、XXE(17)、LDAP注入(19)等

2. 策略规则攻击类型 (policy_rule_attack_type)

这是攻击类型的子集，专门用于策略规则配置。相比完整攻击类型列表，它包含的攻击类型较少，但涵盖了主要的Web安全威胁。

3. 用户权限列表 (user_permission_list)

该配置定义了平台中的用户权限体系，分为两大类：

通用权限 (General)

• 用户管理：管理用户信息、凭证和权限等
• 审计日志管理：查看审计日志

安全相关权限 (Security)

• 网站与安全策略管理：管理网站、安全策略、检测日志等
• 系统监控：查看CPU、内存、磁盘、网络等系统监控数据
• 系统管理：管理全局设置，如SMTP、LDAP、时间、许可证等

4. 告警类型列表 (alarm_type_list)

定义了平台支持的告警类型分类：

通用告警 (General)

• 账户安全
• 系统管理
• 系统监控与告警

安全相关告警 (Security)

• 网站管理
• 安全策略管理
• ACL管理
• 插件管理
• 请求日志转发

5. 检测模块配置 (detection_config)

这是最复杂的配置部分，包含了各个安全检测模块的具体配置选项。每个模块都有：

• 模块名称（中英文）
• 模块唯一标识(key)
• 具体配置项数组

主要检测模块示例

1. SQL注入检测模块 (m_sqli)

   • 可配置是否检测非注入型SQL攻击

2. XSS检测模块 (m_xss)

   • 可配置是否检测非注入型XSS攻击（如完整HTML文件）

3. 情报模块 (m_rule)

   • 可配置检测的信息泄露类型（测试文件、备份文件等）
   • 可配置是否结合response判断信息泄露

4. PHP代码注入检测模块 (m_php_code_injection)

   • 可配置是否检测上传文件中的PHP代码注入

使用建议

1. 获取完整配置：首次集成时建议获取完整配置，了解所有可用选项
2. 按需查询：后续可根据需要查询特定类型的配置，提高效率
3. 模块配置理解：仔细阅读各检测模块的配置说明，确保正确理解每个选项的作用
4. 默认值利用：大多数配置项都有合理的默认值，除非有特殊需求，否则可先使用默认值

最佳实践

1. 权限管理：根据实际需求分配用户权限，遵循最小权限原则
2. 告警配置：根据业务重要性配置适当的告警类型
3. 检测模块调优：根据业务特点调整检测模块参数，平衡安全性和性能
4. 定期检查：定期检查配置，确保与安全策略保持一致

总结

Safeline Open Platform 的服务器控制配置API提供了丰富的安全配置选项，通过合理使用这些配置，可以实现精细化的安全策略管理。开发者应充分理解各配置项的含义和作用，根据实际业务需求进行适当调整，以达到最佳的安全防护效果。