1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
35 #ifndef _SYS_GEOM_BDE_G_BDE_H_
36 #define _SYS_GEOM_BDE_G_BDE_H_ 1
37
38 /*
39 * These are quite, but not entirely unlike constants.
40 *
41 * They are not commented in details here, to prevent unadvisable
42 * experimentation. Please consult the code where they are used before you
43 * even think about modifying these.
44 */
45
46 #define G_BDE_MKEYLEN (2048/8)
47 #define G_BDE_SKEYBITS 128
48 #define G_BDE_SKEYLEN (G_BDE_SKEYBITS/8)
49 #define G_BDE_KKEYBITS 128
50 #define G_BDE_KKEYLEN (G_BDE_KKEYBITS/8)
51 #define G_BDE_MAXKEYS 4
52 #define G_BDE_LOCKSIZE 384
53 #define NLOCK_FIELDS 13
54
55 /* This just needs to be "large enough" */
56 #define G_BDE_KEYBYTES 304
57
58 /* This file is being included by userspace. */
59 #ifndef __diagused
60 #define __diagused
61 #endif
62
63 struct g_bde_work;
64 struct g_bde_softc;
65
66 struct g_bde_sector {
67 struct g_bde_work *owner;
68 struct g_bde_softc *softc;
69 off_t offset;
70 u_int size;
71 u_int ref;
72 void *data;
73 TAILQ_ENTRY(g_bde_sector) list;
74 u_char valid;
75 u_char malloc;
76 enum {JUNK, IO, VALID} state;
77 int error;
78 time_t used;
79 };
80
81 struct g_bde_work {
82 struct mtx mutex;
83 off_t offset;
84 off_t length;
85 void *data;
86 struct bio *bp;
87 struct g_bde_softc *softc;
88 off_t so;
89 off_t kso;
90 u_int ko;
91 struct g_bde_sector *sp;
92 struct g_bde_sector *ksp;
93 TAILQ_ENTRY(g_bde_work) list;
94 enum {SETUP, WAIT, FINISH} state;
95 int error;
96 };
97
98 /*
99 * The decrypted contents of the lock sectors. Notice that this is not
100 * the same as the on-disk layout. The on-disk layout is dynamic and
101 * dependent on the pass-phrase.
102 */
103 struct g_bde_key {
104 uint64_t sector0;
105 /* Physical byte offset of 1st byte used */
106 uint64_t sectorN;
107 /* Physical byte offset of 1st byte not used */
108 uint64_t keyoffset;
109 /* Number of bytes the disk image is skewed. */
110 uint64_t lsector[G_BDE_MAXKEYS];
111 /* Physical byte offsets of lock sectors */
112 uint32_t sectorsize;
113 /* Our "logical" sector size */
114 uint32_t flags;
115 #define GBDE_F_SECT0 1
116 uint8_t salt[16];
117 /* Used to frustate the kkey generation */
118 uint8_t spare[32];
119 /* For future use, random contents */
120 uint8_t mkey[G_BDE_MKEYLEN];
121 /* Our masterkey. */
122
123 /* Non-stored help-fields */
124 uint64_t zone_width; /* On-disk width of zone */
125 uint64_t zone_cont; /* Payload width of zone */
126 uint64_t media_width; /* Non-magic width of zone */
127 u_int keys_per_sector;
128 };
129
130 struct g_bde_softc {
131 off_t mediasize;
132 u_int sectorsize;
133 uint64_t zone_cont;
134 struct g_geom *geom;
135 struct g_consumer *consumer;
136 TAILQ_HEAD(, g_bde_sector) freelist;
137 TAILQ_HEAD(, g_bde_work) worklist;
138 struct mtx worklist_mutex;
139 struct proc *thread;
140 struct g_bde_key key;
141 int dead;
142 u_int nwork;
143 u_int nsect;
144 u_int ncache;
145 u_char sha2[SHA512_DIGEST_LENGTH];
146 };
147
148 /* g_bde_crypt.c */
149 void g_bde_crypt_delete(struct g_bde_work *wp);
150 void g_bde_crypt_read(struct g_bde_work *wp);
151 void g_bde_crypt_write(struct g_bde_work *wp);
152
153 /* g_bde_key.c */
154 void g_bde_zap_key(struct g_bde_softc *sc);
155 int g_bde_get_key(struct g_bde_softc *sc, void *ptr, int len);
156 int g_bde_init_keybytes(struct g_bde_softc *sc, char *passp, int len);
157
158 /* g_bde_lock .c */
159 int g_bde_encode_lock(u_char *sha2, struct g_bde_key *gl, u_char *ptr);
160 int g_bde_decode_lock(struct g_bde_softc *sc, struct g_bde_key *gl, u_char *ptr);
161 int g_bde_keyloc_encrypt(u_char *sha2, uint64_t v0, uint64_t v1, void *output);
162 int g_bde_keyloc_decrypt(u_char *sha2, void *input, uint64_t *output);
163 int g_bde_decrypt_lock(struct g_bde_softc *sc, u_char *keymat, u_char *meta, off_t mediasize, u_int sectorsize, u_int *nkey);
164 void g_bde_hash_pass(struct g_bde_softc *sc, const void *input, u_int len);
165
166 /* g_bde_math .c */
167 uint64_t g_bde_max_sector(struct g_bde_key *lp);
168 void g_bde_map_sector(struct g_bde_work *wp);
169
170 /* g_bde_work.c */
171 void g_bde_start1(struct bio *bp);
172 void g_bde_worker(void *arg);
173
174 /*
175 * These four functions wrap the raw Rijndael functions and make sure we
176 * explode if something fails which shouldn't.
177 */
178
179 static __inline void
AES_init(cipherInstance * ci)180 AES_init(cipherInstance *ci)
181 {
182 int error __diagused;
183
184 error = rijndael_cipherInit(ci, MODE_CBC, NULL);
185 KASSERT(error > 0, ("rijndael_cipherInit %d", error));
186 }
187
188 static __inline void
AES_makekey(keyInstance * ki,int dir,u_int len,const void * key)189 AES_makekey(keyInstance *ki, int dir, u_int len, const void *key)
190 {
191 int error __diagused;
192
193 error = rijndael_makeKey(ki, dir, len, key);
194 KASSERT(error > 0, ("rijndael_makeKey %d", error));
195 }
196
197 static __inline void
AES_encrypt(cipherInstance * ci,keyInstance * ki,const void * in,void * out,u_int len)198 AES_encrypt(cipherInstance *ci, keyInstance *ki, const void *in, void *out, u_int len)
199 {
200 int error __diagused;
201
202 error = rijndael_blockEncrypt(ci, ki, in, len * 8, out);
203 KASSERT(error > 0, ("rijndael_blockEncrypt %d", error));
204 }
205
206 static __inline void
AES_decrypt(cipherInstance * ci,keyInstance * ki,const void * in,void * out,u_int len)207 AES_decrypt(cipherInstance *ci, keyInstance *ki, const void *in, void *out, u_int len)
208 {
209 int error __diagused;
210
211 error = rijndael_blockDecrypt(ci, ki, in, len * 8, out);
212 KASSERT(error > 0, ("rijndael_blockDecrypt %d", error));
213 }
214
215 #endif /* _SYS_GEOM_BDE_G_BDE_H_ */
216