Mercurial > prosody-modules
view mod_audit/README.md @ 5298:12f7d8b901e0
mod_audit: Support for adding location (GeoIP) to audit events
This can be more privacy-friendly than logging full IP addresses, and also
more informative to a user - IP addresses don't mean much to the average
person, however if they see activity from outside their expected country, they
can immediately identify suspicious activity.
As with IPs, this field is configurable for deployments that would like to
disable it. Location is also not logged when the geoip library is not
available.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Sat, 01 Apr 2023 13:11:53 +0100 |
parents | 530d116b7f68 |
children | dc058fcc3fe3 |
line wrap: on
line source
--- summary: Audit Logging rockspec: {} ... This module provides infrastructure for audit logging inside Prosody. ## What is audit logging? Audit logs will contain security sensitive events, both for server-wide incidents as well as user-specific. This module, however, only provides the infrastructure for audit logging. It does not, by itself, generate such logs. For that, other modules, such as `mod_audit_auth` or `mod_audit_register` need to be loaded. ## A note on privacy Audit logging is intended to ensure the security of a system. As such, its contents are often at the same time highly sensitive (containing user names and IP addresses, for instance) and allowed to be stored under common privacy regulations. Before using these modules, you may want to ensure that you are legally allowed to store the data for the amount of time these modules will store it. Note that it is currently not possible to store different event types with different expiration times.