1 /*- 2 * Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef _G_ELI_H_ 30 #define _G_ELI_H_ 31 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> 37 #ifdef _KERNEL 38 #include <sys/bio.h> 39 #include <sys/libkern.h> 40 #include <geom/geom.h> 41 #else 42 #include <stdio.h> 43 #include <string.h> 44 #include <strings.h> 45 #endif 46 #ifndef _OpenSSL_ 47 #include <sys/md5.h> 48 #endif 49 50 #define G_ELI_CLASS_NAME "ELI" 51 #define G_ELI_MAGIC "GEOM::ELI" 52 #define G_ELI_SUFFIX ".eli" 53 54 /* 55 * Version history: 56 * 0 - Initial version number. 57 * 1 - Added data authentication support (md_aalgo field and 58 * G_ELI_FLAG_AUTH flag). 59 */ 60 #define G_ELI_VERSION 1 61 62 /* Use random, onetime keys. */ 63 #define G_ELI_FLAG_ONETIME 0x00000001 64 /* Ask for the passphrase from the kernel, before mounting root. */ 65 #define G_ELI_FLAG_BOOT 0x00000002 66 /* Detach on last close, if we were open for writing. */ 67 #define G_ELI_FLAG_WO_DETACH 0x00000004 68 /* Detach on last close. */ 69 #define G_ELI_FLAG_RW_DETACH 0x00000008 70 /* Provide data authentication. */ 71 #define G_ELI_FLAG_AUTH 0x00000010 72 /* Provider was open for writing. */ 73 #define G_ELI_FLAG_WOPEN 0x00010000 74 /* Destroy device. */ 75 #define G_ELI_FLAG_DESTROY 0x00020000 76 77 #define SHA512_MDLEN 64 78 #define G_ELI_AUTH_SECKEYLEN SHA256_DIGEST_LENGTH 79 80 #define G_ELI_MAXMKEYS 2 81 #define G_ELI_MAXKEYLEN 64 82 #define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN 83 #define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN 84 #define G_ELI_AUTHKEYLEN G_ELI_MAXKEYLEN 85 #define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN 86 #define G_ELI_SALTLEN 64 87 #define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN) 88 /* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */ 89 #define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN) 90 91 #ifdef _KERNEL 92 extern u_int g_eli_debug; 93 extern u_int g_eli_overwrites; 94 extern u_int g_eli_batch; 95 96 #define G_ELI_CRYPTO_HW 1 97 #define G_ELI_CRYPTO_SW 2 98 99 #define G_ELI_DEBUG(lvl, ...) do { \ 100 if (g_eli_debug >= (lvl)) { \ 101 printf("GEOM_ELI"); \ 102 if (g_eli_debug > 0) \ 103 printf("[%u]", lvl); \ 104 printf(": "); \ 105 printf(__VA_ARGS__); \ 106 printf("\n"); \ 107 } \ 108 } while (0) 109 #define G_ELI_LOGREQ(lvl, bp, ...) do { \ 110 if (g_eli_debug >= (lvl)) { \ 111 printf("GEOM_ELI"); \ 112 if (g_eli_debug > 0) \ 113 printf("[%u]", lvl); \ 114 printf(": "); \ 115 printf(__VA_ARGS__); \ 116 printf(" "); \ 117 g_print_bio(bp); \ 118 printf("\n"); \ 119 } \ 120 } while (0) 121 122 struct g_eli_worker { 123 struct g_eli_softc *w_softc; 124 struct proc *w_proc; 125 u_int w_number; 126 uint64_t w_sid; 127 LIST_ENTRY(g_eli_worker) w_next; 128 }; 129 130 struct g_eli_softc { 131 struct g_geom *sc_geom; 132 u_int sc_crypto; 133 uint8_t sc_mkey[G_ELI_DATAIVKEYLEN]; 134 uint8_t sc_ekey[G_ELI_DATAKEYLEN]; 135 u_int sc_ealgo; 136 u_int sc_ekeylen; 137 uint8_t sc_akey[G_ELI_AUTHKEYLEN]; 138 u_int sc_aalgo; 139 u_int sc_akeylen; 140 u_int sc_alen; 141 SHA256_CTX sc_akeyctx; 142 uint8_t sc_ivkey[G_ELI_IVKEYLEN]; 143 SHA256_CTX sc_ivctx; 144 int sc_nkey; 145 uint32_t sc_flags; 146 u_int sc_bytes_per_sector; 147 u_int sc_data_per_sector; 148 149 /* Only for software cryptography. */ 150 struct bio_queue_head sc_queue; 151 struct mtx sc_queue_mtx; 152 LIST_HEAD(, g_eli_worker) sc_workers; 153 }; 154 #define sc_name sc_geom->name 155 #endif /* _KERNEL */ 156 157 struct g_eli_metadata { 158 char md_magic[16]; /* Magic value. */ 159 uint32_t md_version; /* Version number. */ 160 uint32_t md_flags; /* Additional flags. */ 161 uint16_t md_ealgo; /* Encryption algorithm. */ 162 uint16_t md_keylen; /* Key length. */ 163 uint16_t md_aalgo; /* Authentication algorithm. */ 164 uint64_t md_provsize; /* Provider's size. */ 165 uint32_t md_sectorsize; /* Sector size. */ 166 uint8_t md_keys; /* Available keys. */ 167 int32_t md_iterations; /* Number of iterations for PKCS#5v2. */ 168 uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */ 169 /* Encrypted master key (IV-key, Data-key, HMAC). */ 170 uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN]; 171 u_char md_hash[16]; /* MD5 hash. */ 172 } __packed; 173 #ifndef _OpenSSL_ 174 static __inline void 175 eli_metadata_encode(struct g_eli_metadata *md, u_char *data) 176 { 177 MD5_CTX ctx; 178 u_char *p; 179 180 p = data; 181 bcopy(md->md_magic, p, sizeof(md->md_magic)); p += sizeof(md->md_magic); 182 le32enc(p, md->md_version); p += sizeof(md->md_version); 183 le32enc(p, md->md_flags); p += sizeof(md->md_flags); 184 le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 185 le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 186 le16enc(p, md->md_aalgo); p += sizeof(md->md_aalgo); 187 le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 188 le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 189 *p = md->md_keys; p += sizeof(md->md_keys); 190 le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 191 bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 192 bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 193 MD5Init(&ctx); 194 MD5Update(&ctx, data, p - data); 195 MD5Final(md->md_hash, &ctx); 196 bcopy(md->md_hash, p, sizeof(md->md_hash)); 197 } 198 static __inline int 199 eli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md) 200 { 201 MD5_CTX ctx; 202 const u_char *p; 203 204 p = data + sizeof(md->md_magic) + sizeof(md->md_version); 205 md->md_flags = le32dec(p); p += sizeof(md->md_flags); 206 md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 207 md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 208 md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 209 md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 210 md->md_keys = *p; p += sizeof(md->md_keys); 211 md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 212 bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 213 bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 214 MD5Init(&ctx); 215 MD5Update(&ctx, data, p - data); 216 MD5Final(md->md_hash, &ctx); 217 if (bcmp(md->md_hash, p, 16) != 0) 218 return (EINVAL); 219 return (0); 220 } 221 static __inline int 222 eli_metadata_decode_v1(const u_char *data, struct g_eli_metadata *md) 223 { 224 MD5_CTX ctx; 225 const u_char *p; 226 227 p = data + sizeof(md->md_magic) + sizeof(md->md_version); 228 md->md_flags = le32dec(p); p += sizeof(md->md_flags); 229 md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 230 md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 231 md->md_aalgo = le16dec(p); p += sizeof(md->md_aalgo); 232 md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 233 md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 234 md->md_keys = *p; p += sizeof(md->md_keys); 235 md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 236 bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 237 bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 238 MD5Init(&ctx); 239 MD5Update(&ctx, data, p - data); 240 MD5Final(md->md_hash, &ctx); 241 if (bcmp(md->md_hash, p, 16) != 0) 242 return (EINVAL); 243 return (0); 244 } 245 static __inline int 246 eli_metadata_decode(const u_char *data, struct g_eli_metadata *md) 247 { 248 int error; 249 250 bcopy(data, md->md_magic, sizeof(md->md_magic)); 251 md->md_version = le32dec(data + sizeof(md->md_magic)); 252 switch (md->md_version) { 253 case 0: 254 error = eli_metadata_decode_v0(data, md); 255 break; 256 case 1: 257 error = eli_metadata_decode_v1(data, md); 258 break; 259 default: 260 error = EINVAL; 261 break; 262 } 263 return (error); 264 } 265 #endif /* !_OpenSSL */ 266 267 static __inline u_int 268 g_eli_str2ealgo(const char *name) 269 { 270 271 if (strcasecmp("null", name) == 0) 272 return (CRYPTO_NULL_CBC); 273 else if (strcasecmp("aes", name) == 0) 274 return (CRYPTO_AES_CBC); 275 else if (strcasecmp("blowfish", name) == 0) 276 return (CRYPTO_BLF_CBC); 277 else if (strcasecmp("3des", name) == 0) 278 return (CRYPTO_3DES_CBC); 279 return (CRYPTO_ALGORITHM_MIN - 1); 280 } 281 282 static __inline u_int 283 g_eli_str2aalgo(const char *name) 284 { 285 286 if (strcasecmp("hmac/md5", name) == 0) 287 return (CRYPTO_MD5_HMAC); 288 else if (strcasecmp("hmac/sha1", name) == 0) 289 return (CRYPTO_SHA1_HMAC); 290 else if (strcasecmp("hmac/ripemd160", name) == 0) 291 return (CRYPTO_RIPEMD160_HMAC); 292 else if (strcasecmp("hmac/sha256", name) == 0) 293 return (CRYPTO_SHA2_256_HMAC); 294 else if (strcasecmp("hmac/sha384", name) == 0) 295 return (CRYPTO_SHA2_384_HMAC); 296 else if (strcasecmp("hmac/sha512", name) == 0) 297 return (CRYPTO_SHA2_512_HMAC); 298 return (CRYPTO_ALGORITHM_MIN - 1); 299 } 300 301 static __inline const char * 302 g_eli_algo2str(u_int algo) 303 { 304 305 switch (algo) { 306 case CRYPTO_NULL_CBC: 307 return ("NULL"); 308 case CRYPTO_AES_CBC: 309 return ("AES-CBC"); 310 case CRYPTO_BLF_CBC: 311 return ("Blowfish-CBC"); 312 case CRYPTO_3DES_CBC: 313 return ("3DES-CBC"); 314 case CRYPTO_MD5_HMAC: 315 return ("HMAC/MD5"); 316 case CRYPTO_SHA1_HMAC: 317 return ("HMAC/SHA1"); 318 case CRYPTO_RIPEMD160_HMAC: 319 return ("HMAC/RIPEMD160"); 320 case CRYPTO_SHA2_256_HMAC: 321 return ("HMAC/SHA256"); 322 case CRYPTO_SHA2_384_HMAC: 323 return ("HMAC/SHA384"); 324 case CRYPTO_SHA2_512_HMAC: 325 return ("HMAC/SHA512"); 326 } 327 return ("unknown"); 328 } 329 330 static __inline void 331 eli_metadata_dump(const struct g_eli_metadata *md) 332 { 333 static const char hex[] = "0123456789abcdef"; 334 char str[sizeof(md->md_mkeys) * 2 + 1]; 335 u_int i; 336 337 printf(" magic: %s\n", md->md_magic); 338 printf(" version: %u\n", (u_int)md->md_version); 339 printf(" flags: 0x%x\n", (u_int)md->md_flags); 340 printf(" ealgo: %s\n", g_eli_algo2str(md->md_ealgo)); 341 printf(" keylen: %u\n", (u_int)md->md_keylen); 342 if (md->md_flags & G_ELI_FLAG_AUTH) 343 printf(" aalgo: %s\n", g_eli_algo2str(md->md_aalgo)); 344 printf(" provsize: %ju\n", (uintmax_t)md->md_provsize); 345 printf("sectorsize: %u\n", (u_int)md->md_sectorsize); 346 printf(" keys: 0x%02x\n", (u_int)md->md_keys); 347 printf("iterations: %u\n", (u_int)md->md_iterations); 348 bzero(str, sizeof(str)); 349 for (i = 0; i < sizeof(md->md_salt); i++) { 350 str[i * 2] = hex[md->md_salt[i] >> 4]; 351 str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f]; 352 } 353 printf(" Salt: %s\n", str); 354 bzero(str, sizeof(str)); 355 for (i = 0; i < sizeof(md->md_mkeys); i++) { 356 str[i * 2] = hex[md->md_mkeys[i] >> 4]; 357 str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f]; 358 } 359 printf("Master Key: %s\n", str); 360 bzero(str, sizeof(str)); 361 for (i = 0; i < 16; i++) { 362 str[i * 2] = hex[md->md_hash[i] >> 4]; 363 str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f]; 364 } 365 printf(" MD5 hash: %s\n", str); 366 } 367 368 static __inline u_int 369 g_eli_keylen(u_int algo, u_int keylen) 370 { 371 372 switch (algo) { 373 case CRYPTO_NULL_CBC: 374 if (keylen == 0) 375 keylen = 64 * 8; 376 else { 377 if (keylen > 64 * 8) 378 keylen = 0; 379 } 380 return (keylen); 381 case CRYPTO_AES_CBC: 382 switch (keylen) { 383 case 0: 384 return (128); 385 case 128: 386 case 192: 387 case 256: 388 return (keylen); 389 default: 390 return (0); 391 } 392 case CRYPTO_BLF_CBC: 393 if (keylen == 0) 394 return (128); 395 if (keylen < 128 || keylen > 448) 396 return (0); 397 if ((keylen % 32) != 0) 398 return (0); 399 return (keylen); 400 case CRYPTO_3DES_CBC: 401 if (keylen == 0 || keylen == 192) 402 return (192); 403 return (0); 404 default: 405 return (0); 406 } 407 } 408 409 static __inline u_int 410 g_eli_hashlen(u_int algo) 411 { 412 413 switch (algo) { 414 case CRYPTO_MD5_HMAC: 415 return (16); 416 case CRYPTO_SHA1_HMAC: 417 return (20); 418 case CRYPTO_RIPEMD160_HMAC: 419 return (20); 420 case CRYPTO_SHA2_256_HMAC: 421 return (32); 422 case CRYPTO_SHA2_384_HMAC: 423 return (48); 424 case CRYPTO_SHA2_512_HMAC: 425 return (64); 426 } 427 return (0); 428 } 429 430 #ifdef _KERNEL 431 int g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 432 struct g_eli_metadata *md); 433 struct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp, 434 struct g_provider *bpp, const struct g_eli_metadata *md, 435 const u_char *mkey, int nkey); 436 int g_eli_destroy(struct g_eli_softc *sc, boolean_t force); 437 438 int g_eli_access(struct g_provider *pp, int dr, int dw, int de); 439 void g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb); 440 441 void g_eli_read_done(struct bio *bp); 442 void g_eli_write_done(struct bio *bp); 443 int g_eli_crypto_rerun(struct cryptop *crp); 444 void g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv, 445 size_t size); 446 447 void g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp); 448 449 void g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp); 450 void g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp); 451 #endif 452 453 void g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key); 454 int g_eli_mkey_decrypt(const struct g_eli_metadata *md, 455 const unsigned char *key, unsigned char *mkey, unsigned *nkeyp); 456 int g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen, 457 unsigned char *mkey); 458 #ifdef _KERNEL 459 void g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey); 460 #endif 461 462 int g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize, 463 const u_char *key, size_t keysize); 464 int g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize, 465 const u_char *key, size_t keysize); 466 467 struct hmac_ctx { 468 SHA512_CTX shactx; 469 u_char k_opad[128]; 470 }; 471 472 void g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey, 473 size_t hkeylen); 474 void g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data, 475 size_t datasize); 476 void g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize); 477 void g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize, 478 const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize); 479 #endif /* !_G_ELI_H_ */ 480