providers/implementations/kdfs/krb5kdf.c

   1 /*
   2  * Copyright 2018-2022 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*
  11  * DES low level APIs are deprecated for public use, but still ok for internal
  12  * use.  We access the DES_set_odd_parity(3) function here.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <stdlib.h>
  17 #include <stdarg.h>
  18 #include <string.h>
  19
  20 #include <openssl/core_names.h>
  21 #include <openssl/des.h>
  22 #include <openssl/evp.h>
  23 #include <openssl/kdf.h>
  24 #include <openssl/proverr.h>
  25
  26 #include "internal/cryptlib.h"
  27 #include "crypto/evp.h"
  28 #include "internal/numbers.h"
  29 #include "prov/implementations.h"
  30 #include "prov/provider_ctx.h"
  31 #include "prov/provider_util.h"
  32 #include "prov/providercommon.h"
  33
  34 /* KRB5 KDF defined in RFC 3961, Section 5.1 */
  35
  36 static OSSL_FUNC_kdf_newctx_fn krb5kdf_new;
  37 static OSSL_FUNC_kdf_dupctx_fn krb5kdf_dup;
  38 static OSSL_FUNC_kdf_freectx_fn krb5kdf_free;
  39 static OSSL_FUNC_kdf_reset_fn krb5kdf_reset;
  40 static OSSL_FUNC_kdf_derive_fn krb5kdf_derive;
  41 static OSSL_FUNC_kdf_settable_ctx_params_fn krb5kdf_settable_ctx_params;
  42 static OSSL_FUNC_kdf_set_ctx_params_fn krb5kdf_set_ctx_params;
  43 static OSSL_FUNC_kdf_gettable_ctx_params_fn krb5kdf_gettable_ctx_params;
  44 static OSSL_FUNC_kdf_get_ctx_params_fn krb5kdf_get_ctx_params;
  45
  46 static int KRB5KDF(const EVP_CIPHER *cipher, ENGINE *engine,
  47                    const unsigned char *key, size_t key_len,
  48                    const unsigned char *constant, size_t constant_len,
  49                    unsigned char *okey, size_t okey_len);
  50
  51 typedef struct {
  52     void *provctx;
  53     PROV_CIPHER cipher;
  54     unsigned char *key;
  55     size_t key_len;
  56     unsigned char *constant;
  57     size_t constant_len;
  58 } KRB5KDF_CTX;
  59
  60 static void *krb5kdf_new(void *provctx)
  61 {
  62     KRB5KDF_CTX *ctx;
  63
  64     if (!ossl_prov_is_running())
  65         return NULL;
  66
  67     if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL) {
  68         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  69         return NULL;
  70     }
  71     ctx->provctx = provctx;
  72     return ctx;
  73 }
  74
  75 static void krb5kdf_free(void *vctx)
  76 {
  77     KRB5KDF_CTX *ctx = (KRB5KDF_CTX *)vctx;
  78
  79     if (ctx != NULL) {
  80         krb5kdf_reset(ctx);
  81         OPENSSL_free(ctx);
  82     }
  83 }
  84
  85 static void krb5kdf_reset(void *vctx)
  86 {
  87     KRB5KDF_CTX *ctx = (KRB5KDF_CTX *)vctx;
  88     void *provctx = ctx->provctx;
  89
  90     ossl_prov_cipher_reset(&ctx->cipher);
  91     OPENSSL_clear_free(ctx->key, ctx->key_len);
  92     OPENSSL_clear_free(ctx->constant, ctx->constant_len);
  93     memset(ctx, 0, sizeof(*ctx));
  94     ctx->provctx = provctx;
  95 }
  96
  97 static int krb5kdf_set_membuf(unsigned char **dst, size_t *dst_len,
  98                               const OSSL_PARAM *p)
  99 {
 100     OPENSSL_clear_free(*dst, *dst_len);
 101     *dst = NULL;
 102     *dst_len = 0;
 103     return OSSL_PARAM_get_octet_string(p, (void **)dst, 0, dst_len);
 104 }
 105
 106 static void *krb5kdf_dup(void *vctx)
 107 {
 108     const KRB5KDF_CTX *src = (const KRB5KDF_CTX *)vctx;
 109     KRB5KDF_CTX *dest;
 110
 111     dest = krb5kdf_new(src->provctx);
 112     if (dest != NULL) {
 113         if (!ossl_prov_memdup(src->key, src->key_len,
 114                               &dest->key, &dest->key_len)
 115                 || !ossl_prov_memdup(src->constant, src->constant_len,
 116                                      &dest->constant , &dest->constant_len)
 117                 || !ossl_prov_cipher_copy(&dest->cipher, &src->cipher))
 118             goto err;
 119     }
 120     return dest;
 121
 122  err:
 123     krb5kdf_free(dest);
 124     return NULL;
 125 }
 126
 127 static int krb5kdf_derive(void *vctx, unsigned char *key, size_t keylen,
 128                           const OSSL_PARAM params[])
 129 {
 130     KRB5KDF_CTX *ctx = (KRB5KDF_CTX *)vctx;
 131     const EVP_CIPHER *cipher;
 132     ENGINE *engine;
 133
 134     if (!ossl_prov_is_running() || !krb5kdf_set_ctx_params(ctx, params))
 135         return 0;
 136
 137     cipher = ossl_prov_cipher_cipher(&ctx->cipher);
 138     if (cipher == NULL) {
 139         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CIPHER);
 140         return 0;
 141     }
 142     if (ctx->key == NULL) {
 143         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
 144         return 0;
 145     }
 146     if (ctx->constant == NULL) {
 147         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CONSTANT);
 148         return 0;
 149     }
 150     engine = ossl_prov_cipher_engine(&ctx->cipher);
 151     return KRB5KDF(cipher, engine, ctx->key, ctx->key_len,
 152                    ctx->constant, ctx->constant_len,
 153                    key, keylen);
 154 }
 155
 156 static int krb5kdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 157 {
 158     const OSSL_PARAM *p;
 159     KRB5KDF_CTX *ctx = vctx;
 160     OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
 161
 162     if (params == NULL)
 163         return 1;
 164
 165     if (!ossl_prov_cipher_load_from_params(&ctx->cipher, params, provctx))
 166         return 0;
 167
 168     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL)
 169         if (!krb5kdf_set_membuf(&ctx->key, &ctx->key_len, p))
 170             return 0;
 171
 172     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_CONSTANT))
 173         != NULL)
 174         if (!krb5kdf_set_membuf(&ctx->constant, &ctx->constant_len, p))
 175             return 0;
 176
 177     return 1;
 178 }
 179
 180 static const OSSL_PARAM *krb5kdf_settable_ctx_params(ossl_unused void *ctx,
 181                                                      ossl_unused void *provctx)
 182 {
 183     static const OSSL_PARAM known_settable_ctx_params[] = {
 184         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
 185         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CIPHER, NULL, 0),
 186         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
 187         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_CONSTANT, NULL, 0),
 188         OSSL_PARAM_END
 189     };
 190     return known_settable_ctx_params;
 191 }
 192
 193 static int krb5kdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
 194 {
 195     KRB5KDF_CTX *ctx = (KRB5KDF_CTX *)vctx;
 196     const EVP_CIPHER *cipher;
 197     size_t len;
 198     OSSL_PARAM *p;
 199
 200     cipher = ossl_prov_cipher_cipher(&ctx->cipher);
 201     if (cipher)
 202         len = EVP_CIPHER_get_key_length(cipher);
 203     else
 204         len = EVP_MAX_KEY_LENGTH;
 205
 206     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
 207         return OSSL_PARAM_set_size_t(p, len);
 208     return -2;
 209 }
 210
 211 static const OSSL_PARAM *krb5kdf_gettable_ctx_params(ossl_unused void *ctx,
 212                                                      ossl_unused void *provctx)
 213 {
 214     static const OSSL_PARAM known_gettable_ctx_params[] = {
 215         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
 216         OSSL_PARAM_END
 217     };
 218     return known_gettable_ctx_params;
 219 }
 220
 221 const OSSL_DISPATCH ossl_kdf_krb5kdf_functions[] = {
 222     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))krb5kdf_new },
 223     { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))krb5kdf_dup },
 224     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))krb5kdf_free },
 225     { OSSL_FUNC_KDF_RESET, (void(*)(void))krb5kdf_reset },
 226     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))krb5kdf_derive },
 227     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
 228       (void(*)(void))krb5kdf_settable_ctx_params },
 229     { OSSL_FUNC_KDF_SET_CTX_PARAMS,
 230       (void(*)(void))krb5kdf_set_ctx_params },
 231     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
 232       (void(*)(void))krb5kdf_gettable_ctx_params },
 233     { OSSL_FUNC_KDF_GET_CTX_PARAMS,
 234       (void(*)(void))krb5kdf_get_ctx_params },
 235     { 0, NULL }
 236 };
 237
 238 #ifndef OPENSSL_NO_DES
 239 /*
 240  * DES3 is a special case, it requires a random-to-key function and its
 241  * input truncated to 21 bytes of the 24 produced by the cipher.
 242  * See RFC3961 6.3.1
 243  */
 244 static int fixup_des3_key(unsigned char *key)
 245 {
 246     unsigned char *cblock;
 247     int i, j;
 248
 249     for (i = 2; i >= 0; i--) {
 250         cblock = &key[i * 8];
 251         memmove(cblock, &key[i * 7], 7);
 252         cblock[7] = 0;
 253         for (j = 0; j < 7; j++)
 254             cblock[7] |= (cblock[j] & 1) << (j + 1);
 255         DES_set_odd_parity((DES_cblock *)cblock);
 256     }
 257
 258     /* fail if keys are such that triple des degrades to single des */
 259     if (CRYPTO_memcmp(&key[0], &key[8], 8) == 0 ||
 260         CRYPTO_memcmp(&key[8], &key[16], 8) == 0) {
 261         return 0;
 262     }
 263
 264     return 1;
 265 }
 266 #endif
 267
 268 /*
 269  * N-fold(K) where blocksize is N, and constant_len is K
 270  * Note: Here |= denotes concatenation
 271  *
 272  * L = lcm(N,K)
 273  * R = L/K
 274  *
 275  * for r: 1 -> R
 276  *   s |= constant rot 13*(r-1))
 277  *
 278  * block = 0
 279  * for k: 1 -> K
 280  *   block += s[N(k-1)..(N-1)k] (one's complement addition)
 281  *
 282  * Optimizing for space we compute:
 283  * for each l in L-1 -> 0:
 284  *   s[l] = (constant rot 13*(l/K))[l%k]
 285  *   block[l % N] += s[l] (with carry)
 286  * finally add carry if any
 287  */
 288 static void n_fold(unsigned char *block, unsigned int blocksize,
 289                    const unsigned char *constant, size_t constant_len)
 290 {
 291     unsigned int tmp, gcd, remainder, lcm, carry;
 292     int b, l;
 293
 294     if (constant_len == blocksize) {
 295         memcpy(block, constant, constant_len);
 296         return;
 297     }
 298
 299     /* Least Common Multiple of lengths: LCM(a,b)*/
 300     gcd = blocksize;
 301     remainder = constant_len;
 302     /* Calculate Great Common Divisor first GCD(a,b) */
 303     while (remainder != 0) {
 304         tmp = gcd % remainder;
 305         gcd = remainder;
 306         remainder = tmp;
 307     }
 308     /* resulting a is the GCD, LCM(a,b) = |a*b|/GCD(a,b) */
 309     lcm = blocksize * constant_len / gcd;
 310
 311     /* now spread out the bits */
 312     memset(block, 0, blocksize);
 313
 314     /* last to first to be able to bring carry forward */
 315     carry = 0;
 316     for (l = lcm - 1; l >= 0; l--) {
 317         unsigned int rotbits, rshift, rbyte;
 318
 319         /* destination byte in block is l % N */
 320         b = l % blocksize;
 321         /* Our virtual s buffer is R = L/K long (K = constant_len) */
 322         /* So we rotate backwards from R-1 to 0 (none) rotations */
 323         rotbits = 13 * (l / constant_len);
 324         /* find the byte on s where rotbits falls onto */
 325         rbyte = l - (rotbits / 8);
 326         /* calculate how much shift on that byte */
 327         rshift = rotbits & 0x07;
 328         /* rbyte % constant_len gives us the unrotated byte in the
 329          * constant buffer, get also the previous byte then
 330          * appropriately shift them to get the rotated byte we need */
 331         tmp = (constant[(rbyte-1) % constant_len] << (8 - rshift)
 332                | constant[rbyte % constant_len] >> rshift)
 333               & 0xff;
 334         /* add with carry to any value placed by previous passes */
 335         tmp += carry + block[b];
 336         block[b] = tmp & 0xff;
 337         /* save any carry that may be left */
 338         carry = tmp >> 8;
 339     }
 340
 341     /* if any carry is left at the end, add it through the number */
 342     for (b = blocksize - 1; b >= 0 && carry != 0; b--) {
 343         carry += block[b];
 344         block[b] = carry & 0xff;
 345         carry >>= 8;
 346     }
 347 }
 348
 349 static int cipher_init(EVP_CIPHER_CTX *ctx,
 350                        const EVP_CIPHER *cipher, ENGINE *engine,
 351                        const unsigned char *key, size_t key_len)
 352 {
 353     int klen, ret;
 354
 355     ret = EVP_EncryptInit_ex(ctx, cipher, engine, key, NULL);
 356     if (!ret)
 357         goto out;
 358     /* set the key len for the odd variable key len cipher */
 359     klen = EVP_CIPHER_CTX_get_key_length(ctx);
 360     if (key_len != (size_t)klen) {
 361         ret = EVP_CIPHER_CTX_set_key_length(ctx, key_len);
 362         if (!ret)
 363             goto out;
 364     }
 365     /* we never want padding, either the length requested is a multiple of
 366      * the cipher block size or we are passed a cipher that can cope with
 367      * partial blocks via techniques like cipher text stealing */
 368     ret = EVP_CIPHER_CTX_set_padding(ctx, 0);
 369     if (!ret)
 370         goto out;
 371
 372 out:
 373     return ret;
 374 }
 375
 376 static int KRB5KDF(const EVP_CIPHER *cipher, ENGINE *engine,
 377                    const unsigned char *key, size_t key_len,
 378                    const unsigned char *constant, size_t constant_len,
 379                    unsigned char *okey, size_t okey_len)
 380 {
 381     EVP_CIPHER_CTX *ctx = NULL;
 382     unsigned char block[EVP_MAX_BLOCK_LENGTH * 2];
 383     unsigned char *plainblock, *cipherblock;
 384     size_t blocksize;
 385     size_t cipherlen;
 386     size_t osize;
 387 #ifndef OPENSSL_NO_DES
 388     int des3_no_fixup = 0;
 389 #endif
 390     int ret;
 391
 392     if (key_len != okey_len) {
 393 #ifndef OPENSSL_NO_DES
 394         /* special case for 3des, where the caller may be requesting
 395          * the random raw key, instead of the fixed up key  */
 396         if (EVP_CIPHER_get_nid(cipher) == NID_des_ede3_cbc &&
 397             key_len == 24 && okey_len == 21) {
 398                 des3_no_fixup = 1;
 399         } else {
 400 #endif
 401             ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
 402             return 0;
 403 #ifndef OPENSSL_NO_DES
 404         }
 405 #endif
 406     }
 407
 408     ctx = EVP_CIPHER_CTX_new();
 409     if (ctx == NULL)
 410         return 0;
 411
 412     ret = cipher_init(ctx, cipher, engine, key, key_len);
 413     if (!ret)
 414         goto out;
 415
 416     /* Initialize input block */
 417     blocksize = EVP_CIPHER_CTX_get_block_size(ctx);
 418
 419     if (constant_len > blocksize) {
 420         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CONSTANT_LENGTH);
 421         ret = 0;
 422         goto out;
 423     }
 424
 425     n_fold(block, blocksize, constant, constant_len);
 426     plainblock = block;
 427     cipherblock = block + EVP_MAX_BLOCK_LENGTH;
 428
 429     for (osize = 0; osize < okey_len; osize += cipherlen) {
 430         int olen;
 431
 432         ret = EVP_EncryptUpdate(ctx, cipherblock, &olen,
 433                                 plainblock, blocksize);
 434         if (!ret)
 435             goto out;
 436         cipherlen = olen;
 437         ret = EVP_EncryptFinal_ex(ctx, cipherblock, &olen);
 438         if (!ret)
 439             goto out;
 440         if (olen != 0) {
 441             ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
 442             ret = 0;
 443             goto out;
 444         }
 445
 446         /* write cipherblock out */
 447         if (cipherlen > okey_len - osize)
 448             cipherlen = okey_len - osize;
 449         memcpy(okey + osize, cipherblock, cipherlen);
 450
 451         if (okey_len > osize + cipherlen) {
 452             /* we need to reinitialize cipher context per spec */
 453             ret = EVP_CIPHER_CTX_reset(ctx);
 454             if (!ret)
 455                 goto out;
 456             ret = cipher_init(ctx, cipher, engine, key, key_len);
 457             if (!ret)
 458                 goto out;
 459
 460             /* also swap block offsets so last ciphertext becomes new
 461              * plaintext */
 462             plainblock = cipherblock;
 463             if (cipherblock == block) {
 464                 cipherblock += EVP_MAX_BLOCK_LENGTH;
 465             } else {
 466                 cipherblock = block;
 467             }
 468         }
 469     }
 470
 471 #ifndef OPENSSL_NO_DES
 472     if (EVP_CIPHER_get_nid(cipher) == NID_des_ede3_cbc && !des3_no_fixup) {
 473         ret = fixup_des3_key(okey);
 474         if (!ret) {
 475             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
 476             goto out;
 477         }
 478     }
 479 #endif
 480
 481     ret = 1;
 482
 483 out:
 484     EVP_CIPHER_CTX_free(ctx);
 485     OPENSSL_cleanse(block, EVP_MAX_BLOCK_LENGTH * 2);
 486     return ret;
 487 }
 488