g_eli.h revision 149323
1148456Spjd/*- 2148456Spjd * Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org> 3148456Spjd * All rights reserved. 4148456Spjd * 5148456Spjd * Redistribution and use in source and binary forms, with or without 6148456Spjd * modification, are permitted provided that the following conditions 7148456Spjd * are met: 8148456Spjd * 1. Redistributions of source code must retain the above copyright 9148456Spjd * notice, this list of conditions and the following disclaimer. 10148456Spjd * 2. Redistributions in binary form must reproduce the above copyright 11148456Spjd * notice, this list of conditions and the following disclaimer in the 12148456Spjd * documentation and/or other materials provided with the distribution. 13148456Spjd * 14148456Spjd * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 15148456Spjd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16148456Spjd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17148456Spjd * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 18148456Spjd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19148456Spjd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20148456Spjd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21148456Spjd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22148456Spjd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23148456Spjd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24148456Spjd * SUCH DAMAGE. 25148456Spjd * 26148456Spjd * $FreeBSD: head/sys/geom/eli/g_eli.h 149323 2005-08-20 10:43:03Z pjd $ 27148456Spjd */ 28148456Spjd 29148456Spjd#ifndef _G_ELI_H_ 30148456Spjd#define _G_ELI_H_ 31148456Spjd 32148456Spjd#include <sys/endian.h> 33148456Spjd#include <sys/errno.h> 34148456Spjd#include <sys/malloc.h> 35148456Spjd#include <crypto/sha2/sha2.h> 36148456Spjd#include <opencrypto/cryptodev.h> 37148456Spjd#ifdef _KERNEL 38148456Spjd#include <sys/bio.h> 39148456Spjd#include <sys/libkern.h> 40148456Spjd#include <geom/geom.h> 41148456Spjd#else 42148456Spjd#include <stdio.h> 43148456Spjd#include <string.h> 44148867Spjd#include <strings.h> 45148456Spjd#endif 46148456Spjd#ifndef _OpenSSL_ 47148456Spjd#include <sys/md5.h> 48148456Spjd#endif 49148456Spjd 50148456Spjd#define G_ELI_CLASS_NAME "ELI" 51148456Spjd#define G_ELI_MAGIC "GEOM::ELI" 52148456Spjd#define G_ELI_SUFFIX ".eli" 53148456Spjd 54148456Spjd/* 55148456Spjd * Version history: 56148456Spjd * 0 - Initial version number. 57148456Spjd */ 58148456Spjd#define G_ELI_VERSION 0 59148456Spjd 60148456Spjd/* Use random, onetime keys. */ 61148456Spjd#define G_ELI_FLAG_ONETIME 0x00000001 62148456Spjd/* Ask for the passphrase from the kernel, before mounting root. */ 63148456Spjd#define G_ELI_FLAG_BOOT 0x00000002 64148456Spjd/* Detach on last close, if we were open for writing. */ 65148456Spjd#define G_ELI_FLAG_WO_DETACH 0x00000004 66148456Spjd/* Detach on last close. */ 67148456Spjd#define G_ELI_FLAG_RW_DETACH 0x00000008 68148456Spjd/* Provider was open for writing. */ 69148456Spjd#define G_ELI_FLAG_WOPEN 0x00010000 70148456Spjd/* Destroy device. */ 71148456Spjd#define G_ELI_FLAG_DESTROY 0x00020000 72148456Spjd 73148456Spjd#define SHA512_MDLEN 64 74148456Spjd 75148456Spjd#define G_ELI_MAXMKEYS 2 76148456Spjd#define G_ELI_MAXKEYLEN 64 77148456Spjd#define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN 78148456Spjd#define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN 79148456Spjd#define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN 80148456Spjd#define G_ELI_SALTLEN 64 81148456Spjd#define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN) 82148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */ 83148456Spjd#define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN) 84148456Spjd 85148456Spjd#ifdef _KERNEL 86148456Spjdextern u_int g_eli_debug; 87148456Spjdextern u_int g_eli_overwrites; 88148456Spjd 89148456Spjd#define G_ELI_CRYPTO_HW 1 90148456Spjd#define G_ELI_CRYPTO_SW 2 91148456Spjd 92148456Spjd#define G_ELI_DEBUG(lvl, ...) do { \ 93148456Spjd if (g_eli_debug >= (lvl)) { \ 94148456Spjd printf("GEOM_ELI"); \ 95148456Spjd if (g_eli_debug > 0) \ 96148456Spjd printf("[%u]", lvl); \ 97148456Spjd printf(": "); \ 98148456Spjd printf(__VA_ARGS__); \ 99148456Spjd printf("\n"); \ 100148456Spjd } \ 101148456Spjd} while (0) 102148456Spjd#define G_ELI_LOGREQ(lvl, bp, ...) do { \ 103148456Spjd if (g_eli_debug >= (lvl)) { \ 104148456Spjd printf("GEOM_ELI"); \ 105148456Spjd if (g_eli_debug > 0) \ 106148456Spjd printf("[%u]", lvl); \ 107148456Spjd printf(": "); \ 108148456Spjd printf(__VA_ARGS__); \ 109148456Spjd printf(" "); \ 110148456Spjd g_print_bio(bp); \ 111148456Spjd printf("\n"); \ 112148456Spjd } \ 113148456Spjd} while (0) 114148456Spjd 115148456Spjdstruct g_eli_worker { 116148456Spjd struct g_eli_softc *w_softc; 117148456Spjd struct proc *w_proc; 118148456Spjd u_int w_number; 119148456Spjd uint64_t w_sid; 120148456Spjd LIST_ENTRY(g_eli_worker) w_next; 121148456Spjd}; 122148456Spjd 123148456Spjdstruct g_eli_softc { 124148456Spjd struct g_geom *sc_geom; 125148456Spjd u_int sc_crypto; 126148456Spjd uint8_t sc_datakey[G_ELI_DATAKEYLEN]; 127148456Spjd uint8_t sc_ivkey[G_ELI_IVKEYLEN]; 128148456Spjd SHA256_CTX sc_ivctx; 129148456Spjd u_int sc_algo; 130148456Spjd u_int sc_keylen; 131148456Spjd int sc_nkey; 132148456Spjd uint32_t sc_flags; 133148456Spjd 134148456Spjd /* Only for software cryptography. */ 135148456Spjd struct bio_queue_head sc_queue; 136148456Spjd struct mtx sc_queue_mtx; 137148456Spjd LIST_HEAD(, g_eli_worker) sc_workers; 138148456Spjd}; 139148456Spjd#define sc_name sc_geom->name 140148456Spjd#endif /* _KERNEL */ 141148456Spjd 142148456Spjdstruct g_eli_metadata { 143148456Spjd char md_magic[16]; /* Magic value. */ 144148456Spjd uint32_t md_version; /* Version number. */ 145148456Spjd uint32_t md_flags; /* Additional flags. */ 146148456Spjd uint16_t md_algo; /* Encryption algorithm. */ 147148456Spjd uint16_t md_keylen; /* Key length. */ 148148456Spjd uint64_t md_provsize; /* Provider's size. */ 149148456Spjd uint32_t md_sectorsize; /* Sector size. */ 150148456Spjd uint8_t md_keys; /* Available keys. */ 151149303Spjd int32_t md_iterations; /* Number of iterations for PKCS#5v2. */ 152148456Spjd uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */ 153148456Spjd /* Encrypted master key (IV-key, Data-key, HMAC). */ 154148456Spjd uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN]; 155148456Spjd u_char md_hash[16]; /* MD5 hash. */ 156149323Spjd} __packed; 157148456Spjd#ifndef _OpenSSL_ 158148456Spjdstatic __inline void 159148456Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data) 160148456Spjd{ 161148456Spjd MD5_CTX ctx; 162148456Spjd u_char *p; 163148456Spjd 164148456Spjd p = data; 165148456Spjd bcopy(md->md_magic, p, sizeof(md->md_magic)); p += sizeof(md->md_magic); 166148456Spjd le32enc(p, md->md_version); p += sizeof(md->md_version); 167148456Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 168148456Spjd le16enc(p, md->md_algo); p += sizeof(md->md_algo); 169148456Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 170148456Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 171148456Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 172148456Spjd *p = md->md_keys; p += sizeof(md->md_keys); 173148456Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 174148456Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 175148456Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 176148456Spjd MD5Init(&ctx); 177148456Spjd MD5Update(&ctx, data, p - data); 178148456Spjd MD5Final(md->md_hash, &ctx); 179148456Spjd bcopy(md->md_hash, p, sizeof(md->md_hash)); 180148456Spjd} 181148456Spjdstatic __inline int 182148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md) 183148456Spjd{ 184148456Spjd MD5_CTX ctx; 185148456Spjd const u_char *p; 186148456Spjd 187148456Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 188148456Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 189148456Spjd md->md_algo = le16dec(p); p += sizeof(md->md_algo); 190148456Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 191148456Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 192148456Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 193148456Spjd md->md_keys = *p; p += sizeof(md->md_keys); 194148456Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 195148456Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 196148456Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 197148456Spjd MD5Init(&ctx); 198148456Spjd MD5Update(&ctx, data, p - data); 199148456Spjd MD5Final(md->md_hash, &ctx); 200148456Spjd if (bcmp(md->md_hash, p, 16) != 0) 201148456Spjd return (EINVAL); 202148456Spjd return (0); 203148456Spjd} 204148456Spjdstatic __inline int 205148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md) 206148456Spjd{ 207148456Spjd int error; 208148456Spjd 209148456Spjd bcopy(data, md->md_magic, sizeof(md->md_magic)); 210148456Spjd md->md_version = le32dec(data + sizeof(md->md_magic)); 211148456Spjd switch (md->md_version) { 212148456Spjd case 0: 213148456Spjd error = eli_metadata_decode_v0(data, md); 214148456Spjd break; 215148456Spjd default: 216148456Spjd error = EINVAL; 217148456Spjd break; 218148456Spjd } 219148456Spjd return (error); 220148456Spjd} 221148456Spjd#endif /* !_OpenSSL */ 222148456Spjd 223148456Spjdstatic __inline u_int 224148456Spjdg_eli_str2algo(const char *name) 225148456Spjd{ 226148456Spjd 227148867Spjd if (strcasecmp("null", name) == 0) 228148456Spjd return (CRYPTO_NULL_CBC); 229148867Spjd else if (strcasecmp("aes", name) == 0) 230148456Spjd return (CRYPTO_AES_CBC); 231148867Spjd else if (strcasecmp("blowfish", name) == 0) 232148456Spjd return (CRYPTO_BLF_CBC); 233148867Spjd else if (strcasecmp("3des", name) == 0) 234148456Spjd return (CRYPTO_3DES_CBC); 235148456Spjd return (CRYPTO_ALGORITHM_MIN - 1); 236148456Spjd} 237148456Spjd 238148456Spjdstatic __inline const char * 239148456Spjdg_eli_algo2str(u_int algo) 240148456Spjd{ 241148456Spjd 242148456Spjd switch (algo) { 243148456Spjd case CRYPTO_NULL_CBC: 244148456Spjd return ("NULL"); 245148456Spjd case CRYPTO_AES_CBC: 246148456Spjd return ("AES"); 247148456Spjd case CRYPTO_BLF_CBC: 248148456Spjd return ("Blowfish"); 249148456Spjd case CRYPTO_3DES_CBC: 250148456Spjd return ("3DES"); 251148456Spjd } 252148456Spjd return ("unknown"); 253148456Spjd} 254148456Spjd 255148456Spjdstatic __inline void 256148456Spjdeli_metadata_dump(const struct g_eli_metadata *md) 257148456Spjd{ 258148456Spjd static const char hex[] = "0123456789abcdef"; 259148456Spjd char str[sizeof(md->md_mkeys) * 2 + 1]; 260148456Spjd u_int i; 261148456Spjd 262148456Spjd printf(" magic: %s\n", md->md_magic); 263148456Spjd printf(" version: %u\n", (u_int)md->md_version); 264148456Spjd printf(" flags: 0x%x\n", (u_int)md->md_flags); 265148456Spjd printf(" algo: %s\n", g_eli_algo2str(md->md_algo)); 266148456Spjd printf(" keylen: %u\n", (u_int)md->md_keylen); 267148456Spjd printf(" provsize: %ju\n", (uintmax_t)md->md_provsize); 268148456Spjd printf("sectorsize: %u\n", (u_int)md->md_sectorsize); 269148456Spjd printf(" keys: 0x%02x\n", (u_int)md->md_keys); 270148456Spjd printf("iterations: %u\n", (u_int)md->md_iterations); 271148456Spjd bzero(str, sizeof(str)); 272148456Spjd for (i = 0; i < sizeof(md->md_salt); i++) { 273148456Spjd str[i * 2] = hex[md->md_salt[i] >> 4]; 274148456Spjd str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f]; 275148456Spjd } 276149303Spjd printf(" Salt: %s\n", str); 277148456Spjd bzero(str, sizeof(str)); 278148456Spjd for (i = 0; i < sizeof(md->md_mkeys); i++) { 279148456Spjd str[i * 2] = hex[md->md_mkeys[i] >> 4]; 280148456Spjd str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f]; 281148456Spjd } 282148456Spjd printf("Master Key: %s\n", str); 283148456Spjd bzero(str, sizeof(str)); 284148456Spjd for (i = 0; i < 16; i++) { 285148456Spjd str[i * 2] = hex[md->md_hash[i] >> 4]; 286148456Spjd str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f]; 287148456Spjd } 288149303Spjd printf(" MD5 hash: %s\n", str); 289148456Spjd} 290148456Spjd 291148456Spjdstatic __inline u_int 292148456Spjdg_eli_keylen(u_int algo, u_int keylen) 293148456Spjd{ 294148456Spjd 295148456Spjd switch (algo) { 296148456Spjd case CRYPTO_NULL_CBC: 297148456Spjd if (keylen == 0) 298148456Spjd keylen = 64 * 8; 299148456Spjd else { 300148456Spjd if (keylen > 64 * 8) 301148456Spjd keylen = 0; 302148456Spjd } 303148456Spjd return (keylen); 304148456Spjd case CRYPTO_AES_CBC: 305148456Spjd switch (keylen) { 306148456Spjd case 0: 307148456Spjd return (128); 308148456Spjd case 128: 309148456Spjd case 192: 310148456Spjd case 256: 311148456Spjd return (keylen); 312148456Spjd default: 313148456Spjd return (0); 314148456Spjd } 315148456Spjd case CRYPTO_BLF_CBC: 316148456Spjd if (keylen == 0) 317148456Spjd return (128); 318148456Spjd if (keylen < 128 || keylen > 448) 319148456Spjd return (0); 320148456Spjd if ((keylen % 32) != 0) 321148456Spjd return (0); 322148456Spjd return (keylen); 323148456Spjd case CRYPTO_3DES_CBC: 324148456Spjd if (keylen == 0 || keylen == 192) 325148456Spjd return (192); 326148456Spjd return (0); 327148456Spjd default: 328148456Spjd return (0); 329148456Spjd } 330148456Spjd} 331148456Spjd 332148456Spjd#ifdef _KERNEL 333148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 334148456Spjd struct g_eli_metadata *md); 335148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp, 336148456Spjd struct g_provider *bpp, const struct g_eli_metadata *md, 337148456Spjd const u_char *mkey, int nkey); 338148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force); 339148456Spjd 340148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de); 341148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb); 342148456Spjd#endif 343148456Spjd 344148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key); 345148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md, 346148456Spjd const unsigned char *key, unsigned char *mkey, unsigned *nkeyp); 347148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen, 348148456Spjd unsigned char *mkey); 349148456Spjd 350148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize, 351148456Spjd const u_char *key, size_t keysize); 352148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize, 353148456Spjd const u_char *key, size_t keysize); 354148456Spjd 355148456Spjdstruct hmac_ctx { 356148456Spjd SHA512_CTX shactx; 357148456Spjd u_char k_opad[128]; 358148456Spjd}; 359148456Spjd 360148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey, 361148456Spjd size_t hkeylen); 362148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data, 363148456Spjd size_t datasize); 364148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize); 365148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize, 366148456Spjd const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize); 367148456Spjd#endif /* !_G_ELI_H_ */ 368