Skip to main content

Audit Tools

Send the audit log to your SIEM and export it as CSV or NDJSON.

Access & SecuritySourceAPIChangelog
  • Forward every audit entry to an HTTP collector as it happens
  • Catch up on entries written while the collector or Termix was down
  • Export the audit log as CSV or NDJSON with the same filters as the viewer
  • Spreadsheet formula guard on CSV export
  • Check the audit log's hash chain, download its newest hash to keep elsewhere and compare it later
  • Forwarded and exported entries carry their chain hash

Audit Tools sends your audit log to other systems and checks that it was not changed. It forwards each audit entry to a collector as it happens, exports the log as a file and shows the log's hash chain.

Termix still writes, shows and prunes the audit log itself. This plugin only copies it out.

Turn it on​

  1. Install Audit Tools from the Plugins tab.
  2. Open its settings and fill in the collector URL. Add a bearer token if your collector wants one.

An empty URL turns forwarding off.

Forwarding​

Each entry is posted to the collector as one line of JSON, with the content type application/x-ndjson. The token is sent as Authorization: Bearer <token>. The request times out after 5 seconds and the collector must answer with a 2xx status.

Forwarding never slows down or blocks what was audited. If the collector is down, the plugin keeps the time of the last entry it delivered and sends the missed ones from the stored log, oldest first, when the collector is back. It checks every 30 seconds. One catch up run sends at most 5000 entries, then carries on at the next check. Entries older than your audit log retention cannot be sent.

The first time you set a URL, only new entries are sent. The existing log is not replayed. Use the export for that.

Only public addresses are allowed. A collector on a private network is refused.

Instead of the settings you can set AUDIT_LOG_FORWARD_URL and AUDIT_LOG_FORWARD_TOKEN on the server. The URL in the settings wins over the variable, and the token follows the URL that is used.

Export​

Admins see Export CSV and Export NDJSON buttons in the audit log section of Settings. The export uses the filters you have set in the viewer and streams the whole result, oldest first. The export itself is written to the audit log.

In CSV, a value that starts with =, +, - or @ gets a leading quote so spreadsheet software does not run it as a formula.

Exporting needs the Export the audit log permission. Only admins have it by default.

Audit log check​

Each audit entry stores a hash of the one before it, so a changed, added or removed entry breaks the chain. Termix checks the chain every hour and alerts every admin when it breaks, with or without this plugin.

Open Audit log check from the command palette to see the last check, how many entries it covered and the newest entry's hash. Check now runs a check right away. Entries written before Termix 26.11.2 have no hash and are counted on their own.

Someone who can change the database could rewrite the whole chain so it still checks out. To catch that, press Download head now and then and keep the file somewhere else, like a password manager or another machine. Later, paste it into Paste a saved head and press Compare. If that entry still has the same hash and the chain after it holds, nothing before it was changed. Once the log's size or age limit removes the saved entry, it can't be compared any more, so download a new head before then.

Forwarded entries and exports carry id, hash and prevHash, so a collector keeps its own copy of the chain without any extra step.

The check needs the Export the audit log permission.

Environment variables​

This plugin reads some environment variables on the Termix server. See the reference for the list.