added information above licenses

cyntelligence/FileAnalyze.py

@@ -1,5 +1,9 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# FileAnalyze module for sending file hashes to analyze for possible
+# existing threats
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

cyntelligence/IPEnrich.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# IPEnrich module for enriching IP addresses information
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

cyntelligence/__init__.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Initialization file for cyntelligence.
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,4 +20,4 @@
 from .IPEnrich import IPEnrich
 from .FileAnalyze import FileAnalyze
 
-__all__ = ['IPEnrich', 'FileAnalyze']
+__all__ = ['IPEnrich', 'FileAnalyze']

cyntelligence/common/cache.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Cache utilities for implementing time-invalidation cache
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -37,4 +40,4 @@ def _wrapped(*args, **kwargs):
 
         return _wrapped
 
-    return _decorator
+    return _decorator

cyntelligence/datasource/BaseSource.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Base Data Source file for implementing data source
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

cyntelligence/datasource/QRadar.py

@@ -1,5 +1,9 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# QRadar Data Source file for interacting with QRadar instance
+# via its Ariel API
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,7 +22,7 @@
 from typing import Any
 
 import requests
-from cyntelligence.datasource import BaseSource
+from . import BaseSource
 import os
 
 class QRadar(BaseSource):
@@ -59,5 +63,4 @@ def _get_info_cache(self, ip) -> list[dict]:
                         return body_response
 
         # if any of the steps failed
-        return False
-
+        return [{}]

cyntelligence/datasource/__init__.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Initialization file for datasource module
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,4 +19,4 @@
 
 from .QRadar import QRadar
 
-__all__ = ["QRadar"]
+__all__ = ["QRadar"]

cyntelligence/feature_flags.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Feature Flags file for enabling or disabling features
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,4 +21,4 @@
 VIRUSTOTAL_SOURCE = True
 ABUSEIPDB_SOURCE = True
 
-QRADAR_SOURCE = True
+QRADAR_SOURCE = True

cyntelligence/intelsource/AbuseIPDB.py

@@ -1,5 +1,9 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# AbuseIPDB Intelligence Source File for interacting with
+# AbuseIPDB via its API
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

cyntelligence/intelsource/BaseSource.py

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Base intelligence source file for implementing intelsource file
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

cyntelligence/intelsource/VirusTotal.py

@@ -1,5 +1,9 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# VirusTotal Intelligence Source file for interacting with
+# VirusTotal platform via vt-py
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

cyntelligence/intelsource/__init__.py

@@ -1,4 +1,23 @@
+# ----------------------------------------------------------------------
+# Initialization file for intelsource module
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
+#
+# 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.
+# ----------------------------------------------------------------------
+
 from .VirusTotal import VirusTotal
 from .AbuseIPDB import AbuseIPDB
 
-__all__ = ["VirusTotal", "AbuseIPDB"]
+__all__ = ["VirusTotal", "AbuseIPDB"]

main.py

@@ -1,5 +1,9 @@
 # ----------------------------------------------------------------------
-# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net> on behalf of Up Up Up All Night
+# Main Automated Investigator File containing the web interface
+# and most of the logic.
+#
+# Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
+# on behalf of Up Up Up All Night
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.