NAS-130700 / 25.04 / Add support for remote controller audit query and download

src/middlewared/middlewared/plugins/audit/audit.py

@@ -31,7 +31,7 @@
     accepts, Bool, Datetime, Dict, Int, List, Patch, Ref, returns, Str, UUID
 )
 from middlewared.service import filterable, filterable_returns, job, private, ConfigService
-from middlewared.service_exception import CallError, ValidationErrors
+from middlewared.service_exception import CallError, ValidationErrors, ValidationError
 from middlewared.utils import filter_list
 from middlewared.utils.mount import getmntinfo
 from middlewared.utils.functools_ import cache
@@ -135,6 +135,7 @@ async def compress(self, data):
         List('services', items=[Str('db_name', enum=ALL_AUDITED)], default=NON_BULK_AUDIT),
         Ref('query-filters'),
         Ref('query-options'),
+        Bool('remote_controller', default=False),
         register=True
     ))
     @filterable_returns(Dict(
@@ -159,6 +160,9 @@ async def query(self, data):
         converted into a more efficient form for better performance. This will
         not be possible if filters use keys within `svc_data` and `event_data`.
 
+        HA systems may direct the query to the 'remote' controller by
+        including 'remote_controller=True'.  The default is the 'current' controller.
+
         Each audit entry contains the following keys:
 
         `audit_id` - GUID uniquely identifying this specific audit event.
@@ -193,9 +197,27 @@ async def query(self, data):
         `success` - boolean value indicating whether the action generating the
         event message succeeded.
         """
-        sql_filters = data['query-options']['force_sql_filters']
 
         verrors = ValidationErrors()
+
+        # If HA, handle the possibility of remote controller requests
+        ctrlr_state = await self.middleware.call('failover.status')
+        if ctrlr_state != 'SINGLE' and data['remote_controller']:
+            try:
+                if audit_query := self.middleware.call(
+                    'failover.call_remote',
+                    'audit.query',
+                    [data],
+                    {'raise_connect_error': False, 'timeout': 2, 'connect_timeout': 2}
+                ):
+                    return audit_query
+            except Exception:
+                self.logger.exception('Unexpected failure querying remote node for audit entries')
+            else:
+                raise ValidationError('audit.query.remote_controller', 'Failed to query audit logs of remote controller')
+
+        sql_filters = data['query-options']['force_sql_filters']
+
         if (select := data['query-options'].get('select')):
             for idx, entry in enumerate(select):
                 if isinstance(entry, list):

src/middlewared/middlewared/plugins/audit/utils.py

@@ -25,6 +25,7 @@
     AuditEventParam.SUCCESS.value,
 )
 
+
 AuditBase = declarative_base()
 
 

tests/api2/test_audit_basic.py

@@ -4,6 +4,7 @@
 from middlewared.test.integration.utils import call, url
 from middlewared.test.integration.utils.audit import get_audit_entry
 
+from auto_config import ha
 from protocols import smb_connection
 from time import sleep
 
@@ -43,7 +44,6 @@ class AUDIT_CONFIG():
     }
 
 
-# def get_zfs(key, zfs_config):
 def get_zfs(data_type, key, zfs_config):
     """ Get the equivalent ZFS value associated with the audit config setting """
 
@@ -64,10 +64,27 @@ def get_zfs(data_type, key, zfs_config):
             'used_by_reservation': zfs_config['properties']['usedbyrefreservation']['parsed']
         }
     }
-    # return zfs[key]
     return types[data_type][key]
 
 
+def check_audit_download(report_path, report_type, tag=None):
+    """ Download audit DB (root user)
+    If requested, assert the tag is present
+    INPUT: report_type ['CSV'|'JSON'|'YAML']
+    RETURN: lenght of content (bytes)
+    """
+    job_id, url_path = call(
+        "core.download", "audit.download_report",
+        [{"report_name": os.path.basename(report_path)}],
+        f"report.{report_type.lower()}"
+    )
+    r = requests.get(f"{url()}{url_path}")
+    r.raise_for_status()
+    if tag is not None:
+        assert f"{tag}" in r.text
+    return len(r.content)
+
+
 @pytest.fixture(scope='class')
 def initialize_for_smb_tests():
     with dataset('audit-test-basic', data={'share_type': 'SMB'}) as ds:
@@ -97,6 +114,29 @@ def init_audit():
         call('audit.update', AUDIT_CONFIG.defaults)
 
 
+@pytest.fixture(scope='class')
+def standby_user():
+    """ HA system: Create a user on the BACKUP node
+    This will generate a 'create' audit entry, yield,
+    and on exit generate a 'delete' audit entry.
+    """
+    user_id = None
+    try:
+        name = "StandbyUser" + PASSWD
+        user_id = call('failover.call_remote', 'user.create', [{
+            "username": name,
+            "full_name": name + " Deleteme",
+            "group": 100,
+            "smb": False,
+            "home_create": False,
+            "password": "testing"
+        }])
+        yield name
+    finally:
+        if user_id is not None:
+            call('failover.call_remote', 'user.delete', [user_id])
+
+
 # =====================================================================
 #                           Tests
 # =====================================================================
@@ -242,14 +282,8 @@ def test_audit_export(self):
             st = call('filesystem.stat', report_path)
             assert st['size'] != 0, str(st)
 
-            job_id, path = call(
-                "core.download", "audit.download_report",
-                [{"report_name": os.path.basename(report_path)}],
-                f"report.{backend.lower()}"
-            )
-            r = requests.get(f"{url()}{path}")
-            r.raise_for_status()
-            assert len(r.content) == st['size']
+            content_len = check_audit_download(report_path, backend)
+            assert content_len == st['size']
 
     def test_audit_export_nonroot(self):
         with unprivileged_user_client(roles=['SYSTEM_AUDIT_READ', 'FILESYSTEM_ATTRS_READ']) as c:
@@ -262,6 +296,7 @@ def test_audit_export_nonroot(self):
                 st = c.call('filesystem.stat', report_path)
                 assert st['size'] != 0, str(st)
 
+                # Make the call as the client
                 job_id, path = c.call(
                     "core.download", "audit.download_report",
                     [{"report_name": os.path.basename(report_path)}],
@@ -282,3 +317,47 @@ def test_audit_timestamps(self, svc):
         ae_ts_ts = int(audit_entry['timestamp'].timestamp())
         ae_msg_ts = int(audit_entry['message_timestamp'])
         assert abs(ae_ts_ts - ae_msg_ts) < 2, f"$date='{ae_ts_ts}, message_timestamp={ae_msg_ts}"
+
+
+@pytest.mark.skipif(not ha, reason="Skip HA tests")
+class TestAuditOpsHA:
+    def test_audit_ha_query(self, standby_user):
+        name = standby_user
+        remote_user = call('failover.call_remote', 'user.query', [[["username", "=", name]]])
+        assert remote_user != []
+
+        # Handle delays in the audit database
+        remote_audit_entry = []
+        tries = 3
+        while tries > 0 and remote_audit_entry == []:
+            sleep(1)
+            remote_audit_entry = call('audit.query', {
+                "query-filters": [["event_data.description", "$", name]],
+                "query-options": {"select": ["event_data", "success"]},
+                "remote_controller": True
+            })
+            if remote_audit_entry != []:
+                break
+            tries -= 1
+
+        assert tries > 0, "Failed to get expected audit entry"
+        assert remote_audit_entry != []
+        params = remote_audit_entry[0]['event_data']['params'][0]
+        assert params['username'] == name
+
+    def test_audit_ha_export(self, standby_user):
+        """
+        Confirm we can download 'Active' and 'Standby' audit DB.
+        With a user created on the 'Standby' controller download the
+        audit DB from both controllers and confirm the user create is
+        in the 'Standby' audit DB and not in the 'Active' audit DB.
+        """
+        report_path_active = call('audit.export', {'export_format': 'CSV'}, job=True)
+        report_path_standby = call('audit.export', {'export_format': 'CSV', 'remote_controller': True}, job=True)
+
+        # Confirm entry NOT in active controller audit DB
+        with pytest.raises(AssertionError):
+            check_audit_download(report_path_active, 'CSV', f"Create user {standby_user}")
+
+        # Confirm entry IS in standby controller audit DB
+        check_audit_download(report_path_standby, 'CSV', f"Create user {standby_user}")