stix2arango 1.1.10__py3-none-any.whl

stix2arango/templates/marking-definition.json

@@ -0,0 +1,111 @@
+[
+  {
+    "type": "marking-definition",
+    "spec_version": "2.1",
+    "id": "marking-definition--613f2e26-407d-48c7-9eca-b8e91df99dc9",
+    "created": "2017-01-20T00:00:00.000Z",
+    "definition_type": "tlp",
+    "name": "TLP:WHITE",
+    "definition": {
+      "tlp": "white"
+    }
+  },
+  {
+    "type": "marking-definition",
+    "spec_version": "2.1",
+    "id": "marking-definition--34098fce-860f-48ae-8e50-ebd3cc5e41da",
+    "created": "2017-01-20T00:00:00.000Z",
+    "definition_type": "tlp",
+    "name": "TLP:GREEN",
+    "definition": {
+      "tlp": "green"
+    }
+  },
+  {
+    "type": "marking-definition",
+    "spec_version": "2.1",
+    "id": "marking-definition--f88d31f6-486f-44da-b317-01333bde0b82",
+    "created": "2017-01-20T00:00:00.000Z",
+    "definition_type": "tlp",
+    "name": "TLP:AMBER",
+    "definition": {
+      "tlp": "amber"
+    }
+  },
+  {
+    "type": "marking-definition",
+    "spec_version": "2.1",
+    "id": "marking-definition--5e57c739-391a-4eb3-b6be-7d15ca92d5ed",
+    "created": "2017-01-20T00:00:00.000Z",
+    "definition_type": "tlp",
+    "name": "TLP:RED",
+    "definition": {
+      "tlp": "red"
+    }
+  },
+  { 
+    "type": "marking-definition", 
+    "spec_version": "2.1", 
+    "id": "marking-definition--94868c89-83c2-464b-929b-a1a8aa3c8487", 
+    "created": "2022-10-01T00:00:00.000Z", 
+    "name": "TLP:CLEAR",
+    "extensions": {
+      "extension-definition--60a3c5c5-0d10-413e-aab3-9e08dde9e88d": {
+        "extension_type": "property-extension",
+        "tlp_2_0" : "clear"
+      }
+    }
+  },
+  { 
+    "type": "marking-definition", 
+    "spec_version": "2.1", 
+    "id": "marking-definition--bab4a63c-aed9-4cf5-a766-dfca5abac2bb", 
+    "created": "2022-10-01T00:00:00.000Z", 
+    "name": "TLP:GREEN",
+    "extensions": {
+      "extension-definition--60a3c5c5-0d10-413e-aab3-9e08dde9e88d": {
+        "extension_type": "property-extension",
+        "tlp_2_0" : "green"
+      }
+    }
+  },
+  { 
+    "type": "marking-definition", 
+    "spec_version": "2.1", 
+    "id": "marking-definition--55d920b0-5e8b-4f79-9ee9-91f868d9b421", 
+    "created": "2022-10-01T00:00:00.000Z", 
+    "name": "TLP:AMBER",
+    "extensions": {
+      "extension-definition--60a3c5c5-0d10-413e-aab3-9e08dde9e88d": {
+        "extension_type": "property-extension",
+        "tlp_2_0" : "amber"
+      }
+    }
+  },
+  { 
+    "type": "marking-definition", 
+    "spec_version": "2.1", 
+    "id": "marking-definition--939a9414-2ddd-4d32-a0cd-375ea402b003", 
+    "created": "2022-10-01T00:00:00.000Z", 
+    "name": "TLP:AMBER+STRICT",
+    "extensions": {
+      "extension-definition--60a3c5c5-0d10-413e-aab3-9e08dde9e88d": {
+        "extension_type": "property-extension",
+        "tlp_2_0" : "amber+strict"
+      }
+    }
+  },
+  { 
+    "type": "marking-definition", 
+    "spec_version": "2.1", 
+    "id": "marking-definition--e828b379-4e03-4974-9ac4-e53a884c97c1", 
+    "created": "2022-10-01T00:00:00.000Z", 
+    "name": "TLP:RED",
+    "extensions": {
+      "extension-definition--60a3c5c5-0d10-413e-aab3-9e08dde9e88d": {
+        "extension_type": "property-extension",
+        "tlp_2_0" : "red"
+      }
+    }
+  }
+]

