security_content/spec/lookups.spec.json at develop · DevToolCreator/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
{
  "$id": "https://api.splunkresearch.com/schemas/lookups.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "A object that defines a lookup file and its properties.",
  "oneOf": [
    {
      "required": [
        "collection"
      ]
    },
    {
      "required": [
        "filename"
      ]
    }
  ],
  "properties": {
    "case_sensitive_match": {
      "description": "What the macro is intended to filter",
      "enum": [
        "true",
        "false"
      ],
      "examples": [
        "true"
      ],
      "type": "string"
    },
    "collection": {
      "description": "Name of the collection to use for this lookup",
      "examples": [
        "prohibited_apps_launching_cmd"
      ],
      "type": "string"
    },
    "default_match": {
      "description": "The default value if no match is found",
      "examples": [
        "true"
      ],
      "type": "string"
    },
    "description": {
      "description": "The description of this lookup",
      "examples": [
        "This lookup contains file names that exist in the Windows\\System32 directory"
      ],
      "type": "string"
    },
    "fields_list": {
      "description": "A comma and space separated list of field names",
      "examples": [
        "_key, dest, process_name"
      ],
      "type": "string"
    },
    "filename": {
      "description": "The name of the file to use for this lookup",
      "examples": [
        "prohibited_apps_launching_cmd.csv"
      ],
      "type": "string"
    },
    "filter": {
      "description": "Use this attribute to improve search performance when working with significantly large KV",
      "examples": [
        "dest=\"SPLK_*\""
      ],
      "type": "string"
    },
    "match_type": {
      "description": "A comma and space-delimited list of <match_type>(<field_name>) specification to allow for non-exact matching",
      "examples": [
        "WILDCARD(process)"
      ],
      "type": "string"
    },
    "max_matches": {
      "description": "The maximum number of possible matches for each input lookup value",
      "examples": [
        "100"
      ],
      "type": "integer"
    },
    "min_matches": {
      "description": "Minimum number of possible matches for each input lookup value",
      "examples": [
        "1"
      ],
      "type": "integer"
    },
    "name": {
      "description": "The name of the lookup to be used in searches",
      "examples": [
        "isWindowsSystemFile_lookup"
      ],
      "type": "string"
    }
  },
  "title": "Lookup Manifest",
  "type": "object"
}