2 * Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/endian.h>
33 #include <sys/errno.h>
34 #include <sys/malloc.h>
35 #include <crypto/sha2/sha2.h>
36 #include <opencrypto/cryptodev.h>
39 #include <sys/libkern.h>
41 #include <sys/mutex.h>
42 #include <sys/queue.h>
44 #include <geom/geom.h>
55 #define G_ELI_CLASS_NAME "ELI"
56 #define G_ELI_MAGIC "GEOM::ELI"
57 #define G_ELI_SUFFIX ".eli"
61 * 0 - Initial version number.
62 * 1 - Added data authentication support (md_aalgo field and
63 * G_ELI_FLAG_AUTH flag).
64 * 2 - Added G_ELI_FLAG_READONLY.
65 * 3 - Added 'configure' subcommand.
66 * 4 - IV is generated from offset converted to little-endian
67 * (the G_ELI_FLAG_NATIVE_BYTE_ORDER flag will be set for older versions).
68 * 5 - Added multiple encrypton keys and AES-XTS support.
69 * 6 - Fixed usage of multiple keys for authenticated providers (the
70 * G_ELI_FLAG_FIRST_KEY flag will be set for older versions).
72 #define G_ELI_VERSION_00 0
73 #define G_ELI_VERSION_01 1
74 #define G_ELI_VERSION_02 2
75 #define G_ELI_VERSION_03 3
76 #define G_ELI_VERSION_04 4
77 #define G_ELI_VERSION_05 5
78 #define G_ELI_VERSION_06 6
79 #define G_ELI_VERSION G_ELI_VERSION_06
82 /* Use random, onetime keys. */
83 #define G_ELI_FLAG_ONETIME 0x00000001
84 /* Ask for the passphrase from the kernel, before mounting root. */
85 #define G_ELI_FLAG_BOOT 0x00000002
86 /* Detach on last close, if we were open for writing. */
87 #define G_ELI_FLAG_WO_DETACH 0x00000004
88 /* Detach on last close. */
89 #define G_ELI_FLAG_RW_DETACH 0x00000008
90 /* Provide data authentication. */
91 #define G_ELI_FLAG_AUTH 0x00000010
92 /* Provider is read-only, we should deny all write attempts. */
93 #define G_ELI_FLAG_RO 0x00000020
95 /* Provider was open for writing. */
96 #define G_ELI_FLAG_WOPEN 0x00010000
98 #define G_ELI_FLAG_DESTROY 0x00020000
99 /* Provider uses native byte-order for IV generation. */
100 #define G_ELI_FLAG_NATIVE_BYTE_ORDER 0x00040000
101 /* Provider uses single encryption key. */
102 #define G_ELI_FLAG_SINGLE_KEY 0x00080000
103 /* Device suspended. */
104 #define G_ELI_FLAG_SUSPEND 0x00100000
105 /* Provider uses first encryption key. */
106 #define G_ELI_FLAG_FIRST_KEY 0x00200000
108 #define G_ELI_NEW_BIO 255
110 #define SHA512_MDLEN 64
111 #define G_ELI_AUTH_SECKEYLEN SHA256_DIGEST_LENGTH
113 #define G_ELI_MAXMKEYS 2
114 #define G_ELI_MAXKEYLEN 64
115 #define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN
116 #define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN
117 #define G_ELI_AUTHKEYLEN G_ELI_MAXKEYLEN
118 #define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN
119 #define G_ELI_SALTLEN 64
120 #define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN)
121 /* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */
122 #define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN)
123 #define G_ELI_OVERWRITES 5
124 /* Switch data encryption key every 2^20 blocks. */
125 #define G_ELI_KEY_SHIFT 20
128 extern int g_eli_debug;
129 extern u_int g_eli_overwrites;
130 extern u_int g_eli_batch;
132 #define G_ELI_CRYPTO_UNKNOWN 0
133 #define G_ELI_CRYPTO_HW 1
134 #define G_ELI_CRYPTO_SW 2
136 #define G_ELI_DEBUG(lvl, ...) do { \
137 if (g_eli_debug >= (lvl)) { \
138 printf("GEOM_ELI"); \
139 if (g_eli_debug > 0) \
140 printf("[%u]", lvl); \
142 printf(__VA_ARGS__); \
146 #define G_ELI_LOGREQ(lvl, bp, ...) do { \
147 if (g_eli_debug >= (lvl)) { \
148 printf("GEOM_ELI"); \
149 if (g_eli_debug > 0) \
150 printf("[%u]", lvl); \
152 printf(__VA_ARGS__); \
159 struct g_eli_worker {
160 struct g_eli_softc *w_softc;
165 LIST_ENTRY(g_eli_worker) w_next;
169 struct g_geom *sc_geom;
172 uint8_t sc_mkey[G_ELI_DATAIVKEYLEN];
173 uint8_t sc_ekey[G_ELI_DATAKEYLEN];
174 TAILQ_HEAD(, g_eli_key) sc_ekeys_queue;
175 RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree;
176 struct mtx sc_ekeys_lock;
177 uint64_t sc_ekeys_total;
178 uint64_t sc_ekeys_allocated;
181 uint8_t sc_akey[G_ELI_AUTHKEYLEN];
185 SHA256_CTX sc_akeyctx;
186 uint8_t sc_ivkey[G_ELI_IVKEYLEN];
192 size_t sc_sectorsize;
193 u_int sc_bytes_per_sector;
194 u_int sc_data_per_sector;
195 boolean_t sc_cpubind;
197 /* Only for software cryptography. */
198 struct bio_queue_head sc_queue;
199 struct mtx sc_queue_mtx;
200 LIST_HEAD(, g_eli_worker) sc_workers;
202 #define sc_name sc_geom->name
205 struct g_eli_metadata {
206 char md_magic[16]; /* Magic value. */
207 uint32_t md_version; /* Version number. */
208 uint32_t md_flags; /* Additional flags. */
209 uint16_t md_ealgo; /* Encryption algorithm. */
210 uint16_t md_keylen; /* Key length. */
211 uint16_t md_aalgo; /* Authentication algorithm. */
212 uint64_t md_provsize; /* Provider's size. */
213 uint32_t md_sectorsize; /* Sector size. */
214 uint8_t md_keys; /* Available keys. */
215 int32_t md_iterations; /* Number of iterations for PKCS#5v2. */
216 uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */
217 /* Encrypted master key (IV-key, Data-key, HMAC). */
218 uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN];
219 u_char md_hash[16]; /* MD5 hash. */
223 eli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap)
228 le32enc(p, md->md_flags); p += sizeof(md->md_flags);
229 le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo);
230 le16enc(p, md->md_keylen); p += sizeof(md->md_keylen);
231 le64enc(p, md->md_provsize); p += sizeof(md->md_provsize);
232 le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize);
233 *p = md->md_keys; p += sizeof(md->md_keys);
234 le32enc(p, md->md_iterations); p += sizeof(md->md_iterations);
235 bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
236 bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
240 eli_metadata_encode_v1v2v3v4v5v6(struct g_eli_metadata *md, u_char **datap)
245 le32enc(p, md->md_flags); p += sizeof(md->md_flags);
246 le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo);
247 le16enc(p, md->md_keylen); p += sizeof(md->md_keylen);
248 le16enc(p, md->md_aalgo); p += sizeof(md->md_aalgo);
249 le64enc(p, md->md_provsize); p += sizeof(md->md_provsize);
250 le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize);
251 *p = md->md_keys; p += sizeof(md->md_keys);
252 le32enc(p, md->md_iterations); p += sizeof(md->md_iterations);
253 bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
254 bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
258 eli_metadata_encode(struct g_eli_metadata *md, u_char *data)
264 bcopy(md->md_magic, p, sizeof(md->md_magic));
265 p += sizeof(md->md_magic);
266 le32enc(p, md->md_version);
267 p += sizeof(md->md_version);
268 switch (md->md_version) {
269 case G_ELI_VERSION_00:
270 eli_metadata_encode_v0(md, &p);
272 case G_ELI_VERSION_01:
273 case G_ELI_VERSION_02:
274 case G_ELI_VERSION_03:
275 case G_ELI_VERSION_04:
276 case G_ELI_VERSION_05:
277 case G_ELI_VERSION_06:
278 eli_metadata_encode_v1v2v3v4v5v6(md, &p);
282 panic("%s: Unsupported version %u.", __func__,
283 (u_int)md->md_version);
285 assert(!"Unsupported metadata version.");
289 MD5Update(&ctx, data, p - data);
290 MD5Final(md->md_hash, &ctx);
291 bcopy(md->md_hash, p, sizeof(md->md_hash));
294 eli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md)
299 p = data + sizeof(md->md_magic) + sizeof(md->md_version);
300 md->md_flags = le32dec(p); p += sizeof(md->md_flags);
301 md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo);
302 md->md_keylen = le16dec(p); p += sizeof(md->md_keylen);
303 md->md_provsize = le64dec(p); p += sizeof(md->md_provsize);
304 md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize);
305 md->md_keys = *p; p += sizeof(md->md_keys);
306 md->md_iterations = le32dec(p); p += sizeof(md->md_iterations);
307 bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
308 bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
310 MD5Update(&ctx, data, p - data);
311 MD5Final(md->md_hash, &ctx);
312 if (bcmp(md->md_hash, p, 16) != 0)
318 eli_metadata_decode_v1v2v3v4v5v6(const u_char *data, struct g_eli_metadata *md)
323 p = data + sizeof(md->md_magic) + sizeof(md->md_version);
324 md->md_flags = le32dec(p); p += sizeof(md->md_flags);
325 md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo);
326 md->md_keylen = le16dec(p); p += sizeof(md->md_keylen);
327 md->md_aalgo = le16dec(p); p += sizeof(md->md_aalgo);
328 md->md_provsize = le64dec(p); p += sizeof(md->md_provsize);
329 md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize);
330 md->md_keys = *p; p += sizeof(md->md_keys);
331 md->md_iterations = le32dec(p); p += sizeof(md->md_iterations);
332 bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
333 bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
335 MD5Update(&ctx, data, p - data);
336 MD5Final(md->md_hash, &ctx);
337 if (bcmp(md->md_hash, p, 16) != 0)
342 eli_metadata_decode(const u_char *data, struct g_eli_metadata *md)
346 bcopy(data, md->md_magic, sizeof(md->md_magic));
347 if (strcmp(md->md_magic, G_ELI_MAGIC) != 0)
349 md->md_version = le32dec(data + sizeof(md->md_magic));
350 switch (md->md_version) {
351 case G_ELI_VERSION_00:
352 error = eli_metadata_decode_v0(data, md);
354 case G_ELI_VERSION_01:
355 case G_ELI_VERSION_02:
356 case G_ELI_VERSION_03:
357 case G_ELI_VERSION_04:
358 case G_ELI_VERSION_05:
359 case G_ELI_VERSION_06:
360 error = eli_metadata_decode_v1v2v3v4v5v6(data, md);
368 #endif /* !_OpenSSL */
370 static __inline u_int
371 g_eli_str2ealgo(const char *name)
374 if (strcasecmp("null", name) == 0)
375 return (CRYPTO_NULL_CBC);
376 else if (strcasecmp("null-cbc", name) == 0)
377 return (CRYPTO_NULL_CBC);
378 else if (strcasecmp("aes", name) == 0)
379 return (CRYPTO_AES_XTS);
380 else if (strcasecmp("aes-cbc", name) == 0)
381 return (CRYPTO_AES_CBC);
382 else if (strcasecmp("aes-xts", name) == 0)
383 return (CRYPTO_AES_XTS);
384 else if (strcasecmp("blowfish", name) == 0)
385 return (CRYPTO_BLF_CBC);
386 else if (strcasecmp("blowfish-cbc", name) == 0)
387 return (CRYPTO_BLF_CBC);
388 else if (strcasecmp("camellia", name) == 0)
389 return (CRYPTO_CAMELLIA_CBC);
390 else if (strcasecmp("camellia-cbc", name) == 0)
391 return (CRYPTO_CAMELLIA_CBC);
392 else if (strcasecmp("3des", name) == 0)
393 return (CRYPTO_3DES_CBC);
394 else if (strcasecmp("3des-cbc", name) == 0)
395 return (CRYPTO_3DES_CBC);
396 return (CRYPTO_ALGORITHM_MIN - 1);
399 static __inline u_int
400 g_eli_str2aalgo(const char *name)
403 if (strcasecmp("hmac/md5", name) == 0)
404 return (CRYPTO_MD5_HMAC);
405 else if (strcasecmp("hmac/sha1", name) == 0)
406 return (CRYPTO_SHA1_HMAC);
407 else if (strcasecmp("hmac/ripemd160", name) == 0)
408 return (CRYPTO_RIPEMD160_HMAC);
409 else if (strcasecmp("hmac/sha256", name) == 0)
410 return (CRYPTO_SHA2_256_HMAC);
411 else if (strcasecmp("hmac/sha384", name) == 0)
412 return (CRYPTO_SHA2_384_HMAC);
413 else if (strcasecmp("hmac/sha512", name) == 0)
414 return (CRYPTO_SHA2_512_HMAC);
415 return (CRYPTO_ALGORITHM_MIN - 1);
418 static __inline const char *
419 g_eli_algo2str(u_int algo)
423 case CRYPTO_NULL_CBC:
430 return ("Blowfish-CBC");
431 case CRYPTO_CAMELLIA_CBC:
432 return ("CAMELLIA-CBC");
433 case CRYPTO_3DES_CBC:
435 case CRYPTO_MD5_HMAC:
437 case CRYPTO_SHA1_HMAC:
438 return ("HMAC/SHA1");
439 case CRYPTO_RIPEMD160_HMAC:
440 return ("HMAC/RIPEMD160");
441 case CRYPTO_SHA2_256_HMAC:
442 return ("HMAC/SHA256");
443 case CRYPTO_SHA2_384_HMAC:
444 return ("HMAC/SHA384");
445 case CRYPTO_SHA2_512_HMAC:
446 return ("HMAC/SHA512");
452 eli_metadata_dump(const struct g_eli_metadata *md)
454 static const char hex[] = "0123456789abcdef";
455 char str[sizeof(md->md_mkeys) * 2 + 1];
458 printf(" magic: %s\n", md->md_magic);
459 printf(" version: %u\n", (u_int)md->md_version);
460 printf(" flags: 0x%x\n", (u_int)md->md_flags);
461 printf(" ealgo: %s\n", g_eli_algo2str(md->md_ealgo));
462 printf(" keylen: %u\n", (u_int)md->md_keylen);
463 if (md->md_flags & G_ELI_FLAG_AUTH)
464 printf(" aalgo: %s\n", g_eli_algo2str(md->md_aalgo));
465 printf(" provsize: %ju\n", (uintmax_t)md->md_provsize);
466 printf("sectorsize: %u\n", (u_int)md->md_sectorsize);
467 printf(" keys: 0x%02x\n", (u_int)md->md_keys);
468 printf("iterations: %u\n", (u_int)md->md_iterations);
469 bzero(str, sizeof(str));
470 for (i = 0; i < sizeof(md->md_salt); i++) {
471 str[i * 2] = hex[md->md_salt[i] >> 4];
472 str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f];
474 printf(" Salt: %s\n", str);
475 bzero(str, sizeof(str));
476 for (i = 0; i < sizeof(md->md_mkeys); i++) {
477 str[i * 2] = hex[md->md_mkeys[i] >> 4];
478 str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f];
480 printf("Master Key: %s\n", str);
481 bzero(str, sizeof(str));
482 for (i = 0; i < 16; i++) {
483 str[i * 2] = hex[md->md_hash[i] >> 4];
484 str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f];
486 printf(" MD5 hash: %s\n", str);
489 static __inline u_int
490 g_eli_keylen(u_int algo, u_int keylen)
494 case CRYPTO_NULL_CBC:
503 case CRYPTO_CAMELLIA_CBC:
527 if (keylen < 128 || keylen > 448)
529 if ((keylen % 32) != 0)
532 case CRYPTO_3DES_CBC:
533 if (keylen == 0 || keylen == 192)
541 static __inline u_int
542 g_eli_hashlen(u_int algo)
546 case CRYPTO_MD5_HMAC:
548 case CRYPTO_SHA1_HMAC:
550 case CRYPTO_RIPEMD160_HMAC:
552 case CRYPTO_SHA2_256_HMAC:
554 case CRYPTO_SHA2_384_HMAC:
556 case CRYPTO_SHA2_512_HMAC:
563 int g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
564 struct g_eli_metadata *md);
565 struct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp,
566 struct g_provider *bpp, const struct g_eli_metadata *md,
567 const u_char *mkey, int nkey);
568 int g_eli_destroy(struct g_eli_softc *sc, boolean_t force);
570 int g_eli_access(struct g_provider *pp, int dr, int dw, int de);
571 void g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb);
573 void g_eli_read_done(struct bio *bp);
574 void g_eli_write_done(struct bio *bp);
575 int g_eli_crypto_rerun(struct cryptop *crp);
576 void g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
579 void g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker);
580 void g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp);
582 void g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp);
583 void g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp);
586 void g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key);
587 int g_eli_mkey_decrypt(const struct g_eli_metadata *md,
588 const unsigned char *key, unsigned char *mkey, unsigned *nkeyp);
589 int g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen,
590 unsigned char *mkey);
592 void g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey);
595 int g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize,
596 const u_char *key, size_t keysize);
597 int g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize,
598 const u_char *key, size_t keysize);
605 void g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey,
607 void g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data,
609 void g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize);
610 void g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize,
611 const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize);
614 void g_eli_key_init(struct g_eli_softc *sc);
615 void g_eli_key_destroy(struct g_eli_softc *sc);
616 uint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize);
617 void g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey);
619 #endif /* !_G_ELI_H_ */