1 /* $NetBSD: verified_exec.h,v 1.6.2.12 2007/06/26 17:00:46 ghen Exp $ */
2
3 /*-
4 * Copyright 2005 Elad Efrat <elad@bsd.org.il>
5 * Copyright 2005 Brett Lymn <blymn@netbsd.org>
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Brett Lymn and Elad Efrat
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Neither the name of The NetBSD Foundation nor the names of its
16 * contributors may be used to endorse or promote products derived
17 * from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*
33 *
34 * Definitions for the Verified Executables kernel function.
35 *
36 */
37 #ifndef _SYS_VERIFIED_EXEC_H_
38 #define _SYS_VERIFIED_EXEC_H_
39
40 #include <sys/cdefs.h>
41 #include <sys/param.h>
42 #include <sys/hash.h>
43
44 __KERNEL_RCSID(0, "$NetBSD: verified_exec.h,v 1.6.2.12 2007/06/26 17:00:46 ghen Exp $");
45
46 /* Max length of the fingerprint type string, including terminating \0 char */
47 #define VERIEXEC_TYPE_MAXLEN 9
48
49 struct veriexec_params {
50 unsigned char type;
51 unsigned char fp_type[VERIEXEC_TYPE_MAXLEN];
52 char file[MAXPATHLEN];
53 unsigned int size; /* number of bytes in the fingerprint */
54 unsigned char *fingerprint;
55 };
56
57 struct veriexec_sizing_params {
58 dev_t dev;
59 size_t hash_size;
60 };
61
62 /*
63 * Types of veriexec inodes we can have. Ordered from less strict to
64 * most strict -- this is enforced if a duplicate entry is loaded.
65 */
66 #define VERIEXEC_DIRECT 0x01 /* Direct execution (exec) */
67 #define VERIEXEC_INDIRECT 0x02 /* Indirect execution (#!) */
68 #define VERIEXEC_FILE 0x04 /* Plain file (open) */
69
70 #define VERIEXEC_LOAD _IOW('S', 0x1, struct veriexec_params)
71 #define VERIEXEC_TABLESIZE _IOW('S', 0x2, struct veriexec_sizing_params)
72
73 /* Verified exec sysctl objects. */
74 #define VERIEXEC_VERBOSE 1 /* Verbosity level. */
75 #define VERIEXEC_STRICT 2 /* Strict mode level. */
76 #define VERIEXEC_ALGORITHMS 3 /* Supported hashing algorithms. */
77 #define VERIEXEC_COUNT 4 /* # of fingerprinted files on device. */
78
79 #ifdef _KERNEL
80 void veriexecattach(struct device *, struct device *, void *);
81 int veriexecopen(dev_t, int, int, struct proc *);
82 int veriexecclose(dev_t, int, int, struct proc *);
83 int veriexecioctl(dev_t, u_long, caddr_t, int, struct proc *);
84
85 /* defined in kern_verifiedexec.c */
86 extern char *veriexec_fp_names;
87 extern int veriexec_verbose;
88 extern int veriexec_strict;
89 /* this one requires sysctl.h to be included before verified_exec.h */
90 #ifdef VERIEXEC_NEED_NODE
91 extern struct sysctlnode *veriexec_count_node;
92 #endif /* VERIEXEC_NEED_NODE */
93
94 /*
95 * Operations vector for verified exec, this defines the characteristics
96 * for the fingerprint type.
97 */
98
99 /* Function types: init, update, final. */
100 typedef void (*VERIEXEC_INIT_FN)(void *);
101 typedef void (*VERIEXEC_UPDATE_FN)(void *, u_char *, u_int);
102 typedef void (*VERIEXEC_FINAL_FN)(u_char *, void *);
103
104 struct veriexec_fp_ops {
105 char type[VERIEXEC_TYPE_MAXLEN];
106 size_t hash_len;
107 size_t context_size;
108 VERIEXEC_INIT_FN init;
109 VERIEXEC_UPDATE_FN update;
110 VERIEXEC_FINAL_FN final;
111 LIST_ENTRY(veriexec_fp_ops) entries;
112 };
113
114 /*
115 * list structure definitions - needed in kern_exec.c
116 */
117
118 /* An entry in the per-device hash table. */
119 struct veriexec_hash_entry {
120 ino_t inode; /* Inode number. */
121 unsigned char type; /* Entry type. */
122 unsigned char status; /* Evaluation status. */
123 unsigned char *fp; /* Fingerprint. */
124 struct veriexec_fp_ops *ops; /* Fingerprint ops vector*/
125 LIST_ENTRY(veriexec_hash_entry) entries; /* List pointer. */
126 };
127
128 /* Valid status field values. */
129 #define FINGERPRINT_NOTEVAL 0 /* fingerprint has not been evaluated */
130 #define FINGERPRINT_VALID 1 /* fingerprint evaluated and matches list */
131 #define FINGERPRINT_NOMATCH 2 /* fingerprint evaluated but does not match */
132
133 LIST_HEAD(veriexec_hashhead, veriexec_hash_entry) *hash_tbl;
134
135 /* Veriexec hash table information. */
136 struct veriexec_hashtbl {
137 struct veriexec_hashhead *hash_tbl;
138 size_t hash_size; /* Number of slots in the table. */
139 dev_t hash_dev; /* Device ID the hash table refers to. */
140 uint64_t hash_count; /* # of fingerprinted files in table. */
141 LIST_ENTRY(veriexec_hashtbl) hash_list;
142 };
143
144 /* Global list of hash tables. */
145 LIST_HEAD(, veriexec_hashtbl) veriexec_tables;
146
147 /* Mask to ensure bounded access to elements in the hash table. */
148 #define VERIEXEC_HASH_MASK(tbl) ((tbl)->hash_size - 1)
149
150 /* Readable values for veriexec_report(). */
151 #define REPORT_NOVERBOSE 0
152 #define REPORT_VERBOSE 1
153 #define REPORT_VERBOSE_HIGH 2
154 #define REPORT_NOPANIC 0
155 #define REPORT_PANIC 1
156 #define REPORT_NOALARM 0
157 #define REPORT_ALARM 1
158
159 /*
160 * Hashing function: Takes an inode number modulus the mask to give back
161 * an index into the hash table.
162 */
163 #define VERIEXEC_HASH(tbl, inode) \
164 (hash32_buf(&(inode), sizeof((inode)), HASH32_BUF_INIT) \
165 & VERIEXEC_HASH_MASK(tbl))
166
167 /* Initialize a fingerprint ops struct. */
168 #define VERIEXEC_OPINIT(ops, fp_type, hashlen, ctx_size, init_fn, \
169 update_fn, final_fn) \
170 do { \
171 (void) strlcpy((ops)->type, fp_type, sizeof((ops)->type)); \
172 (ops)->hash_len = (hashlen); \
173 (ops)->context_size = (ctx_size); \
174 (ops)->init = (VERIEXEC_INIT_FN) (init_fn); \
175 (ops)->update = (VERIEXEC_UPDATE_FN) (update_fn); \
176 (ops)->final = (VERIEXEC_FINAL_FN) (final_fn); \
177 } while (0);
178
179 int veriexec_add_fp_ops(struct veriexec_fp_ops *);
180 void veriexec_init_fp_ops(void);
181 struct veriexec_fp_ops *veriexec_find_ops(u_char *name);
182 int veriexec_fp_calc(struct proc *, struct vnode *,
183 struct veriexec_hash_entry *, uint64_t, u_char *);
184 int veriexec_fp_cmp(struct veriexec_fp_ops *, u_char *, u_char *);
185 struct veriexec_hashtbl *veriexec_tblfind(dev_t);
186 struct veriexec_hash_entry *veriexec_lookup(dev_t, ino_t);
187 int veriexec_hashadd(struct veriexec_hashtbl *, struct veriexec_hash_entry *);
188 int veriexec_verify(struct proc *, struct vnode *, struct vattr *,
189 const u_char *, int, struct veriexec_hash_entry **);
190 int veriexec_removechk(struct proc *, struct vnode *, const char *);
191 int veriexec_renamechk(struct vnode *, struct vnode *, const char *,
192 const char *);
193 void veriexec_init_fp_ops(void);
194 void veriexec_report(const u_char *, const u_char *, struct vattr *,
195 struct proc *, int, int, int);
196
197 #endif /* _KERNEL */
198
199 #endif /* _SYS_VERIFIED_EXEC_H_ */
Cache object: fcd5b43a3f3a70818bf76fd661224e81
|