Blame include/openssl/kdf.h

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
#ifndef HEADER_KDF_H
Packit c4476c
# define HEADER_KDF_H
Packit c4476c
Packit c4476c
# include <openssl/ossl_typ.h>
Packit c4476c
# include <openssl/kdferr.h>
Packit c4476c
# ifdef __cplusplus
Packit c4476c
extern "C" {
Packit c4476c
# endif
Packit c4476c
Packit c4476c
# define EVP_KDF_PBKDF2     NID_id_pbkdf2
Packit c4476c
# define EVP_KDF_SCRYPT     NID_id_scrypt
Packit c4476c
# define EVP_KDF_TLS1_PRF   NID_tls1_prf
Packit c4476c
# define EVP_KDF_HKDF       NID_hkdf
Packit c4476c
# define EVP_KDF_SSHKDF     NID_sshkdf
Packit c4476c
# define EVP_KDF_KB         NID_kbkdf
Packit c4476c
# define EVP_KDF_KRB5KDF    NID_krb5kdf
Packit c4476c
# define EVP_KDF_SS         NID_sskdf
Packit c4476c
Packit c4476c
EVP_KDF_CTX *EVP_KDF_CTX_new_id(int id);
Packit c4476c
void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx);
Packit c4476c
Packit c4476c
void EVP_KDF_reset(EVP_KDF_CTX *ctx);
Packit c4476c
int EVP_KDF_ctrl(EVP_KDF_CTX *ctx, int cmd, ...);
Packit c4476c
int EVP_KDF_vctrl(EVP_KDF_CTX *ctx, int cmd, va_list args);
Packit c4476c
int EVP_KDF_ctrl_str(EVP_KDF_CTX *ctx, const char *type, const char *value);
Packit c4476c
size_t EVP_KDF_size(EVP_KDF_CTX *ctx);
Packit c4476c
int EVP_KDF_derive(EVP_KDF_CTX *ctx, unsigned char *key, size_t keylen);
Packit c4476c
Packit c4476c
Packit c4476c
# define EVP_KDF_CTRL_SET_PASS          0x01 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SALT          0x02 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_ITER          0x03 /* int */
Packit c4476c
# define EVP_KDF_CTRL_SET_MD            0x04 /* EVP_MD * */
Packit c4476c
# define EVP_KDF_CTRL_SET_KEY           0x05 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_MAXMEM_BYTES  0x06 /* uint64_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_TLS_SECRET    0x07 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_RESET_TLS_SEED    0x08
Packit c4476c
# define EVP_KDF_CTRL_ADD_TLS_SEED      0x09 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_RESET_HKDF_INFO   0x0a
Packit c4476c
# define EVP_KDF_CTRL_ADD_HKDF_INFO     0x0b /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_HKDF_MODE     0x0c /* int */
Packit c4476c
# define EVP_KDF_CTRL_SET_SCRYPT_N      0x0d /* uint64_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SCRYPT_R      0x0e /* uint32_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SCRYPT_P      0x0f /* uint32_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SSHKDF_XCGHASH    0x10 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SSHKDF_SESSION_ID 0x11 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SSHKDF_TYPE       0x12 /* int */
Packit c4476c
# define EVP_KDF_CTRL_SET_KB_MODE       0x13 /* int */
Packit c4476c
# define EVP_KDF_CTRL_SET_KB_MAC_TYPE   0x14 /* int */
Packit c4476c
# define EVP_KDF_CTRL_SET_CIPHER        0x15 /* EVP_CIPHER * */
Packit c4476c
# define EVP_KDF_CTRL_SET_KB_INFO       0x16 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_KB_SEED       0x17 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_KRB5KDF_CONSTANT  0x18 /* unsigned char *, size_t */
Packit c4476c
# define EVP_KDF_CTRL_SET_SSKDF_INFO    0x19 /* unsigned char *, size_t */
Packit c4476c
Packit c4476c
# define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND  0
Packit c4476c
# define EVP_KDF_HKDF_MODE_EXTRACT_ONLY        1
Packit c4476c
# define EVP_KDF_HKDF_MODE_EXPAND_ONLY         2
Packit c4476c
Packit c4476c
#define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV 65
Packit c4476c
#define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI 66
Packit c4476c
#define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV 67
Packit c4476c
#define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI 68
Packit c4476c
#define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV 69
Packit c4476c
#define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI 70
Packit c4476c
Packit c4476c
#define EVP_KDF_KB_MODE_COUNTER     0
Packit c4476c
#define EVP_KDF_KB_MODE_FEEDBACK    1
Packit c4476c
Packit c4476c
#define EVP_KDF_KB_MAC_TYPE_HMAC    0
Packit c4476c
#define EVP_KDF_KB_MAC_TYPE_CMAC    1
Packit c4476c
Packit c4476c
/**** The legacy PKEY-based KDF API follows. ****/
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTRL_TLS_MD                   (EVP_PKEY_ALG_CTRL)
Packit c4476c
# define EVP_PKEY_CTRL_TLS_SECRET               (EVP_PKEY_ALG_CTRL + 1)
Packit c4476c
# define EVP_PKEY_CTRL_TLS_SEED                 (EVP_PKEY_ALG_CTRL + 2)
Packit c4476c
# define EVP_PKEY_CTRL_HKDF_MD                  (EVP_PKEY_ALG_CTRL + 3)
Packit c4476c
# define EVP_PKEY_CTRL_HKDF_SALT                (EVP_PKEY_ALG_CTRL + 4)
Packit c4476c
# define EVP_PKEY_CTRL_HKDF_KEY                 (EVP_PKEY_ALG_CTRL + 5)
Packit c4476c
# define EVP_PKEY_CTRL_HKDF_INFO                (EVP_PKEY_ALG_CTRL + 6)
Packit c4476c
# define EVP_PKEY_CTRL_HKDF_MODE                (EVP_PKEY_ALG_CTRL + 7)
Packit c4476c
# define EVP_PKEY_CTRL_PASS                     (EVP_PKEY_ALG_CTRL + 8)
Packit c4476c
# define EVP_PKEY_CTRL_SCRYPT_SALT              (EVP_PKEY_ALG_CTRL + 9)
Packit c4476c
# define EVP_PKEY_CTRL_SCRYPT_N                 (EVP_PKEY_ALG_CTRL + 10)
Packit c4476c
# define EVP_PKEY_CTRL_SCRYPT_R                 (EVP_PKEY_ALG_CTRL + 11)
Packit c4476c
# define EVP_PKEY_CTRL_SCRYPT_P                 (EVP_PKEY_ALG_CTRL + 12)
Packit c4476c
# define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES      (EVP_PKEY_ALG_CTRL + 13)
Packit c4476c
Packit c4476c
# define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
Packit c4476c
            EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
