【架构与设计】安全设备联动服务设计方案

原创 已于 2024-04-10 15:34:23 修改 · 1.1k 阅读 · 18 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #架构

于 2024-04-10 15:30:04 首次发布
本文详细描述了一种安全设备联动服务的设计方案，包括技术选型（Java、MySQL、Redis、Ansible），数据模型的关键用例，组件图、活动图以及与业务模块的交互分析。还介绍了接口设计，如获取能力列表、执行设备能力等，以及MQ消息结构的设计。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

【架构与设计】安全设备联动服务设计方案

背景

对于资源库、资产库、情报库、威胁库等其他业务模块，需要与技防设备进行联动的场景；各业务分别描述自己的联动需求，统一由联动服务来创建联动剧本、剧本编排、剧本执行，由联动服务来直接对接技防设备；各自业务只需要关注模块业务，不需要关注设备交互方式。

技术选型

编程语言
java

关系型数据库
MySQL 存储联动剧本/联动能力执行结果

缓存
redis 存储联动模板文件

剧本编排与执行工具
ansible

数据模型设计

在这里插入图片描述

关键用例

在这里插入图片描述

组件图

在这里插入图片描述

活动图

在这里插入图片描述

联动引擎与业务模块交互分析图

在这里插入图片描述

模板抽象设计

联动能力模板

device_linkage_abilities:
    - ability_code: blacklist
      ability_name: 黑名单
        # 能力共同参数
      params:
          - key: product_code
            type: string
          - key: device_ip
            type: string
          - key: device_port
            type: string
          - key: target
            type: string
      support_devices:
          # code规则 产品code:版本号 版本号可以无
          # 来描述 一个唯一的实体：某产品，或某产品的某个版本，用以关联ansible模板、api模板，或是 设备管理中的设备          - product_code: "fw:xxx"
          - product_code: "fw:xxx"
            params:
                - key: device_version
                  type: string
      exclude_devices:
          - 1.1.1.1
 
    - ability_code: ip_banned
      ability_name: IP封禁
      # 能力共同参数
      params:
          - key: product_code
            type: string
          - key: device_ip
            type: string
          - key: device_port
            type: string
          - key: target
            type: string
      support_devices:
          - product_code: "fw:xxxx"
            params:
                - key: device_version
                  type: string
      exclude_devices:
          - 1.1.1.1

联动能力执行模板

device_linkage_execute:
    - product_code: "fw:xxx"
      linkage_abilities:
        - ability: blacklist
          exec_tool: api
          requet_api_code: device_block
        - ability: ip_banned
          exec_tool: ansible
          playbook: firewall-demo-playbook11.yml
          cmd: "ansible-playbook -i /tmp/host.ini /tmp/firewall-demo-playbook.yml --extra-vars target_ips='{{device_ip_arr}}'"
        - ability: query_strategy
          exec_tool: ansible
          playbook: firewall-demo-playbook11.yml
          cmd: "XXXXX"

联动剧本模板

script:
    - script_code: demo1
      script_name: 测试剧本
      cron: "" # cron表达式
      exec_model: 1 #执行模式，1：自动  0：手动
      enable: true # 是否启用
      exec_items:
          - linkage_abilitiy: query_strategy
            product_code: "fw:xxx"
            params:
              - device_ip: 1.1.1.1
              - device_port: 22
          - exec_tool: ansible
            playbook: firewall-demo-playbook11.yml
            params:
              - device_ip: 1.1.1.1
              - device_port: 22

host模板

[device]
host ansible_host={{device_ip}}  
;host指定设备ip
​
[ansible_host]
host1 ansible_host={{ansible_host}}
;host指定ansible安装主机

playbook模板

- name: firewall-demo
  hosts: device
  gather_facts: no  # 禁用事实收集
  tasks:
    - name: 测试ssh
      shell: echo "test"
      register: ssh_output  # 保存 命令执行结果 输出到变量 ssh_output
      vars:
         ansible_ssh_user: {{ansible_user_name}}
         ansible_ssh_pass: {{ansible_user_password}}
         ansible_ssh_common_args: "-o StrictHostKeyChecking=no"  # 忽略 SSH 主机密钥检查
    - name: print
      debug:
         var: ssh_output

api配置模板

[
    {
        "request_api_code": "api_demo1",
        "content": {
            "method": "GET",
            "url": "http://127.0.0.1:8080/xxx",
            "body": {
                "device_id": "{id}",
                "device_type": "{device_type}",
                "name": "{device_name}",
                "ip": "{ip}",
                "device_version": "{version}",
                "port": "{port}"
            }
        }
    }
]

接口设计

获取能力列表接口

