providers/implementations/kdfs/krb5kdf.c

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