[thirdparty/systemd.git] / src / shared / openssl-util.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include "iovec-util.h"
#include "macro.h"
#include "sha256.h"

#define X509_FINGERPRINT_SIZE SHA256_DIGEST_SIZE

#if HAVE_OPENSSL
#  include <openssl/bio.h>
#  include <openssl/bn.h>
#  include <openssl/crypto.h>
#  include <openssl/err.h>
#  include <openssl/evp.h>
#  include <openssl/opensslv.h>
#  include <openssl/pkcs7.h>
#  include <openssl/ssl.h>
#  include <openssl/x509v3.h>
#  ifndef OPENSSL_VERSION_MAJOR
/* OPENSSL_VERSION_MAJOR macro was added in OpenSSL 3. Thus, if it doesn't exist,  we must be before OpenSSL 3. */
#    define OPENSSL_VERSION_MAJOR 1
#  endif
#  if OPENSSL_VERSION_MAJOR >= 3
#    include <openssl/core_names.h>
#    include <openssl/kdf.h>
#    include <openssl/param_build.h>
#  endif

DEFINE_TRIVIAL_CLEANUP_FUNC_FULL_MACRO(void*, OPENSSL_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509_NAME*, X509_NAME_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY_CTX*, EVP_PKEY_CTX_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER_CTX*, EVP_CIPHER_CTX_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_POINT*, EC_POINT_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_GROUP*, EC_GROUP_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIGNUM*, BN_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BN_CTX*, BN_CTX_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(ECDSA_SIG*, ECDSA_SIG_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(PKCS7*, PKCS7_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(SSL*, SSL_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIO*, BIO_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD_CTX*, EVP_MD_CTX_free, NULL);
#if OPENSSL_VERSION_MAJOR >= 3
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER*, EVP_CIPHER_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_KDF*, EVP_KDF_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_KDF_CTX*, EVP_KDF_CTX_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MAC*, EVP_MAC_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MAC_CTX*, EVP_MAC_CTX_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD*, EVP_MD_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM*, OSSL_PARAM_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM_BLD*, OSSL_PARAM_BLD_free, NULL);
#else
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_KEY*, EC_KEY_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(HMAC_CTX*, HMAC_CTX_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(RSA*, RSA_free, NULL);
#endif

static inline void sk_X509_free_allp(STACK_OF(X509) **sk) {
        if (!sk || !*sk)
                return;

        sk_X509_pop_free(*sk, X509_free);
}

int openssl_pkey_from_pem(const void *pem, size_t pem_size, EVP_PKEY **ret);

int openssl_digest_size(const char *digest_alg, size_t *ret_digest_size);

int openssl_digest_many(const char *digest_alg, const struct iovec data[], size_t n_data, void **ret_digest, size_t *ret_digest_size);

static inline int openssl_digest(const char *digest_alg, const void *buf, size_t len, void **ret_digest, size_t *ret_digest_size) {
        return openssl_digest_many(digest_alg, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
}

int openssl_hmac_many(const char *digest_alg, const void *key, size_t key_size, const struct iovec data[], size_t n_data, void **ret_digest, size_t *ret_digest_size);

static inline int openssl_hmac(const char *digest_alg, const void *key, size_t key_size, const void *buf, size_t len, void **ret_digest, size_t *ret_digest_size) {
        return openssl_hmac_many(digest_alg, key, key_size, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
}

int openssl_cipher_many(const char *alg, size_t bits, const char *mode, const void *key, size_t key_size, const void *iv, size_t iv_size, const struct iovec data[], size_t n_data, void **ret, size_t *ret_size);

static inline int openssl_cipher(const char *alg, size_t bits, const char *mode, const void *key, size_t key_size, const void *iv, size_t iv_size, const void *buf, size_t len, void **ret, size_t *ret_size) {
        return openssl_cipher_many(alg, bits, mode, key, key_size, iv, iv_size, &IOVEC_MAKE((void*) buf, len), 1, ret, ret_size);
}

int kdf_ss_derive(const char *digest, const void *key, size_t key_size, const void *salt, size_t salt_size, const void *info, size_t info_size, size_t derive_size, void **ret);

int kdf_kb_hmac_derive(const char *mode, const char *digest, const void *key, size_t key_size, const void *salt, size_t salt_size, const void *info, size_t info_size, const void *seed, size_t seed_size, size_t derive_size, void **ret);

int rsa_encrypt_bytes(EVP_PKEY *pkey, const void *decrypted_key, size_t decrypted_key_size, void **ret_encrypt_key, size_t *ret_encrypt_key_size);

int rsa_oaep_encrypt_bytes(const EVP_PKEY *pkey, const char *digest_alg, const char *label, const void *decrypted_key, size_t decrypted_key_size, void **ret_encrypt_key, size_t *ret_encrypt_key_size);

int rsa_pkey_to_suitable_key_size(EVP_PKEY *pkey, size_t *ret_suitable_key_size);

int rsa_pkey_new(size_t bits, EVP_PKEY **ret);

int rsa_pkey_from_n_e(const void *n, size_t n_size, const void *e, size_t e_size, EVP_PKEY **ret);

int rsa_pkey_to_n_e(const EVP_PKEY *pkey, void **ret_n, size_t *ret_n_size, void **ret_e, size_t *ret_e_size);

int ecc_pkey_from_curve_x_y(int curve_id, const void *x, size_t x_size, const void *y, size_t y_size, EVP_PKEY **ret);

int ecc_pkey_to_curve_x_y(const EVP_PKEY *pkey, int *ret_curve_id, void **ret_x, size_t *ret_x_size, void **ret_y, size_t *ret_y_size);

int ecc_pkey_new(int curve_id, EVP_PKEY **ret);

int ecc_ecdh(const EVP_PKEY *private_pkey, const EVP_PKEY *peer_pkey, void **ret_shared_secret, size_t *ret_shared_secret_size);

int pubkey_fingerprint(EVP_PKEY *pk, const EVP_MD *md, void **ret, size_t *ret_size);

int digest_and_sign(const EVP_MD *md, EVP_PKEY *privkey, const void *data, size_t size, void **ret, size_t *ret_size);

#else

typedef struct X509 X509;
typedef struct EVP_PKEY EVP_PKEY;

static inline void *X509_free(X509 *p) {
        assert(p == NULL);
        return NULL;
}

static inline void *EVP_PKEY_free(EVP_PKEY *p) {
        assert(p == NULL);
        return NULL;
}

#endif

DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509*, X509_free, NULL);
DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY*, EVP_PKEY_free, NULL);

int x509_fingerprint(X509 *cert, uint8_t buffer[static X509_FINGERPRINT_SIZE]);

#if PREFER_OPENSSL
/* The openssl definition */
typedef const EVP_MD* hash_md_t;
typedef const EVP_MD* hash_algorithm_t;
typedef int elliptic_curve_t;
typedef EVP_MD_CTX* hash_context_t;
#  define OPENSSL_OR_GCRYPT(a, b) (a)

#elif HAVE_GCRYPT

#  include <gcrypt.h>

/* The gcrypt definition */
typedef int hash_md_t;
typedef const char* hash_algorithm_t;
typedef const char* elliptic_curve_t;
typedef gcry_md_hd_t hash_context_t;
#  define OPENSSL_OR_GCRYPT(a, b) (b)
#endif

#if PREFER_OPENSSL
int string_hashsum(const char *s, size_t len, const char *md_algorithm, char **ret);

static inline int string_hashsum_sha224(const char *s, size_t len, char **ret) {
        return string_hashsum(s, len, "SHA224", ret);
}

static inline int string_hashsum_sha256(const char *s, size_t len, char **ret) {
        return string_hashsum(s, len, "SHA256", ret);
}
#endif
Commit	Line	Data
db9ecf05	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
3f637019 LP	2	#pragma once
3f637019 LP	3
bd1ae178	4	#include "iovec-util.h"
f2d5df8a	5	#include "macro.h"
8939d335 DDM	6	#include "sha256.h"
	7
	8	#define X509_FINGERPRINT_SIZE SHA256_DIGEST_SIZE
f2d5df8a	9
b012a1f4	10	#if HAVE_OPENSSL
c2fa92e7	11	# include <openssl/bio.h>
57633d23	12	# include <openssl/bn.h>
900e73f8	13	# include <openssl/crypto.h>
57633d23	14	# include <openssl/err.h>
4ef65db3	15	# include <openssl/evp.h>
d9b5841d	16	# include <openssl/opensslv.h>
c2fa92e7 LP	17	# include <openssl/pkcs7.h>
	18	# include <openssl/ssl.h>
	19	# include <openssl/x509v3.h>
d9b5841d LP	20	# ifndef OPENSSL_VERSION_MAJOR
	21	/* OPENSSL_VERSION_MAJOR macro was added in OpenSSL 3. Thus, if it doesn't exist, we must be before OpenSSL 3. */
	22	# define OPENSSL_VERSION_MAJOR 1
	23	# endif
	24	# if OPENSSL_VERSION_MAJOR >= 3
	25	# include <openssl/core_names.h>
a65a25be	26	# include <openssl/kdf.h>
dcec950c	27	# include <openssl/param_build.h>
d9b5841d	28	# endif
3f637019	29
900e73f8	30	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL_MACRO(void*, OPENSSL_free, NULL);
fd421c4a ZJS	31	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509_NAME*, X509_NAME_free, NULL);
	32	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY_CTX*, EVP_PKEY_CTX_free, NULL);
	33	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER_CTX*, EVP_CIPHER_CTX_free, NULL);