Packit c4476c
# define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY       \
Packit c4476c
            EVP_KDF_HKDF_MODE_EXTRACT_ONLY
Packit c4476c
# define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY        \
Packit c4476c
            EVP_KDF_HKDF_MODE_EXPAND_ONLY
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_TLS_MD, 0, (void *)(md))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)(sec))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)(seed))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_HKDF_MD, 0, (void *)(md))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)(salt))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)(key))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)(info))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                              EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set1_pbe_pass(pctx, pass, passlen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                            EVP_PKEY_CTRL_PASS, passlen, (void *)(pass))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set1_scrypt_salt(pctx, salt, saltlen) \
Packit c4476c
            EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                            EVP_PKEY_CTRL_SCRYPT_SALT, saltlen, (void *)(salt))
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set_scrypt_N(pctx, n) \
Packit c4476c
            EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                            EVP_PKEY_CTRL_SCRYPT_N, n)
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set_scrypt_r(pctx, r) \
Packit c4476c
            EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                            EVP_PKEY_CTRL_SCRYPT_R, r)
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set_scrypt_p(pctx, p) \
Packit c4476c
            EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                            EVP_PKEY_CTRL_SCRYPT_P, p)
Packit c4476c
Packit c4476c
# define EVP_PKEY_CTX_set_scrypt_maxmem_bytes(pctx, maxmem_bytes) \
Packit c4476c
            EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
Packit c4476c
                            EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, maxmem_bytes)
Packit c4476c
Packit c4476c
Packit c4476c
# ifdef __cplusplus
Packit c4476c
}
Packit c4476c
# endif
Packit c4476c
#endif