django-log-formatter-asim 1.1.0a1__tar.gz → 1.1.0a3__tar.gz

{django_log_formatter_asim-1.1.0a1 → django_log_formatter_asim-1.1.0a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-log-formatter-asim
-Version: 1.1.0a1
+Version: 1.1.0a3
 Summary: Formats Django logs in ASIM format.
 License: MIT
 Author: Department for Business and Trade Platform Team
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: ddtrace (>=3.2.1,<4.0.0)
 Requires-Dist: django (>=3,<5) ; python_version == "3.9"
 Requires-Dist: django (>=3,<6) ; python_version >= "3.10" and python_version < "4"
+Requires-Dist: django-ipware (>=7.0.1,<8.0.0)
 Description-Content-Type: text/markdown
 
 # Django ASIM log formatter

{django_log_formatter_asim-1.1.0a1 → django_log_formatter_asim-1.1.0a3}/django_log_formatter_asim/__init__.py

@@ -1,8 +1,9 @@
 import json
 import logging
+import os
 from datetime import datetime
+from datetime import timezone
 from importlib.metadata import distribution
-import os
 
 import ddtrace
 from ddtrace.trace import tracer
@@ -70,7 +71,7 @@ class ASIMRootFormatter:
 
     def get_log_dict(self):
         record = self.record
-        log_time = datetime.utcfromtimestamp(record.created).isoformat()
+        log_time = datetime.fromtimestamp(record.created, timezone.utc).isoformat()
         log_dict = {
             # Event fields...
             "EventMessage": record.getMessage(),
@@ -200,14 +201,6 @@ class ASIMRequestFormatter(ASIMRootFormatter):
             http_user_agent = request.META.get("HTTP_USER_AGENT", None)
         return http_user_agent
 
-    def _get_ip_address(self, request):
-        # Import here as ipware uses settings
-        from ipware import get_client_ip
-
-        client_ip, is_routable = get_client_ip(request)
-        return client_ip or "Unknown"
-
-
 ASIM_FORMATTERS = {
     "root": ASIMRootFormatter,
     "django.request": ASIMRequestFormatter,

{django_log_formatter_asim-1.1.0a1 → django_log_formatter_asim-1.1.0a3}/django_log_formatter_asim/events/authentication.py

@@ -12,6 +12,7 @@ from .common import Result
 from .common import Server
 from .common import Severity
 from .common import _default_severity
+from .common import _get_client_ip_address
 
 
 class AuthenticationEvent(str, Enum):
@@ -50,6 +51,12 @@ class AuthenticationUser(TypedDict):
     """
     username: Optional[str]
     """
+    Email address for the user if one exists.
+
+    Defaults to the logged in Django User.email if not provided.
+    """
+    email: Optional[str]
+    """
     A unique identifier for this authentication session if one exists.
 
     Defaults to the Django Sessions session key if not provided.
@@ -78,6 +85,7 @@ def log_authentication(
                         - Django Authentication systems current username
                         - Django Session middlewares Session Key
                         - Client IP address
+                        - URL requested by the client
                         - Server hostname
     :param event: What authentication action was attempted, either "Logon" or "Logoff"
     :param result: What outcome did the action have, either "Success", "Failure", "Partial", "NA"
@@ -126,13 +134,18 @@ def log_authentication(
 
     if "hostname" in server:
         log["DvcHostname"] = server["hostname"]
-    elif hasattr(request, "environ") and "SERVER_NAME" in request.environ:
-        log["DvcHostname"] = request.environ["SERVER_NAME"]
+    elif "HTTP_HOST" in request.META:
+        log["DvcHostname"] = request.get_host()
 
     if "ip_address" in client:
         log["SrcIpAddr"] = client["ip_address"]
-    elif hasattr(request, "environ") and "REMOTE_ADDR" in request.environ:
-        log["SrcIpAddr"] = request.environ.get("REMOTE_ADDR")
+    elif client_ip := _get_client_ip_address(request):
+        log["SrcIpAddr"] = client_ip
+
+    if "requested_url" in client:
+        log["TargetUrl"] = client["requested_url"]
+    elif "HTTP_HOST" in request.META:
+        log["TargetUrl"] = request.scheme + "://" + request.get_host() + request.get_full_path()
 
     if "role" in user:
         log["ActorUserType"] = user["role"]
@@ -143,9 +156,14 @@ def log_authentication(
         log["ActorSessionId"] = request.session.session_key
 
     if "username" in user:
-        log["ActorUsername"] = user["username"]
-    elif request.user.username:
-        log["ActorUsername"] = request.user.username
+        log["TargetUsername"] = user["username"]
+    elif hasattr(request, "user") and request.user.username:
+        log["TargetUsername"] = request.user.username
+
+    if "email" in user:
+        log["ActorUsername"] = user["email"]
+    elif hasattr(request, "user") and hasattr(request.user, "email") and request.user.email:
+        log["ActorUsername"] = request.user.email
 
     if result_details:
         log["EventResultDetails"] = result_details

{django_log_formatter_asim-1.1.0a1 → django_log_formatter_asim-1.1.0a3}/django_log_formatter_asim/events/common.py

@@ -2,6 +2,8 @@ from enum import Enum
 from typing import Optional
 from typing import TypedDict
 
+from django.http import HttpRequest
+
 
 class Result(str, Enum):
     Success = "Success"
@@ -23,6 +25,8 @@ class Client(TypedDict):
     """Internet Protocol Address of the client making the Authentication
     event."""
     ip_address: Optional[str]
+    """URL requested by the client."""
+    requested_url: Optional[str]
 
 
 class Server(TypedDict):
@@ -31,7 +35,7 @@ class Server(TypedDict):
     """
     A unique identifier for the server which serviced the Authentication event.
 
-    Defaults to the WSGI SERVER_NAME field if not provided.
+    Defaults to the WSGI HTTP_HOST field if not provided.
     """
     hostname: Optional[str]
     """Internet Protocol Address of the server serving this request."""
@@ -40,3 +44,11 @@ class Server(TypedDict):
 
 def _default_severity(result: Result) -> Severity:
     return Severity.Informational if result == Result.Success else Severity.Medium
+
+
+def _get_client_ip_address(request: HttpRequest) -> Optional[str]:
+    # Import here as ipware uses settings
+    from ipware import get_client_ip
+
+    client_ip, _ = get_client_ip(request)
+    return client_ip

{django_log_formatter_asim-1.1.0a1 → django_log_formatter_asim-1.1.0a3}/django_log_formatter_asim/events/file_activity.py

@@ -12,6 +12,7 @@ from .common import Result
 from .common import Server
 from .common import Severity
 from .common import _default_severity
+from .common import _get_client_ip_address
 
 
 class FileActivityEvent(str, Enum):
@@ -92,6 +93,7 @@ def log_file_activity(
                     from which the following data will be logged if available
                         - Django Authentication systems current username
                         - Client IP address
+                        - URL requested by the client
                         - Server hostname
     :param event: What File Event action was attempted, one of:
                         - FileAccessed
@@ -167,18 +169,23 @@ def log_file_activity(
 
     if "hostname" in server:
         log["DvcHostname"] = server["hostname"]
-    elif hasattr(request, "environ") and "SERVER_NAME" in request.environ:
-        log["DvcHostname"] = request.environ["SERVER_NAME"]
+    elif "HTTP_HOST" in request.META:
+        log["DvcHostname"] = request.get_host()
 
     if "ip_address" in client:
         log["SrcIpAddr"] = client["ip_address"]
-    elif hasattr(request, "environ") and "REMOTE_ADDR" in request.environ:
-        log["SrcIpAddr"] = request.environ.get("REMOTE_ADDR")
+    elif client_ip := _get_client_ip_address(request):
+        log["SrcIpAddr"] = client_ip
+
+    if "requested_url" in client:
+        log["TargetUrl"] = client["requested_url"]
+    elif "HTTP_HOST" in request.META:
+        log["TargetUrl"] = request.scheme + "://" + request.get_host() + request.get_full_path()
 
     if "username" in user:
-        log["ActorUsername"] = user["username"]
+        log["TargetUsername"] = user["username"]
     elif request.user.username:
-        log["ActorUsername"] = request.user.username
+        log["TargetUsername"] = request.user.username
 
     if result_details:
         log["EventResultDetails"] = result_details

{django_log_formatter_asim-1.1.0a1 → django_log_formatter_asim-1.1.0a3}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "django-log-formatter-asim"
-version = "1.1.0a1"
+version = "1.1.0a3"
 description = "Formats Django logs in ASIM format."
 authors = ["Department for Business and Trade Platform Team <sre-team@digital.trade.gov.uk>"]
 license = "MIT"
@@ -19,12 +19,13 @@ django = [
     { version = ">=3,<6", python = ">=3.10,<4" },
 ]
 ddtrace = "^3.2.1"
+django-ipware = "^7.0.1"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.5.0"
 pytest = "^7.4.3"
 tox = "^4.11.3"
-freezegun = "^1.2.2"
+freezegun = "^1.5.2"
 pytest-django = "^4.7.0"
 importlib-metadata = "^6.8.0"