forked from abusix/xarf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xarf_shared.schema.json
264 lines (264 loc) · 8.17 KB
/
xarf_shared.schema.json
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
{
"$schema": "http://json-schema.org/draft-07/schema#",
"ReporterInfo": {
"type": "object",
"properties": {
"ReporterOrg": {
"type": "string",
"description": "name of the reporter organisation",
"minLength": 3
},
"ReporterOrgDomain": {
"type": "string",
"description": "domain.tld of the reporter organisation",
"format": "hostname"
},
"ReporterOrgEmail": {
"type": "string",
"description": "email-address of the reporter organisation",
"format": "email"
},
"ReporterContactEmail": {
"type": "string",
"description": "email-address of the reporter contact",
"format": "email"
},
"ReporterContactName": {
"type": "string",
"description": "name of the reporter contact",
"minLength": 3
},
"ReporterContactPhone": {
"type": "string",
"description": "phone number of the reporter contact",
"minLength": 3
}
},
"required": [
"ReporterOrg",
"ReporterOrgDomain",
"ReporterOrgEmail"
]
},
"OnBehalfOf": {
"type": "object",
"properties": {
"ComplainantOrg": {
"type": "string",
"description": "name of the complainant organisation",
"minLength": 3
},
"ComplainantOrgDomain": {
"type": "string",
"description": "domain.tld of the complainant organisation",
"format": "hostname"
},
"ComplainantOrgEmail": {
"type": "string",
"description": "email-address of the complainant organisation",
"format": "email"
},
"ComplainantContactEmail": {
"type": "string",
"description": "email-address of the complainant contact",
"format": "email"
},
"ComplainantContactName": {
"type": "string",
"description": "name of the complainant contact",
"minLength": 3
},
"ComplainantContactPhone": {
"type": "string",
"description": "phone number of the complainant contact",
"minLength": 3
}
},
"required": [
"ComplainantOrg",
"ComplainantOrgDomain",
"ComplainantOrgEmail"
]
},
"XarfBase": {
"description": "Base properties for all xarf reports",
"type": "object",
"properties": {
"ReporterInfo": {
"$ref": "#/ReporterInfo"
},
"OnBehalfOf": {
"$ref": "#/OnBehalfOf"
},
"Disclosure": {
"type": "boolean",
"description": "if this event is disclosed or not",
"default": true
}
},
"required": [
"ReporterInfo",
"Disclosure"
]
},
"ReportBase": {
"description": "Base properties for the report part of all xarf report types",
"type": "object",
"properties": {
"ReportClass": {
"type": "string",
"description": "class of the reported abuse event",
"enum": [
"Content",
"Activity"
]
},
"ReportType": {
"type": "string",
"description": "type of the reported abuse event",
"minLength": 1
},
"ReportSubType": {
"type": "string",
"description": "subtype of the reported abuse event"
},
"ReporterCaseID": {
"type": "string",
"description": "case id of this report given by the reporter"
},
"ReporterSeverity": {
"type": "string",
"description": "class of the reported abuse event",
"enum": [
"low",
"medium",
"high"
]
},
"ReporterNotes": {
"type": "string",
"description": "free text - notes by the reporter"
}
},
"required": [
"ReportClass",
"ReportType"
]
},
"IpBasedReport": {
"description": "Base properties for the report part of all xarf report types",
"allOf": [
{
"$ref": "#/ReportBase"
},
{
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "date the abuse event occured in rfc3339 format",
"format": "date-time"
},
"SourceIp": {
"description": "ip from that the abuse event originated",
"anyOf": [
{
"type": "string",
"format": "ipv4"
},
{
"type": "string",
"format": "ipv6"
}
]
},
"SourcePort": {
"type": "integer",
"description": "source port from that the abuse event originated",
"minimum": 0,
"maximum": 65535
}
},
"required": [
"Date",
"SourceIp"
]
}
]
},
"Sample": {
"description": "Evidence sample",
"properties": {
"ContentType": {
"type": "string",
"description": "content type of the sample (e.g. application/rfc822 or image/jpg)"
},
"Base64Encoded": {
"type": "boolean",
"description": "if payload is base64 encoded. Useful to avoid losing encoding information (e.g. in mails)",
"default": false
},
"Description": {
"type": "string",
"description": "description of the sample in plain text"
},
"Payload": {
"type": "string",
"description": "actual sample"
}
},
"required": [
"ContentType",
"Payload"
]
},
"CommonProps": {
"Ongoing": {
"type": "boolean",
"description": "is the reported abuse ongoing?"
},
"ThreatActor": {
"type": "string",
"description": "!TODO!"
},
"Samples": {
"type": "array",
"description": "Samples of the malware",
"items": {
"$ref": "#/Sample"
},
"minItems": 1
}
},
"WithDestination": {
"DestinationIp": {
"description": "targeted ip",
"anyOf": [
{
"type": "string",
"format": "ipv4"
},
{
"type": "string",
"format": "ipv6"
}
]
},
"DestinationPort": {
"type": "integer",
"description": "targeted port",
"minimum": 0,
"maximum": 65535
}
},
"WithTrafficStats": {
"ByteCount": {
"type": "integer",
"description": "Bytes per second"
},
"PacketCount": {
"type": "integer",
"description": "Packets per second"
}
}
}