/src/openssl/providers/implementations/kdfs/sshkdf.c

Source (jump to first uncovered line)
/*
 * Copyright 2018-2024 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */


#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <openssl/evp.h>
#include <openssl/kdf.h>
#include <openssl/core_names.h>
#include <openssl/proverr.h>
#include "internal/cryptlib.h"
#include "internal/numbers.h"
#include "crypto/evp.h"
#include "prov/provider_ctx.h"
#include "prov/providercommon.h"
#include "prov/implementations.h"
#include "prov/provider_util.h"
#include "prov/securitycheck.h"

/* See RFC 4253, Section 7.2 */
static OSSL_FUNC_kdf_newctx_fn kdf_sshkdf_new;
static OSSL_FUNC_kdf_dupctx_fn kdf_sshkdf_dup;
static OSSL_FUNC_kdf_freectx_fn kdf_sshkdf_free;
static OSSL_FUNC_kdf_reset_fn kdf_sshkdf_reset;
static OSSL_FUNC_kdf_derive_fn kdf_sshkdf_derive;
static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_sshkdf_settable_ctx_params;
static OSSL_FUNC_kdf_set_ctx_params_fn kdf_sshkdf_set_ctx_params;
static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_sshkdf_gettable_ctx_params;
static OSSL_FUNC_kdf_get_ctx_params_fn kdf_sshkdf_get_ctx_params;

static int SSHKDF(const EVP_MD *evp_md,
                  const unsigned char *key, size_t key_len,
                  const unsigned char *xcghash, size_t xcghash_len,
                  const unsigned char *session_id, size_t session_id_len,
                  char type, unsigned char *okey, size_t okey_len);

typedef struct {
    void *provctx;
    PROV_DIGEST digest;
    unsigned char *key; /* K */
    size_t key_len;
    unsigned char *xcghash; /* H */
    size_t xcghash_len;
    char type; /* X */
    unsigned char *session_id;
    size_t session_id_len;
    OSSL_FIPS_IND_DECLARE
} KDF_SSHKDF;

static void *kdf_sshkdf_new(void *provctx)
{
    KDF_SSHKDF *ctx;

    if (!ossl_prov_is_running())
        return NULL;

    if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) != NULL) {
        ctx->provctx = provctx;
        OSSL_FIPS_IND_INIT(ctx)
    }
    return ctx;
}

static void kdf_sshkdf_free(void *vctx)
{
    KDF_SSHKDF *ctx = (KDF_SSHKDF *)vctx;

    if (ctx != NULL) {
        kdf_sshkdf_reset(ctx);
        OPENSSL_free(ctx);
    }
}

static void kdf_sshkdf_reset(void *vctx)
{
    KDF_SSHKDF *ctx = (KDF_SSHKDF *)vctx;
    void *provctx = ctx->provctx;

    ossl_prov_digest_reset(&ctx->digest);
    OPENSSL_clear_free(ctx->key, ctx->key_len);
    OPENSSL_clear_free(ctx->xcghash, ctx->xcghash_len);
    OPENSSL_clear_free(ctx->session_id, ctx->session_id_len);
    memset(ctx, 0, sizeof(*ctx));
    ctx->provctx = provctx;
}

static void *kdf_sshkdf_dup(void *vctx)
{
    const KDF_SSHKDF *src = (const KDF_SSHKDF *)vctx;
    KDF_SSHKDF *dest;

    dest = kdf_sshkdf_new(src->provctx);
    if (dest != NULL) {
        if (!ossl_prov_memdup(src->key, src->key_len,
                              &dest->key, &dest->key_len)
                || !ossl_prov_memdup(src->xcghash, src->xcghash_len,
                                     &dest->xcghash , &dest->xcghash_len)
                || !ossl_prov_memdup(src->session_id, src->session_id_len,
                                     &dest->session_id , &dest->session_id_len)
                || !ossl_prov_digest_copy(&dest->digest, &src->digest))
            goto err;
        dest->type = src->type;
        OSSL_FIPS_IND_COPY(dest, src)
    }
    return dest;

 err:
    kdf_sshkdf_free(dest);
    return NULL;
}

static int sshkdf_set_membuf(unsigned char **dst, size_t *dst_len,
                             const OSSL_PARAM *p)
{
    OPENSSL_clear_free(*dst, *dst_len);
    *dst = NULL;
    *dst_len = 0;
    return OSSL_PARAM_get_octet_string(p, (void **)dst, 0, dst_len);
}

#ifdef FIPS_MODULE
static int fips_digest_check_passed(KDF_SSHKDF *ctx, const EVP_MD *md)
{
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
    /*
     * Perform digest check
     *
     * According to NIST SP 800-135r1 section 5.2, the valid hash functions are
     * specified in FIPS 180-3. ACVP also only lists the same set of hash
     * functions.
     */
    int digest_unapproved = !EVP_MD_is_a(md, SN_sha1)
        && !EVP_MD_is_a(md, SN_sha224)
        && !EVP_MD_is_a(md, SN_sha256)
        && !EVP_MD_is_a(md, SN_sha384)
        && !EVP_MD_is_a(md, SN_sha512);

    if (digest_unapproved) {
        if (!OSSL_FIPS_IND_ON_UNAPPROVED(ctx, OSSL_FIPS_IND_SETTABLE0,
                                         libctx, "SSHKDF", "Digest",
                                         ossl_fips_config_sshkdf_digest_check)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_DIGEST_NOT_ALLOWED);
            return 0;
        }
    }
    return 1;
}

