clamav/docs/man
ChaoticByte a3be0d2d45
clamd: Add options to toggle SHUTDOWN, RELOAD, STATS and VERSION (#1502)
The `clamd` protocol lacks authentication or authorization controls
needed to limit access to more administrative commands.
Depending on your use case, disabling some commands like `SHUTDOWN`
may improve the security of the scanning daemon.

This commit adds options to enable/disable the `SHUTDOWN`, `RELOAD`,
`STATS` and `VERSION` commands in `clamd.conf`.
When a client sends one of the following commands but it is disabled,
`clamd` will respond with "COMMAND UNAVAILABLE".

The new `clamd.conf` options are:

- `EnableShutdownCommand`: Enable the `SHUTDOWN` command.
  Setting this to no prevents a client to stop `clamd` via the
  protocol.
  Default: yes

- `EnableReloadCommand` Enable the `RELOAD` command.
  Setting this to no prevents a client to reload the database.
  This disables Freshclam's `NotifyClamd` option. 
  `clamd` monitors for database directory changes, so this should 
  Default: yes

- `EnableStatsCommand` Enable the `STATS` command.
  Setting this to no prevents a client from querying statistics.
  This disables the `clamdtop` program.
  Default: yes

- `EnableVersionCommand` Enable the `VERSION` command.
  Setting this to no prevents a client from querying version
  information.
  This disables the `clamdtop` program and will cause `clamdscan` to
  display a warning when using the `--version` option.
  Default: yes

Resolves: https://github.com/Cisco-Talos/clamav/issues/922
Resolves: https://github.com/Cisco-Talos/clamav/issues/1169
Related: https://github.com/Cisco-Talos/clamav/pull/347
2025-06-04 10:47:57 -04:00
..
clamav-milter.8.in CMake: Fix build on systems lacking inttypes format string macros 2021-08-05 16:54:02 -07:00
clamav-milter.conf.5.in Update scan limits documented in clamscan and clamav-milter manpages 2023-08-23 16:21:40 -07:00
clambc.1.in Docs: Warn against running untrusted bytecode 2020-07-09 15:38:15 -07:00
clamconf.1.in shared/optparser.c, clamconf/clamconf.c: add --generate-config 2009-01-29 19:03:59 +00:00
clamd.8.in FIPS-compliant CVD signing and verification 2025-03-26 19:33:25 -04:00
clamd.conf.5.in clamd: Add options to toggle SHUTDOWN, RELOAD, STATS and VERSION (#1502) 2025-06-04 10:47:57 -04:00
clamdscan.1.in Docs: Clarify help text about --fdpass option 2024-04-25 10:59:32 -07:00
clamdtop.1.in Spelling Adjustments (#30) 2018-02-27 22:00:09 -05:00
clamonacc.8.in Correct short flag of watch-list 2022-09-29 16:21:14 -07:00
clamscan.1.in FIPS-compliant CVD signing and verification 2025-03-26 19:33:25 -04:00
clamsubmit.1.in Extend freshclam client key/cert auth to macOS and Windows 2023-08-03 19:31:36 -07:00
freshclam.1.in FIPS-compliant CVD signing and verification 2025-03-26 19:33:25 -04:00
freshclam.conf.5.in FIPS-compliant CVD signing and verification 2025-03-26 19:33:25 -04:00
sigtool.1.in FIPS-compliant CVD signing and verification 2025-03-26 19:33:25 -04:00