Safeline Open Platform ACL规则管理API详解

概述

Safeline Open Platform提供了一套完整的ACL（访问控制列表）规则管理API，允许开发者通过编程方式实现对网络访问的控制和管理。本文将详细介绍这些API的功能和使用方法。

ACL规则基础

ACL规则是网络安全中常见的访问控制机制，用于定义哪些IP地址、会话或特定请求可以访问资源，以及访问的频率限制等。Safeline Open Platform的ACL规则支持以下核心功能：

1. 基于IP地址或会话的访问控制
2. 基于域名的访问控制
3. 基于URL路径的访问控制
4. 访问频率限制
5. 规则过期时间设置

API接口详解

1. 获取ACL规则列表

接口：GET /api/v1/acl_rule

此接口用于获取当前配置的所有ACL规则，支持分页参数。

响应示例：

{
    "err": null,
    "msg": "",
    "data": []
}

2. 创建ACL规则

接口：POST /api/v1/acl_rule

创建新的ACL规则，支持多种配置选项。

请求参数说明

字段名	类型	必填	说明
expire_time	浮点数	否	绝对过期时间戳
expire_after	整数	否	相对过期时间(秒)
domain	字符串	否	域名限制
urlpath	字符串	否	URL路径限制
urlpath_match_method	枚举	否	路径匹配方式('str'或'prefix')
action	枚举	是	动作类型('forbid'或'limit_rate')
limit_rate_period	整数	否	限流周期(秒)
limit_rate_limit	整数	否	限流次数
comment	字符串	否	规则备注
cidr_list	列表	否	IP地址列表
session_list	列表	否	会话列表
on_duplicate	枚举	否	重复规则处理方式('skip'或'error')
status	枚举	否	规则状态('enabled'或'disabled')
forbid_type	枚举	否	禁止类型('cidr'或'session')

典型使用场景

1. 基础IP禁止规则

{
    "cidr_list": ["1.2.3.4"],
    "action": "forbid",
    "comment": "禁止特定IP访问"
}

2. 域名+路径限制

{
    "cidr_list": ["1.2.3.5"],
    "action": "forbid",
    "domain": "example.com",
    "urlpath": "/admin",
    "urlpath_match_method": "prefix"
}

3. 频率限制规则

{
    "cidr_list": ["1.2.3.6"],
    "action": "limit_rate",
    "limit_rate_period": 60,
    "limit_rate_limit": 100,
    "comment": "每分钟最多100次请求"
}

4. 会话控制规则

{
    "session_list": ["malicious_session"],
    "action": "forbid",
    "forbid_type": "session"
}

3. 修改ACL规则

接口：PUT /api/v1/acl_rule

修改现有ACL规则，参数与创建接口类似，但需要指定规则ID。

4. 禁用ACL规则

接口：POST /api/v1/acl_rule/disable

临时禁用指定的ACL规则而不删除。

5. 删除ACL规则

接口：POST /api/v1/acl_rule/delete

永久删除指定的ACL规则。

数据分析功能

Safeline Open Platform还提供了ACL规则相关的数据分析接口：

1. Top IP Session分析

   • 接口：GET /api/v1/acl/analyze/top_ip_session
   • 功能：获取会话最多的IP地址统计

2. 自定义数据分析

   • 接口：GET /api/v1/acl/analyze
   • 支持按IP、域名、URL路径等维度分组分析
   • 支持按时间范围筛选
   • 支持多种排序方式

最佳实践

1. 合理设置过期时间：对于临时规则，建议设置expire_after而非expire_time，避免时间同步问题。

2. 路径匹配选择：

   • 'str'：精确匹配URL路径
   • 'prefix'：前缀匹配，适用于目录限制

3. 处理重复规则：

   • 默认行为是报错(on_duplicate='error')
   • 可设置为'skip'跳过重复项

4. 白名单冲突处理：系统会自动检测并阻止与白名单冲突的规则创建。

5. 性能考虑：对于高频访问的路径，建议使用更精确的匹配条件减少规则检查开销。

总结

Safeline Open Platform的ACL规则管理API提供了灵活而强大的访问控制能力，通过合理的规则配置，可以有效保护Web应用免受异常访问和网络攻击。开发者可以根据实际需求组合不同的限制条件，构建多层次的防护体系。