static int fips_key_check_passed(KDF_SSHKDF *ctx)
{
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
    int key_approved = ossl_kdf_check_key_size(ctx->key_len);

    if (!key_approved) {
        if (!OSSL_FIPS_IND_ON_UNAPPROVED(ctx, OSSL_FIPS_IND_SETTABLE1,
                                         libctx, "SSHKDF", "Key size",
                                         ossl_fips_config_sshkdf_key_check)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
            return 0;
        }
    }
    return 1;
}
#endif

static int kdf_sshkdf_derive(void *vctx, unsigned char *key, size_t keylen,
                             const OSSL_PARAM params[])
{
    KDF_SSHKDF *ctx = (KDF_SSHKDF *)vctx;
    const EVP_MD *md;

    if (!ossl_prov_is_running() || !kdf_sshkdf_set_ctx_params(ctx, params))
        return 0;

    md = ossl_prov_digest_md(&ctx->digest);
    if (md == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
        return 0;
    }
    if (ctx->key == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
        return 0;
    }
    if (ctx->xcghash == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_XCGHASH);
        return 0;
    }
    if (ctx->session_id == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SESSION_ID);
        return 0;
    }
    if (ctx->type == 0) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_TYPE);
        return 0;
    }

    return SSHKDF(md, ctx->key, ctx->key_len,
                  ctx->xcghash, ctx->xcghash_len,
                  ctx->session_id, ctx->session_id_len,
                  ctx->type, key, keylen);
}

/* Machine generated by util/perl/OpenSSL/paramnames.pm */
#ifndef sshkdf_set_ctx_params_list
static const OSSL_PARAM sshkdf_set_ctx_params_list[] = {
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SSHKDF_XCGHASH, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SSHKDF_SESSION_ID, NULL, 0),
    OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_SSHKDF_TYPE, NULL, 0),
    OSSL_PARAM_int(OSSL_KDF_PARAM_FIPS_DIGEST_CHECK, NULL),
    OSSL_PARAM_int(OSSL_KDF_PARAM_FIPS_KEY_CHECK, NULL),
    OSSL_PARAM_END
};
#endif

#ifndef sshkdf_set_ctx_params_st
struct sshkdf_set_ctx_params_st {
    OSSL_PARAM *digest;
    OSSL_PARAM *engine;
    OSSL_PARAM *ind_d;
    OSSL_PARAM *ind_k;
    OSSL_PARAM *key;
    OSSL_PARAM *propq;
    OSSL_PARAM *sid;
    OSSL_PARAM *type;
    OSSL_PARAM *xcg;
};
#endif

#ifndef sshkdf_set_ctx_params_decoder
static int sshkdf_set_ctx_params_decoder
    (const OSSL_PARAM *p, struct sshkdf_set_ctx_params_st *r)
{
    const char *s;

    memset(r, 0, sizeof(*r));
    if (p != NULL)
        for (; (s = p->key) != NULL; p++)
            switch(s[0]) {
            default:
                break;
            case 'd':
                switch(s[1]) {
                default:
                    break;
                case 'i':
                    switch(s[2]) {
                    default:
                        break;
                    case 'g':
                        switch(s[3]) {
                        default:
                            break;
                        case 'e':
                            switch(s[4]) {
                            default:
                                break;
                            case 's':
                                switch(s[5]) {
                                default:
                                    break;
                                case 't':
                                    switch(s[6]) {
                                    default:
                                        break;
                                    case '-':
                                        if (ossl_likely(strcmp("check", s + 7) == 0)) {
                                            if (ossl_likely(r->ind_d == NULL))
                                                r->ind_d = (OSSL_PARAM *)p;
                                        }
                                        break;
                                    case '\0':
                                        if (ossl_likely(r->digest == NULL))
                                            r->digest = (OSSL_PARAM *)p;
                                    }
                                }
                            }
                        }
                    }
                }
                break;
            case 'e':
                if (ossl_likely(strcmp("ngine", s + 1) == 0)) {
                    if (ossl_likely(r->engine == NULL))
                        r->engine = (OSSL_PARAM *)p;
                }
                break;
            case 'k':
                switch(s[1]) {
                default:
                    break;
                case 'e':
                    switch(s[2]) {
                    default:
                        break;
                    case 'y':
                        switch(s[3]) {
                        default:
                            break;
                        case '-':
                            if (ossl_likely(strcmp("check", s + 4) == 0)) {
                                if (ossl_likely(r->ind_k == NULL))
                                    r->ind_k = (OSSL_PARAM *)p;
                            }
                            break;
                        case '\0':
                            if (ossl_likely(r->key == NULL))
                                r->key = (OSSL_PARAM *)p;
                        }
                    }
                }
                break;
            case 'p':
                if (ossl_likely(strcmp("roperties", s + 1) == 0)) {
                    if (ossl_likely(r->propq == NULL))
                        r->propq = (OSSL_PARAM *)p;
                }
                break;
            case 's':
                if (ossl_likely(strcmp("ession_id", s + 1) == 0)) {
                    if (ossl_likely(r->sid == NULL))
                        r->sid = (OSSL_PARAM *)p;
                }
                break;
            case 't':
                if (ossl_likely(strcmp("ype", s + 1) == 0)) {
                    if (ossl_likely(r->type == NULL))
                        r->type = (OSSL_PARAM *)p;
                }
                break;
            case 'x':
                if (ossl_likely(strcmp("cghash", s + 1) == 0)) {
                    if (ossl_likely(r->xcg == NULL))
                        r->xcg = (OSSL_PARAM *)p;
                }
            }
    return 1;
}
#endif
/* End of machine generated */

