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-4.0.2.tar.gz (4.1 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for secautoban-4.0.2.tar.gz
Algorithm Hash digest
SHA256 9ea3a7cfe5ef3c77b25097308fa829024bce4a0644f54dbc199b08c1105630ef
MD5 3cb720212a4fc32951451f9da31e3243
BLAKE2b-256 ea90183c9af77e397ab9039c37028ab6adeb2ab93e1b997f0c1dc030fdc77552

See more details on using hashes here.

Provenance

The following attestation bundles were made for secautoban-4.0.2.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