Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

audit.ini [AuditPrivacySettings]

The settings of [AuditPrivacySettings] in audit.ini: Field, IPv4Prefix, IPv6Prefix, SecretPathViews, NeverRecord, PseudonymiseAfterDays

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/audit/AuditPrivacySettings.md

On this page

audit.ini [AuditPrivacySettings]

The block [AuditPrivacySettings] of settings/audit.ini, with 6 setting(s).

Never edit settings/audit.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

  • settings/override/audit.ini.append.php for every siteaccess,
  • settings/siteaccess/<siteaccess>/audit.ini.append.php for one siteaccess,
  • extension/<extension>/settings/audit.ini.append.php in an extension (read when the extension is active).

Field

Per field: full | truncate | hash | off (see "The record format" for what truncate
means per field). Q3: a safe default; the session can only be hashed or off.
E-mail addresses in access.user.* events and attempted logins of unknown users.

Default: a hash of 10: actor.login=full, actor.ip=truncate, actor.ua=truncate, actor.session=hash, actor.cli.os_user=full, request.url=truncate, request.host=full, object.name=full, email=hash, attempted_login=hash.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditPrivacySettings]
# an empty "Field[]" first replaces the shipped list; without it the items are added
Field[]
Field[actor.login]=full
Field[actor.ip]=truncate
Field[actor.ua]=truncate
Field[actor.session]=hash
Field[actor.cli.os_user]=full
Field[request.url]=truncate
Field[request.host]=full
Field[object.name]=full
Field[email]=hash
Field[attempted_login]=hash
*/ ?>

IPv4Prefix

Prefix lengths for truncate of addresses: /24 for IPv4, /48 for IPv6 (Q3).

Default: 24.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditPrivacySettings]
IPv4Prefix=24
*/ ?>

IPv6Prefix

Default: 48.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditPrivacySettings]
IPv6Prefix=48
*/ ?>

SecretPathViews

Views whose path parameters are tokens: their parameters are never recorded.

Default: a list of 3: user/activate, user/forgotpassword, userpaex/forgotpassword.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditPrivacySettings]
# an empty "SecretPathViews[]" first replaces the shipped list; without it the items are added
SecretPathViews[]
SecretPathViews[]=user/activate
SecretPathViews[]=user/forgotpassword
SecretPathViews[]=userpaex/forgotpassword
*/ ?>

NeverRecord

Attribute and parameter names never recorded, besides everything
expIniEditor::isSecret() recognises.

Default: a list of 6: HashKey, Hash, Password, PasswordConfirm, password_hash, ezxform_token.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditPrivacySettings]
# an empty "NeverRecord[]" first replaces the shipped list; without it the items are added
NeverRecord[]
NeverRecord[]=HashKey
NeverRecord[]=Hash
NeverRecord[]=Password
NeverRecord[]=PasswordConfirm
NeverRecord[]=password_hash
NeverRecord[]=ezxform_token
*/ ?>

PseudonymiseAfterDays

Days after which the index replaces personal fields by their hashed form (Q3, F6).

Default: 90.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditPrivacySettings]
PseudonymiseAfterDays=90
*/ ?>

Generated by ./console exp:help:examples from settings/audit.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x