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