static int kdf_sshkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    struct sshkdf_set_ctx_params_st p;
    KDF_SSHKDF *ctx = vctx;
    OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);

    if (ctx == NULL || !sshkdf_set_ctx_params_decoder(params, &p))
        return 0;

    if (!OSSL_FIPS_IND_SET_CTX_FROM_PARAM(ctx, OSSL_FIPS_IND_SETTABLE0, p.ind_d))
        return 0;
    if (!OSSL_FIPS_IND_SET_CTX_FROM_PARAM(ctx, OSSL_FIPS_IND_SETTABLE1, p.ind_k))
        return 0;

    if (p.digest != NULL) {
        const EVP_MD *md = NULL;

        if (!ossl_prov_digest_load(&ctx->digest, p.digest,
                                   p.propq, p.engine, provctx))
            return 0;

        md = ossl_prov_digest_md(&ctx->digest);
        if (EVP_MD_xof(md)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_XOF_DIGESTS_NOT_ALLOWED);
            return 0;
        }

#ifdef FIPS_MODULE
        if (!fips_digest_check_passed(ctx, md))
            return 0;
#endif
    }

    if (p.key != NULL) {
        if (!sshkdf_set_membuf(&ctx->key, &ctx->key_len, p.key))
            return 0;

#ifdef FIPS_MODULE
        if (!fips_key_check_passed(ctx))
            return 0;
#endif
    }

    if (p.xcg != NULL
            && !sshkdf_set_membuf(&ctx->xcghash, &ctx->xcghash_len, p.xcg))
        return 0;

    if (p.sid != NULL
            && !sshkdf_set_membuf(&ctx->session_id, &ctx->session_id_len, p.sid))
        return 0;

    if (p.type != NULL) {
        const char *kdftype;

        if (!OSSL_PARAM_get_utf8_string_ptr(p.type, &kdftype))
            return 0;
        /* Expect one character (byte in this case) */
        if (kdftype == NULL || p.type->data_size != 1)
            return 0;
        if (kdftype[0] < 65 || kdftype[0] > 70) {
            ERR_raise(ERR_LIB_PROV, PROV_R_VALUE_ERROR);
            return 0;
        }
        ctx->type = kdftype[0];
    }
    return 1;
}

static const OSSL_PARAM *kdf_sshkdf_settable_ctx_params(ossl_unused void *ctx,
                                                        ossl_unused void *p_ctx)
{
    return sshkdf_set_ctx_params_list;
}

/* Machine generated by util/perl/OpenSSL/paramnames.pm */
#ifndef sshkdf_get_ctx_params_list
static const OSSL_PARAM sshkdf_get_ctx_params_list[] = {
    OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
    OSSL_PARAM_int(OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR, NULL),
    OSSL_PARAM_END
};
#endif

#ifndef sshkdf_get_ctx_params_st
struct sshkdf_get_ctx_params_st {
    OSSL_PARAM *ind;
    OSSL_PARAM *size;
};
#endif

#ifndef sshkdf_get_ctx_params_decoder
static int sshkdf_get_ctx_params_decoder
    (const OSSL_PARAM *p, struct sshkdf_get_ctx_params_st *r)
{
    const char *s;

    memset(r, 0, sizeof(*r));
    if (p != NULL)
        for (; (s = p->key) != NULL; p++)
            switch(s[0]) {
            default:
                break;
            case 'f':
                if (ossl_likely(strcmp("ips-indicator", s + 1) == 0)) {
                    if (ossl_likely(r->ind == NULL))
                        r->ind = (OSSL_PARAM *)p;
                }
                break;
            case 's':
                if (ossl_likely(strcmp("ize", s + 1) == 0)) {
                    if (ossl_likely(r->size == NULL))
                        r->size = (OSSL_PARAM *)p;
                }
            }
    return 1;
}
#endif
/* End of machine generated */

