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 344397 2019-02-20 23:42:03Z kevans $ 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> 44329099Skevans#include <crypto/intake.h> 45148456Spjd#else 46226733Spjd#include <assert.h> 47148456Spjd#include <stdio.h> 48148456Spjd#include <string.h> 49148867Spjd#include <strings.h> 50148456Spjd#endif 51293306Sallanjude#include <sys/queue.h> 52293306Sallanjude#include <sys/tree.h> 53148456Spjd#ifndef _OpenSSL_ 54148456Spjd#include <sys/md5.h> 55148456Spjd#endif 56148456Spjd 57148456Spjd#define G_ELI_CLASS_NAME "ELI" 58148456Spjd#define G_ELI_MAGIC "GEOM::ELI" 59148456Spjd#define G_ELI_SUFFIX ".eli" 60148456Spjd 61148456Spjd/* 62148456Spjd * Version history: 63148456Spjd * 0 - Initial version number. 64159307Spjd * 1 - Added data authentication support (md_aalgo field and 65159307Spjd * G_ELI_FLAG_AUTH flag). 66161217Spjd * 2 - Added G_ELI_FLAG_READONLY. 67211927Spjd * 3 - Added 'configure' subcommand. 68211927Spjd * 4 - IV is generated from offset converted to little-endian 69221628Spjd * (the G_ELI_FLAG_NATIVE_BYTE_ORDER flag will be set for older versions). 70213070Spjd * 5 - Added multiple encrypton keys and AES-XTS support. 71221628Spjd * 6 - Fixed usage of multiple keys for authenticated providers (the 72221628Spjd * G_ELI_FLAG_FIRST_KEY flag will be set for older versions). 73238116Spjd * 7 - Encryption keys are now generated from the Data Key and not from the 74238116Spjd * IV Key (the G_ELI_FLAG_ENC_IVKEY flag will be set for older versions). 75148456Spjd */ 76221628Spjd#define G_ELI_VERSION_00 0 77221628Spjd#define G_ELI_VERSION_01 1 78221628Spjd#define G_ELI_VERSION_02 2 79221628Spjd#define G_ELI_VERSION_03 3 80221628Spjd#define G_ELI_VERSION_04 4 81221628Spjd#define G_ELI_VERSION_05 5 82221628Spjd#define G_ELI_VERSION_06 6 83238116Spjd#define G_ELI_VERSION_07 7 84238116Spjd#define G_ELI_VERSION G_ELI_VERSION_07 85148456Spjd 86161127Spjd/* ON DISK FLAGS. */ 87148456Spjd/* Use random, onetime keys. */ 88161220Spjd#define G_ELI_FLAG_ONETIME 0x00000001 89148456Spjd/* Ask for the passphrase from the kernel, before mounting root. */ 90161220Spjd#define G_ELI_FLAG_BOOT 0x00000002 91148456Spjd/* Detach on last close, if we were open for writing. */ 92161220Spjd#define G_ELI_FLAG_WO_DETACH 0x00000004 93148456Spjd/* Detach on last close. */ 94161220Spjd#define G_ELI_FLAG_RW_DETACH 0x00000008 95159307Spjd/* Provide data authentication. */ 96161220Spjd#define G_ELI_FLAG_AUTH 0x00000010 97161127Spjd/* Provider is read-only, we should deny all write attempts. */ 98161220Spjd#define G_ELI_FLAG_RO 0x00000020 99286444Spjd/* Don't pass through BIO_DELETE requests. */ 100286444Spjd#define G_ELI_FLAG_NODELETE 0x00000040 101297691Sallanjude/* This GELI supports GELIBoot */ 102297691Sallanjude#define G_ELI_FLAG_GELIBOOT 0x00000080 103329114Skevans/* Hide passphrase length in GELIboot. */ 104329114Skevans#define G_ELI_FLAG_GELIDISPLAYPASS 0x00000100 105161127Spjd/* RUNTIME FLAGS. */ 106148456Spjd/* Provider was open for writing. */ 107161220Spjd#define G_ELI_FLAG_WOPEN 0x00010000 108148456Spjd/* Destroy device. */ 109161220Spjd#define G_ELI_FLAG_DESTROY 0x00020000 110161220Spjd/* Provider uses native byte-order for IV generation. */ 111161220Spjd#define G_ELI_FLAG_NATIVE_BYTE_ORDER 0x00040000 112213067Spjd/* Provider uses single encryption key. */ 113213067Spjd#define G_ELI_FLAG_SINGLE_KEY 0x00080000 114214118Spjd/* Device suspended. */ 115214118Spjd#define G_ELI_FLAG_SUSPEND 0x00100000 116221628Spjd/* Provider uses first encryption key. */ 117221628Spjd#define G_ELI_FLAG_FIRST_KEY 0x00200000 118238116Spjd/* Provider uses IV-Key for encryption key generation. */ 119238116Spjd#define G_ELI_FLAG_ENC_IVKEY 0x00400000 120148456Spjd 121214118Spjd#define G_ELI_NEW_BIO 255 122214118Spjd 123148456Spjd#define SHA512_MDLEN 64 124159307Spjd#define G_ELI_AUTH_SECKEYLEN SHA256_DIGEST_LENGTH 125148456Spjd 126148456Spjd#define G_ELI_MAXMKEYS 2 127148456Spjd#define G_ELI_MAXKEYLEN 64 128148456Spjd#define G_ELI_USERKEYLEN G_ELI_MAXKEYLEN 129148456Spjd#define G_ELI_DATAKEYLEN G_ELI_MAXKEYLEN 130159307Spjd#define G_ELI_AUTHKEYLEN G_ELI_MAXKEYLEN 131148456Spjd#define G_ELI_IVKEYLEN G_ELI_MAXKEYLEN 132148456Spjd#define G_ELI_SALTLEN 64 133148456Spjd#define G_ELI_DATAIVKEYLEN (G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN) 134148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */ 135148456Spjd#define G_ELI_MKEYLEN (G_ELI_DATAIVKEYLEN + SHA512_MDLEN) 136213062Spjd#define G_ELI_OVERWRITES 5 137213067Spjd/* Switch data encryption key every 2^20 blocks. */ 138213067Spjd#define G_ELI_KEY_SHIFT 20 139148456Spjd 140293306Sallanjude#define G_ELI_CRYPTO_UNKNOWN 0 141293306Sallanjude#define G_ELI_CRYPTO_HW 1 142293306Sallanjude#define G_ELI_CRYPTO_SW 2 143293306Sallanjude 144148456Spjd#ifdef _KERNEL 145329099Skevans#if (MAX_KEY_BYTES < G_ELI_DATAIVKEYLEN) 146329099Skevans#error "MAX_KEY_BYTES is less than G_ELI_DATAKEYLEN" 147329099Skevans#endif 148329099Skevans 149213165Spjdextern int g_eli_debug; 150148456Spjdextern u_int g_eli_overwrites; 151159307Spjdextern u_int g_eli_batch; 152148456Spjd 153148456Spjd#define G_ELI_DEBUG(lvl, ...) do { \ 154148456Spjd if (g_eli_debug >= (lvl)) { \ 155148456Spjd printf("GEOM_ELI"); \ 156148456Spjd if (g_eli_debug > 0) \ 157148456Spjd printf("[%u]", lvl); \ 158148456Spjd printf(": "); \ 159148456Spjd printf(__VA_ARGS__); \ 160148456Spjd printf("\n"); \ 161148456Spjd } \ 162148456Spjd} while (0) 163148456Spjd#define G_ELI_LOGREQ(lvl, bp, ...) do { \ 164148456Spjd if (g_eli_debug >= (lvl)) { \ 165148456Spjd printf("GEOM_ELI"); \ 166148456Spjd if (g_eli_debug > 0) \ 167148456Spjd printf("[%u]", lvl); \ 168148456Spjd printf(": "); \ 169148456Spjd printf(__VA_ARGS__); \ 170148456Spjd printf(" "); \ 171148456Spjd g_print_bio(bp); \ 172148456Spjd printf("\n"); \ 173148456Spjd } \ 174148456Spjd} while (0) 175148456Spjd 176148456Spjdstruct g_eli_worker { 177148456Spjd struct g_eli_softc *w_softc; 178148456Spjd struct proc *w_proc; 179148456Spjd u_int w_number; 180148456Spjd uint64_t w_sid; 181214118Spjd boolean_t w_active; 182148456Spjd LIST_ENTRY(g_eli_worker) w_next; 183148456Spjd}; 184148456Spjd 185293306Sallanjude#endif /* _KERNEL */ 186293306Sallanjude 187148456Spjdstruct g_eli_softc { 188220922Spjd struct g_geom *sc_geom; 189226733Spjd u_int sc_version; 190220922Spjd u_int sc_crypto; 191220922Spjd uint8_t sc_mkey[G_ELI_DATAIVKEYLEN]; 192220922Spjd uint8_t sc_ekey[G_ELI_DATAKEYLEN]; 193220922Spjd TAILQ_HEAD(, g_eli_key) sc_ekeys_queue; 194220922Spjd RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree; 195220922Spjd struct mtx sc_ekeys_lock; 196220922Spjd uint64_t sc_ekeys_total; 197220922Spjd uint64_t sc_ekeys_allocated; 198220922Spjd u_int sc_ealgo; 199220922Spjd u_int sc_ekeylen; 200220922Spjd uint8_t sc_akey[G_ELI_AUTHKEYLEN]; 201220922Spjd u_int sc_aalgo; 202220922Spjd u_int sc_akeylen; 203220922Spjd u_int sc_alen; 204220922Spjd SHA256_CTX sc_akeyctx; 205220922Spjd uint8_t sc_ivkey[G_ELI_IVKEYLEN]; 206220922Spjd SHA256_CTX sc_ivctx; 207220922Spjd int sc_nkey; 208220922Spjd uint32_t sc_flags; 209220922Spjd int sc_inflight; 210220922Spjd off_t sc_mediasize; 211220922Spjd size_t sc_sectorsize; 212220922Spjd u_int sc_bytes_per_sector; 213220922Spjd u_int sc_data_per_sector; 214293306Sallanjude#ifndef _KERNEL 215293306Sallanjude int sc_cpubind; 216293306Sallanjude#else /* _KERNEL */ 217226840Spjd boolean_t sc_cpubind; 218148456Spjd 219148456Spjd /* Only for software cryptography. */ 220148456Spjd struct bio_queue_head sc_queue; 221220922Spjd struct mtx sc_queue_mtx; 222148456Spjd LIST_HEAD(, g_eli_worker) sc_workers; 223293306Sallanjude#endif /* _KERNEL */ 224148456Spjd}; 225148456Spjd#define sc_name sc_geom->name 226148456Spjd 227293306Sallanjude#define G_ELI_KEY_MAGIC 0xe11341c 228293306Sallanjude 229293306Sallanjudestruct g_eli_key { 230293306Sallanjude /* Key value, must be first in the structure. */ 231293306Sallanjude uint8_t gek_key[G_ELI_DATAKEYLEN]; 232293306Sallanjude /* Magic. */ 233293306Sallanjude int gek_magic; 234293306Sallanjude /* Key number. */ 235293306Sallanjude uint64_t gek_keyno; 236293306Sallanjude /* Reference counter. */ 237293306Sallanjude int gek_count; 238293306Sallanjude /* Keeps keys sorted by most recent use. */ 239293306Sallanjude TAILQ_ENTRY(g_eli_key) gek_next; 240293306Sallanjude /* Keeps keys sorted by number. */ 241293306Sallanjude RB_ENTRY(g_eli_key) gek_link; 242293306Sallanjude}; 243293306Sallanjude 244148456Spjdstruct g_eli_metadata { 245148456Spjd char md_magic[16]; /* Magic value. */ 246148456Spjd uint32_t md_version; /* Version number. */ 247148456Spjd uint32_t md_flags; /* Additional flags. */ 248159307Spjd uint16_t md_ealgo; /* Encryption algorithm. */ 249148456Spjd uint16_t md_keylen; /* Key length. */ 250159307Spjd uint16_t md_aalgo; /* Authentication algorithm. */ 251148456Spjd uint64_t md_provsize; /* Provider's size. */ 252148456Spjd uint32_t md_sectorsize; /* Sector size. */ 253148456Spjd uint8_t md_keys; /* Available keys. */ 254149303Spjd int32_t md_iterations; /* Number of iterations for PKCS#5v2. */ 255148456Spjd uint8_t md_salt[G_ELI_SALTLEN]; /* Salt. */ 256148456Spjd /* Encrypted master key (IV-key, Data-key, HMAC). */ 257148456Spjd uint8_t md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN]; 258148456Spjd u_char md_hash[16]; /* MD5 hash. */ 259149323Spjd} __packed; 260148456Spjd#ifndef _OpenSSL_ 261148456Spjdstatic __inline void 262226733Spjdeli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap) 263148456Spjd{ 264148456Spjd u_char *p; 265148456Spjd 266226733Spjd p = *datap; 267148456Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 268159307Spjd le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 269148456Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 270226733Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 271226733Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 272226733Spjd *p = md->md_keys; p += sizeof(md->md_keys); 273226733Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 274226733Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 275226733Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 276226733Spjd *datap = p; 277226733Spjd} 278226733Spjdstatic __inline void 279238116Spjdeli_metadata_encode_v1v2v3v4v5v6v7(struct g_eli_metadata *md, u_char **datap) 280226733Spjd{ 281226733Spjd u_char *p; 282226733Spjd 283226733Spjd p = *datap; 284226733Spjd le32enc(p, md->md_flags); p += sizeof(md->md_flags); 285226733Spjd le16enc(p, md->md_ealgo); p += sizeof(md->md_ealgo); 286226733Spjd le16enc(p, md->md_keylen); p += sizeof(md->md_keylen); 287159307Spjd le16enc(p, md->md_aalgo); p += sizeof(md->md_aalgo); 288148456Spjd le64enc(p, md->md_provsize); p += sizeof(md->md_provsize); 289148456Spjd le32enc(p, md->md_sectorsize); p += sizeof(md->md_sectorsize); 290148456Spjd *p = md->md_keys; p += sizeof(md->md_keys); 291148456Spjd le32enc(p, md->md_iterations); p += sizeof(md->md_iterations); 292148456Spjd bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt); 293148456Spjd bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 294226733Spjd *datap = p; 295226733Spjd} 296226733Spjdstatic __inline void 297226733Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data) 298226733Spjd{ 299332522Skevans uint32_t hash[4]; 300226733Spjd MD5_CTX ctx; 301226733Spjd u_char *p; 302226733Spjd 303226733Spjd p = data; 304226733Spjd bcopy(md->md_magic, p, sizeof(md->md_magic)); 305226733Spjd p += sizeof(md->md_magic); 306226733Spjd le32enc(p, md->md_version); 307226733Spjd p += sizeof(md->md_version); 308226733Spjd switch (md->md_version) { 309226733Spjd case G_ELI_VERSION_00: 310226733Spjd eli_metadata_encode_v0(md, &p); 311226733Spjd break; 312226733Spjd case G_ELI_VERSION_01: 313226733Spjd case G_ELI_VERSION_02: 314226733Spjd case G_ELI_VERSION_03: 315226733Spjd case G_ELI_VERSION_04: 316226733Spjd case G_ELI_VERSION_05: 317226733Spjd case G_ELI_VERSION_06: 318238116Spjd case G_ELI_VERSION_07: 319238116Spjd eli_metadata_encode_v1v2v3v4v5v6v7(md, &p); 320226733Spjd break; 321226733Spjd default: 322226733Spjd#ifdef _KERNEL 323226733Spjd panic("%s: Unsupported version %u.", __func__, 324226733Spjd (u_int)md->md_version); 325226733Spjd#else 326226733Spjd assert(!"Unsupported metadata version."); 327226733Spjd#endif 328226733Spjd } 329148456Spjd MD5Init(&ctx); 330148456Spjd MD5Update(&ctx, data, p - data); 331332522Skevans MD5Final((void *)hash, &ctx); 332332522Skevans bcopy(hash, md->md_hash, sizeof(md->md_hash)); 333148456Spjd bcopy(md->md_hash, p, sizeof(md->md_hash)); 334148456Spjd} 335148456Spjdstatic __inline int 336148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md) 337148456Spjd{ 338332522Skevans uint32_t hash[4]; 339148456Spjd MD5_CTX ctx; 340148456Spjd const u_char *p; 341148456Spjd 342148456Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 343148456Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 344159307Spjd md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 345148456Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 346148456Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 347148456Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 348148456Spjd md->md_keys = *p; p += sizeof(md->md_keys); 349148456Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 350148456Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 351148456Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 352148456Spjd MD5Init(&ctx); 353148456Spjd MD5Update(&ctx, data, p - data); 354332522Skevans MD5Final((void *)hash, &ctx); 355332522Skevans bcopy(hash, md->md_hash, sizeof(md->md_hash)); 356148456Spjd if (bcmp(md->md_hash, p, 16) != 0) 357148456Spjd return (EINVAL); 358148456Spjd return (0); 359148456Spjd} 360212845Sbrian 361148456Spjdstatic __inline int 362238116Spjdeli_metadata_decode_v1v2v3v4v5v6v7(const u_char *data, struct g_eli_metadata *md) 363159307Spjd{ 364332522Skevans uint32_t hash[4]; 365159307Spjd MD5_CTX ctx; 366159307Spjd const u_char *p; 367159307Spjd 368159307Spjd p = data + sizeof(md->md_magic) + sizeof(md->md_version); 369159307Spjd md->md_flags = le32dec(p); p += sizeof(md->md_flags); 370159307Spjd md->md_ealgo = le16dec(p); p += sizeof(md->md_ealgo); 371159307Spjd md->md_keylen = le16dec(p); p += sizeof(md->md_keylen); 372159307Spjd md->md_aalgo = le16dec(p); p += sizeof(md->md_aalgo); 373159307Spjd md->md_provsize = le64dec(p); p += sizeof(md->md_provsize); 374159307Spjd md->md_sectorsize = le32dec(p); p += sizeof(md->md_sectorsize); 375159307Spjd md->md_keys = *p; p += sizeof(md->md_keys); 376159307Spjd md->md_iterations = le32dec(p); p += sizeof(md->md_iterations); 377159307Spjd bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt); 378159307Spjd bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys); 379159307Spjd MD5Init(&ctx); 380159307Spjd MD5Update(&ctx, data, p - data); 381332522Skevans MD5Final((void *)hash, &ctx); 382332522Skevans bcopy(hash, md->md_hash, sizeof(md->md_hash)); 383159307Spjd if (bcmp(md->md_hash, p, 16) != 0) 384159307Spjd return (EINVAL); 385159307Spjd return (0); 386159307Spjd} 387159307Spjdstatic __inline int 388148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md) 389148456Spjd{ 390148456Spjd int error; 391148456Spjd 392148456Spjd bcopy(data, md->md_magic, sizeof(md->md_magic)); 393226730Spjd if (strcmp(md->md_magic, G_ELI_MAGIC) != 0) 394226730Spjd return (EINVAL); 395148456Spjd md->md_version = le32dec(data + sizeof(md->md_magic)); 396148456Spjd switch (md->md_version) { 397221629Spjd case G_ELI_VERSION_00: 398148456Spjd error = eli_metadata_decode_v0(data, md); 399148456Spjd break; 400221629Spjd case G_ELI_VERSION_01: 401221629Spjd case G_ELI_VERSION_02: 402221629Spjd case G_ELI_VERSION_03: 403221629Spjd case G_ELI_VERSION_04: 404221629Spjd case G_ELI_VERSION_05: 405221629Spjd case G_ELI_VERSION_06: 406238116Spjd case G_ELI_VERSION_07: 407238116Spjd error = eli_metadata_decode_v1v2v3v4v5v6v7(data, md); 408159307Spjd break; 409148456Spjd default: 410226721Spjd error = EOPNOTSUPP; 411148456Spjd break; 412148456Spjd } 413148456Spjd return (error); 414148456Spjd} 415148456Spjd#endif /* !_OpenSSL */ 416148456Spjd 417148456Spjdstatic __inline u_int 418159307Spjdg_eli_str2ealgo(const char *name) 419148456Spjd{ 420148456Spjd 421148867Spjd if (strcasecmp("null", name) == 0) 422148456Spjd return (CRYPTO_NULL_CBC); 423213070Spjd else if (strcasecmp("null-cbc", name) == 0) 424213070Spjd return (CRYPTO_NULL_CBC); 425148867Spjd else if (strcasecmp("aes", name) == 0) 426213070Spjd return (CRYPTO_AES_XTS); 427213070Spjd else if (strcasecmp("aes-cbc", name) == 0) 428148456Spjd return (CRYPTO_AES_CBC); 429213070Spjd else if (strcasecmp("aes-xts", name) == 0) 430213070Spjd return (CRYPTO_AES_XTS); 431148867Spjd else if (strcasecmp("blowfish", name) == 0) 432148456Spjd return (CRYPTO_BLF_CBC); 433213070Spjd else if (strcasecmp("blowfish-cbc", name) == 0) 434213070Spjd return (CRYPTO_BLF_CBC); 435172031Spjd else if (strcasecmp("camellia", name) == 0) 436172031Spjd return (CRYPTO_CAMELLIA_CBC); 437213070Spjd else if (strcasecmp("camellia-cbc", name) == 0) 438213070Spjd return (CRYPTO_CAMELLIA_CBC); 439148867Spjd else if (strcasecmp("3des", name) == 0) 440148456Spjd return (CRYPTO_3DES_CBC); 441213070Spjd else if (strcasecmp("3des-cbc", name) == 0) 442213070Spjd return (CRYPTO_3DES_CBC); 443148456Spjd return (CRYPTO_ALGORITHM_MIN - 1); 444148456Spjd} 445148456Spjd 446159307Spjdstatic __inline u_int 447159307Spjdg_eli_str2aalgo(const char *name) 448159307Spjd{ 449159307Spjd 450159307Spjd if (strcasecmp("hmac/md5", name) == 0) 451159307Spjd return (CRYPTO_MD5_HMAC); 452159307Spjd else if (strcasecmp("hmac/sha1", name) == 0) 453159307Spjd return (CRYPTO_SHA1_HMAC); 454159307Spjd else if (strcasecmp("hmac/ripemd160", name) == 0) 455159307Spjd return (CRYPTO_RIPEMD160_HMAC); 456159307Spjd else if (strcasecmp("hmac/sha256", name) == 0) 457159307Spjd return (CRYPTO_SHA2_256_HMAC); 458159307Spjd else if (strcasecmp("hmac/sha384", name) == 0) 459159307Spjd return (CRYPTO_SHA2_384_HMAC); 460159307Spjd else if (strcasecmp("hmac/sha512", name) == 0) 461159307Spjd return (CRYPTO_SHA2_512_HMAC); 462159307Spjd return (CRYPTO_ALGORITHM_MIN - 1); 463159307Spjd} 464159307Spjd 465148456Spjdstatic __inline const char * 466148456Spjdg_eli_algo2str(u_int algo) 467148456Spjd{ 468148456Spjd 469148456Spjd switch (algo) { 470148456Spjd case CRYPTO_NULL_CBC: 471148456Spjd return ("NULL"); 472148456Spjd case CRYPTO_AES_CBC: 473159307Spjd return ("AES-CBC"); 474213070Spjd case CRYPTO_AES_XTS: 475213070Spjd return ("AES-XTS"); 476148456Spjd case CRYPTO_BLF_CBC: 477159307Spjd return ("Blowfish-CBC"); 478172031Spjd case CRYPTO_CAMELLIA_CBC: 479172031Spjd return ("CAMELLIA-CBC"); 480148456Spjd case CRYPTO_3DES_CBC: 481159307Spjd return ("3DES-CBC"); 482159307Spjd case CRYPTO_MD5_HMAC: 483159307Spjd return ("HMAC/MD5"); 484159307Spjd case CRYPTO_SHA1_HMAC: 485159307Spjd return ("HMAC/SHA1"); 486159307Spjd case CRYPTO_RIPEMD160_HMAC: 487159307Spjd return ("HMAC/RIPEMD160"); 488159307Spjd case CRYPTO_SHA2_256_HMAC: 489159307Spjd return ("HMAC/SHA256"); 490159307Spjd case CRYPTO_SHA2_384_HMAC: 491159307Spjd return ("HMAC/SHA384"); 492159307Spjd case CRYPTO_SHA2_512_HMAC: 493159307Spjd return ("HMAC/SHA512"); 494148456Spjd } 495148456Spjd return ("unknown"); 496148456Spjd} 497148456Spjd 498148456Spjdstatic __inline void 499148456Spjdeli_metadata_dump(const struct g_eli_metadata *md) 500148456Spjd{ 501148456Spjd static const char hex[] = "0123456789abcdef"; 502148456Spjd char str[sizeof(md->md_mkeys) * 2 + 1]; 503148456Spjd u_int i; 504148456Spjd 505148456Spjd printf(" magic: %s\n", md->md_magic); 506148456Spjd printf(" version: %u\n", (u_int)md->md_version); 507148456Spjd printf(" flags: 0x%x\n", (u_int)md->md_flags); 508159307Spjd printf(" ealgo: %s\n", g_eli_algo2str(md->md_ealgo)); 509148456Spjd printf(" keylen: %u\n", (u_int)md->md_keylen); 510159307Spjd if (md->md_flags & G_ELI_FLAG_AUTH) 511159307Spjd printf(" aalgo: %s\n", g_eli_algo2str(md->md_aalgo)); 512148456Spjd printf(" provsize: %ju\n", (uintmax_t)md->md_provsize); 513148456Spjd printf("sectorsize: %u\n", (u_int)md->md_sectorsize); 514148456Spjd printf(" keys: 0x%02x\n", (u_int)md->md_keys); 515317859Smav printf("iterations: %d\n", (int)md->md_iterations); 516148456Spjd bzero(str, sizeof(str)); 517148456Spjd for (i = 0; i < sizeof(md->md_salt); i++) { 518148456Spjd str[i * 2] = hex[md->md_salt[i] >> 4]; 519148456Spjd str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f]; 520148456Spjd } 521149303Spjd printf(" Salt: %s\n", str); 522148456Spjd bzero(str, sizeof(str)); 523148456Spjd for (i = 0; i < sizeof(md->md_mkeys); i++) { 524148456Spjd str[i * 2] = hex[md->md_mkeys[i] >> 4]; 525148456Spjd str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f]; 526148456Spjd } 527148456Spjd printf("Master Key: %s\n", str); 528148456Spjd bzero(str, sizeof(str)); 529148456Spjd for (i = 0; i < 16; i++) { 530148456Spjd str[i * 2] = hex[md->md_hash[i] >> 4]; 531148456Spjd str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f]; 532148456Spjd } 533149303Spjd printf(" MD5 hash: %s\n", str); 534148456Spjd} 535148456Spjd 536148456Spjdstatic __inline u_int 537148456Spjdg_eli_keylen(u_int algo, u_int keylen) 538148456Spjd{ 539148456Spjd 540148456Spjd switch (algo) { 541148456Spjd case CRYPTO_NULL_CBC: 542148456Spjd if (keylen == 0) 543148456Spjd keylen = 64 * 8; 544148456Spjd else { 545148456Spjd if (keylen > 64 * 8) 546148456Spjd keylen = 0; 547148456Spjd } 548148456Spjd return (keylen); 549211927Spjd case CRYPTO_AES_CBC: 550172031Spjd case CRYPTO_CAMELLIA_CBC: 551148456Spjd switch (keylen) { 552148456Spjd case 0: 553148456Spjd return (128); 554148456Spjd case 128: 555148456Spjd case 192: 556148456Spjd case 256: 557148456Spjd return (keylen); 558148456Spjd default: 559148456Spjd return (0); 560148456Spjd } 561213070Spjd case CRYPTO_AES_XTS: 562213070Spjd switch (keylen) { 563213070Spjd case 0: 564213070Spjd return (128); 565213070Spjd case 128: 566213070Spjd case 256: 567213070Spjd return (keylen); 568213070Spjd default: 569213070Spjd return (0); 570213070Spjd } 571148456Spjd case CRYPTO_BLF_CBC: 572148456Spjd if (keylen == 0) 573148456Spjd return (128); 574148456Spjd if (keylen < 128 || keylen > 448) 575148456Spjd return (0); 576148456Spjd if ((keylen % 32) != 0) 577148456Spjd return (0); 578148456Spjd return (keylen); 579148456Spjd case CRYPTO_3DES_CBC: 580148456Spjd if (keylen == 0 || keylen == 192) 581148456Spjd return (192); 582148456Spjd return (0); 583148456Spjd default: 584148456Spjd return (0); 585148456Spjd } 586148456Spjd} 587148456Spjd 588159307Spjdstatic __inline u_int 589159307Spjdg_eli_hashlen(u_int algo) 590159307Spjd{ 591159307Spjd 592159307Spjd switch (algo) { 593159307Spjd case CRYPTO_MD5_HMAC: 594159307Spjd return (16); 595159307Spjd case CRYPTO_SHA1_HMAC: 596159307Spjd return (20); 597159307Spjd case CRYPTO_RIPEMD160_HMAC: 598159307Spjd return (20); 599159307Spjd case CRYPTO_SHA2_256_HMAC: 600159307Spjd return (32); 601159307Spjd case CRYPTO_SHA2_384_HMAC: 602159307Spjd return (48); 603159307Spjd case CRYPTO_SHA2_512_HMAC: 604159307Spjd return (64); 605159307Spjd } 606159307Spjd return (0); 607159307Spjd} 608159307Spjd 609293306Sallanjudestatic __inline void 610293306Sallanjudeeli_metadata_softc(struct g_eli_softc *sc, const struct g_eli_metadata *md, 611293306Sallanjude u_int sectorsize, off_t mediasize) 612293306Sallanjude{ 613293306Sallanjude 614293306Sallanjude sc->sc_version = md->md_version; 615293306Sallanjude sc->sc_inflight = 0; 616293306Sallanjude sc->sc_crypto = G_ELI_CRYPTO_UNKNOWN; 617293306Sallanjude sc->sc_flags = md->md_flags; 618293306Sallanjude /* Backward compatibility. */ 619293306Sallanjude if (md->md_version < G_ELI_VERSION_04) 620293306Sallanjude sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER; 621293306Sallanjude if (md->md_version < G_ELI_VERSION_05) 622293306Sallanjude sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY; 623293306Sallanjude if (md->md_version < G_ELI_VERSION_06 && 624293306Sallanjude (sc->sc_flags & G_ELI_FLAG_AUTH) != 0) { 625293306Sallanjude sc->sc_flags |= G_ELI_FLAG_FIRST_KEY; 626293306Sallanjude } 627293306Sallanjude if (md->md_version < G_ELI_VERSION_07) 628293306Sallanjude sc->sc_flags |= G_ELI_FLAG_ENC_IVKEY; 629293306Sallanjude sc->sc_ealgo = md->md_ealgo; 630293306Sallanjude 631293306Sallanjude if (sc->sc_flags & G_ELI_FLAG_AUTH) { 632293306Sallanjude sc->sc_akeylen = sizeof(sc->sc_akey) * 8; 633293306Sallanjude sc->sc_aalgo = md->md_aalgo; 634293306Sallanjude sc->sc_alen = g_eli_hashlen(sc->sc_aalgo); 635293306Sallanjude 636293306Sallanjude sc->sc_data_per_sector = sectorsize - sc->sc_alen; 637293306Sallanjude /* 638293306Sallanjude * Some hash functions (like SHA1 and RIPEMD160) generates hash 639293306Sallanjude * which length is not multiple of 128 bits, but we want data 640293306Sallanjude * length to be multiple of 128, so we can encrypt without 641293306Sallanjude * padding. The line below rounds down data length to multiple 642293306Sallanjude * of 128 bits. 643293306Sallanjude */ 644293306Sallanjude sc->sc_data_per_sector -= sc->sc_data_per_sector % 16; 645293306Sallanjude 646293306Sallanjude sc->sc_bytes_per_sector = 647293306Sallanjude (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1; 648293306Sallanjude sc->sc_bytes_per_sector *= sectorsize; 649293306Sallanjude } 650293306Sallanjude sc->sc_sectorsize = md->md_sectorsize; 651293306Sallanjude sc->sc_mediasize = mediasize; 652293306Sallanjude if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) 653293306Sallanjude sc->sc_mediasize -= sectorsize; 654293306Sallanjude if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) 655293306Sallanjude sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize); 656293306Sallanjude else { 657293306Sallanjude sc->sc_mediasize /= sc->sc_bytes_per_sector; 658293306Sallanjude sc->sc_mediasize *= sc->sc_sectorsize; 659293306Sallanjude } 660293306Sallanjude sc->sc_ekeylen = md->md_keylen; 661293306Sallanjude} 662293306Sallanjude 663148456Spjd#ifdef _KERNEL 664148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 665148456Spjd struct g_eli_metadata *md); 666148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp, 667148456Spjd struct g_provider *bpp, const struct g_eli_metadata *md, 668148456Spjd const u_char *mkey, int nkey); 669148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force); 670148456Spjd 671148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de); 672148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb); 673159307Spjd 674159307Spjdvoid g_eli_read_done(struct bio *bp); 675159307Spjdvoid g_eli_write_done(struct bio *bp); 676159307Spjdint g_eli_crypto_rerun(struct cryptop *crp); 677159307Spjd 678214118Spjdvoid g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker); 679159307Spjdvoid g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp); 680159307Spjd 681159307Spjdvoid g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp); 682159307Spjdvoid g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp); 683148456Spjd#endif 684293306Sallanjudevoid g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv, 685293306Sallanjude size_t size); 686148456Spjd 687148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key); 688148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md, 689344397Skevans const unsigned char *key, unsigned char *mkey, unsigned keyp); 690344397Skevansint g_eli_mkey_decrypt_any(const struct g_eli_metadata *md, 691148456Spjd const unsigned char *key, unsigned char *mkey, unsigned *nkeyp); 692148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen, 693148456Spjd unsigned char *mkey); 694159307Spjd#ifdef _KERNEL 695159307Spjdvoid g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey); 696159307Spjd#endif 697148456Spjd 698148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize, 699148456Spjd const u_char *key, size_t keysize); 700148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize, 701148456Spjd const u_char *key, size_t keysize); 702148456Spjd 703148456Spjdstruct hmac_ctx { 704327856Sasomers SHA512_CTX innerctx; 705327856Sasomers SHA512_CTX outerctx; 706148456Spjd}; 707148456Spjd 708148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey, 709148456Spjd size_t hkeylen); 710148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data, 711148456Spjd size_t datasize); 712148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize); 713148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize, 714148456Spjd const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize); 715220922Spjd 716293306Sallanjudevoid g_eli_key_fill(struct g_eli_softc *sc, struct g_eli_key *key, 717293306Sallanjude uint64_t keyno); 718220922Spjd#ifdef _KERNEL 719220922Spjdvoid g_eli_key_init(struct g_eli_softc *sc); 720220922Spjdvoid g_eli_key_destroy(struct g_eli_softc *sc); 721220922Spjduint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize); 722220922Spjdvoid g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey); 723220922Spjd#endif 724148456Spjd#endif /* !_G_ELI_H_ */ 725