stix2arango/utils.py

@@ -0,0 +1,150 @@
+from contextlib import contextmanager
+from functools import lru_cache
+import re
+import requests
+import logging
+import uuid
+import json
+import hashlib
+import os
+from . import config
+from datetime import UTC, datetime
+
+module_logger = logging.getLogger("data_ingestion_service")
+from arango.database import StandardDatabase
+
+
+EMBEDDED_RELATIONSHIP_RE = re.compile(r"([a-z\-_]+)[_\-]refs{0,1}")
+
+
+@lru_cache
+def load_file_from_url(url):
+    try:
+        response = requests.get(url)
+        response.raise_for_status()  # Raise an HTTPError for bad responses
+        return json.loads(response.text)
+    except requests.exceptions.RequestException as e:
+        raise Exception(f"Error loading JSON from {url}: {e}") from e
+
+
+def create_relationship_obj(
+    obj: dict,
+    source: str,
+    targets: list,
+    relationship: str,
+    insert_statement,
+    bundle_id: str,
+    arango_obj=None,
+    extra_data=None,
+):
+    if not isinstance(targets, list):
+        return []
+    for target in targets:
+        relationship_object = {
+            "relationship_type": relationship,
+        }
+        for key in ["created", "modified", "object_marking_refs"]:
+            if key in obj:
+                relationship_object[key] = obj[key]
+
+        relationship_object.update(
+            id="relationship--"
+            + str(
+                uuid.uuid5(
+                    config.namespace,
+                    "{}+{}+{}".format(relationship, source, target),
+                )
+            ),
+            created_by_ref=arango_obj.identity_ref["id"],
+        )
+
+        if not isinstance(target, str):
+            continue
+        relationship_object["source_ref"] = source
+        relationship_object["target_ref"] = target
+        relationship_object["_from"] = f"{arango_obj.core_collection_vertex}/{source}"
+        relationship_object["_to"] = f"{arango_obj.core_collection_vertex}/{target}"
+        relationship_object["_bundle_id"] = bundle_id
+        relationship_object["_file_name"] = os.path.basename(arango_obj.file or "")
+        relationship_object["_stix2arango_note"] = arango_obj.note
+        relationship_object["_is_ref"] = True
+        relationship_object["type"] = "relationship"
+        relationship_object["spec_version"] = "2.1"
+        relationship_object["external_references"] = [
+            {
+                "source_name": "stix2arango",
+                "description": "embedded-relationship",
+            }
+        ]
+        if extra_data:
+            relationship_object.update(extra_data)
+
+        insert_statement.append(relationship_object)
+    return
+
+
+def generate_md5(obj: dict):
+    obj_copy = {k: v for k, v in obj.items() if not k.startswith("_")}
+    for k in ["_from", "_to", "_stix2arango_note"]:
+        if v := obj.get(k):
+            obj_copy[k] = v
+    json_str = json.dumps(obj_copy, sort_keys=True, default=str).encode("utf-8")
+    return hashlib.md5(json_str).hexdigest()
+
+
+def get_vertex_and_edge_collection_names(name):
+    ENDINGS = ["vertex_collection", "edge_collection"]
+    splits = name.split("_")
+    if "_".join(splits[-2:]) in ENDINGS:
+        splits = splits[:-2]
+    return "_".join(splits + [ENDINGS[0]]), "_".join(splits + [ENDINGS[1]])
+
+
+def chunked(iterable, n):
+    if not iterable:
+        return []
+    for i in range(0, len(iterable), n):
+        yield iterable[i : i + n]
+
+
+def remove_duplicates(objects):
+    objects_hashmap = {}
+    for object in objects:
+        md5hash = object.get("_record_md5_hash")
+        if not md5hash:
+            md5hash = generate_md5(object)
+        key = "{id}/{hash}".format(id=object["id"], hash=md5hash)
+        objects_hashmap[key] = object
+    return list(objects_hashmap.values())
+
+
+def get_embedded_refs(object: list | dict, xpath: list = [], attributes=None):
+    embedded_refs = []
+    if isinstance(object, dict):
+        for key, value in object.items():
+            if key in ["source_ref", "target_ref"]:
+                continue
+            if match := EMBEDDED_RELATIONSHIP_RE.fullmatch(key):
+                relationship_type = "-".join(xpath + match.group(1).split("_"))
+                targets = value if isinstance(value, list) else [value]
+                targets = [
+                    _target
+                    for _target in targets
+                    if _target and isinstance(_target, str)
+                ]
+                if not targets:
+                    continue
+                if attributes and key not in attributes:
+                    continue
+                embedded_refs.append((relationship_type, targets))
+            elif isinstance(value, list):
+                embedded_refs.extend(
+                    get_embedded_refs(value, xpath + [key], attributes=attributes)
+                )
+    elif isinstance(object, list):
+        for obj in object:
+            if isinstance(obj, dict):
+                embedded_refs.extend(
+                    get_embedded_refs(obj, xpath, attributes=attributes)
+                )
+    return embedded_refs

