g_eli.h revision 293306
1148456Spjd/*- 2220922Spjd * Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net> 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. 13155174Spjd * 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 293306 2016-01-07 05:47:34Z allanjude $ 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> 35292782Sallanjude#include <crypto/sha2/sha256.h> 36292782Sallanjude#include <crypto/sha2/sha512.h> 37148456Spjd#include <opencrypto/cryptodev.h> 38148456Spjd#ifdef _KERNEL 39148456Spjd#include <sys/bio.h> 40148456Spjd#include <sys/libkern.h> 41220922Spjd#include <sys/lock.h> 42220922Spjd#include <sys/mutex.h> 43148456Spjd#include <geom/geom.h> 44148456Spjd#else 45226733Spjd#include <assert.h> 46148456Spjd#include <stdio.h> 47148456Spjd#include <string.h> 48148867Spjd#include <strings.h> 49148456Spjd#endif 50293306Sallanjude#include <sys/queue.h> 51293306Sallanjude#include <sys/tree.h> 52148456Spjd#ifndef _OpenSSL_ 53148456Spjd#include <sys/md5.h> 54148456Spjd#endif 55148456Spjd 56148456Spjd#define G_ELI_CLASS_NAME "ELI" 57148456Spjd#define G_ELI_MAGIC "GEOM::ELI" 58148456Spjd#define G_ELI_SUFFIX ".eli" 59148456Spjd 60148456Spjd/* 61148456Spjd * Version history: 62148456Spjd * 0 - Initial version number. 63159307Spjd * 1 - Added data authentication support (md_aalgo field and 64159307Spjd * G_ELI_FLAG_AUTH flag). 65161217Spjd * 2 - Added G_ELI_FLAG_READONLY. 66211927Spjd * 3 - Added 'configure' subcommand. 67211927Spjd * 4 - IV is generated from offset converted to little-endian 68221628Spjd * (the G_ELI_FLAG_NATIVE_BYTE_ORDER flag will be set for older versions). 69213070Spjd * 5 - Added multiple encrypton keys and AES-XTS support. 70221628Spjd * 6 - Fixed usage of multiple keys for authenticated providers (the 71221628Spjd * G_ELI_FLAG_FIRST_KEY flag will be set for older versions). 72238116Spjd * 7 - Encryption keys are now generated from the Data Key and not from the 73238116Spjd * IV Key (the G_ELI_FLAG_ENC_IVKEY flag will be set for older versions). 74148456Spjd */ 75221628Spjd#define G_ELI_VERSION_00 0 76221628Spjd#define G_ELI_VERSION_01 1 77221628Spjd#define G_ELI_VERSION_02 2 78221628Spjd#define G_ELI_VERSION_03 3 79221628Spjd#define G_ELI_VERSION_04 4 80221628Spjd#define G_ELI_VERSION_05 5 81221628Spjd#define G_ELI_VERSION_06 6 82238116Spjd#define G_ELI_VERSION_07 7 83238116Spjd#define G_ELI_VERSION G_ELI_VERSION_07 84148456Spjd 85161127Spjd/* ON DISK FLAGS. */ 86148456Spjd/* Use random, onetime keys. */ 87161220Spjd#define G_ELI_FLAG_ONETIME 0x00000001 88148456Spjd/* Ask for the passphrase from the kernel, before mounting root. */ 89161220Spjd#define G_ELI_FLAG_BOOT 0x00000002 90148456Spjd/* Detach on last close, if we were open for writing. */ 91161220Spjd#define G_ELI_FLAG_WO_DETACH 0x00000004 92148456Spjd/* Detach on last close. */ 93161220Spjd#define G_ELI_FLAG_RW_DETACH 0x00000008 94159307Spjd/* Provide data authentication. */ 95161220Spjd#define G_ELI_FLAG_AUTH 0x00000010 96161127Spjd/* Provider is read-only, we should deny all write attempts. */ 97161220Spjd#define G_ELI_FLAG_RO 0x00000020 98286444Spjd/* Don't pass through BIO_DELETE requests. */ 99286444Spjd#define G_ELI_FLAG_NODELETE 0x00000040 100161127Spjd/* RUNTIME FLAGS. */ 101148456Spjd/* Provider was open for writing. */ 102161220Spjd#define G_ELI_FLAG_WOPEN 0x00010000 103148456Spjd/* Destroy device. */ 104161220Spjd#define G_ELI_FLAG_DESTROY 0x00020000 105161220Spjd/* Provider uses native byte-order for IV generation. */ 106161220Spjd#define G_ELI_FLAG_NATIVE_BYTE_ORDER 0x00040000 107213067Spjd/* Provider uses single encryption key. */ 108213067Spjd#define G_ELI_FLAG_SINGLE_KEY 0x00080000 109214118Spjd/* Device suspended. */ 110214118Spjd#define G_ELI_FLAG_SUSPEND 0x00100000 111221628Spjd/* Provider uses first encryption key. */ 112221628Spjd#define G_ELI_FLAG_FIRST_KEY 0x00200000 113238116Spjd/* Provider uses IV-Key for encryption key generation. */ 114238116Spjd#define G_ELI_FLAG_ENC_IVKEY 0x00400000 115148456Spjd 116214118Spjd#define G_ELI_NEW_BIO 255 117214118Spjd 118148456Spjd#define SHA512_MDLEN 64 119159307Spjd#define G_ELI_AUTH_SECKEYLEN SHA256_DIGEST_LENGTH 120148456Spjd 121148456Spjd#define G_ELI_MAXMKEYS 2 122148456Spjd#define G_ELI_MAXKEYLEN 64 123148456Spjd#define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN 124148456Spjd#define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN 125159307Spjd#define G_ELI_AUTHKEYLEN G_ELI_MAXKEYLEN 126148456Spjd#define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN 127148456Spjd#define G_ELI_SALTLEN 64 128148456Spjd#define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN) 129148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */ 130148456Spjd#define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN) 131213062Spjd#define G_ELI_OVERWRITES 5 132213067Spjd/* Switch data encryption key every 2^20 blocks. */ 133213067Spjd#define G_ELI_KEY_SHIFT 20 134148456Spjd 135293306Sallanjude#define G_ELI_CRYPTO_UNKNOWN 0 136293306Sallanjude#define G_ELI_CRYPTO_HW 1 137293306Sallanjude#define G_ELI_CRYPTO_SW 2 138293306Sallanjude 139148456Spjd#ifdef _KERNEL 140213165Spjdextern int g_eli_debug; 141148456Spjdextern u_int g_eli_overwrites; 142159307Spjdextern u_int g_eli_batch; 143148456Spjd 144148456Spjd#define G_ELI_DEBUG(lvl, ...) do { \ 145148456Spjd if (g_eli_debug >= (lvl)) { \ 146148456Spjd printf("GEOM_ELI"); \ 147148456Spjd if (g_eli_debug > 0) \ 148148456Spjd printf("[%u]", lvl); \ 149148456Spjd printf(": "); \ 150148456Spjd printf(__VA_ARGS__); \ 151148456Spjd printf("\n"); \ 152148456Spjd } \ 153148456Spjd} while (0) 154148456Spjd#define G_ELI_LOGREQ(lvl, bp, ...) do { \ 155148456Spjd if (g_eli_debug >= (lvl)) { \ 156148456Spjd printf("GEOM_ELI"); \ 157148456Spjd if (g_eli_debug > 0) \ 158148456Spjd printf("[%u]", lvl); \ 159148456Spjd printf(": "); \ 160148456Spjd printf(__VA_ARGS__); \ 161148456Spjd printf(" "); \ 162148456Spjd g_print_bio(bp); \ 163148456Spjd printf("\n"); \ 164148456Spjd } \ 165148456Spjd} while (0) 166148456Spjd 167148456Spjdstruct g_eli_worker { 168148456Spjd struct g_eli_softc *w_softc; 169148456Spjd struct proc *w_proc; 170148456Spjd u_int w_number; 171148456Spjd uint64_t w_sid; 172214118Spjd boolean_t w_active; 173148456Spjd LIST_ENTRY(g_eli_worker) w_next; 174148456Spjd}; 175148456Spjd 176293306Sallanjude#endif /* _KERNEL */ 177293306Sallanjude 178148456Spjdstruct g_eli_softc { 179220922Spjd struct g_geom *sc_geom; 180226733Spjd u_int sc_version; 181220922Spjd u_int sc_crypto; 182220922Spjd uint8_t sc_mkey[G_ELI_DATAIVKEYLEN]; 183220922Spjd uint8_t sc_ekey[G_ELI_DATAKEYLEN]; 184220922Spjd TAILQ_HEAD(, g_eli_key) sc_ekeys_queue; 185220922Spjd RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree; 186220922Spjd struct mtx sc_ekeys_lock; 187220922Spjd uint64_t sc_ekeys_total; 188220922Spjd uint64_t sc_ekeys_allocated; 189220922Spjd u_int sc_ealgo; 190220922Spjd u_int sc_ekeylen; 191220922Spjd uint8_t sc_akey[G_ELI_AUTHKEYLEN]; 192220922Spjd u_int sc_aalgo; 193220922Spjd u_int sc_akeylen; 194220922Spjd u_int sc_alen; 195220922Spjd SHA256_CTX sc_akeyctx; 196220922Spjd uint8_t sc_ivkey[G_ELI_IVKEYLEN]; 197220922Spjd SHA256_CTX sc_ivctx; 198220922Spjd int sc_nkey; 199220922Spjd uint32_t sc_flags; 200220922Spjd int sc_inflight; 201220922Spjd off_t sc_mediasize; 202220922Spjd size_t sc_sectorsize; 203220922Spjd u_int sc_bytes_per_sector; 204220922Spjd u_int sc_data_per_sector; 205293306Sallanjude#ifndef _KERNEL 206293306Sallanjude int sc_cpubind; 207293306Sallanjude#else /* _KERNEL */ 208226840Spjd boolean_t sc_cpubind; 209148456Spjd 210148456Spjd /* Only for software cryptography. */ 211148456Spjd struct bio_queue_head sc_queue; 212220922Spjd struct mtx sc_queue_mtx; 213148456Spjd LIST_HEAD(, g_eli_worker) sc_workers; 214293306Sallanjude#endif /* _KERNEL */ 215148456Spjd}; 216148456Spjd#define sc_name sc_geom->name 217148456Spjd 218293306Sallanjude#define G_ELI_KEY_MAGIC 0xe11341c 219293306Sallanjude 220293306Sallanjudestruct g_eli_key { 221293306Sallanjude /* Key value, must be first in the structure. */ 222293306Sallanjude uint8_t gek_key[G_ELI_DATAKEYLEN]; 223293306Sallanjude /* Magic. */ 224293306Sallanjude int gek_magic; 225293306Sallanjude /* Key number. */ 226293306Sallanjude uint64_t gek_keyno; 227293306Sallanjude /* Reference counter. */ 228293306Sallanjude int gek_count; 229293306Sallanjude /* Keeps keys sorted by most recent use. */ 230293306Sallanjude TAILQ_ENTRY(g_eli_key) gek_next; 231293306Sallanjude /* Keeps keys sorted by number. */ 232293306Sallanjude RB_ENTRY(g_eli_key) gek_link; 233293306Sallanjude}; 234293306Sallanjude 235148456Spjdstruct g_eli_metadata { 236148456Spjd char md_magic[16]; /* Magic value. */ 237148456Spjd uint32_t md_version; /* Version number. */ 238148456Spjd uint32_t md_flags; /* Additional flags. */ 239159307Spjd uint16_t md_ealgo; /* Encryption algorithm. */ 240148456Spjd uint16_t md_keylen; /* Key length. */ 241159307Spjd uint16_t md_aalgo; /* Authentication algorithm. */ 242148456Spjd uint64_t md_provsize; /* Provider's size. */ 243148456Spjd uint32_t md_sectorsize; /* Sector size. */ 244148456Spjd uint8_t md_keys; /* Available keys. */ 245149303Spjd int32_t md_iterations; /* Number of iterations for PKCS#5v2. */ 246148456Spjd uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */ 247148456Spjd /* Encrypted master key (IV-key, Data-key, HMAC). */ 248148456Spjd uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN]; 249148456Spjd u_char md_hash[16]; /* MD5 hash. */ 250149323Spjd} __packed; 251148456Spjd#ifndef _OpenSSL_ 252148456Spjdstatic __inline void 253226733Spjdeli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap) 254148456Spjd{ 255148456Spjd u_char *p; 256148456Spjd 257226733Spjd p = *datap; 258148456Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 259159307Spjd le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 260148456Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 261226733Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 262226733Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 263226733Spjd *p = md->md_keys; p += sizeof(md->md_keys); 264226733Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 265226733Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 266226733Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 267226733Spjd *datap = p; 268226733Spjd} 269226733Spjdstatic __inline void 270238116Spjdeli_metadata_encode_v1v2v3v4v5v6v7(struct g_eli_metadata *md, u_char **datap) 271226733Spjd{ 272226733Spjd u_char *p; 273226733Spjd 274226733Spjd p = *datap; 275226733Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 276226733Spjd le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 277226733Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 278159307Spjd le16enc(p, md->md_aalgo); p += sizeof(md->md_aalgo); 279148456Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 280148456Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 281148456Spjd *p = md->md_keys; p += sizeof(md->md_keys); 282148456Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 283148456Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 284148456Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 285226733Spjd *datap = p; 286226733Spjd} 287226733Spjdstatic __inline void 288226733Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data) 289226733Spjd{ 290226733Spjd MD5_CTX ctx; 291226733Spjd u_char *p; 292226733Spjd 293226733Spjd p = data; 294226733Spjd bcopy(md->md_magic, p, sizeof(md->md_magic)); 295226733Spjd p += sizeof(md->md_magic); 296226733Spjd le32enc(p, md->md_version); 297226733Spjd p += sizeof(md->md_version); 298226733Spjd switch (md->md_version) { 299226733Spjd case G_ELI_VERSION_00: 300226733Spjd eli_metadata_encode_v0(md, &p); 301226733Spjd break; 302226733Spjd case G_ELI_VERSION_01: 303226733Spjd case G_ELI_VERSION_02: 304226733Spjd case G_ELI_VERSION_03: 305226733Spjd case G_ELI_VERSION_04: 306226733Spjd case G_ELI_VERSION_05: 307226733Spjd case G_ELI_VERSION_06: 308238116Spjd case G_ELI_VERSION_07: 309238116Spjd eli_metadata_encode_v1v2v3v4v5v6v7(md, &p); 310226733Spjd break; 311226733Spjd default: 312226733Spjd#ifdef _KERNEL 313226733Spjd panic("%s: Unsupported version %u.", __func__, 314226733Spjd (u_int)md->md_version); 315226733Spjd#else 316226733Spjd assert(!"Unsupported metadata version."); 317226733Spjd#endif 318226733Spjd } 319148456Spjd MD5Init(&ctx); 320148456Spjd MD5Update(&ctx, data, p - data); 321157305Spjd MD5Final(md->md_hash, &ctx); 322148456Spjd bcopy(md->md_hash, p, sizeof(md->md_hash)); 323148456Spjd} 324148456Spjdstatic __inline int 325148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md) 326148456Spjd{ 327148456Spjd MD5_CTX ctx; 328148456Spjd const u_char *p; 329148456Spjd 330148456Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 331148456Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 332159307Spjd md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 333148456Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 334148456Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 335148456Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 336148456Spjd md->md_keys = *p; p += sizeof(md->md_keys); 337148456Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 338148456Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 339148456Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 340148456Spjd MD5Init(&ctx); 341148456Spjd MD5Update(&ctx, data, p - data); 342157305Spjd MD5Final(md->md_hash, &ctx); 343148456Spjd if (bcmp(md->md_hash, p, 16) != 0) 344148456Spjd return (EINVAL); 345148456Spjd return (0); 346148456Spjd} 347212845Sbrian 348148456Spjdstatic __inline int 349238116Spjdeli_metadata_decode_v1v2v3v4v5v6v7(const u_char *data, struct g_eli_metadata *md) 350159307Spjd{ 351159307Spjd MD5_CTX ctx; 352159307Spjd const u_char *p; 353159307Spjd 354159307Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 355159307Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 356159307Spjd md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 357159307Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 358159307Spjd md->md_aalgo = le16dec(p); p += sizeof(md->md_aalgo); 359159307Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 360159307Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 361159307Spjd md->md_keys = *p; p += sizeof(md->md_keys); 362159307Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 363159307Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 364159307Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 365159307Spjd MD5Init(&ctx); 366159307Spjd MD5Update(&ctx, data, p - data); 367159307Spjd MD5Final(md->md_hash, &ctx); 368159307Spjd if (bcmp(md->md_hash, p, 16) != 0) 369159307Spjd return (EINVAL); 370159307Spjd return (0); 371159307Spjd} 372159307Spjdstatic __inline int 373148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md) 374148456Spjd{ 375148456Spjd int error; 376148456Spjd 377148456Spjd bcopy(data, md->md_magic, sizeof(md->md_magic)); 378226730Spjd if (strcmp(md->md_magic, G_ELI_MAGIC) != 0) 379226730Spjd return (EINVAL); 380148456Spjd md->md_version = le32dec(data + sizeof(md->md_magic)); 381148456Spjd switch (md->md_version) { 382221629Spjd case G_ELI_VERSION_00: 383148456Spjd error = eli_metadata_decode_v0(data, md); 384148456Spjd break; 385221629Spjd case G_ELI_VERSION_01: 386221629Spjd case G_ELI_VERSION_02: 387221629Spjd case G_ELI_VERSION_03: 388221629Spjd case G_ELI_VERSION_04: 389221629Spjd case G_ELI_VERSION_05: 390221629Spjd case G_ELI_VERSION_06: 391238116Spjd case G_ELI_VERSION_07: 392238116Spjd error = eli_metadata_decode_v1v2v3v4v5v6v7(data, md); 393159307Spjd break; 394148456Spjd default: 395226721Spjd error = EOPNOTSUPP; 396148456Spjd break; 397148456Spjd } 398148456Spjd return (error); 399148456Spjd} 400148456Spjd#endif /* !_OpenSSL */ 401148456Spjd 402148456Spjdstatic __inline u_int 403159307Spjdg_eli_str2ealgo(const char *name) 404148456Spjd{ 405148456Spjd 406148867Spjd if (strcasecmp("null", name) == 0) 407148456Spjd return (CRYPTO_NULL_CBC); 408213070Spjd else if (strcasecmp("null-cbc", name) == 0) 409213070Spjd return (CRYPTO_NULL_CBC); 410148867Spjd else if (strcasecmp("aes", name) == 0) 411213070Spjd return (CRYPTO_AES_XTS); 412213070Spjd else if (strcasecmp("aes-cbc", name) == 0) 413148456Spjd return (CRYPTO_AES_CBC); 414213070Spjd else if (strcasecmp("aes-xts", name) == 0) 415213070Spjd return (CRYPTO_AES_XTS); 416148867Spjd else if (strcasecmp("blowfish", name) == 0) 417148456Spjd return (CRYPTO_BLF_CBC); 418213070Spjd else if (strcasecmp("blowfish-cbc", name) == 0) 419213070Spjd return (CRYPTO_BLF_CBC); 420172031Spjd else if (strcasecmp("camellia", name) == 0) 421172031Spjd return (CRYPTO_CAMELLIA_CBC); 422213070Spjd else if (strcasecmp("camellia-cbc", name) == 0) 423213070Spjd return (CRYPTO_CAMELLIA_CBC); 424148867Spjd else if (strcasecmp("3des", name) == 0) 425148456Spjd return (CRYPTO_3DES_CBC); 426213070Spjd else if (strcasecmp("3des-cbc", name) == 0) 427213070Spjd return (CRYPTO_3DES_CBC); 428148456Spjd return (CRYPTO_ALGORITHM_MIN - 1); 429148456Spjd} 430148456Spjd 431159307Spjdstatic __inline u_int 432159307Spjdg_eli_str2aalgo(const char *name) 433159307Spjd{ 434159307Spjd 435159307Spjd if (strcasecmp("hmac/md5", name) == 0) 436159307Spjd return (CRYPTO_MD5_HMAC); 437159307Spjd else if (strcasecmp("hmac/sha1", name) == 0) 438159307Spjd return (CRYPTO_SHA1_HMAC); 439159307Spjd else if (strcasecmp("hmac/ripemd160", name) == 0) 440159307Spjd return (CRYPTO_RIPEMD160_HMAC); 441159307Spjd else if (strcasecmp("hmac/sha256", name) == 0) 442159307Spjd return (CRYPTO_SHA2_256_HMAC); 443159307Spjd else if (strcasecmp("hmac/sha384", name) == 0) 444159307Spjd return (CRYPTO_SHA2_384_HMAC); 445159307Spjd else if (strcasecmp("hmac/sha512", name) == 0) 446159307Spjd return (CRYPTO_SHA2_512_HMAC); 447159307Spjd return (CRYPTO_ALGORITHM_MIN - 1); 448159307Spjd} 449159307Spjd 450148456Spjdstatic __inline const char * 451148456Spjdg_eli_algo2str(u_int algo) 452148456Spjd{ 453148456Spjd 454148456Spjd switch (algo) { 455148456Spjd case CRYPTO_NULL_CBC: 456148456Spjd return ("NULL"); 457148456Spjd case CRYPTO_AES_CBC: 458159307Spjd return ("AES-CBC"); 459213070Spjd case CRYPTO_AES_XTS: 460213070Spjd return ("AES-XTS"); 461148456Spjd case CRYPTO_BLF_CBC: 462159307Spjd return ("Blowfish-CBC"); 463172031Spjd case CRYPTO_CAMELLIA_CBC: 464172031Spjd return ("CAMELLIA-CBC"); 465148456Spjd case CRYPTO_3DES_CBC: 466159307Spjd return ("3DES-CBC"); 467159307Spjd case CRYPTO_MD5_HMAC: 468159307Spjd return ("HMAC/MD5"); 469159307Spjd case CRYPTO_SHA1_HMAC: 470159307Spjd return ("HMAC/SHA1"); 471159307Spjd case CRYPTO_RIPEMD160_HMAC: 472159307Spjd return ("HMAC/RIPEMD160"); 473159307Spjd case CRYPTO_SHA2_256_HMAC: 474159307Spjd return ("HMAC/SHA256"); 475159307Spjd case CRYPTO_SHA2_384_HMAC: 476159307Spjd return ("HMAC/SHA384"); 477159307Spjd case CRYPTO_SHA2_512_HMAC: 478159307Spjd return ("HMAC/SHA512"); 479148456Spjd } 480148456Spjd return ("unknown"); 481148456Spjd} 482148456Spjd 483148456Spjdstatic __inline void 484148456Spjdeli_metadata_dump(const struct g_eli_metadata *md) 485148456Spjd{ 486148456Spjd static const char hex[] = "0123456789abcdef"; 487148456Spjd char str[sizeof(md->md_mkeys) * 2 + 1]; 488148456Spjd u_int i; 489148456Spjd 490148456Spjd printf(" magic: %s\n", md->md_magic); 491148456Spjd printf(" version: %u\n", (u_int)md->md_version); 492148456Spjd printf(" flags: 0x%x\n", (u_int)md->md_flags); 493159307Spjd printf(" ealgo: %s\n", g_eli_algo2str(md->md_ealgo)); 494148456Spjd printf(" keylen: %u\n", (u_int)md->md_keylen); 495159307Spjd if (md->md_flags & G_ELI_FLAG_AUTH) 496159307Spjd printf(" aalgo: %s\n", g_eli_algo2str(md->md_aalgo)); 497148456Spjd printf(" provsize: %ju\n", (uintmax_t)md->md_provsize); 498148456Spjd printf("sectorsize: %u\n", (u_int)md->md_sectorsize); 499148456Spjd printf(" keys: 0x%02x\n", (u_int)md->md_keys); 500148456Spjd printf("iterations: %u\n", (u_int)md->md_iterations); 501148456Spjd bzero(str, sizeof(str)); 502148456Spjd for (i = 0; i < sizeof(md->md_salt); i++) { 503148456Spjd str[i * 2] = hex[md->md_salt[i] >> 4]; 504148456Spjd str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f]; 505148456Spjd } 506149303Spjd printf(" Salt: %s\n", str); 507148456Spjd bzero(str, sizeof(str)); 508148456Spjd for (i = 0; i < sizeof(md->md_mkeys); i++) { 509148456Spjd str[i * 2] = hex[md->md_mkeys[i] >> 4]; 510148456Spjd str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f]; 511148456Spjd } 512148456Spjd printf("Master Key: %s\n", str); 513148456Spjd bzero(str, sizeof(str)); 514148456Spjd for (i = 0; i < 16; i++) { 515148456Spjd str[i * 2] = hex[md->md_hash[i] >> 4]; 516148456Spjd str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f]; 517148456Spjd } 518149303Spjd printf(" MD5 hash: %s\n", str); 519148456Spjd} 520148456Spjd 521148456Spjdstatic __inline u_int 522148456Spjdg_eli_keylen(u_int algo, u_int keylen) 523148456Spjd{ 524148456Spjd 525148456Spjd switch (algo) { 526148456Spjd case CRYPTO_NULL_CBC: 527148456Spjd if (keylen == 0) 528148456Spjd keylen = 64 * 8; 529148456Spjd else { 530148456Spjd if (keylen > 64 * 8) 531148456Spjd keylen = 0; 532148456Spjd } 533148456Spjd return (keylen); 534211927Spjd case CRYPTO_AES_CBC: 535172031Spjd case CRYPTO_CAMELLIA_CBC: 536148456Spjd switch (keylen) { 537148456Spjd case 0: 538148456Spjd return (128); 539148456Spjd case 128: 540148456Spjd case 192: 541148456Spjd case 256: 542148456Spjd return (keylen); 543148456Spjd default: 544148456Spjd return (0); 545148456Spjd } 546213070Spjd case CRYPTO_AES_XTS: 547213070Spjd switch (keylen) { 548213070Spjd case 0: 549213070Spjd return (128); 550213070Spjd case 128: 551213070Spjd case 256: 552213070Spjd return (keylen); 553213070Spjd default: 554213070Spjd return (0); 555213070Spjd } 556148456Spjd case CRYPTO_BLF_CBC: 557148456Spjd if (keylen == 0) 558148456Spjd return (128); 559148456Spjd if (keylen < 128 || keylen > 448) 560148456Spjd return (0); 561148456Spjd if ((keylen % 32) != 0) 562148456Spjd return (0); 563148456Spjd return (keylen); 564148456Spjd case CRYPTO_3DES_CBC: 565148456Spjd if (keylen == 0 || keylen == 192) 566148456Spjd return (192); 567148456Spjd return (0); 568148456Spjd default: 569148456Spjd return (0); 570148456Spjd } 571148456Spjd} 572148456Spjd 573159307Spjdstatic __inline u_int 574159307Spjdg_eli_hashlen(u_int algo) 575159307Spjd{ 576159307Spjd 577159307Spjd switch (algo) { 578159307Spjd case CRYPTO_MD5_HMAC: 579159307Spjd return (16); 580159307Spjd case CRYPTO_SHA1_HMAC: 581159307Spjd return (20); 582159307Spjd case CRYPTO_RIPEMD160_HMAC: 583159307Spjd return (20); 584159307Spjd case CRYPTO_SHA2_256_HMAC: 585159307Spjd return (32); 586159307Spjd case CRYPTO_SHA2_384_HMAC: 587159307Spjd return (48); 588159307Spjd case CRYPTO_SHA2_512_HMAC: 589159307Spjd return (64); 590159307Spjd } 591159307Spjd return (0); 592159307Spjd} 593159307Spjd 594293306Sallanjudestatic __inline void 595293306Sallanjudeeli_metadata_softc(struct g_eli_softc *sc, const struct g_eli_metadata *md, 596293306Sallanjude u_int sectorsize, off_t mediasize) 597293306Sallanjude{ 598293306Sallanjude 599293306Sallanjude sc->sc_version = md->md_version; 600293306Sallanjude sc->sc_inflight = 0; 601293306Sallanjude sc->sc_crypto = G_ELI_CRYPTO_UNKNOWN; 602293306Sallanjude sc->sc_flags = md->md_flags; 603293306Sallanjude /* Backward compatibility. */ 604293306Sallanjude if (md->md_version < G_ELI_VERSION_04) 605293306Sallanjude sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER; 606293306Sallanjude if (md->md_version < G_ELI_VERSION_05) 607293306Sallanjude sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY; 608293306Sallanjude if (md->md_version < G_ELI_VERSION_06 && 609293306Sallanjude (sc->sc_flags & G_ELI_FLAG_AUTH) != 0) { 610293306Sallanjude sc->sc_flags |= G_ELI_FLAG_FIRST_KEY; 611293306Sallanjude } 612293306Sallanjude if (md->md_version < G_ELI_VERSION_07) 613293306Sallanjude sc->sc_flags |= G_ELI_FLAG_ENC_IVKEY; 614293306Sallanjude sc->sc_ealgo = md->md_ealgo; 615293306Sallanjude 616293306Sallanjude if (sc->sc_flags & G_ELI_FLAG_AUTH) { 617293306Sallanjude sc->sc_akeylen = sizeof(sc->sc_akey) * 8; 618293306Sallanjude sc->sc_aalgo = md->md_aalgo; 619293306Sallanjude sc->sc_alen = g_eli_hashlen(sc->sc_aalgo); 620293306Sallanjude 621293306Sallanjude sc->sc_data_per_sector = sectorsize - sc->sc_alen; 622293306Sallanjude /* 623293306Sallanjude * Some hash functions (like SHA1 and RIPEMD160) generates hash 624293306Sallanjude * which length is not multiple of 128 bits, but we want data 625293306Sallanjude * length to be multiple of 128, so we can encrypt without 626293306Sallanjude * padding. The line below rounds down data length to multiple 627293306Sallanjude * of 128 bits. 628293306Sallanjude */ 629293306Sallanjude sc->sc_data_per_sector -= sc->sc_data_per_sector % 16; 630293306Sallanjude 631293306Sallanjude sc->sc_bytes_per_sector = 632293306Sallanjude (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1; 633293306Sallanjude sc->sc_bytes_per_sector *= sectorsize; 634293306Sallanjude } 635293306Sallanjude sc->sc_sectorsize = md->md_sectorsize; 636293306Sallanjude sc->sc_mediasize = mediasize; 637293306Sallanjude if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) 638293306Sallanjude sc->sc_mediasize -= sectorsize; 639293306Sallanjude if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) 640293306Sallanjude sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize); 641293306Sallanjude else { 642293306Sallanjude sc->sc_mediasize /= sc->sc_bytes_per_sector; 643293306Sallanjude sc->sc_mediasize *= sc->sc_sectorsize; 644293306Sallanjude } 645293306Sallanjude sc->sc_ekeylen = md->md_keylen; 646293306Sallanjude} 647293306Sallanjude 648148456Spjd#ifdef _KERNEL 649148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 650148456Spjd struct g_eli_metadata *md); 651148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp, 652148456Spjd struct g_provider *bpp, const struct g_eli_metadata *md, 653148456Spjd const u_char *mkey, int nkey); 654148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force); 655148456Spjd 656148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de); 657148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb); 658159307Spjd 659159307Spjdvoid g_eli_read_done(struct bio *bp); 660159307Spjdvoid g_eli_write_done(struct bio *bp); 661159307Spjdint g_eli_crypto_rerun(struct cryptop *crp); 662159307Spjd 663214118Spjdvoid g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker); 664159307Spjdvoid g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp); 665159307Spjd 666159307Spjdvoid g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp); 667159307Spjdvoid g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp); 668148456Spjd#endif 669293306Sallanjudevoid g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv, 670293306Sallanjude size_t size); 671148456Spjd 672148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key); 673148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md, 674148456Spjd const unsigned char *key, unsigned char *mkey, unsigned *nkeyp); 675148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen, 676148456Spjd unsigned char *mkey); 677159307Spjd#ifdef _KERNEL 678159307Spjdvoid g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey); 679159307Spjd#endif 680148456Spjd 681148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize, 682148456Spjd const u_char *key, size_t keysize); 683148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize, 684148456Spjd const u_char *key, size_t keysize); 685148456Spjd 686148456Spjdstruct hmac_ctx { 687148456Spjd SHA512_CTX shactx; 688148456Spjd u_char k_opad[128]; 689148456Spjd}; 690148456Spjd 691148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey, 692148456Spjd size_t hkeylen); 693148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data, 694148456Spjd size_t datasize); 695148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize); 696148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize, 697148456Spjd const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize); 698220922Spjd 699293306Sallanjudevoid g_eli_key_fill(struct g_eli_softc *sc, struct g_eli_key *key, 700293306Sallanjude uint64_t keyno); 701220922Spjd#ifdef _KERNEL 702220922Spjdvoid g_eli_key_init(struct g_eli_softc *sc); 703220922Spjdvoid g_eli_key_destroy(struct g_eli_softc *sc); 704220922Spjduint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize); 705220922Spjdvoid g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey); 706220922Spjd#endif 707148456Spjd#endif /* !_G_ELI_H_ */ 708