g_eli.h revision 317859
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: stable/11/sys/geom/eli/g_eli.h 317859 2017-05-06 00:51:25Z mav $ 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 100297691Sallanjude/* This GELI supports GELIBoot */ 101297691Sallanjude#define G_ELI_FLAG_GELIBOOT 0x00000080 102161127Spjd/* RUNTIME FLAGS. */ 103148456Spjd/* Provider was open for writing. */ 104161220Spjd#define G_ELI_FLAG_WOPEN 0x00010000 105148456Spjd/* Destroy device. */ 106161220Spjd#define G_ELI_FLAG_DESTROY 0x00020000 107161220Spjd/* Provider uses native byte-order for IV generation. */ 108161220Spjd#define G_ELI_FLAG_NATIVE_BYTE_ORDER 0x00040000 109213067Spjd/* Provider uses single encryption key. */ 110213067Spjd#define G_ELI_FLAG_SINGLE_KEY 0x00080000 111214118Spjd/* Device suspended. */ 112214118Spjd#define G_ELI_FLAG_SUSPEND 0x00100000 113221628Spjd/* Provider uses first encryption key. */ 114221628Spjd#define G_ELI_FLAG_FIRST_KEY 0x00200000 115238116Spjd/* Provider uses IV-Key for encryption key generation. */ 116238116Spjd#define G_ELI_FLAG_ENC_IVKEY 0x00400000 117148456Spjd 118214118Spjd#define G_ELI_NEW_BIO 255 119214118Spjd 120148456Spjd#define SHA512_MDLEN 64 121159307Spjd#define G_ELI_AUTH_SECKEYLEN SHA256_DIGEST_LENGTH 122148456Spjd 123148456Spjd#define G_ELI_MAXMKEYS 2 124148456Spjd#define G_ELI_MAXKEYLEN 64 125148456Spjd#define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN 126148456Spjd#define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN 127159307Spjd#define G_ELI_AUTHKEYLEN G_ELI_MAXKEYLEN 128148456Spjd#define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN 129148456Spjd#define G_ELI_SALTLEN 64 130148456Spjd#define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN) 131148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */ 132148456Spjd#define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN) 133213062Spjd#define G_ELI_OVERWRITES 5 134213067Spjd/* Switch data encryption key every 2^20 blocks. */ 135213067Spjd#define G_ELI_KEY_SHIFT 20 136148456Spjd 137293306Sallanjude#define G_ELI_CRYPTO_UNKNOWN 0 138293306Sallanjude#define G_ELI_CRYPTO_HW 1 139293306Sallanjude#define G_ELI_CRYPTO_SW 2 140293306Sallanjude 141148456Spjd#ifdef _KERNEL 142213165Spjdextern int g_eli_debug; 143148456Spjdextern u_int g_eli_overwrites; 144159307Spjdextern u_int g_eli_batch; 145148456Spjd 146148456Spjd#define G_ELI_DEBUG(lvl, ...) do { \ 147148456Spjd if (g_eli_debug >= (lvl)) { \ 148148456Spjd printf("GEOM_ELI"); \ 149148456Spjd if (g_eli_debug > 0) \ 150148456Spjd printf("[%u]", lvl); \ 151148456Spjd printf(": "); \ 152148456Spjd printf(__VA_ARGS__); \ 153148456Spjd printf("\n"); \ 154148456Spjd } \ 155148456Spjd} while (0) 156148456Spjd#define G_ELI_LOGREQ(lvl, bp, ...) do { \ 157148456Spjd if (g_eli_debug >= (lvl)) { \ 158148456Spjd printf("GEOM_ELI"); \ 159148456Spjd if (g_eli_debug > 0) \ 160148456Spjd printf("[%u]", lvl); \ 161148456Spjd printf(": "); \ 162148456Spjd printf(__VA_ARGS__); \ 163148456Spjd printf(" "); \ 164148456Spjd g_print_bio(bp); \ 165148456Spjd printf("\n"); \ 166148456Spjd } \ 167148456Spjd} while (0) 168148456Spjd 169148456Spjdstruct g_eli_worker { 170148456Spjd struct g_eli_softc *w_softc; 171148456Spjd struct proc *w_proc; 172148456Spjd u_int w_number; 173148456Spjd uint64_t w_sid; 174214118Spjd boolean_t w_active; 175148456Spjd LIST_ENTRY(g_eli_worker) w_next; 176148456Spjd}; 177148456Spjd 178293306Sallanjude#endif /* _KERNEL */ 179293306Sallanjude 180148456Spjdstruct g_eli_softc { 181220922Spjd struct g_geom *sc_geom; 182226733Spjd u_int sc_version; 183220922Spjd u_int sc_crypto; 184220922Spjd uint8_t sc_mkey[G_ELI_DATAIVKEYLEN]; 185220922Spjd uint8_t sc_ekey[G_ELI_DATAKEYLEN]; 186220922Spjd TAILQ_HEAD(, g_eli_key) sc_ekeys_queue; 187220922Spjd RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree; 188220922Spjd struct mtx sc_ekeys_lock; 189220922Spjd uint64_t sc_ekeys_total; 190220922Spjd uint64_t sc_ekeys_allocated; 191220922Spjd u_int sc_ealgo; 192220922Spjd u_int sc_ekeylen; 193220922Spjd uint8_t sc_akey[G_ELI_AUTHKEYLEN]; 194220922Spjd u_int sc_aalgo; 195220922Spjd u_int sc_akeylen; 196220922Spjd u_int sc_alen; 197220922Spjd SHA256_CTX sc_akeyctx; 198220922Spjd uint8_t sc_ivkey[G_ELI_IVKEYLEN]; 199220922Spjd SHA256_CTX sc_ivctx; 200220922Spjd int sc_nkey; 201220922Spjd uint32_t sc_flags; 202220922Spjd int sc_inflight; 203220922Spjd off_t sc_mediasize; 204220922Spjd size_t sc_sectorsize; 205220922Spjd u_int sc_bytes_per_sector; 206220922Spjd u_int sc_data_per_sector; 207293306Sallanjude#ifndef _KERNEL 208293306Sallanjude int sc_cpubind; 209293306Sallanjude#else /* _KERNEL */ 210226840Spjd boolean_t sc_cpubind; 211148456Spjd 212148456Spjd /* Only for software cryptography. */ 213148456Spjd struct bio_queue_head sc_queue; 214220922Spjd struct mtx sc_queue_mtx; 215148456Spjd LIST_HEAD(, g_eli_worker) sc_workers; 216293306Sallanjude#endif /* _KERNEL */ 217148456Spjd}; 218148456Spjd#define sc_name sc_geom->name 219148456Spjd 220293306Sallanjude#define G_ELI_KEY_MAGIC 0xe11341c 221293306Sallanjude 222293306Sallanjudestruct g_eli_key { 223293306Sallanjude /* Key value, must be first in the structure. */ 224293306Sallanjude uint8_t gek_key[G_ELI_DATAKEYLEN]; 225293306Sallanjude /* Magic. */ 226293306Sallanjude int gek_magic; 227293306Sallanjude /* Key number. */ 228293306Sallanjude uint64_t gek_keyno; 229293306Sallanjude /* Reference counter. */ 230293306Sallanjude int gek_count; 231293306Sallanjude /* Keeps keys sorted by most recent use. */ 232293306Sallanjude TAILQ_ENTRY(g_eli_key) gek_next; 233293306Sallanjude /* Keeps keys sorted by number. */ 234293306Sallanjude RB_ENTRY(g_eli_key) gek_link; 235293306Sallanjude}; 236293306Sallanjude 237148456Spjdstruct g_eli_metadata { 238148456Spjd char md_magic[16]; /* Magic value. */ 239148456Spjd uint32_t md_version; /* Version number. */ 240148456Spjd uint32_t md_flags; /* Additional flags. */ 241159307Spjd uint16_t md_ealgo; /* Encryption algorithm. */ 242148456Spjd uint16_t md_keylen; /* Key length. */ 243159307Spjd uint16_t md_aalgo; /* Authentication algorithm. */ 244148456Spjd uint64_t md_provsize; /* Provider's size. */ 245148456Spjd uint32_t md_sectorsize; /* Sector size. */ 246148456Spjd uint8_t md_keys; /* Available keys. */ 247149303Spjd int32_t md_iterations; /* Number of iterations for PKCS#5v2. */ 248148456Spjd uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */ 249148456Spjd /* Encrypted master key (IV-key, Data-key, HMAC). */ 250148456Spjd uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN]; 251148456Spjd u_char md_hash[16]; /* MD5 hash. */ 252149323Spjd} __packed; 253148456Spjd#ifndef _OpenSSL_ 254148456Spjdstatic __inline void 255226733Spjdeli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap) 256148456Spjd{ 257148456Spjd u_char *p; 258148456Spjd 259226733Spjd p = *datap; 260148456Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 261159307Spjd le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 262148456Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 263226733Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 264226733Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 265226733Spjd *p = md->md_keys; p += sizeof(md->md_keys); 266226733Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 267226733Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 268226733Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 269226733Spjd *datap = p; 270226733Spjd} 271226733Spjdstatic __inline void 272238116Spjdeli_metadata_encode_v1v2v3v4v5v6v7(struct g_eli_metadata *md, u_char **datap) 273226733Spjd{ 274226733Spjd u_char *p; 275226733Spjd 276226733Spjd p = *datap; 277226733Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 278226733Spjd le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 279226733Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 280159307Spjd le16enc(p, md->md_aalgo); p += sizeof(md->md_aalgo); 281148456Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 282148456Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 283148456Spjd *p = md->md_keys; p += sizeof(md->md_keys); 284148456Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 285148456Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 286148456Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 287226733Spjd *datap = p; 288226733Spjd} 289226733Spjdstatic __inline void 290226733Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data) 291226733Spjd{ 292226733Spjd MD5_CTX ctx; 293226733Spjd u_char *p; 294226733Spjd 295226733Spjd p = data; 296226733Spjd bcopy(md->md_magic, p, sizeof(md->md_magic)); 297226733Spjd p += sizeof(md->md_magic); 298226733Spjd le32enc(p, md->md_version); 299226733Spjd p += sizeof(md->md_version); 300226733Spjd switch (md->md_version) { 301226733Spjd case G_ELI_VERSION_00: 302226733Spjd eli_metadata_encode_v0(md, &p); 303226733Spjd break; 304226733Spjd case G_ELI_VERSION_01: 305226733Spjd case G_ELI_VERSION_02: 306226733Spjd case G_ELI_VERSION_03: 307226733Spjd case G_ELI_VERSION_04: 308226733Spjd case G_ELI_VERSION_05: 309226733Spjd case G_ELI_VERSION_06: 310238116Spjd case G_ELI_VERSION_07: 311238116Spjd eli_metadata_encode_v1v2v3v4v5v6v7(md, &p); 312226733Spjd break; 313226733Spjd default: 314226733Spjd#ifdef _KERNEL 315226733Spjd panic("%s: Unsupported version %u.", __func__, 316226733Spjd (u_int)md->md_version); 317226733Spjd#else 318226733Spjd assert(!"Unsupported metadata version."); 319226733Spjd#endif 320226733Spjd } 321148456Spjd MD5Init(&ctx); 322148456Spjd MD5Update(&ctx, data, p - data); 323157305Spjd MD5Final(md->md_hash, &ctx); 324148456Spjd bcopy(md->md_hash, p, sizeof(md->md_hash)); 325148456Spjd} 326148456Spjdstatic __inline int 327148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md) 328148456Spjd{ 329148456Spjd MD5_CTX ctx; 330148456Spjd const u_char *p; 331148456Spjd 332148456Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 333148456Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 334159307Spjd md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 335148456Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 336148456Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 337148456Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 338148456Spjd md->md_keys = *p; p += sizeof(md->md_keys); 339148456Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 340148456Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 341148456Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 342148456Spjd MD5Init(&ctx); 343148456Spjd MD5Update(&ctx, data, p - data); 344157305Spjd MD5Final(md->md_hash, &ctx); 345148456Spjd if (bcmp(md->md_hash, p, 16) != 0) 346148456Spjd return (EINVAL); 347148456Spjd return (0); 348148456Spjd} 349212845Sbrian 350148456Spjdstatic __inline int 351238116Spjdeli_metadata_decode_v1v2v3v4v5v6v7(const u_char *data, struct g_eli_metadata *md) 352159307Spjd{ 353159307Spjd MD5_CTX ctx; 354159307Spjd const u_char *p; 355159307Spjd 356159307Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 357159307Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 358159307Spjd md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 359159307Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 360159307Spjd md->md_aalgo = le16dec(p); p += sizeof(md->md_aalgo); 361159307Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 362159307Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 363159307Spjd md->md_keys = *p; p += sizeof(md->md_keys); 364159307Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 365159307Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 366159307Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 367159307Spjd MD5Init(&ctx); 368159307Spjd MD5Update(&ctx, data, p - data); 369159307Spjd MD5Final(md->md_hash, &ctx); 370159307Spjd if (bcmp(md->md_hash, p, 16) != 0) 371159307Spjd return (EINVAL); 372159307Spjd return (0); 373159307Spjd} 374159307Spjdstatic __inline int 375148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md) 376148456Spjd{ 377148456Spjd int error; 378148456Spjd 379148456Spjd bcopy(data, md->md_magic, sizeof(md->md_magic)); 380226730Spjd if (strcmp(md->md_magic, G_ELI_MAGIC) != 0) 381226730Spjd return (EINVAL); 382148456Spjd md->md_version = le32dec(data + sizeof(md->md_magic)); 383148456Spjd switch (md->md_version) { 384221629Spjd case G_ELI_VERSION_00: 385148456Spjd error = eli_metadata_decode_v0(data, md); 386148456Spjd break; 387221629Spjd case G_ELI_VERSION_01: 388221629Spjd case G_ELI_VERSION_02: 389221629Spjd case G_ELI_VERSION_03: 390221629Spjd case G_ELI_VERSION_04: 391221629Spjd case G_ELI_VERSION_05: 392221629Spjd case G_ELI_VERSION_06: 393238116Spjd case G_ELI_VERSION_07: 394238116Spjd error = eli_metadata_decode_v1v2v3v4v5v6v7(data, md); 395159307Spjd break; 396148456Spjd default: 397226721Spjd error = EOPNOTSUPP; 398148456Spjd break; 399148456Spjd } 400148456Spjd return (error); 401148456Spjd} 402148456Spjd#endif /* !_OpenSSL */ 403148456Spjd 404148456Spjdstatic __inline u_int 405159307Spjdg_eli_str2ealgo(const char *name) 406148456Spjd{ 407148456Spjd 408148867Spjd if (strcasecmp("null", name) == 0) 409148456Spjd return (CRYPTO_NULL_CBC); 410213070Spjd else if (strcasecmp("null-cbc", name) == 0) 411213070Spjd return (CRYPTO_NULL_CBC); 412148867Spjd else if (strcasecmp("aes", name) == 0) 413213070Spjd return (CRYPTO_AES_XTS); 414213070Spjd else if (strcasecmp("aes-cbc", name) == 0) 415148456Spjd return (CRYPTO_AES_CBC); 416213070Spjd else if (strcasecmp("aes-xts", name) == 0) 417213070Spjd return (CRYPTO_AES_XTS); 418148867Spjd else if (strcasecmp("blowfish", name) == 0) 419148456Spjd return (CRYPTO_BLF_CBC); 420213070Spjd else if (strcasecmp("blowfish-cbc", name) == 0) 421213070Spjd return (CRYPTO_BLF_CBC); 422172031Spjd else if (strcasecmp("camellia", name) == 0) 423172031Spjd return (CRYPTO_CAMELLIA_CBC); 424213070Spjd else if (strcasecmp("camellia-cbc", name) == 0) 425213070Spjd return (CRYPTO_CAMELLIA_CBC); 426148867Spjd else if (strcasecmp("3des", name) == 0) 427148456Spjd return (CRYPTO_3DES_CBC); 428213070Spjd else if (strcasecmp("3des-cbc", name) == 0) 429213070Spjd return (CRYPTO_3DES_CBC); 430148456Spjd return (CRYPTO_ALGORITHM_MIN - 1); 431148456Spjd} 432148456Spjd 433159307Spjdstatic __inline u_int 434159307Spjdg_eli_str2aalgo(const char *name) 435159307Spjd{ 436159307Spjd 437159307Spjd if (strcasecmp("hmac/md5", name) == 0) 438159307Spjd return (CRYPTO_MD5_HMAC); 439159307Spjd else if (strcasecmp("hmac/sha1", name) == 0) 440159307Spjd return (CRYPTO_SHA1_HMAC); 441159307Spjd else if (strcasecmp("hmac/ripemd160", name) == 0) 442159307Spjd return (CRYPTO_RIPEMD160_HMAC); 443159307Spjd else if (strcasecmp("hmac/sha256", name) == 0) 444159307Spjd return (CRYPTO_SHA2_256_HMAC); 445159307Spjd else if (strcasecmp("hmac/sha384", name) == 0) 446159307Spjd return (CRYPTO_SHA2_384_HMAC); 447159307Spjd else if (strcasecmp("hmac/sha512", name) == 0) 448159307Spjd return (CRYPTO_SHA2_512_HMAC); 449159307Spjd return (CRYPTO_ALGORITHM_MIN - 1); 450159307Spjd} 451159307Spjd 452148456Spjdstatic __inline const char * 453148456Spjdg_eli_algo2str(u_int algo) 454148456Spjd{ 455148456Spjd 456148456Spjd switch (algo) { 457148456Spjd case CRYPTO_NULL_CBC: 458148456Spjd return ("NULL"); 459148456Spjd case CRYPTO_AES_CBC: 460159307Spjd return ("AES-CBC"); 461213070Spjd case CRYPTO_AES_XTS: 462213070Spjd return ("AES-XTS"); 463148456Spjd case CRYPTO_BLF_CBC: 464159307Spjd return ("Blowfish-CBC"); 465172031Spjd case CRYPTO_CAMELLIA_CBC: 466172031Spjd return ("CAMELLIA-CBC"); 467148456Spjd case CRYPTO_3DES_CBC: 468159307Spjd return ("3DES-CBC"); 469159307Spjd case CRYPTO_MD5_HMAC: 470159307Spjd return ("HMAC/MD5"); 471159307Spjd case CRYPTO_SHA1_HMAC: 472159307Spjd return ("HMAC/SHA1"); 473159307Spjd case CRYPTO_RIPEMD160_HMAC: 474159307Spjd return ("HMAC/RIPEMD160"); 475159307Spjd case CRYPTO_SHA2_256_HMAC: 476159307Spjd return ("HMAC/SHA256"); 477159307Spjd case CRYPTO_SHA2_384_HMAC: 478159307Spjd return ("HMAC/SHA384"); 479159307Spjd case CRYPTO_SHA2_512_HMAC: 480159307Spjd return ("HMAC/SHA512"); 481148456Spjd } 482148456Spjd return ("unknown"); 483148456Spjd} 484148456Spjd 485148456Spjdstatic __inline void 486148456Spjdeli_metadata_dump(const struct g_eli_metadata *md) 487148456Spjd{ 488148456Spjd static const char hex[] = "0123456789abcdef"; 489148456Spjd char str[sizeof(md->md_mkeys) * 2 + 1]; 490148456Spjd u_int i; 491148456Spjd 492148456Spjd printf(" magic: %s\n", md->md_magic); 493148456Spjd printf(" version: %u\n", (u_int)md->md_version); 494148456Spjd printf(" flags: 0x%x\n", (u_int)md->md_flags); 495159307Spjd printf(" ealgo: %s\n", g_eli_algo2str(md->md_ealgo)); 496148456Spjd printf(" keylen: %u\n", (u_int)md->md_keylen); 497159307Spjd if (md->md_flags & G_ELI_FLAG_AUTH) 498159307Spjd printf(" aalgo: %s\n", g_eli_algo2str(md->md_aalgo)); 499148456Spjd printf(" provsize: %ju\n", (uintmax_t)md->md_provsize); 500148456Spjd printf("sectorsize: %u\n", (u_int)md->md_sectorsize); 501148456Spjd printf(" keys: 0x%02x\n", (u_int)md->md_keys); 502317859Smav printf("iterations: %d\n", (int)md->md_iterations); 503148456Spjd bzero(str, sizeof(str)); 504148456Spjd for (i = 0; i < sizeof(md->md_salt); i++) { 505148456Spjd str[i * 2] = hex[md->md_salt[i] >> 4]; 506148456Spjd str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f]; 507148456Spjd } 508149303Spjd printf(" Salt: %s\n", str); 509148456Spjd bzero(str, sizeof(str)); 510148456Spjd for (i = 0; i < sizeof(md->md_mkeys); i++) { 511148456Spjd str[i * 2] = hex[md->md_mkeys[i] >> 4]; 512148456Spjd str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f]; 513148456Spjd } 514148456Spjd printf("Master Key: %s\n", str); 515148456Spjd bzero(str, sizeof(str)); 516148456Spjd for (i = 0; i < 16; i++) { 517148456Spjd str[i * 2] = hex[md->md_hash[i] >> 4]; 518148456Spjd str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f]; 519148456Spjd } 520149303Spjd printf(" MD5 hash: %s\n", str); 521148456Spjd} 522148456Spjd 523148456Spjdstatic __inline u_int 524148456Spjdg_eli_keylen(u_int algo, u_int keylen) 525148456Spjd{ 526148456Spjd 527148456Spjd switch (algo) { 528148456Spjd case CRYPTO_NULL_CBC: 529148456Spjd if (keylen == 0) 530148456Spjd keylen = 64 * 8; 531148456Spjd else { 532148456Spjd if (keylen > 64 * 8) 533148456Spjd keylen = 0; 534148456Spjd } 535148456Spjd return (keylen); 536211927Spjd case CRYPTO_AES_CBC: 537172031Spjd case CRYPTO_CAMELLIA_CBC: 538148456Spjd switch (keylen) { 539148456Spjd case 0: 540148456Spjd return (128); 541148456Spjd case 128: 542148456Spjd case 192: 543148456Spjd case 256: 544148456Spjd return (keylen); 545148456Spjd default: 546148456Spjd return (0); 547148456Spjd } 548213070Spjd case CRYPTO_AES_XTS: 549213070Spjd switch (keylen) { 550213070Spjd case 0: 551213070Spjd return (128); 552213070Spjd case 128: 553213070Spjd case 256: 554213070Spjd return (keylen); 555213070Spjd default: 556213070Spjd return (0); 557213070Spjd } 558148456Spjd case CRYPTO_BLF_CBC: 559148456Spjd if (keylen == 0) 560148456Spjd return (128); 561148456Spjd if (keylen < 128 || keylen > 448) 562148456Spjd return (0); 563148456Spjd if ((keylen % 32) != 0) 564148456Spjd return (0); 565148456Spjd return (keylen); 566148456Spjd case CRYPTO_3DES_CBC: 567148456Spjd if (keylen == 0 || keylen == 192) 568148456Spjd return (192); 569148456Spjd return (0); 570148456Spjd default: 571148456Spjd return (0); 572148456Spjd } 573148456Spjd} 574148456Spjd 575159307Spjdstatic __inline u_int 576159307Spjdg_eli_hashlen(u_int algo) 577159307Spjd{ 578159307Spjd 579159307Spjd switch (algo) { 580159307Spjd case CRYPTO_MD5_HMAC: 581159307Spjd return (16); 582159307Spjd case CRYPTO_SHA1_HMAC: 583159307Spjd return (20); 584159307Spjd case CRYPTO_RIPEMD160_HMAC: 585159307Spjd return (20); 586159307Spjd case CRYPTO_SHA2_256_HMAC: 587159307Spjd return (32); 588159307Spjd case CRYPTO_SHA2_384_HMAC: 589159307Spjd return (48); 590159307Spjd case CRYPTO_SHA2_512_HMAC: 591159307Spjd return (64); 592159307Spjd } 593159307Spjd return (0); 594159307Spjd} 595159307Spjd 596293306Sallanjudestatic __inline void 597293306Sallanjudeeli_metadata_softc(struct g_eli_softc *sc, const struct g_eli_metadata *md, 598293306Sallanjude u_int sectorsize, off_t mediasize) 599293306Sallanjude{ 600293306Sallanjude 601293306Sallanjude sc->sc_version = md->md_version; 602293306Sallanjude sc->sc_inflight = 0; 603293306Sallanjude sc->sc_crypto = G_ELI_CRYPTO_UNKNOWN; 604293306Sallanjude sc->sc_flags = md->md_flags; 605293306Sallanjude /* Backward compatibility. */ 606293306Sallanjude if (md->md_version < G_ELI_VERSION_04) 607293306Sallanjude sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER; 608293306Sallanjude if (md->md_version < G_ELI_VERSION_05) 609293306Sallanjude sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY; 610293306Sallanjude if (md->md_version < G_ELI_VERSION_06 && 611293306Sallanjude (sc->sc_flags & G_ELI_FLAG_AUTH) != 0) { 612293306Sallanjude sc->sc_flags |= G_ELI_FLAG_FIRST_KEY; 613293306Sallanjude } 614293306Sallanjude if (md->md_version < G_ELI_VERSION_07) 615293306Sallanjude sc->sc_flags |= G_ELI_FLAG_ENC_IVKEY; 616293306Sallanjude sc->sc_ealgo = md->md_ealgo; 617293306Sallanjude 618293306Sallanjude if (sc->sc_flags & G_ELI_FLAG_AUTH) { 619293306Sallanjude sc->sc_akeylen = sizeof(sc->sc_akey) * 8; 620293306Sallanjude sc->sc_aalgo = md->md_aalgo; 621293306Sallanjude sc->sc_alen = g_eli_hashlen(sc->sc_aalgo); 622293306Sallanjude 623293306Sallanjude sc->sc_data_per_sector = sectorsize - sc->sc_alen; 624293306Sallanjude /* 625293306Sallanjude * Some hash functions (like SHA1 and RIPEMD160) generates hash 626293306Sallanjude * which length is not multiple of 128 bits, but we want data 627293306Sallanjude * length to be multiple of 128, so we can encrypt without 628293306Sallanjude * padding. The line below rounds down data length to multiple 629293306Sallanjude * of 128 bits. 630293306Sallanjude */ 631293306Sallanjude sc->sc_data_per_sector -= sc->sc_data_per_sector % 16; 632293306Sallanjude 633293306Sallanjude sc->sc_bytes_per_sector = 634293306Sallanjude (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1; 635293306Sallanjude sc->sc_bytes_per_sector *= sectorsize; 636293306Sallanjude } 637293306Sallanjude sc->sc_sectorsize = md->md_sectorsize; 638293306Sallanjude sc->sc_mediasize = mediasize; 639293306Sallanjude if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) 640293306Sallanjude sc->sc_mediasize -= sectorsize; 641293306Sallanjude if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) 642293306Sallanjude sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize); 643293306Sallanjude else { 644293306Sallanjude sc->sc_mediasize /= sc->sc_bytes_per_sector; 645293306Sallanjude sc->sc_mediasize *= sc->sc_sectorsize; 646293306Sallanjude } 647293306Sallanjude sc->sc_ekeylen = md->md_keylen; 648293306Sallanjude} 649293306Sallanjude 650148456Spjd#ifdef _KERNEL 651148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 652148456Spjd struct g_eli_metadata *md); 653148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp, 654148456Spjd struct g_provider *bpp, const struct g_eli_metadata *md, 655148456Spjd const u_char *mkey, int nkey); 656148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force); 657148456Spjd 658148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de); 659148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb); 660159307Spjd 661159307Spjdvoid g_eli_read_done(struct bio *bp); 662159307Spjdvoid g_eli_write_done(struct bio *bp); 663159307Spjdint g_eli_crypto_rerun(struct cryptop *crp); 664159307Spjd 665214118Spjdvoid g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker); 666159307Spjdvoid g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp); 667159307Spjd 668159307Spjdvoid g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp); 669159307Spjdvoid g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp); 670148456Spjd#endif 671293306Sallanjudevoid g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv, 672293306Sallanjude size_t size); 673148456Spjd 674148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key); 675148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md, 676148456Spjd const unsigned char *key, unsigned char *mkey, unsigned *nkeyp); 677148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen, 678148456Spjd unsigned char *mkey); 679159307Spjd#ifdef _KERNEL 680159307Spjdvoid g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey); 681159307Spjd#endif 682148456Spjd 683148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize, 684148456Spjd const u_char *key, size_t keysize); 685148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize, 686148456Spjd const u_char *key, size_t keysize); 687148456Spjd 688148456Spjdstruct hmac_ctx { 689148456Spjd SHA512_CTX shactx; 690148456Spjd u_char k_opad[128]; 691148456Spjd}; 692148456Spjd 693148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey, 694148456Spjd size_t hkeylen); 695148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data, 696148456Spjd size_t datasize); 697148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize); 698148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize, 699148456Spjd const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize); 700220922Spjd 701293306Sallanjudevoid g_eli_key_fill(struct g_eli_softc *sc, struct g_eli_key *key, 702293306Sallanjude uint64_t keyno); 703220922Spjd#ifdef _KERNEL 704220922Spjdvoid g_eli_key_init(struct g_eli_softc *sc); 705220922Spjdvoid g_eli_key_destroy(struct g_eli_softc *sc); 706220922Spjduint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize); 707220922Spjdvoid g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey); 708220922Spjd#endif 709148456Spjd#endif /* !_G_ELI_H_ */ 710