usr/src/man/man1m/vscand.1m

   1 '\" te
   2 .\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH VSCAND 1M "Nov 6, 2007"
   7 .SH NAME
   8 vscand \- vscan service daemon
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/vscan/vscand\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBvscand\fR is the daemon that handles virus scan requests from file systems
  19 on file open and close operations. A file system may support enabling and
  20 disabling of virus scanning on a per dataset basis, using that file system's
  21 administrative command, for example \fBzfs\fR(1M).
  22 .sp
  23 .LP
  24 If the file state or scan policy (see \fBvscanadm\fR(1M) requires that a file
  25 be scanned, \fBvscand\fR communicates with external third-party virus scanners
  26 (scan engines) using the Internet Content Adaptation Protocol (\fBICAP\fR,
  27 \fBRFC\fR 3507) to have the file scanned.
  28 .sp
  29 .LP
  30 A file is submitted to a scan engine if it has been modified since it was last
  31 scanned, or if it has not been scanned with the latest scan engine
  32 configuration (Virus definitions). The file's modified attribute and
  33 \fBscanstamp\fR attribute are used to store this information. Once the file is
  34 scanned, the modified attribute is cleared and the \fBscanstamp\fR attribute is
  35 updated.
  36 .sp
  37 .LP
  38 If the file is found to contain a virus, the virus is logged in
  39 \fBsyslogd\fR(1M), an audit record is written, and the file is quarantined (by
  40 setting its quarantine attribute). Once a file is quarantined, attempts to
  41 read, execute or rename the file will be denied by the file system. The
  42 \fBsyslogd\fR(1M) entry and the audit record specify the name of the infected
  43 file and the violations detected in the file. Each violation is specified as
  44 "ID - threat description", where \fBID\fR and threat description are defined in
  45 the X-Infection-Found-Header in \fBICAP\fR \fBRFC\fR 3507; Extensions.
  46 .sp
  47 .LP
  48 By default, \fBvscand\fR connects to scan engines on port 1344. The port and
  49 other service configuration parameters can be configured using
  50 \fBvscanadm\fR(1M).
  51 .sp
  52 .LP
  53 The \fBvscan\fR service is disabled by default, and can be enabled using
  54 \fBsvcadm\fR(1M).
  55 .SH EXIT STATUS
  56 .sp
  57 .LP
  58 The following exit values are returned:
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB0\fR\fR
  63 .ad
  64 .RS 12n
  65 Daemon started successfully.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBnon-zero\fR\fR
  72 .ad
  73 .RS 12n
  74 Daemon failed to start.
  75 .RE
  76
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 Interface Stability     Uncommitted
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBps\fR(1), \fBsvcs\fR(1), \fBlogadm\fR(1M), \fBsvcadm\fR(1M),
  97 \fBsyslogd\fR(1M), \fBvscanadm\fR(1M), \fBzfs\fR(1M), \fBattributes\fR(5),
  98 \fBsmf\fR(5)
  99 .SH NOTES
 100 .sp
 101 .LP
 102 If a file is accessed using a protocol which does not invoke the file system
 103 open and close operations, for example \fBNFSv3\fR, virus scanning is not
 104 initiated on the file.
 105 .sp
 106 .LP
 107 File content is transferred to the scan engines as \fBcleartext\fR data.
 108 .sp
 109 .LP
 110 Administrative actions for the \fBvscan\fR service, such as enabling,
 111 disabling, or requesting a restart, can be performed using \fBsvcadm\fR(1M).
 112 The \fBvscan\fR service status can be queried using the \fBsvcs\fR(1) command.
 113 .sp
 114 .LP
 115 The \fBvscan\fR service is managed by the service management facility,
 116 \fBsmf\fR(5), under the service identifier:
 117 .sp
 118 .in +2
 119 .nf
 120 svc:/system/filesystem/vscan
 121 .fi
 122 .in -2
 123 .sp
 124