g3/g3proxy/doc/configuration/user_group/audit.rst
Zhang Jingqiang e12ae28211 update doc
2024-05-10 12:07:02 +08:00

59 lines
1.6 KiB
ReStructuredText

.. _configuration_user_group_user_audit:
**********
User Audit
**********
.. versionadded:: 1.7.0
The user audit config is in map format. We will use this to specify user level audit actions.
enable_protocol_inspection
--------------------------
**optional**, **type**: bool
Whether protocol inspection functionality should be enabled.
Protocol inspection will be enabled if true, and if audit is also enabled at both server and user side, for a specific user request.
**default**: false
prohibit_unknown_protocol
-------------------------
**optional**, **type**: bool
Whether unknown protocol will be prohibited when protocol inspection is enabled.
**default**: false
prohibit_timeout_protocol
-------------------------
**optional**, **type**: bool
We need to read the initial data to check the protocol type, and we can set the timeout value via the
:ref:`data0_read_timeout <conf_value_dpi_protocol_inspection_data0_read_timeout>` config option in
auditor :ref:`protocol inspection <conf_auditor_protocol_inspection>` config.
This config option will set if we should prohibit the protocol if the inspection process is timed out.
**default**: true
.. versionadded:: 1.9.1
task_audit_ratio
----------------
**optional**, **type**: :ref:`random ratio <conf_value_random_ratio>`
Set the task audit (like ICAP REQMOD/RESPMOD) ratio for incoming user requests.
This also controls whether protocol inspection is really enabled for a specific user request.
If set, this will override the :ref:`task audit ratio <conf_auditor_task_audit_ratio>` config at auditor side.
**default**: not set, **alias**: application_audit_ratio
.. versionadded:: 1.7.4