插件组件

以下各节从高层次记录了主要插件组件。有关更多详细信息,请阅读插件规范下一个。

联系

每个插件五月包含一个连接,该连接是处理身份验证的代码段。连接代码在其他组件之前运行,因此可以用于初始化库。它还可以设置可在后续组件(动作和触发器)中使用的共享变量和代码。

以下是有关连接的一些事实:

  • 连接对于插件开发是可选的
    • 不通过网络连接到服务的插件通常不需要连接
  • 连接在产品中是可重用的
    • 用户可以有多个连接,每个连接连接到单独的工作流,例如IMAP插件可以为每个用户邮箱设置一个连接来监视
  • 使用凭据类型的连接输入是加密的
  • 连接模式在插件规范中定义。plugin.spec.yaml
  • 连接代码存在于图标\插件\名称/connection/connection.py

各个插件作者负责编写模式和连接代码。

行动

每个插件可能包含一个或多个操作,这些操作是短时间运行的进程,执行然后退出。工作流通常包含许多链接在一起的操作。插件代码在Docker容器中执行。当操作初始化时,将创建连接对象,然后运行操作代码。

示例使用:

  • 如果需要发出API请求并返回结果。
    • 例如,取消对用户的授权
    • 创建JIRA票据
    • 例如,进行LDAP查询
  • 如果您需要运行命令/实用程序并返回结果。
    • 运行Nmap扫描
    • 例如,运行base64解码功能

以下是有关行动的一些事实:

  • 如果存在操作,则在工作流触发器之后执行
  • 操作对于插件开发是可选的,可以有多个操作
  • 操作是短期运行的过程
  • 行动失败五月停止工作流
    • 取决于在步骤失败时继续工作流程为工作流生成器中的插件设置
    • 如果工作流的其余部分取决于操作的成功,则可能需要停止工作流
    • 如果工作流的其余部分能够处理操作的失败,那么继续工作流可能是可取的
  • 操作模式在插件规范中定义,例如。plugin.spec.yaml
  • 行动代码存在于图标\u$PLUGIN\u NAME/actions/$ACTION\u NAME/ACTION.py

各个插件作者负责编写模式和操作代码。

触发

每个插件可能包含一个或多个触发器,这些触发器是长时间运行的进程,它们轮询/发出一个新事件,然后将该事件发送给引擎,以启动一个工作流。由于工作流获取数据的方式,所有工作流都必须以触发器开始. 激活工作流时,带有触发器的插件将在Docker容器中执行。当触发器初始化时,将创建连接对象,然后触发器进入一个循环,在其中等待消息或轮询新数据。

示例使用:

  • 如果您需要对API、网站等进行轮询,以便进行更改,触发器是一个很好的候选机制。
    • 例如,在一个板上监视JIRA新创建的票据,并在发现时触发
    • 例如,监控一个Twitter帐户的新消息,并在发现时触发
  • 如果需要打开套接字来侦听消息,触发器是一个很好的候选机制。
    • 例如,打开一个Kafka监听器,并触发任何新消息
    • 例如,创建一个自定义HTTP服务器来侦听来自ElastAlert的消息,并触发它们

以下是关于触发器的一些事实:

  • 所有工作流都必须以触发器开始
  • 触发器对于插件开发是可选的,可以有多个触发器
  • 触发器是长时间运行的进程
  • 触发器失败将停止工作流的功能
    • 触发器需要具有弹性
  • 触发器模式在插件规范中定义,例如。plugin.spec.yaml
  • 触发器代码位于icon_ PLUGIN_NAME /触发/ TRIGGER_NAME / trigger.py美元

各个插件作者负责生成模式和编写触发器代码。