57633d23 ZJS	34	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_POINT*, EC_POINT_free, NULL);
	35	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_GROUP*, EC_GROUP_free, NULL);
	36	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIGNUM*, BN_free, NULL);
	37	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BN_CTX*, BN_CTX_free, NULL);
	38	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(ECDSA_SIG*, ECDSA_SIG_free, NULL);
c2fa92e7 LP	39	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(PKCS7*, PKCS7_free, NULL);
	40	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(SSL*, SSL_free, NULL);
	41	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIO*, BIO_free, NULL);
18f568b8	42	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD_CTX*, EVP_MD_CTX_free, NULL);
dcec950c	43	#if OPENSSL_VERSION_MAJOR >= 3
58f215a0	44	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER*, EVP_CIPHER_free, NULL);
a65a25be DS	45	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_KDF*, EVP_KDF_free, NULL);
a65a25be DS	46	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_KDF_CTX*, EVP_KDF_CTX_free, NULL);
a95e8fa2 DS	47	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MAC*, EVP_MAC_free, NULL);
a95e8fa2 DS	48	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MAC_CTX*, EVP_MAC_CTX_free, NULL);
c52a003d	49	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD*, EVP_MD_free, NULL);
dcec950c DS	50	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM*, OSSL_PARAM_free, NULL);
	51	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM_BLD*, OSSL_PARAM_BLD_free, NULL);
	52	#else
	53	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_KEY*, EC_KEY_free, NULL);
