forked from OpenCTI-Platform/client-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopencti_campaign.py
404 lines (383 loc) · 14 KB
/
opencti_campaign.py
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# coding: utf-8
import json
import uuid
from stix2.canonicalization.Canonicalize import canonicalize
from pycti.entities import LOGGER
class Campaign:
def __init__(self, opencti):
self.opencti = opencti
self.properties = """
id
standard_id
entity_type
parent_types
spec_version
created_at
updated_at
createdBy {
... on Identity {
id
standard_id
entity_type
parent_types
spec_version
identity_class
name
description
roles
contact_information
x_opencti_aliases
created
modified
objectLabel {
edges {
node {
id
value
color
}
}
}
}
... on Organization {
x_opencti_organization_type
x_opencti_reliability
}
... on Individual {
x_opencti_firstname
x_opencti_lastname
}
}
objectMarking {
edges {
node {
id
standard_id
entity_type
definition_type
definition
created
modified
x_opencti_order
x_opencti_color
}
}
}
objectLabel {
edges {
node {
id
value
color
}
}
}
externalReferences {
edges {
node {
id
standard_id
entity_type
source_name
description
url
hash
external_id
created
modified
importFiles {
edges {
node {
id
name
size
metaData {
mimetype
version
}
}
}
}
}
}
}
revoked
confidence
created
modified
name
description
aliases
first_seen
last_seen
objective
importFiles {
edges {
node {
id
name
size
metaData {
mimetype
version
}
}
}
}
"""
@staticmethod
def generate_id(name):
name = name.lower().strip()
data = {"name": name}
data = canonicalize(data, utf8=False)
id = str(uuid.uuid5(uuid.UUID("00abedb4-aa42-466c-9c01-fed23315a9b7"), data))
return "campaign--" + id
"""
List Campaign objects
:param filters: the filters to apply
:param search: the search keyword
:param first: return the first n rows from the after ID (or the beginning if not set)
:param after: ID of the first row for pagination
:return List of Campaign objects
"""
def list(self, **kwargs):
filters = kwargs.get("filters", None)
search = kwargs.get("search", None)
first = kwargs.get("first", 500)
after = kwargs.get("after", None)
order_by = kwargs.get("orderBy", None)
order_mode = kwargs.get("orderMode", None)
custom_attributes = kwargs.get("customAttributes", None)
get_all = kwargs.get("getAll", False)
with_pagination = kwargs.get("withPagination", False)
if get_all:
first = 100
LOGGER.info("Listing Campaigns with filters %s.", json.dumps(filters))
query = (
"""
query Campaigns($filters: [CampaignsFiltering], $search: String, $first: Int, $after: ID, $orderBy: CampaignsOrdering, $orderMode: OrderingMode) {
campaigns(filters: $filters, search: $search, first: $first, after: $after, orderBy: $orderBy, orderMode: $orderMode) {
edges {
node {
"""
+ (custom_attributes if custom_attributes is not None else self.properties)
+ """
}
}
pageInfo {
startCursor
endCursor
hasNextPage
hasPreviousPage
globalCount
}
}
}
"""
)
result = self.opencti.query(
query,
{
"filters": filters,
"search": search,
"first": first,
"after": after,
"orderBy": order_by,
"orderMode": order_mode,
},
)
if get_all:
final_data = []
data = self.opencti.process_multiple(result["data"]["campaigns"])
final_data = final_data + data
while result["data"]["campaigns"]["pageInfo"]["hasNextPage"]:
after = result["data"]["campaigns"]["pageInfo"]["endCursor"]
LOGGER.info("Listing Campaigns after " + after)
result = self.opencti.query(
query,
{
"filters": filters,
"search": search,
"first": first,
"after": after,
"orderBy": order_by,
"orderMode": order_mode,
},
)
data = self.opencti.process_multiple(result["data"]["campaigns"])
final_data = final_data + data
return final_data
else:
return self.opencti.process_multiple(
result["data"]["campaigns"], with_pagination
)
"""
Read a Campaign object
:param id: the id of the Campaign
:param filters: the filters to apply if no id provided
:return Campaign object
"""
def read(self, **kwargs):
id = kwargs.get("id", None)
filters = kwargs.get("filters", None)
custom_attributes = kwargs.get("customAttributes", None)
if id is not None:
LOGGER.info("Reading Campaign {%s}.", id)
query = (
"""
query Campaign($id: String!) {
campaign(id: $id) {
"""
+ (
custom_attributes
if custom_attributes is not None
else self.properties
)
+ """
}
}
"""
)
result = self.opencti.query(query, {"id": id})
return self.opencti.process_multiple_fields(result["data"]["campaign"])
elif filters is not None:
result = self.list(filters=filters)
if len(result) > 0:
return result[0]
else:
return None
else:
LOGGER.error("[opencti_campaign] Missing parameters: id or filters")
return None
"""
Create a Campaign object
:param name: the name of the Campaign
:return Campaign object
"""
def create(self, **kwargs):
stix_id = kwargs.get("stix_id", None)
created_by = kwargs.get("createdBy", None)
object_marking = kwargs.get("objectMarking", None)
object_label = kwargs.get("objectLabel", None)
external_references = kwargs.get("externalReferences", None)
revoked = kwargs.get("revoked", None)
confidence = kwargs.get("confidence", None)
lang = kwargs.get("lang", None)
created = kwargs.get("created", None)
modified = kwargs.get("modified", None)
name = kwargs.get("name", None)
description = kwargs.get("description", None)
aliases = kwargs.get("aliases", None)
first_seen = kwargs.get("first_seen", None)
last_seen = kwargs.get("last_seen", None)
objective = kwargs.get("objective", None)
granted_refs = kwargs.get("objectOrganization", None)
x_opencti_stix_ids = kwargs.get("x_opencti_stix_ids", None)
update = kwargs.get("update", False)
if name is not None:
LOGGER.info("Creating Campaign {%s}.", name)
query = """
mutation CampaignAdd($input: CampaignAddInput!) {
campaignAdd(input: $input) {
id
standard_id
entity_type
parent_types
}
}
"""
result = self.opencti.query(
query,
{
"input": {
"stix_id": stix_id,
"createdBy": created_by,
"objectMarking": object_marking,
"objectOrganization": granted_refs,
"objectLabel": object_label,
"externalReferences": external_references,
"revoked": revoked,
"confidence": confidence,
"lang": lang,
"created": created,
"modified": modified,
"name": name,
"description": description,
"aliases": aliases,
"first_seen": first_seen,
"last_seen": last_seen,
"objective": objective,
"update": update,
"x_opencti_stix_ids": x_opencti_stix_ids,
}
},
)
return self.opencti.process_multiple_fields(result["data"]["campaignAdd"])
else:
LOGGER.error("[opencti_campaign] Missing parameters: name and description")
"""
Import a Campaign object from a STIX2 object
:param stixObject: the Stix-Object Campaign
:return Campaign object
"""
def import_from_stix2(self, **kwargs):
stix_object = kwargs.get("stixObject", None)
extras = kwargs.get("extras", {})
update = kwargs.get("update", False)
if stix_object is not None:
# Search in extensions
if "x_opencti_stix_ids" not in stix_object:
stix_object[
"x_opencti_stix_ids"
] = self.opencti.get_attribute_in_extension("stix_ids", stix_object)
if "x_opencti_granted_refs" not in stix_object:
stix_object[
"x_opencti_granted_refs"
] = self.opencti.get_attribute_in_extension("granted_refs", stix_object)
return self.create(
stix_id=stix_object["id"],
createdBy=extras["created_by_id"]
if "created_by_id" in extras
else None,
objectMarking=extras["object_marking_ids"]
if "object_marking_ids" in extras
else None,
objectLabel=extras["object_label_ids"]
if "object_label_ids" in extras
else None,
externalReferences=extras["external_references_ids"]
if "external_references_ids" in extras
else None,
revoked=stix_object["revoked"] if "revoked" in stix_object else None,
confidence=stix_object["confidence"]
if "confidence" in stix_object
else None,
lang=stix_object["lang"] if "lang" in stix_object else None,
created=stix_object["created"] if "created" in stix_object else None,
modified=stix_object["modified"] if "modified" in stix_object else None,
name=stix_object["name"],
description=self.opencti.stix2.convert_markdown(
stix_object["description"]
)
if "description" in stix_object
else None,
aliases=self.opencti.stix2.pick_aliases(stix_object),
objective=stix_object["objective"]
if "objective" in stix_object
else None,
first_seen=stix_object["first_seen"]
if "first_seen" in stix_object
else None,
last_seen=stix_object["last_seen"]
if "last_seen" in stix_object
else None,
x_opencti_stix_ids=stix_object["x_opencti_stix_ids"]
if "x_opencti_stix_ids" in stix_object
else None,
objectOrganization=stix_object["x_opencti_granted_refs"]
if "x_opencti_granted_refs" in stix_object
else None,
update=update,
)
else:
LOGGER.error("[opencti_campaign] Missing parameters: stixObject")