g_eli.h revision 148456
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 148456 2005-07-27 21:43:37Z 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> 44148456Spjd#endif 45148456Spjd#ifndef _OpenSSL_ 46148456Spjd#include <sys/md5.h> 47148456Spjd#endif 48148456Spjd 49148456Spjd#define G_ELI_CLASS_NAME "ELI" 50148456Spjd#define G_ELI_MAGIC "GEOM::ELI" 51148456Spjd#define G_ELI_SUFFIX ".eli" 52148456Spjd 53148456Spjd/* 54148456Spjd * Version history: 55148456Spjd * 0 - Initial version number. 56148456Spjd */ 57148456Spjd#define G_ELI_VERSION 0 58148456Spjd 59148456Spjd/* Use random, onetime keys. */ 60148456Spjd#define G_ELI_FLAG_ONETIME 0x00000001 61148456Spjd/* Ask for the passphrase from the kernel, before mounting root. */ 62148456Spjd#define G_ELI_FLAG_BOOT 0x00000002 63148456Spjd/* Detach on last close, if we were open for writing. */ 64148456Spjd#define G_ELI_FLAG_WO_DETACH 0x00000004 65148456Spjd/* Detach on last close. */ 66148456Spjd#define G_ELI_FLAG_RW_DETACH 0x00000008 67148456Spjd/* Provider was open for writing. */ 68148456Spjd#define G_ELI_FLAG_WOPEN 0x00010000 69148456Spjd/* Destroy device. */ 70148456Spjd#define G_ELI_FLAG_DESTROY 0x00020000 71148456Spjd 72148456Spjd#define SHA512_MDLEN 64 73148456Spjd 74148456Spjd#define G_ELI_MAXMKEYS 2 75148456Spjd#define G_ELI_MAXKEYLEN 64 76148456Spjd#define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN 77148456Spjd#define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN 78148456Spjd#define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN 79148456Spjd#define G_ELI_SALTLEN 64 80148456Spjd#define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN) 81148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */ 82148456Spjd#define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN) 83148456Spjd 84148456Spjd#ifdef _KERNEL 85148456Spjdextern u_int g_eli_debug; 86148456Spjdextern u_int g_eli_overwrites; 87148456Spjd 88148456Spjd#define G_ELI_CRYPTO_HW 1 89148456Spjd#define G_ELI_CRYPTO_SW 2 90148456Spjd 91148456Spjd#define G_ELI_DEBUG(lvl, ...) do { \ 92148456Spjd if (g_eli_debug >= (lvl)) { \ 93148456Spjd printf("GEOM_ELI"); \ 94148456Spjd if (g_eli_debug > 0) \ 95148456Spjd printf("[%u]", lvl); \ 96148456Spjd printf(": "); \ 97148456Spjd printf(__VA_ARGS__); \ 98148456Spjd printf("\n"); \ 99148456Spjd } \ 100148456Spjd} while (0) 101148456Spjd#define G_ELI_LOGREQ(lvl, bp, ...) do { \ 102148456Spjd if (g_eli_debug >= (lvl)) { \ 103148456Spjd printf("GEOM_ELI"); \ 104148456Spjd if (g_eli_debug > 0) \ 105148456Spjd printf("[%u]", lvl); \ 106148456Spjd printf(": "); \ 107148456Spjd printf(__VA_ARGS__); \ 108148456Spjd printf(" "); \ 109148456Spjd g_print_bio(bp); \ 110148456Spjd printf("\n"); \ 111148456Spjd } \ 112148456Spjd} while (0) 113148456Spjd 114148456Spjdstruct g_eli_worker { 115148456Spjd struct g_eli_softc *w_softc; 116148456Spjd struct proc *w_proc; 117148456Spjd u_int w_number; 118148456Spjd uint64_t w_sid; 119148456Spjd LIST_ENTRY(g_eli_worker) w_next; 120148456Spjd}; 121148456Spjd 122148456Spjdstruct g_eli_softc { 123148456Spjd struct g_geom *sc_geom; 124148456Spjd u_int sc_crypto; 125148456Spjd uint8_t sc_datakey[G_ELI_DATAKEYLEN]; 126148456Spjd uint8_t sc_ivkey[G_ELI_IVKEYLEN]; 127148456Spjd SHA256_CTX sc_ivctx; 128148456Spjd u_int sc_algo; 129148456Spjd u_int sc_keylen; 130148456Spjd int sc_nkey; 131148456Spjd uint32_t sc_flags; 132148456Spjd 133148456Spjd /* Only for software cryptography. */ 134148456Spjd struct bio_queue_head sc_queue; 135148456Spjd struct mtx sc_queue_mtx; 136148456Spjd LIST_HEAD(, g_eli_worker) sc_workers; 137148456Spjd}; 138148456Spjd#define sc_name sc_geom->name 139148456Spjd#endif /* _KERNEL */ 140148456Spjd 141148456Spjdstruct g_eli_metadata { 142148456Spjd char md_magic[16]; /* Magic value. */ 143148456Spjd uint32_t md_version; /* Version number. */ 144148456Spjd uint32_t md_flags; /* Additional flags. */ 145148456Spjd uint16_t md_algo; /* Encryption algorithm. */ 146148456Spjd uint16_t md_keylen; /* Key length. */ 147148456Spjd uint64_t md_provsize; /* Provider's size. */ 148148456Spjd uint32_t md_sectorsize; /* Sector size. */ 149148456Spjd uint8_t md_keys; /* Available keys. */ 150148456Spjd int32_t md_iterations; /* Number of iterations for PKCS#5v2 */ 151148456Spjd uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */ 152148456Spjd /* Encrypted master key (IV-key, Data-key, HMAC). */ 153148456Spjd uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN]; 154148456Spjd u_char md_hash[16]; /* MD5 hash. */ 155148456Spjd}; 156148456Spjd#ifndef _OpenSSL_ 157148456Spjdstatic __inline void 158148456Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data) 159148456Spjd{ 160148456Spjd MD5_CTX ctx; 161148456Spjd u_char *p; 162148456Spjd 163148456Spjd p = data; 164148456Spjd bcopy(md->md_magic, p, sizeof(md->md_magic)); p += sizeof(md->md_magic); 165148456Spjd le32enc(p, md->md_version); p += sizeof(md->md_version); 166148456Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 167148456Spjd le16enc(p, md->md_algo); p += sizeof(md->md_algo); 168148456Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 169148456Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 170148456Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 171148456Spjd *p = md->md_keys; p += sizeof(md->md_keys); 172148456Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 173148456Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 174148456Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 175148456Spjd MD5Init(&ctx); 176148456Spjd MD5Update(&ctx, data, p - data); 177148456Spjd MD5Final(md->md_hash, &ctx); 178148456Spjd bcopy(md->md_hash, p, sizeof(md->md_hash)); 179148456Spjd} 180148456Spjdstatic __inline int 181148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md) 182148456Spjd{ 183148456Spjd MD5_CTX ctx; 184148456Spjd const u_char *p; 185148456Spjd 186148456Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 187148456Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 188148456Spjd md->md_algo = le16dec(p); p += sizeof(md->md_algo); 189148456Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 190148456Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 191148456Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 192148456Spjd md->md_keys = *p; p += sizeof(md->md_keys); 193148456Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 194148456Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 195148456Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 196148456Spjd MD5Init(&ctx); 197148456Spjd MD5Update(&ctx, data, p - data); 198148456Spjd MD5Final(md->md_hash, &ctx); 199148456Spjd if (bcmp(md->md_hash, p, 16) != 0) 200148456Spjd return (EINVAL); 201148456Spjd return (0); 202148456Spjd} 203148456Spjdstatic __inline int 204148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md) 205148456Spjd{ 206148456Spjd int error; 207148456Spjd 208148456Spjd bcopy(data, md->md_magic, sizeof(md->md_magic)); 209148456Spjd md->md_version = le32dec(data + sizeof(md->md_magic)); 210148456Spjd switch (md->md_version) { 211148456Spjd case 0: 212148456Spjd error = eli_metadata_decode_v0(data, md); 213148456Spjd break; 214148456Spjd default: 215148456Spjd error = EINVAL; 216148456Spjd break; 217148456Spjd } 218148456Spjd return (error); 219148456Spjd} 220148456Spjd#endif /* !_OpenSSL */ 221148456Spjd 222148456Spjdstatic __inline u_int 223148456Spjdg_eli_str2algo(const char *name) 224148456Spjd{ 225148456Spjd 226148456Spjd if (strcmp("null", name) == 0) 227148456Spjd return (CRYPTO_NULL_CBC); 228148456Spjd if (strcmp("aes", name) == 0) 229148456Spjd return (CRYPTO_AES_CBC); 230148456Spjd else if (strcmp("blowfish", name) == 0) 231148456Spjd return (CRYPTO_BLF_CBC); 232148456Spjd else if (strcmp("3des", name) == 0) 233148456Spjd return (CRYPTO_3DES_CBC); 234148456Spjd return (CRYPTO_ALGORITHM_MIN - 1); 235148456Spjd} 236148456Spjd 237148456Spjdstatic __inline const char * 238148456Spjdg_eli_algo2str(u_int algo) 239148456Spjd{ 240148456Spjd 241148456Spjd switch (algo) { 242148456Spjd case CRYPTO_NULL_CBC: 243148456Spjd return ("NULL"); 244148456Spjd case CRYPTO_AES_CBC: 245148456Spjd return ("AES"); 246148456Spjd case CRYPTO_BLF_CBC: 247148456Spjd return ("Blowfish"); 248148456Spjd case CRYPTO_3DES_CBC: 249148456Spjd return ("3DES"); 250148456Spjd } 251148456Spjd return ("unknown"); 252148456Spjd} 253148456Spjd 254148456Spjdstatic __inline void 255148456Spjdeli_metadata_dump(const struct g_eli_metadata *md) 256148456Spjd{ 257148456Spjd static const char hex[] = "0123456789abcdef"; 258148456Spjd char str[sizeof(md->md_mkeys) * 2 + 1]; 259148456Spjd u_int i; 260148456Spjd 261148456Spjd printf(" magic: %s\n", md->md_magic); 262148456Spjd printf(" version: %u\n", (u_int)md->md_version); 263148456Spjd printf(" flags: 0x%x\n", (u_int)md->md_flags); 264148456Spjd printf(" algo: %s\n", g_eli_algo2str(md->md_algo)); 265148456Spjd printf(" keylen: %u\n", (u_int)md->md_keylen); 266148456Spjd printf(" provsize: %ju\n", (uintmax_t)md->md_provsize); 267148456Spjd printf("sectorsize: %u\n", (u_int)md->md_sectorsize); 268148456Spjd printf(" keys: 0x%02x\n", (u_int)md->md_keys); 269148456Spjd printf("iterations: %u\n", (u_int)md->md_iterations); 270148456Spjd bzero(str, sizeof(str)); 271148456Spjd for (i = 0; i < sizeof(md->md_salt); i++) { 272148456Spjd str[i * 2] = hex[md->md_salt[i] >> 4]; 273148456Spjd str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f]; 274148456Spjd } 275148456Spjd printf(" Salt: %s\n", str); 276148456Spjd bzero(str, sizeof(str)); 277148456Spjd for (i = 0; i < sizeof(md->md_mkeys); i++) { 278148456Spjd str[i * 2] = hex[md->md_mkeys[i] >> 4]; 279148456Spjd str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f]; 280148456Spjd } 281148456Spjd printf("Master Key: %s\n", str); 282148456Spjd bzero(str, sizeof(str)); 283148456Spjd for (i = 0; i < 16; i++) { 284148456Spjd str[i * 2] = hex[md->md_hash[i] >> 4]; 285148456Spjd str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f]; 286148456Spjd } 287148456Spjd printf(" MD5 hash: %s\n", str); 288148456Spjd} 289148456Spjd 290148456Spjdstatic __inline u_int 291148456Spjdg_eli_keylen(u_int algo, u_int keylen) 292148456Spjd{ 293148456Spjd 294148456Spjd switch (algo) { 295148456Spjd case CRYPTO_NULL_CBC: 296148456Spjd if (keylen == 0) 297148456Spjd keylen = 64 * 8; 298148456Spjd else { 299148456Spjd if (keylen > 64 * 8) 300148456Spjd keylen = 0; 301148456Spjd } 302148456Spjd return (keylen); 303148456Spjd case CRYPTO_AES_CBC: 304148456Spjd switch (keylen) { 305148456Spjd case 0: 306148456Spjd return (128); 307148456Spjd case 128: 308148456Spjd case 192: 309148456Spjd case 256: 310148456Spjd return (keylen); 311148456Spjd default: 312148456Spjd return (0); 313148456Spjd } 314148456Spjd case CRYPTO_BLF_CBC: 315148456Spjd if (keylen == 0) 316148456Spjd return (128); 317148456Spjd if (keylen < 128 || keylen > 448) 318148456Spjd return (0); 319148456Spjd if ((keylen % 32) != 0) 320148456Spjd return (0); 321148456Spjd return (keylen); 322148456Spjd case CRYPTO_3DES_CBC: 323148456Spjd if (keylen == 0 || keylen == 192) 324148456Spjd return (192); 325148456Spjd return (0); 326148456Spjd default: 327148456Spjd return (0); 328148456Spjd } 329148456Spjd} 330148456Spjd 331148456Spjd#ifdef _KERNEL 332148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 333148456Spjd struct g_eli_metadata *md); 334148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp, 335148456Spjd struct g_provider *bpp, const struct g_eli_metadata *md, 336148456Spjd const u_char *mkey, int nkey); 337148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force); 338148456Spjd 339148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de); 340148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb); 341148456Spjd#endif 342148456Spjd 343148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key); 344148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md, 345148456Spjd const unsigned char *key, unsigned char *mkey, unsigned *nkeyp); 346148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen, 347148456Spjd unsigned char *mkey); 348148456Spjd 349148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize, 350148456Spjd const u_char *key, size_t keysize); 351148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize, 352148456Spjd const u_char *key, size_t keysize); 353148456Spjd 354148456Spjdstruct hmac_ctx { 355148456Spjd SHA512_CTX shactx; 356148456Spjd u_char k_opad[128]; 357148456Spjd}; 358148456Spjd 359148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey, 360148456Spjd size_t hkeylen); 361148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data, 362148456Spjd size_t datasize); 363148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize); 364148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize, 365148456Spjd const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize); 366148456Spjd#endif /* !_G_ELI_H_ */ 367