Blame crypto/kdf/hkdf.c

Packit c4476c
/*
Packit c4476c
 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
#include <stdlib.h>
Packit c4476c
#include <stdarg.h>
Packit c4476c
#include <string.h>
Packit c4476c
#include <openssl/hmac.h>
Packit c4476c
#include <openssl/kdf.h>
Packit c4476c
#include <openssl/evp.h>
Packit c4476c
#include "internal/numbers.h"
Packit c4476c
#include "internal/cryptlib.h"
Packit c4476c
#include "crypto/evp.h"
Packit c4476c
#include "kdf_local.h"
Packit c4476c
Packit c4476c
#define HKDF_MAXBUF 1024
Packit c4476c
Packit c4476c
static void kdf_hkdf_reset(EVP_KDF_IMPL *impl);
Packit c4476c
static int HKDF(const EVP_MD *evp_md,
Packit c4476c
                const unsigned char *salt, size_t salt_len,
Packit c4476c
                const unsigned char *key, size_t key_len,
Packit c4476c
                const unsigned char *info, size_t info_len,
Packit c4476c
                unsigned char *okm, size_t okm_len);
Packit c4476c
static int HKDF_Extract(const EVP_MD *evp_md,
Packit c4476c
                        const unsigned char *salt, size_t salt_len,
Packit c4476c
                        const unsigned char *key, size_t key_len,
Packit c4476c
                        unsigned char *prk, size_t prk_len);
Packit c4476c
static int HKDF_Expand(const EVP_MD *evp_md,
Packit c4476c
                       const unsigned char *prk, size_t prk_len,
Packit c4476c
                       const unsigned char *info, size_t info_len,
Packit c4476c
                       unsigned char *okm, size_t okm_len);
Packit c4476c
Packit c4476c
struct evp_kdf_impl_st {
Packit c4476c
    int mode;
Packit c4476c
    const EVP_MD *md;
Packit c4476c
    unsigned char *salt;
Packit c4476c
    size_t salt_len;
Packit c4476c
    unsigned char *key;
Packit c4476c
    size_t key_len;
Packit c4476c
    unsigned char info[HKDF_MAXBUF];
Packit c4476c
    size_t info_len;
Packit c4476c
};
Packit c4476c
Packit c4476c
static EVP_KDF_IMPL *kdf_hkdf_new(void)
Packit c4476c
{
Packit c4476c
    EVP_KDF_IMPL *impl;
Packit c4476c
Packit c4476c
    if ((impl = OPENSSL_zalloc(sizeof(*impl))) == NULL)
Packit c4476c
        KDFerr(KDF_F_KDF_HKDF_NEW, ERR_R_MALLOC_FAILURE);
Packit c4476c
    return impl;
Packit c4476c
}
Packit c4476c
Packit c4476c
static void kdf_hkdf_free(EVP_KDF_IMPL *impl)
Packit c4476c
{
Packit c4476c
    kdf_hkdf_reset(impl);
Packit c4476c
    OPENSSL_free(impl);
Packit c4476c
}
Packit c4476c
Packit c4476c
static void kdf_hkdf_reset(EVP_KDF_IMPL *impl)
Packit c4476c
{
Packit c4476c
    OPENSSL_free(impl->salt);
Packit c4476c
    OPENSSL_clear_free(impl->key, impl->key_len);
Packit c4476c
    OPENSSL_cleanse(impl->info, impl->info_len);
Packit c4476c
    memset(impl, 0, sizeof(*impl));
Packit c4476c
}
Packit c4476c
Packit c4476c
static int kdf_hkdf_ctrl(EVP_KDF_IMPL *impl, int cmd, va_list args)
Packit c4476c
{
Packit c4476c
    const unsigned char *p;
Packit c4476c
    size_t len;
Packit c4476c
    const EVP_MD *md;
Packit c4476c
Packit c4476c
    switch (cmd) {
Packit c4476c
    case EVP_KDF_CTRL_SET_MD:
Packit c4476c
        md = va_arg(args, const EVP_MD *);
Packit c4476c
        if (md == NULL)
Packit c4476c
            return 0;
Packit c4476c
Packit c4476c
        impl->md = md;
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    case EVP_KDF_CTRL_SET_HKDF_MODE:
Packit c4476c
        impl->mode = va_arg(args, int);
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    case EVP_KDF_CTRL_SET_SALT:
Packit c4476c
        p = va_arg(args, const unsigned char *);
Packit c4476c
        len = va_arg(args, size_t);
Packit c4476c
        if (len == 0 || p == NULL)
Packit c4476c
            return 1;
Packit c4476c
Packit c4476c
        OPENSSL_free(impl->salt);
Packit c4476c
        impl->salt = OPENSSL_memdup(p, len);
Packit c4476c
        if (impl->salt == NULL)
Packit c4476c
            return 0;
Packit c4476c
Packit c4476c
        impl->salt_len = len;
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    case EVP_KDF_CTRL_SET_KEY:
Packit c4476c
        p = va_arg(args, const unsigned char *);
Packit c4476c
        len = va_arg(args, size_t);
Packit c4476c
        OPENSSL_clear_free(impl->key, impl->key_len);
Packit c4476c
        impl->key = OPENSSL_memdup(p, len);
Packit c4476c
        if (impl->key == NULL)
Packit c4476c
            return 0;
Packit c4476c
Packit c4476c
        impl->key_len  = len;
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    case EVP_KDF_CTRL_RESET_HKDF_INFO:
Packit c4476c
        OPENSSL_cleanse(impl->info, impl->info_len);
Packit c4476c
        impl->info_len = 0;
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    case EVP_KDF_CTRL_ADD_HKDF_INFO:
Packit c4476c
        p = va_arg(args, const unsigned char *);
Packit c4476c
        len = va_arg(args, size_t);
Packit c4476c
        if (len == 0 || p == NULL)
Packit c4476c
            return 1;
Packit c4476c
Packit c4476c
        if (len > (HKDF_MAXBUF - impl->info_len))
Packit c4476c
            return 0;
Packit c4476c
Packit c4476c
        memcpy(impl->info + impl->info_len, p, len);
Packit c4476c
        impl->info_len += len;
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    default:
Packit c4476c
        return -2;
Packit c4476c
    }
Packit c4476c
}
Packit c4476c
Packit c4476c
static int kdf_hkdf_ctrl_str(EVP_KDF_IMPL *impl, const char *type,
Packit c4476c
                             const char *value)
Packit c4476c
{
Packit c4476c
    if (strcmp(type, "mode") == 0) {
Packit c4476c
        int mode;
Packit c4476c
Packit c4476c
        if (strcmp(value, "EXTRACT_AND_EXPAND") == 0)
Packit c4476c
            mode = EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND;
Packit c4476c
        else if (strcmp(value, "EXTRACT_ONLY") == 0)
Packit c4476c
            mode = EVP_KDF_HKDF_MODE_EXTRACT_ONLY;
Packit c4476c
        else if (strcmp(value, "EXPAND_ONLY") == 0)
Packit c4476c
            mode = EVP_KDF_HKDF_MODE_EXPAND_ONLY;
Packit c4476c
        else
Packit c4476c
            return 0;
Packit c4476c
Packit c4476c
        return call_ctrl(kdf_hkdf_ctrl, impl, EVP_KDF_CTRL_SET_HKDF_MODE, mode);
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (strcmp(type, "digest") == 0)
Packit c4476c
        return kdf_md2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_SET_MD, value);
Packit c4476c
Packit c4476c
    if (strcmp(type, "salt") == 0)
Packit c4476c
        return kdf_str2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_SET_SALT, value);
Packit c4476c
Packit c4476c
    if (strcmp(type, "hexsalt") == 0)
Packit c4476c
        return kdf_hex2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_SET_SALT, value);
Packit c4476c
Packit c4476c
    if (strcmp(type, "key") == 0)
Packit c4476c
        return kdf_str2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_SET_KEY, value);
Packit c4476c
Packit c4476c
    if (strcmp(type, "hexkey") == 0)
Packit c4476c
        return kdf_hex2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_SET_KEY, value);
Packit c4476c
Packit c4476c
    if (strcmp(type, "info") == 0)
Packit c4476c
        return kdf_str2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_ADD_HKDF_INFO,
Packit c4476c
                            value);
Packit c4476c
Packit c4476c
    if (strcmp(type, "hexinfo") == 0)
Packit c4476c
        return kdf_hex2ctrl(impl, kdf_hkdf_ctrl, EVP_KDF_CTRL_ADD_HKDF_INFO,
Packit c4476c
                            value);
Packit c4476c
Packit c4476c
    return -2;
Packit c4476c
}
Packit c4476c
Packit c4476c
static size_t kdf_hkdf_size(EVP_KDF_IMPL *impl)
Packit c4476c
{
Packit c4476c
    if (impl->mode != EVP_KDF_HKDF_MODE_EXTRACT_ONLY)
Packit c4476c
        return SIZE_MAX;
Packit c4476c
Packit c4476c
    if (impl->md == NULL) {
Packit c4476c
        KDFerr(KDF_F_KDF_HKDF_SIZE, KDF_R_MISSING_MESSAGE_DIGEST);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return EVP_MD_size(impl->md);
Packit c4476c
}
Packit c4476c
Packit c4476c
static int kdf_hkdf_derive(EVP_KDF_IMPL *impl, unsigned char *key,
Packit c4476c
                           size_t keylen)
Packit c4476c
{
Packit c4476c
    if (impl->md == NULL) {
Packit c4476c
        KDFerr(KDF_F_KDF_HKDF_DERIVE, KDF_R_MISSING_MESSAGE_DIGEST);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    if (impl->key == NULL) {
Packit c4476c
        KDFerr(KDF_F_KDF_HKDF_DERIVE, KDF_R_MISSING_KEY);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    switch (impl->mode) {
Packit c4476c
    case EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND:
Packit c4476c
        return HKDF(impl->md, impl->salt, impl->salt_len, impl->key,
Packit c4476c
                    impl->key_len, impl->info, impl->info_len, key,
Packit c4476c
                    keylen);
Packit c4476c
Packit c4476c
    case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
Packit c4476c
        return HKDF_Extract(impl->md, impl->salt, impl->salt_len, impl->key,
Packit c4476c
                            impl->key_len, key, keylen);
Packit c4476c
Packit c4476c
    case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
Packit c4476c
        return HKDF_Expand(impl->md, impl->key, impl->key_len, impl->info,
Packit c4476c
                           impl->info_len, key, keylen);
Packit c4476c
Packit c4476c
    default:
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
}
Packit c4476c
Packit c4476c
const EVP_KDF_METHOD hkdf_kdf_meth = {
Packit c4476c
    EVP_KDF_HKDF,
Packit c4476c
    kdf_hkdf_new,
Packit c4476c
    kdf_hkdf_free,
Packit c4476c
    kdf_hkdf_reset,
Packit c4476c
    kdf_hkdf_ctrl,
Packit c4476c
    kdf_hkdf_ctrl_str,
Packit c4476c
    kdf_hkdf_size,
Packit c4476c
    kdf_hkdf_derive
Packit c4476c
};
Packit c4476c
Packit c4476c
const EVP_PKEY_METHOD *hkdf_pkey_method(void)
Packit c4476c
{
Packit c4476c
    return &hkdf_pkey_meth;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int HKDF(const EVP_MD *evp_md,
Packit c4476c
                const unsigned char *salt, size_t salt_len,
Packit c4476c
                const unsigned char *key, size_t key_len,
Packit c4476c
                const unsigned char *info, size_t info_len,
Packit c4476c
                unsigned char *okm, size_t okm_len)
Packit c4476c
{
Packit c4476c
    unsigned char prk[EVP_MAX_MD_SIZE];
Packit c4476c
    int ret;
Packit c4476c
    size_t prk_len = EVP_MD_size(evp_md);
Packit c4476c
Packit c4476c
    if (!HKDF_Extract(evp_md, salt, salt_len, key, key_len, prk, prk_len))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
Packit c4476c
    OPENSSL_cleanse(prk, sizeof(prk));
Packit c4476c
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int HKDF_Extract(const EVP_MD *evp_md,
Packit c4476c
                        const unsigned char *salt, size_t salt_len,
Packit c4476c
                        const unsigned char *key, size_t key_len,
Packit c4476c
                        unsigned char *prk, size_t prk_len)
Packit c4476c
{
Packit c4476c
    if (prk_len != (size_t)EVP_MD_size(evp_md)) {
Packit c4476c
        KDFerr(KDF_F_HKDF_EXTRACT, KDF_R_WRONG_OUTPUT_BUFFER_SIZE);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return HMAC(evp_md, salt, salt_len, key, key_len, prk, NULL) != NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int HKDF_Expand(const EVP_MD *evp_md,
Packit c4476c
                       const unsigned char *prk, size_t prk_len,
Packit c4476c
                       const unsigned char *info, size_t info_len,
Packit c4476c
                       unsigned char *okm, size_t okm_len)
Packit c4476c
{
Packit c4476c
    HMAC_CTX *hmac;
Packit c4476c
    int ret = 0;
Packit c4476c
    unsigned int i;
Packit c4476c
    unsigned char prev[EVP_MAX_MD_SIZE];
Packit c4476c
    size_t done_len = 0, dig_len = EVP_MD_size(evp_md);
Packit c4476c
    size_t n = okm_len / dig_len;
Packit c4476c
Packit c4476c
    if (okm_len % dig_len)
Packit c4476c
        n++;
Packit c4476c
Packit c4476c
    if (n > 255 || okm == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    if ((hmac = HMAC_CTX_new()) == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
Packit c4476c
        goto err;
Packit c4476c
Packit c4476c
    for (i = 1; i <= n; i++) {
Packit c4476c
        size_t copy_len;
Packit c4476c
        const unsigned char ctr = i;
Packit c4476c
Packit c4476c
        if (i > 1) {
Packit c4476c
            if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
Packit c4476c
                goto err;
Packit c4476c
Packit c4476c
            if (!HMAC_Update(hmac, prev, dig_len))
Packit c4476c
                goto err;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        if (!HMAC_Update(hmac, info, info_len))
Packit c4476c
            goto err;
Packit c4476c
Packit c4476c
        if (!HMAC_Update(hmac, &ctr, 1))
Packit c4476c
            goto err;
Packit c4476c
Packit c4476c
        if (!HMAC_Final(hmac, prev, NULL))
Packit c4476c
            goto err;
Packit c4476c
Packit c4476c
        copy_len = (done_len + dig_len > okm_len) ?
Packit c4476c
                       okm_len - done_len :
Packit c4476c
                       dig_len;
Packit c4476c
Packit c4476c
        memcpy(okm + done_len, prev, copy_len);
Packit c4476c
Packit c4476c
        done_len += copy_len;
Packit c4476c
    }
Packit c4476c
    ret = 1;
Packit c4476c
Packit c4476c
 err:
Packit c4476c
    OPENSSL_cleanse(prev, sizeof(prev));
Packit c4476c
    HMAC_CTX_free(hmac);
Packit c4476c
    return ret;
Packit c4476c
}