API Path

xxx/device-linkage-abilities

请求协议

http

请求方法

GET

请求参数

参数名说明必填类型
ability_code能力编码否string
product_code设备产品编码否string

请求示例

curl http:127.0.0.1:8080/xxx/device-linkage-abilities?ability_code=xxx&product_code=xxx&device_ip=xxx

响应参数 Array

参数名类型说明可选值
ability_codestring能力编码
ability_namestring能力名称
paramsarray能力共同参数
keystring参数名称
typestring参数类型string\int\float\object\array
support_devicesarray适用设备范围
product_codestring设备产品编码
devicesarray设备信息
device_idstring设备id
device_namestring设备名称
device_ipstring设备ip

响应示例

[
    {
        "ability_code": "blacklist",
        "ability_name": "黑名单",
        "params": [
            {
                "key": "device_ip",
                "type": "string"
            },
            {
                "key": "device_port",
                "type": "string"
            }
        ],
        "support_devices": [
            {
                "product_code": "fw:xxx",
                "devices": [
                    {
                        "device_id": "sss",
                        "device_name": "设备A",
                        "device_ip": "4.4.4.4"
                    }
                ]
            }
        ]
    }
]
获取设备能力接口

API Path

xxx/device-linkage-abilities/device

请求协议

http

请求方法

GET

请求参数 device_ip和device_id至少填写一个

参数名说明必填类型
device_ip设备ip是string
device_id设备id否string

请求示例

curl http:127.0.0.1:8080/xxx/device-linkage-abilities/device?device_ip=xxx&device_id=xxx

响应参数 Array

参数名类型说明可选值
device_idstring设备id
device_namestring设备名称
device_ipstring设备ip
abilitiesarray能力集合
ability_codestring能力编码
ability_namestring能力名称
paramsarray能力共同参数
keystring参数名称
typestring参数类型string\int\float\object\array

响应示例

{
  "device_id": "xxx",
  "device_name": "xxx",
  "device_ip": "xxxx",
  "abilities": [
    {
      "ability_code": "sss",
      "ability_name": "xx",
      "params": [
        {
          "key": "device_ip",
          "type": "string"
        },
        {
          "key": "device_port",
          "type": "string"
        }
      ]
    }
  ]
}
能力执行接口

API Path

xxx/device-linkage-abilities/execute

请求协议

http

请求方法

POST

请求body参数 Object product_code和device_ip二选一（要么按照设备类型执行能力，要么按照设备执行能力）

参数名说明必填类型
ability_code能力编码是string
product_code设备产品编码否string
device_ip设备ip否array
params能力共同参数否object

请求示例

curl -XPOST -H "Content-Type: application/json" http:127.0.0.1:8080/xxx/device-linkage-abilities/execute

-d ’

{
  "ability_code": "xxx",
  "product_code": "xxx",
  "device_ip": [
    "8.8.8.8"
  ],
  "params": {
    "device_ip": "2.2.2.2",
    "device_port": "22"
  }
}

’

响应示例

{
  "execute_id": "执行id"
}
获取能力执行结果接口

API Path

xxx/device-linkage-abilities/query

请求协议

http

请求方法

GET

请求参数

参数名说明必填类型默认值
ability_code能力编码是string
ability_name能力名称否string
product_code设备产品编码否string
device_ip设备ip（多个ip用英文逗号分隔）否string
order_by排序参数,支持执行开始和执行结束时间排序(-exec_start_time表示按照执行开始时间倒序排序)否string-exec_end_time
offset偏移量是int
limit分页大小是int

请求示例

curl http:127.0.0.1:8080/xxx/device-linkage-abilities/query?ability_code=xxx&offset=0&limit=10

响应参数 Object

参数名类型说明可选值
itemsarray
ability_codestring能力编码
ability_namestring能力名称
device_iparray设备ip
exec_statusint执行状态1: 执行成功 2:执行中 3: 执行失败
exec_start_timedate执行开始时间
exec_end_timedate执行结束时间
dataobject执行结果信息
totalint总记录数

响应示例

{
  "items": [
    {
      "ability_code": "",
      "ability_name": "",
      "device_ip": [],
      "exec_status": 1,
      "exec_start_time": "",
      "exec_end_time": "",
      "data": {

​      }
​    }
  ],
  "total": 1
}
获取剧本列表接口

API Path

xxx/device-linkage-scripts

请求协议

http

请求方法

GET

请求参数

参数名说明必填类型
script_code剧本编码否string
script_group剧本分组否string

请求示例

curl http:127.0.0.1:8080/xxx/device-linkage-scripts?script_code=xxx&script_group=xxx

响应参数 Array

