[client] Add a method to add tags on an entity

Samuel Hassine · Samuel Hassine · commit 6e61fe4569ec · 2019-12-19T10:19:01.000+01:00
diff --git a/examples/add_external_reference_to_report.py b/examples/add_external_reference_to_report.py
@@ -5,7 +5,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/add_organization_to_sector.py b/examples/add_organization_to_sector.py
@@ -6,7 +6,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/add_tag_to_malwre.py b/examples/add_tag_to_malwre.py
@@ -0,0 +1,24 @@
+# coding: utf-8
+
+from dateutil.parser import parse
+from pycti import OpenCTIApiClient
+
+# Variables
+api_url = 'https://demo.opencti.io'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
+
+# OpenCTI initialization
+opencti_api_client = OpenCTIApiClient(api_url, api_token)
+
+# Create the malware
+malware = opencti_api_client.malware.create(
+    name='My new malware',
+    description='A new evil tool.'
+)
+
+# Create the tag (if not exists)
+
+# Add the tag
+
+# Print
+print(malware)
diff --git a/examples/create_campaign_attributed-to_intrusion_set.py b/examples/create_campaign_attributed-to_intrusion_set.py
@@ -5,7 +5,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/create_incident_with_ttps_and_indicators.py b/examples/create_incident_with_ttps_and_indicators.py
@@ -7,7 +7,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/create_indicator_of_campaign.py b/examples/create_indicator_of_campaign.py
@@ -7,7 +7,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/create_intrusion_set.py b/examples/create_intrusion_set.py
@@ -5,7 +5,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/create_marking_definition.py b/examples/create_marking_definition.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/create_report_with_author.py b/examples/create_report_with_author.py
@@ -5,7 +5,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/export_intrusion_set_stix2.py b/examples/export_intrusion_set_stix2.py
@@ -5,7 +5,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/export_report_stix2.py b/examples/export_report_stix2.py
@@ -5,7 +5,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/get_attack_pattern_by_mitre_id.py b/examples/get_attack_pattern_by_mitre_id.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/get_malwares_of_intrusion_set.py b/examples/get_malwares_of_intrusion_set.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/get_marking_definitions.py b/examples/get_marking_definitions.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/get_reports_about_intrusion_set.py b/examples/get_reports_about_intrusion_set.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/import_stix2_file.py b/examples/import_stix2_file.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/ip_address_resolves_domain.py b/examples/ip_address_resolves_domain.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/examples/link_hashes_together.py b/examples/link_hashes_together.py
@@ -4,7 +4,7 @@
 
 # Variables
 api_url = 'https://demo.opencti.io'
-api_token = 'c2d944bb-aea6-4bd6-b3d7-6c10451e2256'
+api_token = 'fa63eb1f-bf14-4777-9190-43b4571cbc8b'
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)
diff --git a/pycti/entities/opencti_stix_entity.py b/pycti/entities/opencti_stix_entity.py
@@ -46,6 +46,19 @@ def __init__(self, opencti):
                     }
                 }
             }
+            tags {
+                edges {
+                    node {
+                        id
+                        tag_type
+                        value
+                        color
+                    }
+                    relation {
+                        id
+                    }
+                }
+            }
             externalReferences {
                 edges {
                     node {
@@ -339,6 +352,54 @@ def add_marking_definition(self, **kwargs):
             self.opencti.log('error', 'Missing parameters: id and marking_definition_id')
             return False
 
+    """
+        Add a Tag object to Stix-Entity object (tagging)
+
+        :param id: the id of the Stix-Entity
+        :param tag_id: the id of the Tag
+        :return Boolean
+    """
+
+    def add_tag(self, **kwargs):
+        id = kwargs.get('id', None)
+        stix_entity = kwargs.get('entity', None)
+        tag_id = kwargs.get('tag_id', None)
+        if id is not None and tag_id is not None:
+            if stix_entity is None:
+                stix_entity = self.read(id=id)
+            if stix_entity is None:
+                self.opencti.log('error', 'Cannot add Tag, entity not found')
+                return False
+            if tag_id in stix_entity['tagsIds']:
+                return True
+            else:
+                self.opencti.log(
+                    'info',
+                    'Adding Tag {' + tag_id + '} to Stix-Entity {' + id + '}'
+                )
+                query = """
+                   mutation StixEntityAddRelation($id: ID!, $input: RelationAddInput) {
+                       stixEntityEdit(id: $id) {
+                            relationAdd(input: $input) {
+                                id
+                            }
+                       }
+                   }
+                """
+                self.opencti.query(query, {
+                    'id': id,
+                    'input': {
+                        'fromRole': 'so',
+                        'toId': tag_id,
+                        'toRole': 'tagging',
+                        'through': 'tagged'
+                    }
+                })
+                return True
+        else:
+            self.opencti.log('error', 'Missing parameters: id and tag_id')
+            return False
+
     """
         Add a External-Reference object to Stix-Entity object (object_marking_refs)
 
