verified_exec.h revision 1.51 1 /* $NetBSD: verified_exec.h,v 1.51 2007/01/09 12:49:37 elad Exp $ */
2
3 /*-
4 * Copyright (c) 2005, 2006 Elad Efrat <elad (at) NetBSD.org>
5 * Copyright (c) 2005, 2006 Brett Lymn <blymn (at) NetBSD.org>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the authors may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #ifndef _SYS_VERIFIED_EXEC_H_
32 #define _SYS_VERIFIED_EXEC_H_
33
34 #include <sys/cdefs.h>
35 #include <sys/param.h>
36 #include <sys/ioctl.h>
37
38 #if defined(_KERNEL) && !defined(HAVE_NBTOOL_CONFIG_H)
39 #include <sys/malloc.h>
40 #include <uvm/uvm_extern.h>
41 #include <uvm/uvm_pglist.h>
42 #include <uvm/uvm_page.h>
43 #include <prop/proplib.h>
44 #endif /* _KERNEL */
45
46 /* Flags for a Veriexec entry. These can be OR'd together. */
47 #define VERIEXEC_DIRECT 0x01 /* Direct execution (exec) */
48 #define VERIEXEC_INDIRECT 0x02 /* Indirect execution (#!) */
49 #define VERIEXEC_FILE 0x04 /* Plain file (open) */
50 #define VERIEXEC_UNTRUSTED 0x10 /* Untrusted storage */
51
52 /* Operations for /dev/veriexec. */
53 #define VERIEXEC_LOAD _IOW('X', 0x1, struct plistref)
54 #define VERIEXEC_TABLESIZE _IOW('X', 0x2, struct plistref)
55 #define VERIEXEC_DELETE _IOW('X', 0x3, struct plistref)
56 #define VERIEXEC_QUERY _IOWR('X', 0x4, struct plistref)
57
58 /* Veriexec modes (strict levels). */
59 #define VERIEXEC_LEARNING 0 /* Learning mode. */
60 #define VERIEXEC_IDS 1 /* Intrusion detection mode. */
61 #define VERIEXEC_IPS 2 /* Intrusion prevention mode. */
62 #define VERIEXEC_LOCKDOWN 3 /* Lockdown mode. */
63
64 /* Valid status field values. */
65 #define FINGERPRINT_NOTEVAL 0 /* fingerprint has not been evaluated */
66 #define FINGERPRINT_VALID 1 /* fingerprint evaluated and matches list */
67 #define FINGERPRINT_NOMATCH 2 /* fingerprint evaluated but does not match */
68
69 /* Per-page fingerprint status. */
70 #define PAGE_FP_NONE 0 /* no per-page fingerprints. */
71 #define PAGE_FP_READY 1 /* per-page fingerprints ready for use. */
72 #define PAGE_FP_FAIL 2 /* mismatch in per-page fingerprints. */
73
74 /*
75 * Operations vector for verified exec, this defines the characteristics
76 * for the fingerprint type.
77 * Function types: init, update, final.
78 */
79 typedef void (*veriexec_fpop_init_t)(void *);
80 typedef void (*veriexec_fpop_update_t)(void *, u_char *, u_int);
81 typedef void (*veriexec_fpop_final_t)(u_char *, void *);
82
83 #if defined(_KERNEL) && !defined(HAVE_NBTOOL_CONFIG_H)
84 MALLOC_DECLARE(M_VERIEXEC);
85
86 extern int veriexec_verbose;
87 extern int veriexec_strict;
88
89 /* Readable values for veriexec_report(). */
90 #define REPORT_ALWAYS 0x01 /* Always print */
91 #define REPORT_VERBOSE 0x02 /* Print when verbose >= 1 */
92 #define REPORT_DEBUG 0x04 /* Print when verbose >= 2 (debug) */
93 #define REPORT_PANIC 0x08 /* Call panic() */
94 #define REPORT_ALARM 0x10 /* Alarm - also print pid/uid/.. */
95 #define REPORT_LOGMASK (REPORT_ALWAYS|REPORT_VERBOSE|REPORT_DEBUG)
96
97 void veriexecattach(struct device *, struct device *, void *);
98 int veriexecopen(dev_t, int, int, struct lwp *);
99 int veriexecclose(dev_t, int, int, struct lwp *);
100 int veriexecioctl(dev_t, u_long, caddr_t, int, struct lwp *);
101
102 void veriexec_init(void);
103 int veriexec_fpops_add(const char *, size_t, size_t, veriexec_fpop_init_t,
104 veriexec_fpop_update_t, veriexec_fpop_final_t);
105 int veriexec_table_add(struct lwp *, prop_dictionary_t);
106 int veriexec_file_add(struct lwp *, prop_dictionary_t);
107 int veriexec_verify(struct lwp *, struct vnode *, const u_char *, int,
108 boolean_t *);
109 #ifdef notyet
110 int veriexec_page_verify(struct veriexec_file_entry *, struct vm_page *,
111 size_t, struct lwp *);
112 #endif /* notyet */
113 boolean_t veriexec_lookup(struct vnode *);
114 int veriexec_file_delete(struct vnode *);
115 int veriexec_table_delete(struct mount *);
116 int veriexec_convert(struct vnode *, prop_dictionary_t);
117 void veriexec_report(const u_char *, const u_char *, struct lwp *, int);
118 void veriexec_purge(struct vnode *);
119 int veriexec_removechk(struct vnode *, const char *, struct lwp *l);
120 int veriexec_renamechk(struct vnode *, const char *, struct vnode *,
121 const char *, struct lwp *);
122 int veriexec_unmountchk(struct mount *);
123 int veriexec_openchk(struct lwp *, struct vnode *, const char *, int);
124 #endif /* _KERNEL */
125
126 #endif /* !_SYS_VERIFIED_EXEC_H_ */
127