verified_exec.h revision 1.23
1 /* $NetBSD: verified_exec.h,v 1.23 2005/12/10 02:10:00 elad Exp $ */ 2 3 /*- 4 * Copyright 2005 Elad Efrat <elad (at) bsd.org.il> 5 * Copyright 2005 Brett Lymn <blymn (at) 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 #include <uvm/uvm_extern.h> 44 #include <uvm/uvm_pglist.h> 45 #include <uvm/uvm_page.h> 46 47 /* Max length of the fingerprint type string, including terminating \0 char */ 48 #define VERIEXEC_TYPE_MAXLEN 9 49 50 struct veriexec_params { 51 unsigned char type; 52 unsigned char fp_type[VERIEXEC_TYPE_MAXLEN]; 53 char file[MAXPATHLEN]; 54 unsigned int size; /* number of bytes in the fingerprint */ 55 unsigned char *fingerprint; 56 }; 57 58 struct veriexec_sizing_params { 59 dev_t dev; 60 size_t hash_size; 61 }; 62 63 struct veriexec_delete_params { 64 dev_t dev; 65 ino_t ino; 66 }; 67 68 /* 69 * Types of veriexec inodes we can have. Ordered from less strict to 70 * most strict -- this is enforced if a duplicate entry is loaded. 71 */ 72 #define VERIEXEC_DIRECT 0x01 /* Direct execution (exec) */ 73 #define VERIEXEC_INDIRECT 0x02 /* Indirect execution (#!) */ 74 #define VERIEXEC_FILE 0x04 /* Plain file (open) */ 75 #define VERIEXEC_UNTRUSTED 0x10 /* Untrusted storage */ 76 77 #define VERIEXEC_LOAD _IOW('S', 0x1, struct veriexec_params) 78 #define VERIEXEC_TABLESIZE _IOW('S', 0x2, struct veriexec_sizing_params) 79 #define VERIEXEC_DELETE _IOW('S', 0x3, struct veriexec_delete_params) 80 81 /* Verified exec sysctl objects. */ 82 #define VERIEXEC_VERBOSE 1 /* Verbosity level. */ 83 #define VERIEXEC_STRICT 2 /* Strict mode level. */ 84 #define VERIEXEC_ALGORITHMS 3 /* Supported hashing algorithms. */ 85 #define VERIEXEC_COUNT 4 /* # of fingerprinted files on device. */ 86 87 #ifdef _KERNEL 88 void veriexecattach(struct device *, struct device *, void *); 89 int veriexecopen(dev_t, int, int, struct proc *); 90 int veriexecclose(dev_t, int, int, struct proc *); 91 int veriexecioctl(dev_t, u_long, caddr_t, int, struct proc *); 92 93 /* defined in kern_verifiedexec.c */ 94 extern char *veriexec_fp_names; 95 extern int veriexec_verbose; 96 extern int veriexec_strict; 97 /* this one requires sysctl.h to be included before verified_exec.h */ 98 #ifdef VERIEXEC_NEED_NODE 99 extern const struct sysctlnode *veriexec_count_node; 100 #endif /* VERIEXEC_NEED_NODE */ 101 102 /* 103 * Operations vector for verified exec, this defines the characteristics 104 * for the fingerprint type. 105 */ 106 107 /* Function types: init, update, final. */ 108 typedef void (*VERIEXEC_INIT_FN)(void *); 109 typedef void (*VERIEXEC_UPDATE_FN)(void *, u_char *, u_int); 110 typedef void (*VERIEXEC_FINAL_FN)(u_char *, void *); 111 112 struct veriexec_fp_ops { 113 char type[VERIEXEC_TYPE_MAXLEN]; 114 size_t hash_len; 115 size_t context_size; 116 VERIEXEC_INIT_FN init; 117 VERIEXEC_UPDATE_FN update; 118 VERIEXEC_FINAL_FN final; 119 LIST_ENTRY(veriexec_fp_ops) entries; 120 }; 121 122 /* 123 * list structure definitions - needed in kern_exec.c 124 */ 125 126 /* An entry in the per-device hash table. */ 127 struct veriexec_hash_entry { 128 ino_t inode; /* Inode number. */ 129 unsigned char type; /* Entry type. */ 130 unsigned char status; /* Evaluation status. */ 131 unsigned char page_fp_status; /* Per-page FP status. */ 132 unsigned char *fp; /* Fingerprint. */ 133 void *page_fp; /* Per-page fingerprints */ 134 size_t npages; /* Number of pages. */ 135 size_t last_page_size; 136 struct veriexec_fp_ops *ops; /* Fingerprint ops vector*/ 137 LIST_ENTRY(veriexec_hash_entry) entries; /* List pointer. */ 138 }; 139 140 /* Valid status field values. */ 141 #define FINGERPRINT_NOTEVAL 0 /* fingerprint has not been evaluated */ 142 #define FINGERPRINT_VALID 1 /* fingerprint evaluated and matches list */ 143 #define FINGERPRINT_NOMATCH 2 /* fingerprint evaluated but does not match */ 144 145 /* Per-page fingerprint status. */ 146 #define PAGE_FP_NONE 0 /* no per-page fingerprints. */ 147 #define PAGE_FP_READY 1 /* per-page fingerprints ready for use. */ 148 #define PAGE_FP_FAIL 2 /* mismatch in per-page fingerprints. */ 149 150 LIST_HEAD(veriexec_hashhead, veriexec_hash_entry) *hash_tbl; 151 152 /* Veriexec hash table information. */ 153 struct veriexec_hashtbl { 154 struct veriexec_hashhead *hash_tbl; 155 size_t hash_size; /* Number of slots in the table. */ 156 dev_t hash_dev; /* Device ID the hash table refers to. */ 157 uint64_t hash_count; /* # of fingerprinted files in table. */ 158 LIST_ENTRY(veriexec_hashtbl) hash_list; 159 }; 160 161 /* Global list of hash tables. */ 162 LIST_HEAD(, veriexec_hashtbl) veriexec_tables; 163 164 /* Mask to ensure bounded access to elements in the hash table. */ 165 #define VERIEXEC_HASH_MASK(tbl) ((tbl)->hash_size - 1) 166 167 /* Readable values for veriexec_report(). */ 168 #define REPORT_NOVERBOSE 0 169 #define REPORT_VERBOSE 1 170 #define REPORT_VERBOSE_HIGH 2 171 #define REPORT_NOPANIC 0 172 #define REPORT_PANIC 1 173 #define REPORT_NOALARM 0 174 #define REPORT_ALARM 1 175 176 /* 177 * Hashing function: Takes an inode number modulus the mask to give back 178 * an index into the hash table. 179 */ 180 #define VERIEXEC_HASH(tbl, inode) \ 181 (hash32_buf(&(inode), sizeof((inode)), HASH32_BUF_INIT) \ 182 & VERIEXEC_HASH_MASK(tbl)) 183 184 /* Initialize a fingerprint ops struct. */ 185 #define VERIEXEC_OPINIT(ops, fp_type, hashlen, ctx_size, init_fn, \ 186 update_fn, final_fn) \ 187 do { \ 188 (void) strlcpy((ops)->type, fp_type, sizeof((ops)->type)); \ 189 (ops)->hash_len = (hashlen); \ 190 (ops)->context_size = (ctx_size); \ 191 (ops)->init = (VERIEXEC_INIT_FN) (init_fn); \ 192 (ops)->update = (VERIEXEC_UPDATE_FN) (update_fn); \ 193 (ops)->final = (VERIEXEC_FINAL_FN) (final_fn); \ 194 } while (0); 195 196 int veriexec_add_fp_ops(struct veriexec_fp_ops *); 197 void veriexec_init_fp_ops(void); 198 struct veriexec_fp_ops *veriexec_find_ops(u_char *name); 199 int veriexec_fp_calc(struct proc *, struct vnode *, 200 struct veriexec_hash_entry *, uint64_t, u_char *); 201 int veriexec_fp_cmp(struct veriexec_fp_ops *, u_char *, u_char *); 202 struct veriexec_hashtbl *veriexec_tblfind(dev_t); 203 struct veriexec_hash_entry *veriexec_lookup(dev_t, ino_t); 204 int veriexec_hashadd(struct veriexec_hashtbl *, struct veriexec_hash_entry *); 205 int veriexec_verify(struct proc *, struct vnode *, struct vattr *, 206 const u_char *, int, struct veriexec_hash_entry **); 207 int veriexec_page_verify(struct veriexec_hash_entry *, struct vattr *, 208 struct vm_page *, size_t); 209 int veriexec_removechk(struct proc *, struct vnode *, const char *); 210 int veriexec_renamechk(struct vnode *, const char *, const char *); 211 void veriexec_init_fp_ops(void); 212 void veriexec_report(const u_char *, const u_char *, struct vattr *, 213 struct proc *, int, int, int); 214 int veriexec_newtable(struct veriexec_sizing_params *); 215 int veriexec_load(struct veriexec_params *, struct proc *); 216 int veriexec_delete(struct veriexec_delete_params *); 217 218 #endif /* _KERNEL */ 219 220 #endif /* !_SYS_VERIFIED_EXEC_H_ */ 221
Indexes created Thu Sep 25 08:09:54 GMT 2025