[client] Implement methods for export/import, upgrade with connectors helpers, handle update (#22,#24,#25)

* Implement graphql file upload specification using multipart
* Adding support for multiple uploads at the same time
* Adapt mutation to push export file
* Adapating helper to rely on API
* Improve helper
* Refactoring client api to introduce connectors needs
* Update all entities if the entity already exists and update is True
* Add the init file and enhance upgrading entities
* Update version number for next release
* Introduce keys for internal_id and stix_id to avoid race conditions
* Adapt helper for now reporting jobs. Add capacity for observable localization relations
* Adapt job api for internal key and remove city api
* Prepare relation to relation

Author: Samuel Hassine

pycti/__init__.py

@@ -1,2 +1,2 @@
-from .opencti_api_client import OpenCTIApiClient
-from .opencti_connector_helper import OpenCTIConnectorHelper
+from api.opencti_api_client import OpenCTIApiClient
+from connector.opencti_connector_helper import OpenCTIConnectorHelper

pycti/opencti_api_client.py pycti/api/opencti_api_client.pypycti/opencti_api_client.py renamed to pycti/api/opencti_api_client.py

@@ -0,0 +1,56 @@
+import logging
+
+from connector.opencti_connector import OpenCTIConnector
+
+
+class OpenCTIApiConnector:
+
+    def __init__(self, api):
+        self.api = api
+
+    def list(self):
+        logging.info('Getting connectors ...')
+        query = """
+            query GetConnectors {
+                connectors {
+                    id
+                    name
+                    config {
+                        uri
+                        listen
+                        push
+                    }
+                }
+            }
+        """
+        result = self.api.query(query)
+        return result['data']['connectors']
+
+    def ping(self, connector_id):
+        query = """
+            mutation PingConnector($id: ID!) {
+                pingConnector(id: $id) {
+                    id
+                }
+            }
+           """
+        self.api.query(query, {'id': connector_id})
+
+    def register(self, connector: OpenCTIConnector):
+        query = """
+            mutation RegisterConnector($input: RegisterConnectorInput) {
+                registerConnector(input: $input) {
+                    id
+                    config {
+                        uri
+                        listen
+                        listen_exchange
+                        push
+                        push_exchange
+                    }
+                }
+            }
+           """
+        result = self.api.query(query, connector.to_input())
+        return result['data']['registerConnector']
+

pycti/api/opencti_api_connector.py

@@ -0,0 +1,31 @@
+import logging
+
+
+class OpenCTIApiJob:
+
+    def __init__(self, api):
+        self.api = api
+
+    def update_job(self, job_id: str, status: str, messages: [str]):
+        logging.info('Reporting job ' + job_id + ' with status ' + status + '...')
+        query = """
+            mutation UpdateJob($id: ID!, $status: Status!, $messages: [String]) {
+                updateJob(jobId: $id, status: $status, messages: $messages) {
+                    internal_id_key
+                }
+            }
+           """
+        result = self.api.query(query, {'id': job_id, 'status': status, 'messages': messages})
+        return result['data']['updateJob']['internal_id_key']
+
+    def initiate_job(self, work_id: str):
+        logging.info('Creating new job on work ' + work_id)
+        query = """
+            mutation InitiateJob($id: ID!) {
+                initiateJob(workId: $id) {
+                    internal_id_key
+                }
+            }
+           """
+        result = self.api.query(query, {'id': work_id})
+        return result['data']['initiateJob']['internal_id_key']

pycti/api/opencti_api_job.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+# Scope definition
+# EXTERNAL_IMPORT = None
+# INTERNAL_IMPORT_FILE = Files mime types to support (application/json, ...)
+# INTERNAL_ENRICHMENT = Entity types to support (Report, Hash, ...)
+# INTERNAL_EXPORT_FILE = Files mime types to generate (application/pdf, ...)
+
+
+class ConnectorType(Enum):
+    EXTERNAL_IMPORT = 'EXTERNAL_IMPORT'  # From remote sources to OpenCTI stix2
+    INTERNAL_IMPORT_FILE = 'INTERNAL_IMPORT_FILE'  # From OpenCTI file system to OpenCTI stix2
+    INTERNAL_ENRICHMENT = 'INTERNAL_ENRICHMENT'  # From OpenCTI stix2 to OpenCTI stix2
+    INTERNAL_EXPORT_FILE = 'INTERNAL_EXPORT_FILE'  # From OpenCTI stix2 to OpenCTI file system
+
+
+class OpenCTIConnector:
+    def __init__(self, connector_id: str, connector_name: str, connector_type: str, scope: str):
+        self.id = connector_id
+        self.name = connector_name
+        self.type = ConnectorType(connector_type)
+        if self.type is None:
+            raise ValueError('Invalid connector type: ' + connector_type)
+        self.scope = scope.split(',')
+
+    def to_input(self):
+        return {'input': {'id': self.id, 'name': self.name, 'type': self.type.name, 'scope': self.scope}}