static int kdf_sshkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
{
    KDF_SSHKDF *ctx = (KDF_SSHKDF *)vctx;
    struct sshkdf_get_ctx_params_st p;

    if (ctx == NULL || !sshkdf_get_ctx_params_decoder(params, &p))
        return 0;

    if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, SIZE_MAX))
        return 0;

    if (!OSSL_FIPS_IND_GET_CTX_FROM_PARAM(ctx, p.ind))
        return 0;
    return 1;
}

static const OSSL_PARAM *kdf_sshkdf_gettable_ctx_params(ossl_unused void *ctx,
                                                        ossl_unused void *p_ctx)
{
    return sshkdf_get_ctx_params_list;
}

const OSSL_DISPATCH ossl_kdf_sshkdf_functions[] = {
    { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_sshkdf_new },
    { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_sshkdf_dup },
    { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_sshkdf_free },
    { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_sshkdf_reset },
    { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_sshkdf_derive },
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
      (void(*)(void))kdf_sshkdf_settable_ctx_params },
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_sshkdf_set_ctx_params },
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
      (void(*)(void))kdf_sshkdf_gettable_ctx_params },
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_sshkdf_get_ctx_params },
    OSSL_DISPATCH_END
};

static int SSHKDF(const EVP_MD *evp_md,
                  const unsigned char *key, size_t key_len,
                  const unsigned char *xcghash, size_t xcghash_len,
                  const unsigned char *session_id, size_t session_id_len,
                  char type, unsigned char *okey, size_t okey_len)
{
    EVP_MD_CTX *md = NULL;
    unsigned char digest[EVP_MAX_MD_SIZE];
    unsigned int dsize = 0;
    size_t cursize = 0;
    int ret = 0;

    md = EVP_MD_CTX_new();
    if (md == NULL)
        return 0;

    if (!EVP_DigestInit_ex(md, evp_md, NULL))
        goto out;

    if (!EVP_DigestUpdate(md, key, key_len))
        goto out;

    if (!EVP_DigestUpdate(md, xcghash, xcghash_len))
        goto out;

    if (!EVP_DigestUpdate(md, &type, 1))
        goto out;

    if (!EVP_DigestUpdate(md, session_id, session_id_len))
        goto out;

    if (!EVP_DigestFinal_ex(md, digest, &dsize))
        goto out;

    if (okey_len < dsize) {
        memcpy(okey, digest, okey_len);
        ret = 1;
        goto out;
    }

    memcpy(okey, digest, dsize);

    for (cursize = dsize; cursize < okey_len; cursize += dsize) {

        if (!EVP_DigestInit_ex(md, evp_md, NULL))
            goto out;

        if (!EVP_DigestUpdate(md, key, key_len))
            goto out;

        if (!EVP_DigestUpdate(md, xcghash, xcghash_len))
            goto out;

        if (!EVP_DigestUpdate(md, okey, cursize))
            goto out;

        if (!EVP_DigestFinal_ex(md, digest, &dsize))
            goto out;

        if (okey_len < cursize + dsize) {
            memcpy(okey + cursize, digest, okey_len - cursize);
            ret = 1;
            goto out;
        }

        memcpy(okey + cursize, digest, dsize);
    }

    ret = 1;

out:
    EVP_MD_CTX_free(md);
    OPENSSL_cleanse(digest, EVP_MAX_MD_SIZE);
    return ret;
}

Coverage Report

