Skip to content

Python SDK

安装

Shell
pip3 install SecAutoBan

样例

告警模块

Python
from SecAutoBan import SecAutoBan

def alarm_analysis(ws_client):
    ws_client.send_alarm("127.1.0.3", "127.0.0.1", "NMAP 扫描")

sec_auto_ban = SecAutoBan(
    server_ip="127.0.0.1",
    server_port=8000,
    sk="sk-*****",
    client_type="alarm",
    alarm_analysis = alarm_analysis
)
sec_auto_ban.run()

封禁模块

Python
from SecAutoBan import SecAutoBan

def block_ip(ip):
    if check_exist_ip(ip):
        return
    pass # 具体封禁代码

def unblock_ip(ip):
    pass # 具体解封代码

def get_all_block_ip() -> list:
    ip_list = [] # 具体获取防火墙全部封禁IP代码
    return ip_list

def check_exist_ip(ip) -> bool:
    return ip in get_all_block_ip() # 获取防火墙对传入IP是否封禁代码

sec_auto_ban = SecAutoBan(
    server_ip="127.0.0.1",
    server_port=8000,
    sk="sk-*****",
    client_type="block",
    block_ip = block_ip,
    unblock_ip = unblock_ip,
    get_all_block_ip= get_all_block_ip,
    enable_cidr=False
)
sec_auto_ban.run()

参数说明

参数描述是否需要填写
server_ip核心模块回连IP需要
server_port核心模块回连端口需要
sk设备页面生成的密钥需要
client_type模块类型(alarm/block)需要
enable_cidr封禁模块是否开启 Cidr 封禁,若开启block_ip()unblock_ip()参数将传入Cidr可选,默认为 False
alarm_analysis告警分析函数alarm模块必填
block_ip封禁函数block模块必填
unblock_ip解禁函数block模块必填
get_all_block_ip获取设备中全部封禁IP函数block模块可选