Browse code

clamonacc - update conf and manpage

Mickey Sola authored on 2019/07/19 02:06:24
Showing 2 changed files
... ...
@@ -653,11 +653,6 @@ WARNING: setting this limit too high or disabling it may severely impact perform
653 653
 .br
654 654
 Default: 25M
655 655
 .TP
656
-\fBScanOnAccess BOOL\fR
657
-This option enables on-access scanning (Linux only)
658
-.br
659
-Default: disabled
660
-.TP
661 656
 \fBOnAccessIncludePath STRING\fR
662 657
 This option specifies a directory (including all files and directories inside it), which should be scanned on access. This option can be used multiple times.
663 658
 .br
... ...
@@ -686,11 +681,26 @@ Also note that if clamd cannot check the uid of the process that generated an on
686 686
 .br
687 687
 Default: disabled
688 688
 .TP
689
+\fBOnAccessExcludeUname STRING\fR
690
+This option allows exclusions via user names when using the on-access scanning client. It can be used multiple times, and has the same potential race condition limitations of the OnAccessExcludeUID option.
691
+.br
692
+Default: disabled
693
+.TP
689 694
 \fBOnAccessMaxFileSize SIZE\fR
690 695
 Files larger than this value will not be scanned in on access.
691 696
 .br
692 697
 Default: 5M
693 698
 .TP
699
+\fBOnAccessMaxThreads NUMBER\fR
700
+Max number of scanning threads to allocate to the OnAccess thread pool at startup. These threads are the ones responsible for creating a connection with the daemon and kicking off scanning after an event has been processed. To prevent clamonacc from consuming all clamd's resources keep this lower than clamd's max threads.
701
+.br
702
+Default: 5
703
+.TP
704
+\fBOnAccessCurlTimeout NUMBER\fR
705
+Max amount of time (in milliseconds) that the OnAccess client should spend for every connect, send, and recieve attempt when communicating with clamd via curl.
706
+.br
707
+Default: 5000 (5 seconds)
708
+.TP
694 709
 \fBOnAccessMountPath STRING\fR
695 710
 Specifies a mount point (including all files and directories under it), which should be scanned on access. This option can be used multiple times.
696 711
 .br
... ...
@@ -706,6 +716,23 @@ Enables fanotify blocking when malicious files are found.
706 706
 .br
707 707
 Default: disabled
708 708
 .TP
709
+\fBOnAccessRetryAttempts NUMBER\fR
710
+Number of times the OnAccess client will retry a failed scan due to connection problems (or other issues).
711
+.br
712
+Default: 0
713
+.TP
714
+\fBOnAccessDenyOnError BOOL\fR
715
+When using prevention, if this option is turned on, any errors that occur during  scanning will result in the event attempt being denied. This could potentially lead to unwanted system behaviour with certain configurations, so the client defaults this to off and prefers allowing access events in case of scan or connection error.
716
+.br
717
+Default: no
718
+.TP
719
+\fBOnAccessExtraScanning BOOL\fR
720
+Toggles extra scanning and notifications when a file or directory is created or moved.
721
+.br
722
+Requires the  DDD system to kick-off extra scans.
723
+.br
724
+Default: no
725
+.TP
709 726
 \fBDisableCertCheck BOOL\fR
710 727
 Disable authenticode certificate chain verification in PE files.
711 728
 .br
... ...
@@ -609,7 +609,6 @@ Example
609 609
 # Default: no
610 610
 #AlertExceedsMax yes
611 611
 
612
-
613 612
 ##
614 613
 ## On-access Scan Settings
615 614
 ##
... ...
@@ -631,6 +630,11 @@ Example
631 631
 # Default: 5000 (5 seconds)
632 632
 # OnAccessCurlTimeout 10000
633 633
 
634
+# Toggles dynamic directory determination. Allows for recursively watching
635
+# include paths.
636
+# Default: no
637
+#OnAccessDisableDDD yes
638
+
634 639
 # Set the include paths (all files inside them will be scanned). You can have
635 640
 # multiple OnAccessIncludePath directives but each directory must be added
636 641
 # in a separate line.
... ...
@@ -638,32 +642,40 @@ Example
638 638
 #OnAccessIncludePath /home
639 639
 #OnAccessIncludePath /students
640 640
 
641
+# Set the exclude paths. All subdirectories are also excluded.
642
+# Default: disabled
643
+#OnAccessExcludePath /home/user
644
+
641 645
 # Modifies fanotify blocking behaviour when handling permission events.
642 646
 # If off, fanotify will only notify if the file scanned is a virus,
643 647
 # and not perform any blocking.
644 648
 # Default: no
645 649
 #OnAccessPrevention yes
646 650
 
647
-# Toggles dynamic directory determination. Allows for recursively watching
648
-# include paths.
651
+# When using prevention, if this option is turned on, any errors that occur during 
652
+# scanning will result in the event attempt being denied. This could potentially 
653
+# lead to unwanted system behaviour with certain configurations, so the client defaults 
654
+# this to off and prefers allowing access events in case of scan or connection error.
649 655
 # Default: no
650
-#OnAccessDisableDDD yes
656
+#OnAccessDenyOnError yes
657
+
658
+# Toggles extra scanning and notifications when a file or directory is
659
+# created or moved.
660
+# Requires the  DDD system to kick-off extra scans.
661
+# Default: no
662
+#OnAccessExtraScanning yes
651 663
 
652 664
 # Set the  mount point to be scanned. The mount point specified, or the mount
653 665
 # point containing the specified directory will be watched. If any directories
654 666
 # are specified, this option will preempt (disable and ignore all options related to) 
655
-# the DDD system. This option will result in verdicts only: Prevention is explicitly 
656
-# disallowed to prevent uninteded, fatal misuse by users due to their potential 
657
-# fundamental misunderstanding of (pre kernel 5.1) fanotify mechanisms.
667
+# the DDD system. This option will result in verdicts only.
668
+# Note that prevention is explicitly disallowed to prevent common, fatal misconfigurations. (e.g. 
669
+# watching "/" with prevention on and no exclusions made on vital system directories)
658 670
 # It can be used multiple times.
659 671
 # Default: disabled
660 672
 #OnAccessMountPath /
661 673
 #OnAccessMountPath /home/user
662 674
 
663
-# Set the exclude paths. All subdirectories are also excluded.
664
-# Default: disabled
665
-#OnAccessExcludePath /home/bofh
666
-
667 675
 # With this option you can whitelist the root UID (0). Processes run under
668 676
 # root with be able to access all files without triggering scans or
669 677
 # permission denied events.
... ...
@@ -701,20 +713,6 @@ Example
701 701
 # Default: 0
702 702
 #OnAccessRetryAttempts 3
703 703
 
704
-# When using prevention, if this option is turned on, any errors that occur during 
705
-# scanning will result in the event attempt being denied. This could potentially 
706
-# lead to unwanted system behaviour with certain configurations, so the client defaults 
707
-# this to off and prefers allowing access events in case of scan or connection error.
708
-# Default: no
709
-#OnAccessDenyOnError yes
710
-
711
-
712
-# Toggles extra scanning and notifications when a file or directory is
713
-# created or moved.
714
-# Requires the  DDD system to kick-off extra scans.
715
-# Default: no
716
-#OnAccessExtraScanning yes
717
-
718 704
 ##
719 705
 ## Bytecode
720 706
 ##