mirror of
https://github.com/openssl/openssl.git
synced 2024-12-21 06:09:35 +08:00
ad062480f7
This supports all the modes, suites and export mechanisms defined in RFC9180 and should be relatively easily extensible if/as new suites are added. The APIs are based on the pseudo-code from the RFC, e.g. OSS_HPKE_encap() roughly maps to SetupBaseS(). External APIs are defined in include/openssl/hpke.h and documented in doc/man3/OSSL_HPKE_CTX_new.pod. Tests (test/hpke_test.c) include verifying a number of the test vectors from the RFC as well as round-tripping for all the modes and suites. We have demonstrated interoperability with other HPKE implementations via a fork [1] that implements TLS Encrypted ClientHello (ECH) which uses HPKE. @slontis provided huge help in getting this done and this makes extensive use of the KEM handling code from his PR#19068. [1] https://github.com/sftcd/openssl/tree/ECH-draft-13c Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17172)
101 lines
4.1 KiB
C
101 lines
4.1 KiB
C
/*
|
|
* Copyright 2022 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
|
|
*/
|
|
|
|
#ifndef OSSL_INTERNAL_HPKE_UTIL_H
|
|
# define OSSL_INTERNAL_HPKE_UTIL_H
|
|
# pragma once
|
|
|
|
/* Constants from RFC 9180 Section 7.1 and 7.3 */
|
|
# define OSSL_HPKE_MAX_SECRET 64
|
|
# define OSSL_HPKE_MAX_PUBLIC 133
|
|
# define OSSL_HPKE_MAX_PRIVATE 66
|
|
# define OSSL_HPKE_MAX_KDF_INPUTLEN 64
|
|
|
|
/*
|
|
* max length of a base-nonce (the Nn field from OSSL_HPKE_AEAD_INFO), this
|
|
* is used for a local stack array size
|
|
*/
|
|
# define OSSL_HPKE_MAX_NONCELEN 12
|
|
|
|
/*
|
|
* @brief info about a KEM
|
|
* Used to store constants from Section 7.1 "Table 2 KEM IDs"
|
|
* and the bitmask for EC curves described in Section 7.1.3 DeriveKeyPair
|
|
*/
|
|
typedef struct {
|
|
uint16_t kem_id; /* code point for key encipherment method */
|
|
const char *keytype; /* string form of algtype "EC"/"X25519"/"X448" */
|
|
const char *groupname; /* string form of EC group for NIST curves */
|
|
const char *mdname; /* hash alg name for the HKDF */
|
|
size_t Nsecret; /* size of secrets */
|
|
size_t Nenc; /* length of encapsulated key */
|
|
size_t Npk; /* length of public key */
|
|
size_t Nsk; /* length of raw private key */
|
|
uint8_t bitmask;
|
|
} OSSL_HPKE_KEM_INFO;
|
|
|
|
/*
|
|
* @brief info about a KDF
|
|
*/
|
|
typedef struct {
|
|
uint16_t kdf_id; /* code point for KDF */
|
|
const char *mdname; /* hash alg name for the HKDF */
|
|
size_t Nh; /* length of hash/extract output */
|
|
} OSSL_HPKE_KDF_INFO;
|
|
|
|
/*
|
|
* @brief info about an AEAD
|
|
*/
|
|
typedef struct {
|
|
uint16_t aead_id; /* code point for aead alg */
|
|
const char *name; /* alg name */
|
|
size_t taglen; /* aead tag len */
|
|
size_t Nk; /* size of a key for this aead */
|
|
size_t Nn; /* length of a nonce for this aead */
|
|
} OSSL_HPKE_AEAD_INFO;
|
|
|
|
const OSSL_HPKE_KEM_INFO *ossl_HPKE_KEM_INFO_find_curve(const char *curve);
|
|
const OSSL_HPKE_KEM_INFO *ossl_HPKE_KEM_INFO_find_id(uint16_t kemid);
|
|
const OSSL_HPKE_KEM_INFO *ossl_HPKE_KEM_INFO_find_random(OSSL_LIB_CTX *ctx);
|
|
const OSSL_HPKE_KDF_INFO *ossl_HPKE_KDF_INFO_find_id(uint16_t kdfid);
|
|
const OSSL_HPKE_KDF_INFO *ossl_HPKE_KDF_INFO_find_random(OSSL_LIB_CTX *ctx);
|
|
const OSSL_HPKE_AEAD_INFO *ossl_HPKE_AEAD_INFO_find_id(uint16_t aeadid);
|
|
const OSSL_HPKE_AEAD_INFO *ossl_HPKE_AEAD_INFO_find_random(OSSL_LIB_CTX *ctx);
|
|
|
|
int ossl_hpke_kdf_extract(EVP_KDF_CTX *kctx,
|
|
unsigned char *prk, size_t prklen,
|
|
const unsigned char *salt, size_t saltlen,
|
|
const unsigned char *ikm, size_t ikmlen);
|
|
|
|
int ossl_hpke_kdf_expand(EVP_KDF_CTX *kctx,
|
|
unsigned char *okm, size_t okmlen,
|
|
const unsigned char *prk, size_t prklen,
|
|
const unsigned char *info, size_t infolen);
|
|
|
|
int ossl_hpke_labeled_extract(EVP_KDF_CTX *kctx,
|
|
unsigned char *prk, size_t prklen,
|
|
const unsigned char *salt, size_t saltlen,
|
|
const char *protocol_label,
|
|
const unsigned char *suiteid, size_t suiteidlen,
|
|
const char *label,
|
|
const unsigned char *ikm, size_t ikmlen);
|
|
int ossl_hpke_labeled_expand(EVP_KDF_CTX *kctx,
|
|
unsigned char *okm, size_t okmlen,
|
|
const unsigned char *prk, size_t prklen,
|
|
const char *protocol_label,
|
|
const unsigned char *suiteid, size_t suiteidlen,
|
|
const char *label,
|
|
const unsigned char *info, size_t infolen);
|
|
|
|
EVP_KDF_CTX *ossl_kdf_ctx_create(const char *kdfname, const char *mdname,
|
|
OSSL_LIB_CTX *libctx, const char *propq);
|
|
|
|
int ossl_hpke_str2suite(const char *suitestr, OSSL_HPKE_SUITE *suite);
|
|
#endif
|