relaxcloud/yaraxserver4

创建规则接口

概述

创建规则接口是一个通过HTTP POST方法提供的API端点，用于接收并处理规则创建请求。该接口接收包含规则分类、名称、版本、描述及YARA文件详细配置的JSON格式输入，完成规则创建后返回生成的YARA文件ID和规则ID列表。

核心功能与特性

• 规则信息接收：支持接收规则的基本信息，包括分类（category）、名称（name）、版本（version）和描述（description）。
• YARA文件配置：可接收YARA文件的详细配置，包含模块（modules）和规则（rules）数组。
• 规则详细定义：每个规则可定义名称（name）、私有标识（private）、全局标识（global）、标签（tags）、元数据（meta）、字符串（strings）和条件（condition）等属性。
• 结果返回：创建成功后，返回包含YARA文件ID（yara_file_id）和规则ID列表（rules_id）的JSON响应。

使用场景与适用范围

适用于需要动态创建自定义YARA规则的系统或应用场景，如威胁检测平台、***分析工具等。用户可通过该接口提交规则定义，系统存储规则并生成唯一标识，便于后续规则管理、调用和匹配。

使用方法与配置说明

请求信息

• 请求方法：POST
• 请求端点：/api/create
• 请求体格式：JSON

输入参数说明

请求体为JSON对象，包含以下字段：

规则对象（rules数组元素）字段说明

每个规则对象包含以下字段：

输入示例

json
{
    "category": "test",
    "name": "test_yara_file",
    "version": 1,
    "description": "testing",
    "yara_file": {
        "modules": [
            "pe"
        ],
        "rules": [
            {
                "name": "test_rule",
                "private": true,
                "global": false,
                "tags": [
                    "tag1",
                    "tag2"
                ],
                "meta": [
                    {
                        "key": "is_production",
                        "value": {
                            "Boolean": false
                        }
                    },
                    {
                        "key": "verification",
                        "value": {
                            "Boolean": true
                        }
                    },
                    {
                        "key": "source",
                        "value": {
                            "String": "official"
                        }
                    },
                    {
                        "key": "sharing",
                        "value": {
                            "String": "TLP:Red"
                        }
                    },
                    {
                        "key": "grayscale",
                        "value": {
                            "Boolean": false
                        }
                    },
                    {
                        "key": "attribute",
                        "value": {
                            "String": "white"
                        }
                    },
                    {
                        "key": "auth",
                        "value": {
                            "String": "auth_content"
                        }
                    },
                    {
                        "key": "description",
                        "value": {
                            "String": "Test rule description"
                        }
                    }
                ],
                "strings": [
                    {
                        "key": "$a",
                        "value": "\"hello\""
                    },
                    {
                        "key": "$b",
                        "value": "/world/"
                    }
                ],
                "condition": "any of them"
            }
        ]
    }
}

输出示例

接口创建规则成功后，返回以下JSON格式响应：

json
{
    "yara_file_id": 24,
    "rules_id": [
        8
    ]
}

输出字段说明