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