vscan.h revision bfc848c632c9eacb2a640246d96e198f1b185c03
/*
* CDDL HEADER START
*
* 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.
*
* 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.
*
* 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]
*
* CDDL HEADER END
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _VSCAN_H
#define _VSCAN_H
#pragma ident "%Z%%M% %I% %E% SMI"
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/param.h>
#include <sys/vnode.h>
/*
* vscan.h provides definitions for vscan kernel module
*/
#define VS_DRV_PATH "/dev/vscan/vscan" /* append minor dev num */
#define VS_IOCTL_ENABLE 0x01 /* door rendezvous */
#define VS_IOCTL_DISABLE 0x02 /* vscand shutting down */
#define VS_IOCTL_CONFIG 0x03 /* vscand config data update */
#define VS_IOCTL_RESULT 0x04 /* scan result */
#define VS_IOCTL_MAX_REQ 0x05 /* max in-progress req vscand */
/* Scan Result - vsr_result */
#define VS_STATUS_UNDEFINED 0
#define VS_STATUS_NO_SCAN 1 /* scan not required */
#define VS_STATUS_ERROR 2 /* scan failed */
#define VS_STATUS_CLEAN 3 /* scan successful, file clean */
#define VS_STATUS_INFECTED 4 /* scan successful, file infected */
#define VS_STATUS_SCANNING 5 /* scan in progress - async */
/* Configuration data vs_config_t - vsc_types */
#define VS_TYPES_LEN 4096 /* vs_config_t - types buffer */
#define VS_TYPES_MAX VS_TYPES_LEN / 2
/*
* AV_SCANSTAMP_SZ is the size of the scanstamp stored in the
* filesystem. vs_scanstamp_t is 1 character longer to allow
* a null terminated string to be used within vscan
*/
typedef char vs_scanstamp_t[AV_SCANSTAMP_SZ + 1];
/* used for door request to vscand */
typedef struct vs_scan_req {
uint32_t vsr_idx;
uint32_t vsr_seqnum;
uint64_t vsr_size;
uint32_t vsr_flags;
uint8_t vsr_modified;
uint8_t vsr_quarantined;
char vsr_path[MAXPATHLEN];
vs_scanstamp_t vsr_scanstamp;
} vs_scan_req_t;
/* passed in VS_IOCTL_RESULT - async response from vscand */
typedef struct vs_scan_rsp {
uint32_t vsr_idx;
uint32_t vsr_seqnum;
uint32_t vsr_result;
vs_scanstamp_t vsr_scanstamp;
} vs_scan_rsp_t;
/* passed in VS_IOCTL_CONFIG */
typedef struct vs_config {
char vsc_types[VS_TYPES_LEN];
uint64_t vsc_types_len;
uint64_t vsc_max_size; /* files > max size (bytes) not scan */
uint64_t vsc_allow; /* allow access to file exceeding max_size? */
} vs_config_t;
#ifdef _KERNEL
int vscan_svc_init(void);
void vscan_svc_fini(void);
int vscan_svc_enable(void);
void vscan_svc_disable(void);
int vscan_svc_configure(vs_config_t *);
boolean_t vscan_svc_in_use(void);
void vscan_svc_scan_result(vs_scan_rsp_t *);
void vscan_svc_scan_abort(void);
vnode_t *vscan_svc_get_vnode(int);
int vscan_door_init(void);
void vscan_door_fini(void);
int vscan_door_open(int);
void vscan_door_close(void);
int vscan_door_scan_file(vs_scan_req_t *);
boolean_t vscan_drv_create_node(int);
#endif /* _KERNEL */
#ifdef __cplusplus
}
#endif
#endif /* _VSCAN_H */