stix2arango-1.1.10.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: stix2arango
+Version: 1.1.10
+Summary: stix2arango is a command line tool that takes a group of STIX 2.1 objects in a bundle and inserts them into ArangoDB. It can also handle updates to existing objects in ArangoDB imported in a bundle.
+Project-URL: Homepage, https://github.com/muchdogesec/stix2arango
+Project-URL: Issues, https://github.com/muchdogesec/stix2arango/issues
+Project-URL: dogesec HQ, https://dogesec.com
+Author: dogesec
+Maintainer: dogesec
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: ijson>=3.4.0
+Requires-Dist: jsonschema>=4.22.0; python_version >= '3.8'
+Requires-Dist: python-arango>=8.1.3; python_version >= '3.8'
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: requests>=2.31.0; python_version >= '3.7'
+Requires-Dist: stix2
+Requires-Dist: tqdm>=4.66.4; python_version >= '3.7'
+Description-Content-Type: text/markdown
+
+# stix2arango
+
+[![codecov](https://codecov.io/gh/muchdogesec/stix2arango/graph/badge.svg?token=YI0CEBBHHL)](https://codecov.io/gh/muchdogesec/stix2arango)
+
+## Overview
+
+![](docs/stix2arango.png)
+
+stix2arango is a command line tool that takes a group of STIX 2.1 objects in a bundle and inserts them into ArangoDB. It can also handle updates to existing objects in ArangoDB imported in a bundle.
+
+1. STIX 2.1 bundle entered
+2. User chooses database/collection names (stix2arango creates as needed)
+3. stix2arango inserts objects (or updates them) and then generates any relationships between them
+
+## tl;dr
+
+[![stix2arango](https://img.youtube.com/vi/zn6KCj2O5CY/0.jpg)](https://www.youtube.com/watch?v=zn6KCj2O5CY)
+
+[Watch the demo](https://www.youtube.com/watch?v=zn6KCj2O5CY).
+
+## Usage
+
+### Install the script
+
+```shell
+# clone the latest code
+git clone https://github.com/muchdogesec/stix2arango
+# create a venv
+cd stix2arango
+python3 -m venv stix2arango-venv
+source stix2arango-venv/bin/activate
+# install requirements
+pip3 install .
+````
+
+Note, the installation assumes ArangoDB is already installed locally.
+
+[You can install ArangoDB here](https://arangodb.com/download/). stix2arango is compatible with both the Enterprise and Community versions.
+
+### Configuration options
+
+stix2arango has various settings that are defined in an `.env` file.
+
+To create a template for the file:
+
+```shell
+cp .env.example .env
+```
+
+To see more information about how to set the variables, and what they do, read the `.env.markdown` file.
+
+### Run
+
+```shell
+python3 stix2arango.py \
+	--file PATH/TO/STIX.json \
+	--database NAME \
+	--collection NAME \
+	--stix2arango_note SOMETHING \
+	--ignore_embedded_relationships BOOLEAN
+```
+
+Where;
+
+* `--file` (required): is the path to the valid STIX 2.1 bundle .json file
+* `--database` (required): is the name of the Arango database the objects should be stored in. 
+* `--create_db` (default `true`): If database does not exist, stix2arango will create it. You can set to `false` to stop this behaviour (and avoid the risk of incorrect DBs being created). Generally setting to `false` is a good idea if you know the databases exist. This setting will only work if the Arango user being used to authenticate has permissions to create new databases.
+* `--collection` (required): is the name of the Arango collection in the database specified the objects should be stored in. If the collection does not exist, stix2arango will create it
+* `--stix2arango_note` (optional): Will be stored under the `_stix2arango_note` custom attribute in ArangoDB. Useful as can be used in AQL. `a-z` characters only. Max 24 chars.
+* `--ignore_embedded_relationships` (optional, boolean):  if `true` passed, this will stop ANY embedded relationships from being generated. This applies for all object types (SDO, SCO, SRO, SMO). If you want to target certain object types see `ignore_embedded_relationships_sro` and `ignore_embedded_relationships_sro` flags. ` Default is `false`
+* `--ignore_embedded_relationships_sro` (optional, boolean): if `true` passed, will stop any embedded relationships from being generated from SRO objects (`type` = `relationship`). Default is `false`
+* `--ignore_embedded_relationships_smo` (optional, boolean): if `true` passed, will stop any embedded relationships from being generated from SMO objects (`type` = `marking-defirnition`, `extension-definition`, `language-content`). Default is `false`
+* `--include_embedded_relationships_attributes` (optional, stix `_ref` or `_refs` attribute): if you only want to create embedded relationships from certain keys (attributes) in a STIX object you can pass a list of attributes here. e.g. `object_refs created_by_ref` . In this example, embedded relationships to all objects listed in `object_refs` and objects in `created_by_ref` will be created between source (the objects that house these attibutes) and destinations (the objects listed as values for these attributes)
+* `--is_large_file` (pass flag): Use this mode when the bundle is very large (>100mb), this will chunk the input into multiple files before loading into memory.
+
+For example, [using the MITRE ATT&CK Enterprise bundle](https://raw.githubusercontent.com/mitre/cti/master/enterprise-attack/enterprise-attack.json);
+
+```shell
+python3 stix2arango.py \
+	--file cti_knowledge_base_store/mitre-attack-enterprise/enterprise-attack-15_1.json \
+	--database stix2arango_demo \
+	--collection demo_1 \
+	--stix2arango_note v15.1 \
+	--ignore_embedded_relationships true \
+	--is_large_file
+```
+
+If you want to include embedded relationships as edges in the ArangoDB collection, you would run;
+
+```shell
+python3 stix2arango.py \
+	--file cti_knowledge_base_store/mitre-attack-enterprise/enterprise-attack-15_1.json \
+	--database stix2arango_demo \
+	--collection demo_2 \
+	--stix2arango_note v15.1 \
+	--ignore_embedded_relationships false \
+	--is_large_file
+```
+
+If you want to include embedded relationships for `created_by_ref` and `object_marking_refs` attibutes collection, you would run;
+
+```shell
+python3 stix2arango.py \
+	--file cti_knowledge_base_store/mitre-attack-enterprise/enterprise-attack-15_1.json \
+	--database stix2arango_demo \
+	--collection demo_2 \
+	--stix2arango_note v15.1 \
+	--include_embedded_relationships_attributes object_refs created_by_ref \
+	--is_large_file
+```
+
+#### A note on embedded relationships
+
+stix2arango can handle all embedded references to other STIX objects under `_ref` and `_refs` properties in a STIX object when `--ignore_embedded_relationships` is set to false.
+
+e.g.
+
+```json
+        {
+            "type": "x-mitre-tactic",
+            "spec_version": "2.1",
+            "id": "x-mitre-tactic--b977ad29-eb0c-5f09-bb2f-6d3f23e2a175",
+            "created_by_ref": "identity--8700e156-6ce9-5090-8589-f9d0aef7bdb7",
+```
+
+For the above object a STIX SRO would be generated by stix2arango with `source_ref=x-mitre-tactic--b977ad29-eb0c-5f09-bb2f-6d3f23e2a175`, `target_ref=identity--8700e156-6ce9-5090-8589-f9d0aef7bdb7` and `relationship_type=created-by`.
+
+## Quickstart
+
+We store a lot of STIX data from popular knowledgebases on Cloudflare R2.
+
+This is a useful resource to quickly populate STIX data using stix2arango if you want to see what it can do.
+
+To populate this data for yourself, check out `utilities/README.md` for import scripts.
+
+## Useful supporting tools
+
+* To generate STIX 2.1 Objects: [stix2 Python Lib](https://stix2.readthedocs.io/en/latest/)
+* The STIX 2.1 specification: [STIX 2.1 docs](https://docs.oasis-open.org/cti/stix/v2.1/stix-v2.1.html)
+* [ArangoDB docs](https://docs.arangodb.com/3.11/about-arangodb/)
+
+## Support
+
+[Minimal support provided via the DOGESEC community](https://community.dogesec.com/).
+
+## License
+
+[Apache 2.0](/LICENSE).

stix2arango-1.1.10.dist-info/RECORD

@@ -0,0 +1,16 @@
+stix2arango/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+stix2arango/__main__.py,sha256=zsCi_bfDULLDkqlRwXyGhFuLvSRcvESEc4MMN7h1lbQ,2835
+stix2arango/config.py,sha256=NZFrcnEfz-0QBrut2Rh7xMF78v0bk6U6y2TY_7mHxSs,1407
+stix2arango/utils.py,sha256=CDbLevt-95V6f97rbWRjG-uT2-vPrHFsz4JW7mJ9HyQ,4986
+stix2arango/services/__init__.py,sha256=E87fB-dxI4mPxMVs00jdLhjp9jFhkVfjhMKIqGLRJlY,45
+stix2arango/services/arangodb_service.py,sha256=4iF3tfQqHb-j5zcYQ4UYEEnTMaaCRgdFNmbt3Oe4LpA,12092
+stix2arango/services/version_annotator.py,sha256=na-yyEFNCfLZnV4Sq64BDzTy90LrWgx811qcY7dlMx0,3288
+stix2arango/stix2arango/__init__.py,sha256=OqxWEEsHqR1QQpznM5DbFJ5bO5numKYtoYhjXYJMEyg,36
+stix2arango/stix2arango/bundle_loader.py,sha256=YphKnJIiHjg_nuQUf59OUthDOVIQYoOIoOqqQUlU1II,4982
+stix2arango/stix2arango/stix2arango.py,sha256=HJXDqA9NWxXVQSHPmbpkEKurpWEbZmy5bng5SQ1OsjE,22412
+stix2arango/templates/marking-definition.json,sha256=0q9y35mUmiF6xIWSLpkATL4JTHGSCNyLbejqZiQ0AuE,3113
+stix2arango-1.1.10.dist-info/METADATA,sha256=ke2N0AC0cwmVeBKHh_3bufzTOR3TYXt6c0ixrG2Bcu4,7798
+stix2arango-1.1.10.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+stix2arango-1.1.10.dist-info/entry_points.txt,sha256=k2WnxMsHFLoyC6rqfvjhIMS1zwtWin51-MbNCGmSMYE,58
+stix2arango-1.1.10.dist-info/licenses/LICENSE,sha256=BK8Ppqlc4pdgnNzIxnxde0taoQ1BgicdyqmBvMiNYgY,11364
+stix2arango-1.1.10.dist-info/RECORD,,

stix2arango-1.1.10.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

stix2arango-1.1.10.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+stix2arango = stix2arango.__main__:main

stix2arango-1.1.10.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 DOGESEC (https://www.dogesec.com/)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.