a95e8fa2	54	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(HMAC_CTX*, HMAC_CTX_free, NULL);
dcec950c DS	55	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(RSA*, RSA_free, NULL);
dcec950c DS	56	#endif
c2fa92e7 LP	57
	58	static inline void sk_X509_free_allp(STACK_OF(X509) **sk) {
	59	if (!sk \|\| !*sk)
	60	return;
	61
	62	sk_X509_pop_free(*sk, X509_free);
	63	}
b012a1f4	64
4af788c7 DS	65	int openssl_pkey_from_pem(const void pem, size_t pem_size, EVP_PKEY *ret);
4af788c7 DS	66
c52a003d DS	67	int openssl_digest_size(const char digest_alg, size_t ret_digest_size);
c52a003d DS	68
bed4831c DS	69	int openssl_digest_many(const char digest_alg, const struct iovec data[], size_t n_data, void ret_digest, size_t ret_digest_size);
	70
	71	static inline int openssl_digest(const char digest_alg, const void buf, size_t len, void *ret_digest, size_t ret_digest_size) {
	72	return openssl_digest_many(digest_alg, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
	73	}
	74
a95e8fa2 DS	75	int openssl_hmac_many(const char digest_alg, const void key, size_t key_size, const struct iovec data[], size_t n_data, void *ret_digest, size_t ret_digest_size);
	76
	77	static inline int openssl_hmac(const char digest_alg, const void key, size_t key_size, const void buf, size_t len, void ret_digest, size_t ret_digest_size) {
	78	return openssl_hmac_many(digest_alg, key, key_size, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
	79	}
	80
58f215a0 DS	81	int openssl_cipher_many(const char alg, size_t bits, const char mode, const void key, size_t key_size, const void iv, size_t iv_size, const struct iovec data[], size_t n_data, void *ret, size_t ret_size);
	82
	83	static inline int openssl_cipher(const char alg, size_t bits, const char mode, const void key, size_t key_size, const void iv, size_t iv_size, const void buf, size_t len, void ret, size_t ret_size) {
	84	return openssl_cipher_many(alg, bits, mode, key, key_size, iv, iv_size, &IOVEC_MAKE((void*) buf, len), 1, ret, ret_size);
	85	}
	86
8c2205bb DS	87	int kdf_ss_derive(const char digest, const void key, size_t key_size, const void salt, size_t salt_size, const void info, size_t info_size, size_t derive_size, void **ret);
8c2205bb DS	88
a65a25be DS	89	int kdf_kb_hmac_derive(const char mode, const char digest, const void key, size_t key_size, const void salt, size_t salt_size, const void info, size_t info_size, const void seed, size_t seed_size, size_t derive_size, void **ret);
a65a25be DS	90
f2d5df8a LP	91	int rsa_encrypt_bytes(EVP_PKEY pkey, const void decrypted_key, size_t decrypted_key_size, void *ret_encrypt_key, size_t ret_encrypt_key_size);
f2d5df8a LP	92
816b1dc4 DS	93	int rsa_oaep_encrypt_bytes(const EVP_PKEY pkey, const char digest_alg, const char label, const void decrypted_key, size_t decrypted_key_size, void *ret_encrypt_key, size_t ret_encrypt_key_size);
816b1dc4 DS	94
d041e4fc	95	int rsa_pkey_to_suitable_key_size(EVP_PKEY pkey, size_t ret_suitable_key_size);
e8ccb5c7	96
dcec950c DS	97	int rsa_pkey_new(size_t bits, EVP_PKEY **ret);
	98
	99	int rsa_pkey_from_n_e(const void n, size_t n_size, const void e, size_t e_size, EVP_PKEY **ret);
	100
	101	int rsa_pkey_to_n_e(const EVP_PKEY pkey, void ret_n, size_t ret_n_size, void *ret_e, size_t ret_e_size);
	102
900e73f8 DS	103	int ecc_pkey_from_curve_x_y(int curve_id, const void x, size_t x_size, const void y, size_t y_size, EVP_PKEY **ret);
	104
	105	int ecc_pkey_to_curve_x_y(const EVP_PKEY pkey, int ret_curve_id, void *ret_x, size_t ret_x_size, void *ret_y, size_t ret_y_size);
	106
	107	int ecc_pkey_new(int curve_id, EVP_PKEY **ret);
	108
779b80d8 DS	109	int ecc_ecdh(const EVP_PKEY private_pkey, const EVP_PKEY peer_pkey, void *ret_shared_secret, size_t ret_shared_secret_size);
779b80d8 DS	110
e8ccb5c7 LP	111	int pubkey_fingerprint(EVP_PKEY pk, const EVP_MD md, void *ret, size_t ret_size);
e8ccb5c7 LP	112
ef65c0f6 LP	113	int digest_and_sign(const EVP_MD md, EVP_PKEY privkey, const void data, size_t size, void ret, size_t ret_size);
ef65c0f6 LP	114
bc958a19 DDM	115	#else
	116
	117	typedef struct X509 X509;
	118	typedef struct EVP_PKEY EVP_PKEY;
	119
	120	static inline void X509_free(X509 p) {
	121	assert(p == NULL);
	122	return NULL;
	123	}
	124
	125	static inline void EVP_PKEY_free(EVP_PKEY p) {
	126	assert(p == NULL);
	127	return NULL;
	128	}
	129
57633d23 ZJS	130	#endif
57633d23 ZJS	131
bc958a19 DDM	132	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509*, X509_free, NULL);
	133	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY*, EVP_PKEY_free, NULL);
	134
