Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions keepercommander/commands/aram.py
Original file line number Diff line number Diff line change
Expand Up @@ -570,9 +570,12 @@ def __init__(self):
def convert_event(self, props, event):
pri = 13 * 8 + 6
dt = datetime.datetime.fromtimestamp(event['created'], tz=datetime.timezone.utc)
ip = "-"
if 'ip_address' in event:
ip = event['ip_address']
# RFC 5424 section 6: HOSTNAME = NILVALUE / 1*255PRINTUSASCII (codes 33-126).
# Fall back to NILVALUE "-" for missing, null, empty, whitespace or non-printable values.
ip = str(event.get('ip_address') or '').strip()
if not ip or not all(33 <= ord(ch) <= 126 for ch in ip):
ip = '-'
ip = ip[:255]

message = '<{0}>1 {1} {2} {3} - {4}'.format(pri, dt.strftime('%Y-%m-%dT%H:%M:%SZ'), ip, 'Keeper', event['id'])

Expand Down
64 changes: 64 additions & 0 deletions unit-tests/test_audit_log_syslog.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
"""syslog export must emit a valid RFC 5424 HOSTNAME."""
import pytest

import keepercommander.commands.aram as aram


@pytest.fixture(autouse=True)
def seed_templates(monkeypatch):
# convert_event() reads the module-level template cache, normally loaded from the server.
monkeypatch.setattr(aram, 'syslog_templates',
{'device_approved': 'Device ${device_name} is approved for user ${username}'})


BASE_EVENT = {
'id': 24983911115,
'created': 1788369452, # 2026-09-02T17:17:32Z
'audit_event_type': 'device_approved',
'device_name': 'Browser Extension',
'username': 'test@example.com',
}


def header_hostname(line):
# HEADER = PRI VERSION SP TIMESTAMP SP HOSTNAME SP APP-NAME ...
parts = line.split(' ')
return parts[2], parts[3]


@pytest.mark.parametrize('exporter_cls', [aram.AuditLogSyslogFileExport, aram.AuditLogSyslogPortExport])
@pytest.mark.parametrize('ip_value, expected', [
(None, '-'), # key present with null
('', '-'), # empty string — backend may return "" instead of omitting the key
(' ', '-'),
('\t', '-'),
('10.0.0.1​', '-'), # non-printable / non-ASCII
('10.0.0.1\x00', '-'),
('10.0.12.64', '10.0.12.64'),
(' 10.0.12.64 ', '10.0.12.64'),
('2001:db8::1', '2001:db8::1'),
])
def test_hostname_is_rfc5424_valid(exporter_cls, ip_value, expected):
event = {**BASE_EVENT, 'ip_address': ip_value}
line = exporter_cls().convert_event({}, event)
hostname, app_name = header_hostname(line)
assert hostname == expected
assert app_name == 'Keeper'
assert ' ' not in line.split(' [', 1)[0]


def test_missing_key_still_uses_nilvalue():
line = aram.AuditLogSyslogFileExport().convert_event({}, dict(BASE_EVENT))
assert line.startswith('<110>1 2026-09-02T17:17:32Z - Keeper - 24983911115 ')


def test_hostname_truncated_to_255():
event = {**BASE_EVENT, 'ip_address': 'a' * 300}
hostname, _ = header_hostname(aram.AuditLogSyslogFileExport().convert_event({}, event))
assert len(hostname) == 255


def test_ip_address_not_duplicated_in_structured_data():
event = {**BASE_EVENT, 'ip_address': ''}
line = aram.AuditLogSyslogFileExport().convert_event({}, event)
assert 'ip_address=' not in line
Loading