Created: 2025-08-03 07:12

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2018-2024 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		#include <stdlib.h>
12		#include <stdarg.h>
13		#include <string.h>
14		#include <openssl/evp.h>
15		#include <openssl/kdf.h>
16		#include <openssl/core_names.h>
17		#include <openssl/proverr.h>
18		#include "internal/cryptlib.h"
19		#include "internal/numbers.h"
20		#include "crypto/evp.h"
21		#include "prov/provider_ctx.h"
22		#include "prov/providercommon.h"
23		#include "prov/implementations.h"
24		#include "prov/provider_util.h"
25		#include "prov/securitycheck.h"
26
27		/* See RFC 4253, Section 7.2 */
28		static OSSL_FUNC_kdf_newctx_fn kdf_sshkdf_new;
29		static OSSL_FUNC_kdf_dupctx_fn kdf_sshkdf_dup;
30		static OSSL_FUNC_kdf_freectx_fn kdf_sshkdf_free;
31		static OSSL_FUNC_kdf_reset_fn kdf_sshkdf_reset;
32		static OSSL_FUNC_kdf_derive_fn kdf_sshkdf_derive;
33		static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_sshkdf_settable_ctx_params;
34		static OSSL_FUNC_kdf_set_ctx_params_fn kdf_sshkdf_set_ctx_params;
35		static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_sshkdf_gettable_ctx_params;
36		static OSSL_FUNC_kdf_get_ctx_params_fn kdf_sshkdf_get_ctx_params;
37
38		static int SSHKDF(const EVP_MD *evp_md,
39		const unsigned char *key, size_t key_len,
40		const unsigned char *xcghash, size_t xcghash_len,
41		const unsigned char *session_id, size_t session_id_len,
42		char type, unsigned char *okey, size_t okey_len);
43
44		typedef struct {
45		void *provctx;
46		PROV_DIGEST digest;
47		unsigned char key; / K */
48		size_t key_len;
49		unsigned char xcghash; / H */
50		size_t xcghash_len;
51		char type; /* X */
52		unsigned char *session_id;
53		size_t session_id_len;
54		OSSL_FIPS_IND_DECLARE
55		} KDF_SSHKDF;
56
57		static void kdf_sshkdf_new(void provctx)
58	0	{
59	0	KDF_SSHKDF *ctx;
60
61	0	if (!ossl_prov_is_running())
62	0	return NULL;
63
64	0	if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) != NULL) {
65	0	ctx->provctx = provctx;
66	0	OSSL_FIPS_IND_INIT(ctx)
67	0	}
68	0	return ctx;
69	0	}
70
71		static void kdf_sshkdf_free(void *vctx)
72	0	{
73	0	KDF_SSHKDF ctx = (KDF_SSHKDF )vctx;
74
75	0	if (ctx != NULL) {
76	0	kdf_sshkdf_reset(ctx);
77	0	OPENSSL_free(ctx);
78	0	}
79	0	}
80
81		static void kdf_sshkdf_reset(void *vctx)
82	0	{
83	0	KDF_SSHKDF ctx = (KDF_SSHKDF )vctx;
84	0	void *provctx = ctx->provctx;
85
86	0	ossl_prov_digest_reset(&ctx->digest);
87	0	OPENSSL_clear_free(ctx->key, ctx->key_len);
88	0	OPENSSL_clear_free(ctx->xcghash, ctx->xcghash_len);
89	0	OPENSSL_clear_free(ctx->session_id, ctx->session_id_len);
90	0	memset(ctx, 0, sizeof(*ctx));
91	0	ctx->provctx = provctx;
92	0	}
93
94		static void kdf_sshkdf_dup(void vctx)
95	0	{
96	0	const KDF_SSHKDF src = (const KDF_SSHKDF )vctx;
97	0	KDF_SSHKDF *dest;
98
99	0	dest = kdf_sshkdf_new(src->provctx);
100	0	if (dest != NULL) {
101	0	if (!ossl_prov_memdup(src->key, src->key_len,
102	0	&dest->key, &dest->key_len)
103	0	\|\| !ossl_prov_memdup(src->xcghash, src->xcghash_len,
104	0	&dest->xcghash , &dest->xcghash_len)
105	0	\|\| !ossl_prov_memdup(src->session_id, src->session_id_len,
106	0	&dest->session_id , &dest->session_id_len)
107	0	\|\| !ossl_prov_digest_copy(&dest->digest, &src->digest))
108	0	goto err;
109	0	dest->type = src->type;
110	0	OSSL_FIPS_IND_COPY(dest, src)
111	0	}
112	0	return dest;
113
114	0	err:
115	0	kdf_sshkdf_free(dest);
116	0	return NULL;
117	0	}
118
119		static int sshkdf_set_membuf(unsigned char *dst, size_t dst_len,
120		const OSSL_PARAM *p)
121	0	{
122	0	OPENSSL_clear_free(dst, dst_len);
123	0	*dst = NULL;
124	0	*dst_len = 0;
125	0	return OSSL_PARAM_get_octet_string(p, (void **)dst, 0, dst_len);
126	0	}
127
128		#ifdef FIPS_MODULE
129		static int fips_digest_check_passed(KDF_SSHKDF ctx, const EVP_MD md)
130		{
131		OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
132		/*
133		* Perform digest check
134		*
135		* According to NIST SP 800-135r1 section 5.2, the valid hash functions are
136		* specified in FIPS 180-3. ACVP also only lists the same set of hash
137		* functions.
138		*/
139		int digest_unapproved = !EVP_MD_is_a(md, SN_sha1)
140		&& !EVP_MD_is_a(md, SN_sha224)
141		&& !EVP_MD_is_a(md, SN_sha256)
142		&& !EVP_MD_is_a(md, SN_sha384)
143		&& !EVP_MD_is_a(md, SN_sha512);
144
145		if (digest_unapproved) {
146		if (!OSSL_FIPS_IND_ON_UNAPPROVED(ctx, OSSL_FIPS_IND_SETTABLE0,
147		libctx, "SSHKDF", "Digest",
148		ossl_fips_config_sshkdf_digest_check)) {
149		ERR_raise(ERR_LIB_PROV, PROV_R_DIGEST_NOT_ALLOWED);
150		return 0;
151		}
152		}
153		return 1;
154		}
155
156		static int fips_key_check_passed(KDF_SSHKDF *ctx)
157		{
158		OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
159		int key_approved = ossl_kdf_check_key_size(ctx->key_len);
160
161		if (!key_approved) {
162		if (!OSSL_FIPS_IND_ON_UNAPPROVED(ctx, OSSL_FIPS_IND_SETTABLE1,
163		libctx, "SSHKDF", "Key size",
164		ossl_fips_config_sshkdf_key_check)) {
165		ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
166		return 0;
167		}
168		}
169		return 1;
170		}
171		#endif
172
173		static int kdf_sshkdf_derive(void vctx, unsigned char key, size_t keylen,
174		const OSSL_PARAM params[])
175	0	{
176	0	KDF_SSHKDF ctx = (KDF_SSHKDF )vctx;
177	0	const EVP_MD *md;
178
179	0	if (!ossl_prov_is_running() \|\| !kdf_sshkdf_set_ctx_params(ctx, params))
180	0	return 0;
181
182	0	md = ossl_prov_digest_md(&ctx->digest);
183	0	if (md == NULL) {
184	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
185	0	return 0;
186	0	}
187	0	if (ctx->key == NULL) {
188	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
189	0	return 0;
190	0	}
191	0	if (ctx->xcghash == NULL) {
192	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_XCGHASH);
193	0	return 0;
194	0	}
195	0	if (ctx->session_id == NULL) {
196	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SESSION_ID);
197	0	return 0;
198	0	}
199	0	if (ctx->type == 0) {
200	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_TYPE);
201	0	return 0;
202	0	}
203
204	0	return SSHKDF(md, ctx->key, ctx->key_len,
205	0	ctx->xcghash, ctx->xcghash_len,
206	0	ctx->session_id, ctx->session_id_len,
207	0	ctx->type, key, keylen);
208	0	}
209
210		/* Machine generated by util/perl/OpenSSL/paramnames.pm */
211		#ifndef sshkdf_set_ctx_params_list
212		static const OSSL_PARAM sshkdf_set_ctx_params_list[] = {
213		OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
214		OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
215		OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
216		OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SSHKDF_XCGHASH, NULL, 0),
217		OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SSHKDF_SESSION_ID, NULL, 0),
218		OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_SSHKDF_TYPE, NULL, 0),
219		OSSL_PARAM_int(OSSL_KDF_PARAM_FIPS_DIGEST_CHECK, NULL),
220		OSSL_PARAM_int(OSSL_KDF_PARAM_FIPS_KEY_CHECK, NULL),
221		OSSL_PARAM_END
222		};
223		#endif
224
225		#ifndef sshkdf_set_ctx_params_st
226		struct sshkdf_set_ctx_params_st {
227		OSSL_PARAM *digest;
228		OSSL_PARAM *engine;
229		OSSL_PARAM *ind_d;
230		OSSL_PARAM *ind_k;
231		OSSL_PARAM *key;
232		OSSL_PARAM *propq;
233		OSSL_PARAM *sid;
234		OSSL_PARAM *type;
235		OSSL_PARAM *xcg;
236		};
237		#endif
238
239		#ifndef sshkdf_set_ctx_params_decoder
240		static int sshkdf_set_ctx_params_decoder
241		(const OSSL_PARAM p, struct sshkdf_set_ctx_params_st r)
242	0	{
243	0	const char *s;
244
245	0	memset(r, 0, sizeof(*r));
246	0	if (p != NULL)
247	0	for (; (s = p->key) != NULL; p++)
248	0	switch(s[0]) {
249	0	default:
250	0	break;
251	0	case 'd':
252	0	switch(s[1]) {
253	0	default:
254	0	break;
255	0	case 'i':
256	0	switch(s[2]) {
257	0	default:
258	0	break;
259	0	case 'g':
260	0	switch(s[3]) {
261	0	default:
262	0	break;
263	0	case 'e':
264	0	switch(s[4]) {
265	0	default:
266	0	break;
267	0	case 's':
268	0	switch(s[5]) {
269	0	default:
270	0	break;
271	0	case 't':
272	0	switch(s[6]) {
273	0	default:
274	0	break;
275	0	case '-':
276	0	if (ossl_likely(strcmp("check", s + 7) == 0)) {
277	0	if (ossl_likely(r->ind_d == NULL))
278	0	r->ind_d = (OSSL_PARAM *)p;
279	0	}
280	0	break;
281	0	case '\0':
282	0	if (ossl_likely(r->digest == NULL))
283	0	r->digest = (OSSL_PARAM *)p;
284	0	}
285	0	}
286	0	}
287	0	}
288	0	}
289	0	}
290	0	break;
291	0	case 'e':
292	0	if (ossl_likely(strcmp("ngine", s + 1) == 0)) {
293	0	if (ossl_likely(r->engine == NULL))
294	0	r->engine = (OSSL_PARAM *)p;
295	0	}
296	0	break;
297	0	case 'k':
298	0	switch(s[1]) {
299	0	default:
300	0	break;
301	0	case 'e':
302	0	switch(s[2]) {
303	0	default:
304	0	break;
305	0	case 'y':
306	0	switch(s[3]) {
307	0	default:
308	0	break;
309	0	case '-':
310	0	if (ossl_likely(strcmp("check", s + 4) == 0)) {
311	0	if (ossl_likely(r->ind_k == NULL))
312	0	r->ind_k = (OSSL_PARAM *)p;
313	0	}
314	0	break;
315	0	case '\0':
316	0	if (ossl_likely(r->key == NULL))
317	0	r->key = (OSSL_PARAM *)p;
318	0	}
319	0	}
320	0	}
321	0	break;
322	0	case 'p':
323	0	if (ossl_likely(strcmp("roperties", s + 1) == 0)) {
324	0	if (ossl_likely(r->propq == NULL))
325	0	r->propq = (OSSL_PARAM *)p;
326	0	}
327	0	break;
328	0	case 's':
329	0	if (ossl_likely(strcmp("ession_id", s + 1) == 0)) {
330	0	if (ossl_likely(r->sid == NULL))
331	0	r->sid = (OSSL_PARAM *)p;
332	0	}
333	0	break;
334	0	case 't':
335	0	if (ossl_likely(strcmp("ype", s + 1) == 0)) {
336	0	if (ossl_likely(r->type == NULL))
337	0	r->type = (OSSL_PARAM *)p;
338	0	}
339	0	break;
340	0	case 'x':
341	0	if (ossl_likely(strcmp("cghash", s + 1) == 0)) {
342	0	if (ossl_likely(r->xcg == NULL))
343	0	r->xcg = (OSSL_PARAM *)p;
344	0	}
345	0	}
346	0	return 1;
347	0	}
348		#endif
349		/* End of machine generated */
350
351		static int kdf_sshkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
352	0	{
353	0	struct sshkdf_set_ctx_params_st p;
354	0	KDF_SSHKDF *ctx = vctx;
355	0	OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
356
357	0	if (ctx == NULL \|\| !sshkdf_set_ctx_params_decoder(params, &p))
358	0	return 0;
359
360	0	if (!OSSL_FIPS_IND_SET_CTX_FROM_PARAM(ctx, OSSL_FIPS_IND_SETTABLE0, p.ind_d))
361	0	return 0;
362	0	if (!OSSL_FIPS_IND_SET_CTX_FROM_PARAM(ctx, OSSL_FIPS_IND_SETTABLE1, p.ind_k))
363	0	return 0;
364
365	0	if (p.digest != NULL) {
366	0	const EVP_MD *md = NULL;
367
368	0	if (!ossl_prov_digest_load(&ctx->digest, p.digest,
369	0	p.propq, p.engine, provctx))
370	0	return 0;
371
372	0	md = ossl_prov_digest_md(&ctx->digest);
373	0	if (EVP_MD_xof(md)) {
374	0	ERR_raise(ERR_LIB_PROV, PROV_R_XOF_DIGESTS_NOT_ALLOWED);
375	0	return 0;
376	0	}
377
378		#ifdef FIPS_MODULE
379		if (!fips_digest_check_passed(ctx, md))
380		return 0;
381		#endif
382	0	}
383
384	0	if (p.key != NULL) {
385	0	if (!sshkdf_set_membuf(&ctx->key, &ctx->key_len, p.key))
386	0	return 0;
387
388		#ifdef FIPS_MODULE
389		if (!fips_key_check_passed(ctx))
390		return 0;
391		#endif
392	0	}
393
394	0	if (p.xcg != NULL
395	0	&& !sshkdf_set_membuf(&ctx->xcghash, &ctx->xcghash_len, p.xcg))
396	0	return 0;
397
398	0	if (p.sid != NULL
399	0	&& !sshkdf_set_membuf(&ctx->session_id, &ctx->session_id_len, p.sid))
400	0	return 0;
401
402	0	if (p.type != NULL) {
403	0	const char *kdftype;
404
405	0	if (!OSSL_PARAM_get_utf8_string_ptr(p.type, &kdftype))
406	0	return 0;
407		/* Expect one character (byte in this case) */
408	0	if (kdftype == NULL \|\| p.type->data_size != 1)
409	0	return 0;
410	0	if (kdftype[0] < 65 \|\| kdftype[0] > 70) {
411	0	ERR_raise(ERR_LIB_PROV, PROV_R_VALUE_ERROR);
412	0	return 0;
413	0	}
414	0	ctx->type = kdftype[0];
415	0	}
416	0	return 1;
417	0	}
418
419		static const OSSL_PARAM kdf_sshkdf_settable_ctx_params(ossl_unused void ctx,
420		ossl_unused void *p_ctx)
421	0	{
422	0	return sshkdf_set_ctx_params_list;
423	0	}
424
425		/* Machine generated by util/perl/OpenSSL/paramnames.pm */
426		#ifndef sshkdf_get_ctx_params_list
427		static const OSSL_PARAM sshkdf_get_ctx_params_list[] = {
428		OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
429		OSSL_PARAM_int(OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR, NULL),
430		OSSL_PARAM_END
431		};
432		#endif
433
434		#ifndef sshkdf_get_ctx_params_st
435		struct sshkdf_get_ctx_params_st {
436		OSSL_PARAM *ind;
437		OSSL_PARAM *size;
438		};
439		#endif
440
441		#ifndef sshkdf_get_ctx_params_decoder
442		static int sshkdf_get_ctx_params_decoder
443		(const OSSL_PARAM p, struct sshkdf_get_ctx_params_st r)
444	0	{
445	0	const char *s;
446
447	0	memset(r, 0, sizeof(*r));
448	0	if (p != NULL)
449	0	for (; (s = p->key) != NULL; p++)
450	0	switch(s[0]) {
451	0	default:
452	0	break;
453	0	case 'f':
454	0	if (ossl_likely(strcmp("ips-indicator", s + 1) == 0)) {
455	0	if (ossl_likely(r->ind == NULL))
456	0	r->ind = (OSSL_PARAM *)p;
457	0	}
458	0	break;
459	0	case 's':
460	0	if (ossl_likely(strcmp("ize", s + 1) == 0)) {
461	0	if (ossl_likely(r->size == NULL))
462	0	r->size = (OSSL_PARAM *)p;
463	0	}
464	0	}
465	0	return 1;
466	0	}
467		#endif
468		/* End of machine generated */
469
470		static int kdf_sshkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
471	0	{
472	0	KDF_SSHKDF ctx = (KDF_SSHKDF )vctx;
473	0	struct sshkdf_get_ctx_params_st p;
474
475	0	if (ctx == NULL \|\| !sshkdf_get_ctx_params_decoder(params, &p))
476	0	return 0;
477
478	0	if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, SIZE_MAX))
479	0	return 0;
480
481	0	if (!OSSL_FIPS_IND_GET_CTX_FROM_PARAM(ctx, p.ind))
482	0	return 0;
483	0	return 1;
484	0	}
485
486		static const OSSL_PARAM kdf_sshkdf_gettable_ctx_params(ossl_unused void ctx,
487		ossl_unused void *p_ctx)
488	0	{
489	0	return sshkdf_get_ctx_params_list;
490	0	}
491
492		const OSSL_DISPATCH ossl_kdf_sshkdf_functions[] = {
493		{ OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_sshkdf_new },
494		{ OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_sshkdf_dup },
495		{ OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_sshkdf_free },
496		{ OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_sshkdf_reset },
497		{ OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_sshkdf_derive },
498		{ OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
499		(void(*)(void))kdf_sshkdf_settable_ctx_params },
500		{ OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_sshkdf_set_ctx_params },
501		{ OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
502		(void(*)(void))kdf_sshkdf_gettable_ctx_params },
503		{ OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_sshkdf_get_ctx_params },
504		OSSL_DISPATCH_END
505		};
506
507		static int SSHKDF(const EVP_MD *evp_md,
508		const unsigned char *key, size_t key_len,
509		const unsigned char *xcghash, size_t xcghash_len,
510		const unsigned char *session_id, size_t session_id_len,
511		char type, unsigned char *okey, size_t okey_len)
512	0	{
513	0	EVP_MD_CTX *md = NULL;
514	0	unsigned char digest[EVP_MAX_MD_SIZE];
515	0	unsigned int dsize = 0;
516	0	size_t cursize = 0;
517	0	int ret = 0;
518
519	0	md = EVP_MD_CTX_new();
520	0	if (md == NULL)
521	0	return 0;
522
523	0	if (!EVP_DigestInit_ex(md, evp_md, NULL))
524	0	goto out;
525
526	0	if (!EVP_DigestUpdate(md, key, key_len))
527	0	goto out;
528
529	0	if (!EVP_DigestUpdate(md, xcghash, xcghash_len))
530	0	goto out;
531
532	0	if (!EVP_DigestUpdate(md, &type, 1))
533	0	goto out;
534
535	0	if (!EVP_DigestUpdate(md, session_id, session_id_len))
536	0	goto out;
537
538	0	if (!EVP_DigestFinal_ex(md, digest, &dsize))
539	0	goto out;
540
541	0	if (okey_len < dsize) {
542	0	memcpy(okey, digest, okey_len);
543	0	ret = 1;
544	0	goto out;
545	0	}
546
547	0	memcpy(okey, digest, dsize);
548
549	0	for (cursize = dsize; cursize < okey_len; cursize += dsize) {
550
551	0	if (!EVP_DigestInit_ex(md, evp_md, NULL))
552	0	goto out;
553
554	0	if (!EVP_DigestUpdate(md, key, key_len))
555	0	goto out;
556
557	0	if (!EVP_DigestUpdate(md, xcghash, xcghash_len))
558	0	goto out;
559
560	0	if (!EVP_DigestUpdate(md, okey, cursize))
561	0	goto out;
562
563	0	if (!EVP_DigestFinal_ex(md, digest, &dsize))
564	0	goto out;
565
566	0	if (okey_len < cursize + dsize) {
567	0	memcpy(okey + cursize, digest, okey_len - cursize);
568	0	ret = 1;
569	0	goto out;
570	0	}
571
572	0	memcpy(okey + cursize, digest, dsize);
573	0	}
574
575	0	ret = 1;
576
577	0	out:
578	0	EVP_MD_CTX_free(md);
579	0	OPENSSL_cleanse(digest, EVP_MAX_MD_SIZE);
580	0	return ret;
581	0	}