Skip to main content

SecAutoBan SDK

Project description

SecAutoBan Python SDK

安装

pip3 install SecAutoBan

样例

告警模块

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()

封禁模块

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 = []
    return ip_list

def check_exist_ip(ip) -> bool:
    return ip in get_all_block_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模块可选

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

secautoban-3.3.0.tar.gz (4.0 kB view details)

Uploaded Source

File details

Details for the file secautoban-3.3.0.tar.gz.

File metadata

  • Download URL: secautoban-3.3.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for secautoban-3.3.0.tar.gz
Algorithm Hash digest
SHA256 2c33a709f7fa04407e3f513b59134a54e765528f8e26fe3203ce499785adb3d2
MD5 0dd4181e6038eabd641ec3e4310c6679
BLAKE2b-256 dd49e32b4ffcdc3247a79ed1b9b5fed0a4842c357222dc1b6330252ee67c8d81

See more details on using hashes here.

Provenance

The following attestation bundles were made for secautoban-3.3.0.tar.gz:

Publisher: python_sdk.yml on SecAegis/SecAutoBan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page