Merge pull request #164 from intelowlproject/develop

4.1.5

Author: mlodic

.flac

@@ -1,5 +1,10 @@
 # Changelog
 
+## [4.1.5](https://github.com/intelowlproject/pyintelowl/releases/tag/4.1.5)
+
+- dependencies upgrade
+- #163
+
 ## [4.1.4](https://github.com/intelowlproject/pyintelowl/releases/tag/4.1.4)
 
 - Added support for URLs that use TCP as protocol

.github/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Checklist for creating a new release
+
+- [ ] Update `CHANGELOG.md` for the new version
+- [ ] Change version number in `docs.config.py`, `pyintelowl/version.py`
+- [ ] Verify CI Tests
+- [ ] Merge the PR to the `master` branch. **Note:** Only use "Merge and commit" as the merge strategy and not "Squash and merge". Using "Squash and merge" makes history between branches misaligned.
+
+

.github/release_template.md

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/psf/black
-    rev: 21.9b0
+    rev: 22.3.0
     hooks:
     - id: black
 -   repo: https://gitlab.com/pycqa/flake8

.pre-commit-config.yaml

@@ -13,7 +13,7 @@
 import os
 import sys
 
-VERSION = "4.1.4"
+VERSION = "4.1.5"
 GITHUB_URL = "https://github.com/intelowlproject/pyintelowl"
 
 sys.path.append(os.path.abspath("../"))

docs/conf.py

@@ -1,4 +1,4 @@
-Sphinx==4.1.1
+Sphinx==5.0.1
 sphinx-rtd-theme
 sphinxcontrib.asciinema
 sphinxcontrib-napoleon

docs/requirements.txt

@@ -211,6 +211,7 @@ def send_observable_analysis_request(
         connectors_requested: List[str] = None,
         runtime_configuration: Dict = None,
         tags_labels: List[str] = None,
+        observable_classification: str = None,
     ) -> Dict:
         """Send analysis request for an observable.\n
         Endpoint: ``/api/analyze_observable``
@@ -231,9 +232,14 @@ def send_observable_analysis_request(
                 Overwrite configuration for analyzers. Defaults to ``{}``.
             tags_labels (List[str], optional):
                 List of tag labels to assign (creates non-existing tags)
+            observable_classification (str):
+                Observable classification, Default to None.
+                By default launch analysis with an automatic classification.
+                (options: ``url, domain, hash, ip, generic``)
 
         Raises:
             IntelOwlClientException: on client/HTTP error
+            IntelOwlClientException: on wrong observable_classification
 
         Returns:
             Dict: JSON body
@@ -249,11 +255,24 @@ def send_observable_analysis_request(
                 tags_labels = []
             if not runtime_configuration:
                 runtime_configuration = {}
+            if not observable_classification:
+                observable_classification = self._get_observable_classification(
+                    observable_name
+                )
+            elif observable_classification not in [
+                "generic",
+                "hash",
+                "ip",
+                "domain",
+                "url",
+            ]:
+                raise IntelOwlClientException(
+                    "Observable classification only handle"
+                    " 'generic', 'hash', 'ip', 'domain' and 'url' "
+                )
             data = {
                 "observable_name": observable_name,
-                "observable_classification": self._get_observable_classification(
-                    observable_name
-                ),
+                "observable_classification": observable_classification,
                 "analyzers_requested": analyzers_requested,
                 "connectors_requested": connectors_requested,
                 "tlp": tlp,

pyintelowl/pyintelowl.py

@@ -1 +1 @@
-__version__ = "4.1.4"
+__version__ = "4.1.5"

pyintelowl/version.py

@@ -1,4 +1,4 @@
-requests~=2.26
+requests~=2.27
 geocoder~=1.38
 click>=7.0
 rich~=10.13

requirements.txt

@@ -1,7 +1,7 @@
-black==21.9b0
+black==22.3.0
 flake8==4.0.1
 isort==5.10.1
-pre-commit==2.12.1
-tox==3.24.4
-tox-gh-actions==2.5.0
+pre-commit==2.17.0
+tox==3.24.5
+tox-gh-actions==2.9.1
 codecov==2.1.12

test-requirements.txt

@@ -114,6 +114,24 @@ def test_send_observable_analysis_request_failure(self, mocked_requests):
                 runtime_configuration=runtime_config,
             )
 
+    @mock_connections(
+        patch("requests.Session.post", side_effect=mocked_raise_exception)
+    )
+    def test_send_observable_analysis_request_failure_classify(self, mocked_requests):
+        observable_name = self.domain
+        analyzers_requested = ["test_1", "test_2"]
+        connectors_requested = ["test_1", "test_2"]
+        runtime_config = {"test_key": "test_param"}
+        observable_classification = "unavailable"
+        with self.assertRaises(IntelOwlClientException):
+            self.client.send_observable_analysis_request(
+                observable_name,
+                analyzers_requested=analyzers_requested,
+                connectors_requested=connectors_requested,
+                runtime_configuration=runtime_config,
+                observable_classification=observable_classification,
+            )
+
     @mock_connections(
         patch("requests.Session.post", side_effect=mocked_send_analysis_success)
     )