参数名类型说明可选值
script_codestring剧本编码
script_namestring剧本名称
script_groupstring剧本分组
paramsarray剧本参数
keystring参数名称
typestring参数类型string\int\float\object\array

响应示例

[
  {
    "script_code": "demo1",
    "script_name": "测试",
    "script_group": "demo",
    "params": [
      {
        "key": "device_ip",
        "type": "string"
      },
      {
        "device_port": "string",
        "type": "string"
      }
    ]
  }
]
模板剧本执行接口

API Path

xxx/device-linkage-scripts/execute

请求协议

http

请求方法

POST

请求body参数 Array script_code和script_group二选一（要么按照剧本编码执行剧本，要么按照剧本分组执行剧本）

参数名说明必填类型
script_code剧本编码否string
script_group剧本分组否string
params剧本参数否object

请求示例

curl -XPOST -H "Content-Type: application/json" http:127.0.0.1:8080/xxx/device-linkage-abilities/execute

-d ’

{
  "script_code": "xxx",
  "script_group": "xxxx",
  "params": {
    "device_ip": "2.2.2.2",
    "device_port": "22"
  }
}

’

响应示例

{
  "execute_id": "执行id"
}
业务剧本执行接口

API Path

xxx/device-linkage-scripts/execute:batch

请求协议

http

请求方法

POST

请求body参数 Array

参数名说明必填类型可选值
script_code剧本编码是string
exec_model执行模式是int执行模式(1:自动 0:手动)
croncron表达式objectexec_model=1时必填；cron值为时间戳时表示指定某个时刻执行一次；cron值为cron表达式时表示周期自动执行
abilities能力集合否array
ability_code能力编码是string
product_code设备产品编码否string
device_ip设备ip否array
params能力共同参数是object

请求示例

curl -XPOST -H "Content-Type: application/json" http:127.0.0.1:8080/xxx/device-linkage-abilities/execute:batch

-d ’

{
  "script_code": "xxx",
  "script_group": "xxx",
  "abilities": [
    {
      "ability_code": "xxx",
      "product_code": "xxx",
      "device_ip": [
        "8.8.8.8"
      ],
      "params": {
        "device_ip": "2.2.2.2",
        "device_port": "22"
      }
    }
  ]
}

’

响应示例

{
  "execute_id": "执行id"
}
获取剧本执行结果接口

API Path

xxx/device-linkage-scripts/query

请求协议

http

请求方法

GET

请求参数

参数名说明必填类型默认值
script_code剧本编码是string
script_name剧本名称否string
script_group剧本分组否string
order_by排序参数,支持执行开始和执行结束时间排序(-exec_start_time表示按照执行开始时间倒序排序)否string-exec_end_time
offset偏移量是int
limit分页大小是int

请求示例

curl http:127.0.0.1:8080/xxx/device-linkage-abilities/query?ability_code=xxx&offset=0&limit=10

响应参数 Object

参数名类型说明可选值
itemsarray
script_codestring剧本编码
script_namestring剧本名称
script_grouparray剧本分组
exec_statusint执行状态1: 执行成功 2:执行中 3: 执行失败
exec_start_timedate执行开始时间
exec_end_timedate执行结束时间
dataobject执行结果信息
totalint总记录数

响应示例

{
  "items": [
    {
      "script_code": "",
      "script_name": "",
      "script_group": "",
      "exec_status": 1,
      "exec_start_time": "",
      "exec_end_time": "",
      "data": {

​      }
​    }
  ],
  "total": 1
}
根据执行id获取执行结果接口

API Path

xxx/device-linkage/query/{execute_id}

请求协议

http

请求方法

GET

请求示例

curl http:127.0.0.1:8080/xxx/device-linkage/123455

响应示例

{
  "id": "123455",
  "exec_model": "执行模式(1:自动 0:手动)",
  "exec_type": "执行类型(1:能力 2:剧本)",
  "script_code": "剧本编码",
  "ability_code": "能力编码",
  "exec_status": "执行状态(1: 执行成功 2:执行中 3: 执行失败)",
  "exec_start_time": "执行开始时间",
  "exec_end_time": "执行结束时间",
  "data": {

  }
}

MQ消息结构设计

{
  "id": "执行id 唯一",
  "exec_model": "执行模式(1:自动 0:手动)",
  "exec_type": "执行类型(1:能力 2:剧本)",
  "script_code": "剧本编码",
  "ability_code": "能力编码",
  "exec_status": "执行状态(1: 执行成功 2:执行中 3: 执行失败)",
  "exec_start_time": "执行开始时间",
  "exec_end_time": "执行结束时间",
  "data": {

  }
}
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值