~ubuntu-branches/ubuntu/feisty/clamav/feisty

« back to all changes in this revision

Viewing changes to docs/man/clamd.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-04-11 10:27:47 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20060411102747-neeoigoizk3gubgq
Tags: 0.88.1-1ubuntu1
* Synchronize to Debian to get new upstream microrelease (UVF exception
  approved by Daniel Holbach). This fixes the following vulnerabilities:
  - CVE-2006-1614: integer overflow in the PE header parser
  - CVE-2006-1615: format string vulnerabilities in logging code
  - CVE-2006-1630: DoS due to invalid memory access in cli_bitset_set()
* debian/clamav-base.init-stub: Protect 'x && y' with '|| true' to not break
  init script if it's run under set -e.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Manual page created by Tomasz Kojm, 20021001.
 
2
.TH "clamd.conf" "5" "February 13, 2005" "Tomasz Kojm" "Clam AntiVirus"
 
3
.SH "NAME"
 
4
.LP 
 
5
\fBclamd.conf\fR \- Configuration file for Clam AntiVirus Daemon
 
6
.SH "DESCRIPTION"
 
7
.LP 
 
8
clamd.conf configures the Clam AntiVirus daemon, clamd(8).
 
9
.SH "FILE FORMAT"
 
10
The file consists of comments and options with arguments. Each line that starts with a hash (\fB#\fR) symbol is a comment. Options and arguments are case sensitive and of the form \fBOption Argument\fR. The (possibly optional) arguments are are of the following types:
 
11
.TP 
 
12
\fBSTRING\fR
 
13
String without blank characters.
 
14
.TP 
 
15
\fBSIZE\fR
 
16
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes.
 
17
.TP 
 
18
\fBNUMBER\fR
 
19
Unsigned integer.
 
20
.SH "DIRECTIVES"
 
21
.LP 
 
22
When an option is not used (hashed or doesn't exist in the configuration file) clamd takes a default action.
 
23
.TP 
 
24
\fBExample\fR
 
25
If this option is set clamd will not run.
 
26
.TP 
 
27
\fBLogFile STRING\fR
 
28
Enable logging to selected file.
 
29
.br 
 
30
Default: disabled
 
31
.TP 
 
32
\fBLogFileUnlock\fR
 
33
Disable a system lock that protects against running clamd with a same configuration file multiple times.
 
34
.br 
 
35
Default: disabled
 
36
.TP 
 
37
\fBLogFileMaxSize SIZE\fR
 
38
Limit the size of a log file. The logger will be automatically disabled  if the file is greater than SIZE. Value of 0 disables the limit.
 
39
.br 
 
40
Default: 1M
 
41
.TP 
 
42
\fBLogTime\fR
 
43
Log time with each message.
 
44
.br 
 
45
Default: disabled
 
46
.TP 
 
47
\fBLogClean\fR
 
48
Log clean files.
 
49
.br 
 
50
Default: disabled
 
51
.TP 
 
52
\fBLogSyslog\fR
 
53
Use system logger (can work together with LogFile).
 
54
.br 
 
55
Default: disabled
 
56
.TP 
 
57
\fBLogFacility\fR
 
58
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
 
59
.br 
 
60
Default: LOG_LOCAL6
 
61
.TP 
 
62
\fBLogVerbose\fR
 
63
Enable verbose logging.
 
64
.br 
 
65
Default: disabled
 
66
.TP 
 
67
\fBPidFile STRING\fR
 
68
Save the process identifier of a listening daemon (main thread) to a specified file.
 
69
.br 
 
70
Default: disabled
 
71
.TP 
 
72
\fBTemporaryDirectory STRING\fR
 
73
Optional path to the global temporary directory.
 
74
.br 
 
75
Default: system specific (usually /tmp or /var/tmp).
 
76
.TP 
 
77
\fBDatabaseDirectory STRING\fR
 
78
Path to a directory containing database files.
 
79
.br 
 
80
Default: /usr/local/share/clamav
 
81
.TP 
 
82
\fBLocalSocket STRING\fR
 
83
Path to a local (Unix) socket the daemon will listen on.
 
84
.br 
 
85
Default: disabled
 
86
.TP 
 
87
\fBFixStaleSocket\fR
 
88
Remove stale socket after unclean shutdown.
 
89
.br 
 
90
Default: disabled
 
91
.TP 
 
92
\fBTCPSocket NUMBER\fR
 
93
TCP port number the daemon will listen on.
 
94
.br 
 
95
Default: disabled
 
96
.TP 
 
97
\fBTCPAddr STRING\fR
 
98
TCP socket address to bind to. By default clamd binds to INADDR_ANY.
 
99
.br 
 
100
Default: disabled
 
101
.TP 
 
102
\fBMaxConnectionQueueLength NUMBER\fR
 
103
Maximum length the queue of pending connections may grow to.
 
104
.br 
 
105
Default: 15
 
106
.TP 
 
107
\fBMaxThreads NUMBER\fR
 
108
Maximal number of threads running at the same time.
 
109
.br 
 
110
Default: 10
 
111
.TP 
 
112
\fBReadTimeout NUMBER\fR
 
113
Waiting for data from a client socket will timeout after this time (seconds).
 
114
.br 
 
115
Default: 120
 
116
.TP 
 
117
\fBIdleTimeout NUMBER\fR
 
118
Waiting for a new job will timeout after this time (seconds).
 
119
.br 
 
120
Default: 30
 
121
.TP 
 
122
\fBMaxDirectoryRecursion NUMBER\fR
 
123
Maximal depth directories are scanned at.
 
124
.br 
 
125
Default: 15
 
126
.TP 
 
127
\fBFollowDirectorySymlinks\fR
 
128
Follow directory symlinks.
 
129
.br 
 
130
Default: disabled
 
131
.TP 
 
132
\fBFollowFileSymlinks\fR
 
133
Follow regular file symlinks.
 
134
.br 
 
135
Default: disabled
 
136
.TP 
 
137
\fBSelfCheck NUMBER\fR
 
138
Do internal sanity checks every NUMBER seconds.
 
139
.br 
 
140
Default: 1800
 
141
.TP 
 
142
\fBVirusEvent COMMAND\fR
 
143
Execute the COMMAND when virus is found. In the command string %v will be replaced by a virus name.
 
144
\fR
 
145
.br 
 
146
Default: disabled
 
147
.TP 
 
148
\fBExitOnOOM\fR
 
149
Stop daemon when libclamav reports out of memory condition.
 
150
.br 
 
151
Default: disabled
 
152
.TP 
 
153
.TP 
 
154
\fBUser STRING\fR
 
155
Run as selected user.
 
156
.br 
 
157
Default: disabled
 
158
.TP 
 
159
\fBAllowSupplementaryGroups\fR
 
160
Initialize supplementary group access (clamd must be started by root).
 
161
.br 
 
162
Default: disabled
 
163
.TP 
 
164
\fBForeground\fR
 
165
Don't fork into background.
 
166
.br 
 
167
Default: disabled
 
168
.TP 
 
169
\fBDebug\fR
 
170
Enable debug messages from libclamav.
 
171
.TP 
 
172
\fBLeaveTemporaryFiles\fR
 
173
Do not remove temporary files (for debug purposes).
 
174
.br 
 
175
Default: disabled
 
176
.TP 
 
177
\fBStreamMaxLength SIZE\fR
 
178
Clamd uses FTP\-like protocol to receive data from remote clients. If you are using clamav\-milter to balance load between remote clamd daemons on firewall servers you may need to tune the Stream* options. This option allows you to specify the maximal limit for data transfered to remote daemon when scanning a single file. It should match your MTA's limit for a maximal attachment size.
 
179
.br 
 
180
Default: 10M
 
181
.TP 
 
182
\fBStreamMinPort NUMBER\fR
 
183
Limit data port range.
 
184
.br 
 
185
Default: 1024
 
186
.TP 
 
187
\fBStreamMaxPort NUMBER\fR
 
188
Limit data port range.
 
189
.br 
 
190
Default: 2048
 
191
.TP 
 
192
\fBDisableDefaultScanOptions\fR
 
193
By default clamd uses scan options recommended by libclamav. This option disables recommended options and allows you to enable selected options. DO NOT ENABLE IT unless you know what you are doing.
 
194
.br 
 
195
Default: disabled
 
196
.TP 
 
197
\fBScanPE\fR
 
198
PE stands for Portable Executable \- it's an executable file format used in all 32\-bit versions of Windows operating systems. This option allows ClamAV to perform a deeper analysis of executable files and it's also required for decompression of popular executable packers such as UPX.
 
199
.br 
 
200
Default: enabled
 
201
.TP 
 
202
\fBDetectBrokenExecutables\fR
 
203
With this option clamd will try to detect broken executables and mark them as Broken.Executable.
 
204
.br 
 
205
Default: disabled
 
206
.TP 
 
207
\fBScanOLE2\fR
 
208
Enables scanning of Microsoft Office document macros.
 
209
.br 
 
210
Default: enabled
 
211
.TP 
 
212
\fBScanHTML\fR
 
213
Enables HTML detection and normalisation.
 
214
.br 
 
215
Default: enabled
 
216
.TP 
 
217
\fBScanMail\fR
 
218
Enable scanning of mail files.
 
219
.br 
 
220
Default: enabled
 
221
.TP 
 
222
\fBMailFollowURLs\fR
 
223
If an email contains URLs ClamAV can download and scan them. \fBWARNING: This option may open your system to a DoS attack. Never use it on loaded servers.\fR
 
224
.br 
 
225
Default: disabled
 
226
.TP 
 
227
\fBScanArchive\fR
 
228
Enable archive scanning.
 
229
.br 
 
230
Default: enabled
 
231
.TP 
 
232
\fBScanRAR\fR
 
233
Enable scanning of RAR archives. Due to license issues libclamav does not support RAR 3.0 archives (only the old 2.0 format is supported). Because some users report stability problems with unrarlib it's disabled by default and must be enabled in the config file.
 
234
.br 
 
235
Default: disabled
 
236
.TP 
 
237
\fBArchiveMaxFileSize SIZE\fR
 
238
Files in archives larger than this limit won't be scanned. Value of 0 disables the limit.
 
239
.br 
 
240
Default: 10M
 
241
.TP 
 
242
\fBArchiveMaxRecursion NUMBER\fR
 
243
Limit archive recursion level. Value of 0 disables the limit.
 
244
.br 
 
245
Default: 8
 
246
.TP 
 
247
\fBArchiveMaxFiles NUMBER\fR
 
248
Number of files to be scanned within archive. Value of 0 disables the limit.
 
249
.br 
 
250
Default: 1000
 
251
.TP 
 
252
\fBArchiveMaxCompressionRatio NUMBER\fR
 
253
Analyze compression ratio of every file in an archive and mark potential archive bombs as viruses (0 disables the limit).
 
254
.br 
 
255
Default: 250
 
256
.TP 
 
257
\fBArchiveLimitMemoryUsage\fR
 
258
Use slower decompression algorithm which uses less memory. This option affects bzip2 decompressor only.
 
259
.br 
 
260
Default: disabled
 
261
.TP 
 
262
\fBArchiveBlockEncrypted\fR
 
263
Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
 
264
.br 
 
265
Default: disabled
 
266
.TP 
 
267
\fBArchiveBlockMax\fR
 
268
Mark archives as viruses (e.g RAR.ExceededFileSize, Zip.ExceededFilesLimit) if ArchiveMaxFiles, ArchiveMaxFileSize, or ArchiveMaxRecursion limit is reached.
 
269
.br 
 
270
Default: disabled
 
271
.TP 
 
272
\fBClamukoScanOnAccess\fR
 
273
Enable Clamuko. Dazuko (/dev/dazuko) must be configured and running.
 
274
.br 
 
275
Default: disabled
 
276
.TP 
 
277
\fBClamukoScanOnOpen\fR
 
278
Scan files on open.
 
279
.br 
 
280
Default: disabled
 
281
.TP 
 
282
\fBClamukoScanOnClose\fR
 
283
Scan files on close.
 
284
.br 
 
285
Default: disabled.
 
286
.TP 
 
287
\fBClamukoScanOnExec\fR
 
288
Scan files on execute.
 
289
.br 
 
290
Default: disabled
 
291
.TP 
 
292
\fBClamukoIncludePath STRING\fR
 
293
Set the include paths (all files and directories in them will be scanned). You can have multiple ClamukoIncludePath directives but each directory must be added in a separate line).
 
294
.br 
 
295
Default: disabled
 
296
.TP 
 
297
\fBClamukoExcludePath\fR
 
298
Set the exclude paths. All subdirectories will also be excluded.
 
299
.br 
 
300
Default: disabled
 
301
.TP 
 
302
\fBClamukoMaxFileSize SIZE\fR
 
303
Don't scan files larger than SIZE.
 
304
.br 
 
305
Default: 5M
 
306
.TP 
 
307
\fBClamukoScanArchive\fR
 
308
Enable archive scanning. It uses ArchiveMax* limits.
 
309
.br 
 
310
Default: disabled
 
311
.SH "FILES"
 
312
.LP 
 
313
/usr/local/etc/clamd.conf
 
314
.SH "AUTHOR"
 
315
.LP 
 
316
Tomasz Kojm <tkojm@clamav.net>
 
317
.SH "SEE ALSO"
 
318
.LP 
 
319
clamd(8), clamdscan(1), clamscan(1), freshclam(1), sigtool(1), clamav\-milter(8)