[example] Use environment variable for example to run (#981)

README.md

@@ -89,6 +89,20 @@ Integration testing
 $ pytest ./tests/02-integration/
 ```
 
+Example testing:
+
+> OpenCTI must be running
+
+```bash
+cd examples
+# Configure with you local instance of OpenCTI
+export OPENCTI_API_URL="http://localhost:4000"
+export OPENCTI_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxx"
+
+#Run one example file
+python get_indicators_of_malware.py
+```
+
 ## About
 
 OpenCTI is a product designed and developed by the company [Filigran](https://filigran.io).

examples/add_external_reference_to_report.py

@@ -1,12 +1,13 @@
 # coding: utf-8
+import os
 
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/add_label_to_malware.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/add_label_to_observable.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/add_organization_to_sector.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/add_tool_usage_to_intrusion-set.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/ask_enrichment_of_observable.py

@@ -1,9 +1,11 @@
 # coding: utf-8
+import os
+
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 # Define name of INTERNAL_ENRICHMENT Connector which can enrich IPv4 addresses
 connector_name = "AbuseIPDB"
 

examples/cmd_line_tag_latest_indicators_of_threat.py

@@ -1,13 +1,14 @@
 # coding: utf-8
 import argparse
+import os
 
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_campaign_attributed-to_intrusion_set.py

@@ -1,12 +1,13 @@
 # coding: utf-8
+import os
 
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_file_with_hashes.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_incident_with_ttps_and_indicators.py

@@ -1,12 +1,13 @@
 # coding: utf-8
+import os
 
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_indicator_of_campaign.py

@@ -1,12 +1,13 @@
 # coding: utf-8
+import os
 
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_intrusion_set.py

@@ -1,12 +1,12 @@
 # coding: utf-8
-
 import datetime
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_ip_domain_resolution.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_marking_definition.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_observable_relationships.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_process_observable.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/create_report_with_author.py

@@ -1,12 +1,13 @@
 # coding: utf-8
+import os
 
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/delete_intrusion_set.py

@@ -1,11 +1,12 @@
 # coding: utf-8
 import datetime
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/delete_relation.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/export_async_of_indicators.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/export_async_of_malware.py

@@ -1,10 +1,11 @@
 # coding: utf-8
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/export_incident_stix2.py

@@ -1,12 +1,12 @@
 # coding: utf-8
-
 import json
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/export_incidents_stix2.py

@@ -1,12 +1,12 @@
 # coding: utf-8
-
 import json
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/export_intrusion_set_stix2.py

@@ -1,12 +1,12 @@
 # coding: utf-8
-
 import json
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)

examples/export_report_stix2.py

@@ -1,12 +1,12 @@
 # coding: utf-8
-
 import json
+import os
 
 from pycti import OpenCTIApiClient
 
 # Variables
-api_url = "http://opencti:4000"
-api_token = "bfa014e0-e02e-4aa6-a42b-603b19dcf159"
+api_url = os.getenv("OPENCTI_API_URL", "http://opencti:4000")
+api_token = os.getenv("OPENCTI_API_TOKEN", "bfa014e0-e02e-4aa6-a42b-603b19dcf159")
 
 # OpenCTI initialization
 opencti_api_client = OpenCTIApiClient(api_url, api_token)