1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2002 Poul-Henning Kamp 5 * Copyright (c) 2002 Networks Associates Technology, Inc. 6 * All rights reserved. 7 * 8 * This software was developed for the FreeBSD Project by Poul-Henning Kamp 9 * and NAI Labs, the Security Research Division of Network Associates, Inc. 10 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 11 * DARPA CHATS research program. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * $FreeBSD$ 35 */ 36 37#ifndef _SYS_GEOM_BDE_G_BDE_H_ 38#define _SYS_GEOM_BDE_G_BDE_H_ 1 39 40/* 41 * These are quite, but not entirely unlike constants. 42 * 43 * They are not commented in details here, to prevent unadvisable 44 * experimentation. Please consult the code where they are used before you 45 * even think about modifying these. 46 */ 47 48#define G_BDE_MKEYLEN (2048/8) 49#define G_BDE_SKEYBITS 128 50#define G_BDE_SKEYLEN (G_BDE_SKEYBITS/8) 51#define G_BDE_KKEYBITS 128 52#define G_BDE_KKEYLEN (G_BDE_KKEYBITS/8) 53#define G_BDE_MAXKEYS 4 54#define G_BDE_LOCKSIZE 384 55#define NLOCK_FIELDS 13 56 57/* This just needs to be "large enough" */ 58#define G_BDE_KEYBYTES 304 59 60struct g_bde_work; 61struct g_bde_softc; 62 63struct g_bde_sector { 64 struct g_bde_work *owner; 65 struct g_bde_softc *softc; 66 off_t offset; 67 u_int size; 68 u_int ref; 69 void *data; 70 TAILQ_ENTRY(g_bde_sector) list; 71 u_char valid; 72 u_char malloc; 73 enum {JUNK, IO, VALID} state; 74 int error; 75 time_t used; 76}; 77 78struct g_bde_work { 79 struct mtx mutex; 80 off_t offset; 81 off_t length; 82 void *data; 83 struct bio *bp; 84 struct g_bde_softc *softc; 85 off_t so; 86 off_t kso; 87 u_int ko; 88 struct g_bde_sector *sp; 89 struct g_bde_sector *ksp; 90 TAILQ_ENTRY(g_bde_work) list; 91 enum {SETUP, WAIT, FINISH} state; 92 int error; 93}; 94 95/* 96 * The decrypted contents of the lock sectors. Notice that this is not 97 * the same as the on-disk layout. The on-disk layout is dynamic and 98 * dependent on the pass-phrase. 99 */ 100struct g_bde_key { 101 uint64_t sector0; 102 /* Physical byte offset of 1st byte used */ 103 uint64_t sectorN; 104 /* Physical byte offset of 1st byte not used */ 105 uint64_t keyoffset; 106 /* Number of bytes the disk image is skewed. */ 107 uint64_t lsector[G_BDE_MAXKEYS]; 108 /* Physical byte offsets of lock sectors */ 109 uint32_t sectorsize; 110 /* Our "logical" sector size */ 111 uint32_t flags; 112#define GBDE_F_SECT0 1 113 uint8_t salt[16]; 114 /* Used to frustate the kkey generation */ 115 uint8_t spare[32]; 116 /* For future use, random contents */ 117 uint8_t mkey[G_BDE_MKEYLEN]; 118 /* Our masterkey. */ 119 120 /* Non-stored help-fields */ 121 uint64_t zone_width; /* On-disk width of zone */ 122 uint64_t zone_cont; /* Payload width of zone */ 123 uint64_t media_width; /* Non-magic width of zone */ 124 u_int keys_per_sector; 125}; 126 127struct g_bde_softc { 128 off_t mediasize; 129 u_int sectorsize; 130 uint64_t zone_cont; 131 struct g_geom *geom; 132 struct g_consumer *consumer; 133 TAILQ_HEAD(, g_bde_sector) freelist; 134 TAILQ_HEAD(, g_bde_work) worklist; 135 struct mtx worklist_mutex; 136 struct proc *thread; 137 struct g_bde_key key; 138 int dead; 139 u_int nwork; 140 u_int nsect; 141 u_int ncache; 142 u_char sha2[SHA512_DIGEST_LENGTH]; 143}; 144 145/* g_bde_crypt.c */ 146void g_bde_crypt_delete(struct g_bde_work *wp); 147void g_bde_crypt_read(struct g_bde_work *wp); 148void g_bde_crypt_write(struct g_bde_work *wp); 149 150/* g_bde_key.c */ 151void g_bde_zap_key(struct g_bde_softc *sc); 152int g_bde_get_key(struct g_bde_softc *sc, void *ptr, int len); 153int g_bde_init_keybytes(struct g_bde_softc *sc, char *passp, int len); 154 155/* g_bde_lock .c */ 156int g_bde_encode_lock(u_char *sha2, struct g_bde_key *gl, u_char *ptr); 157int g_bde_decode_lock(struct g_bde_softc *sc, struct g_bde_key *gl, u_char *ptr); 158int g_bde_keyloc_encrypt(u_char *sha2, uint64_t v0, uint64_t v1, void *output); 159int g_bde_keyloc_decrypt(u_char *sha2, void *input, uint64_t *output); 160int g_bde_decrypt_lock(struct g_bde_softc *sc, u_char *keymat, u_char *meta, off_t mediasize, u_int sectorsize, u_int *nkey); 161void g_bde_hash_pass(struct g_bde_softc *sc, const void *input, u_int len); 162 163/* g_bde_math .c */ 164uint64_t g_bde_max_sector(struct g_bde_key *lp); 165void g_bde_map_sector(struct g_bde_work *wp); 166 167/* g_bde_work.c */ 168void g_bde_start1(struct bio *bp); 169void g_bde_worker(void *arg); 170 171/* 172 * These four functions wrap the raw Rijndael functions and make sure we 173 * explode if something fails which shouldn't. 174 */ 175 176static __inline void 177AES_init(cipherInstance *ci) 178{ 179 int error; 180 181 error = rijndael_cipherInit(ci, MODE_CBC, NULL); 182 KASSERT(error > 0, ("rijndael_cipherInit %d", error)); 183} 184 185static __inline void 186AES_makekey(keyInstance *ki, int dir, u_int len, const void *key) 187{ 188 int error; 189 190 error = rijndael_makeKey(ki, dir, len, key); 191 KASSERT(error > 0, ("rijndael_makeKey %d", error)); 192} 193 194static __inline void 195AES_encrypt(cipherInstance *ci, keyInstance *ki, const void *in, void *out, u_int len) 196{ 197 int error; 198 199 error = rijndael_blockEncrypt(ci, ki, in, len * 8, out); 200 KASSERT(error > 0, ("rijndael_blockEncrypt %d", error)); 201} 202 203static __inline void 204AES_decrypt(cipherInstance *ci, keyInstance *ki, const void *in, void *out, u_int len) 205{ 206 int error; 207 208 error = rijndael_blockDecrypt(ci, ki, in, len * 8, out); 209 KASSERT(error > 0, ("rijndael_blockDecrypt %d", error)); 210} 211 212#endif /* _SYS_GEOM_BDE_G_BDE_H_ */ 213