security-content/docs/spec/response_tasks.spec.json at develop · PoeBlu/security-content · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
  "$id": "http://example.com/example.json",
  "$schema": "http://json-schema.org/draft-07/schema",
  "additionalProperties": true,
  "default": {},
  "description": "schema for response tasks",
  "properties": {
    "author": {
      "$id": "#/properties/author",
      "default": "",
      "description": "Author of response task",
      "examples": [
        "Patrick Barei\u00df, Splunk"
      ],
      "type": "string"
    },
    "dashboard": {
      "$id": "#/properties/dashboard",
      "default": "",
      "description": "Name of dashboard used as response task",
      "examples": [
        "process_chain_analysis.json"
      ],
      "type": "string"
    },
    "date": {
      "$id": "#/properties/date",
      "default": "",
      "description": "date of creation or modification, format yyyy-mm-dd",
      "examples": [
        "2019-12-06"
      ],
      "type": "string"
    },
    "description": {
      "$id": "#/properties/description",
      "default": "",
      "description": "Description of response task",
      "examples": [
        "Response Task example description"
      ],
      "type": "string"
    },
    "how_to_implement": {
      "$id": "#/properties/how_to_implement",
      "default": "",
      "description": "information about how to implement. Only needed for non standard implementations.",
      "examples": [
        "This search requires Sysmon Logs and a Sysmon configuration, which includes EventCode 10 for lsass.exe."
      ],
      "type": "string"
    },
    "id": {
      "$id": "#/properties/id",
      "default": "",
      "description": "UUID as unique identifier",
      "examples": [
        "fb4c31b0-13e8-4155-8aa5-24de4b8d6717"
      ],
      "type": "string"
    },
    "inputs": {
      "$id": "#/properties/inputs",
      "default": [],
      "description": "Inputs used from the response task",
      "examples": [
        [
          "lookup_file"
        ]
      ],
      "type": "array"
    },
    "name": {
      "$id": "#/properties/name",
      "default": "",
      "description": "Namo fo response task",
      "examples": [
        "Response Tas Example"
      ],
      "type": "string"
    },
    "playbook": {
      "$id": "#/properties/playbook",
      "additionalProperties": true,
      "default": {},
      "description": "A phantom playbook as response task",
      "examples": [
        {
          "name": "lets_encrypt_domain_investigate.json",
          "url_json": "https://github.com/phantomcyber/playbooks/blob/4.6/lets_encrypt_domain_investigate.json",
          "url_python": "https://github.com/phantomcyber/playbooks/blob/4.6/lets_encrypt_domain_investigate.py"
        }
      ],
      "properties": {
        "name": {
          "$id": "#/properties/playbook/properties/name",
          "default": "",
          "description": "Name of Phantom Playbook",
          "examples": [
            "lets_encrypt_domain_investigate.json"
          ],
          "type": "string"
        },
        "url_json": {
          "$id": "#/properties/playbook/properties/url_json",
          "default": "",
          "description": "URL for phantom playbook json file",
          "examples": [
            "https://github.com/phantomcyber/playbooks/blob/4.6/lets_encrypt_domain_investigate.json"
          ],
          "type": "string"
        },
        "url_python": {
          "$id": "#/properties/playbook/properties/url_python",
          "default": "",
          "description": "URL for phantom playbook python file",
          "examples": [
            "https://github.com/phantomcyber/playbooks/blob/4.6/lets_encrypt_domain_investigate.py"
          ],
          "type": "string"
        }
      },
      "required": [
        "name",
        "url_json",
        "url_python"
      ],
      "type": "object"
    },
    "search": {
      "$id": "#/properties/search",
      "default": "",
      "description": "Search as response task",
      "examples": [
        "`sysmon` EventCode=1 | search [| inputlookup %lookup_file% ] | stats count by dest user process_name"
      ],
      "type": "string"
    },
    "version": {
      "$id": "#/properties/version",
      "default": 0,
      "description": "version of detection, e.g. 1 or 2 ...",
      "examples": [
        3
      ],
      "type": "integer"
    }
  },
  "required": [
    "name",
    "id",
    "version",
    "date",
    "description",
    "author"
  ],
  "title": "Response Task Schema",
  "type": "object"
}