8939d335 DDM	135	int x509_fingerprint(X509 *cert, uint8_t buffer[static X509_FINGERPRINT_SIZE]);
8939d335 DDM	136
57633d23 ZJS	137	#if PREFER_OPENSSL
	138	/* The openssl definition */
	139	typedef const EVP_MD* hash_md_t;
	140	typedef const EVP_MD* hash_algorithm_t;
	141	typedef int elliptic_curve_t;
	142	typedef EVP_MD_CTX* hash_context_t;
	143	# define OPENSSL_OR_GCRYPT(a, b) (a)
	144
	145	#elif HAVE_GCRYPT
	146
	147	# include <gcrypt.h>
d041e4fc	148
57633d23 ZJS	149	/* The gcrypt definition */
	150	typedef int hash_md_t;
	151	typedef const char* hash_algorithm_t;
	152	typedef const char* elliptic_curve_t;
	153	typedef gcry_md_hd_t hash_context_t;
	154	# define OPENSSL_OR_GCRYPT(a, b) (b)
b012a1f4	155	#endif
7e8facb3 ZJS	156
7e8facb3 ZJS	157	#if PREFER_OPENSSL
11f7bc5e	158	int string_hashsum(const char s, size_t len, const char md_algorithm, char **ret);
7e8facb3 ZJS	159
7e8facb3 ZJS	160	static inline int string_hashsum_sha224(const char s, size_t len, char *ret) {
11f7bc5e	161	return string_hashsum(s, len, "SHA224", ret);
7e8facb3 ZJS	162	}
	163
	164	static inline int string_hashsum_sha256(const char s, size_t len, char *ret) {
11f7bc5e	165	return string_hashsum(s, len, "SHA256", ret);
7e8facb3 ZJS	166	}
7e8facb3 ZJS	167	#endif