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

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

#include "io-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/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_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(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_hash(const EVP_MD *alg, const void *msg, size_t msg_len, uint8_t *ret_hash, size_t *ret_hash_len);

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 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_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 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, hash_algorithm_t md_algorithm, char **ret);

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

static inline int string_hashsum_sha256(const char *s, size_t len, char **ret) {
        return string_hashsum(s, len, EVP_sha256(), ret);
}
#endif
Commit	Line	Data
db9ecf05	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
3f637019 LP	2	#pragma once
3f637019 LP	3
bed4831c	4	#include "io-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>
dcec950c	26	# include <openssl/param_build.h>
d9b5841d	27	# endif
3f637019	28
900e73f8	29	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL_MACRO(void*, OPENSSL_free, NULL);
fd421c4a ZJS	30	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509_NAME*, X509_NAME_free, NULL);
	31	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY_CTX*, EVP_PKEY_CTX_free, NULL);
	32	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER_CTX*, EVP_CIPHER_CTX_free, NULL);
57633d23 ZJS	33	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_POINT*, EC_POINT_free, NULL);
	34	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_GROUP*, EC_GROUP_free, NULL);
	35	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIGNUM*, BN_free, NULL);
	36	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BN_CTX*, BN_CTX_free, NULL);
	37	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(ECDSA_SIG*, ECDSA_SIG_free, NULL);
c2fa92e7 LP	38	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(PKCS7*, PKCS7_free, NULL);
	39	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(SSL*, SSL_free, NULL);
	40	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIO*, BIO_free, NULL);
18f568b8	41	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD_CTX*, EVP_MD_CTX_free, NULL);
dcec950c	42	#if OPENSSL_VERSION_MAJOR >= 3
c52a003d	43	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD*, EVP_MD_free, NULL);
dcec950c DS	44	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM*, OSSL_PARAM_free, NULL);
	45	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM_BLD*, OSSL_PARAM_BLD_free, NULL);
	46	#else
	47	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_KEY*, EC_KEY_free, NULL);
	48	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(RSA*, RSA_free, NULL);
	49	#endif
c2fa92e7 LP	50
	51	static inline void sk_X509_free_allp(STACK_OF(X509) **sk) {
	52	if (!sk \|\| !*sk)
	53	return;
	54
	55	sk_X509_pop_free(*sk, X509_free);
	56	}
b012a1f4	57
4af788c7 DS	58	int openssl_pkey_from_pem(const void pem, size_t pem_size, EVP_PKEY *ret);
4af788c7 DS	59
fc169a6f KK	60	int openssl_hash(const EVP_MD alg, const void msg, size_t msg_len, uint8_t ret_hash, size_t ret_hash_len);
fc169a6f KK	61
c52a003d DS	62	int openssl_digest_size(const char digest_alg, size_t ret_digest_size);
c52a003d DS	63
bed4831c DS	64	int openssl_digest_many(const char digest_alg, const struct iovec data[], size_t n_data, void ret_digest, size_t ret_digest_size);
	65
	66	static inline int openssl_digest(const char digest_alg, const void buf, size_t len, void *ret_digest, size_t ret_digest_size) {
	67	return openssl_digest_many(digest_alg, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
	68	}
	69
f2d5df8a LP	70	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	71
d041e4fc	72	int rsa_pkey_to_suitable_key_size(EVP_PKEY pkey, size_t ret_suitable_key_size);
e8ccb5c7	73
dcec950c DS	74	int rsa_pkey_new(size_t bits, EVP_PKEY **ret);
	75
	76	int rsa_pkey_from_n_e(const void n, size_t n_size, const void e, size_t e_size, EVP_PKEY **ret);
	77
	78	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);
	79
900e73f8 DS	80	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);
	81
	82	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);
	83
	84	int ecc_pkey_new(int curve_id, EVP_PKEY **ret);
	85
e8ccb5c7 LP	86	int pubkey_fingerprint(EVP_PKEY pk, const EVP_MD md, void *ret, size_t ret_size);
e8ccb5c7 LP	87
ef65c0f6 LP	88	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	89
bc958a19 DDM	90	#else
	91
	92	typedef struct X509 X509;
	93	typedef struct EVP_PKEY EVP_PKEY;
	94
	95	static inline void X509_free(X509 p) {
	96	assert(p == NULL);
	97	return NULL;
	98	}
	99
	100	static inline void EVP_PKEY_free(EVP_PKEY p) {
	101	assert(p == NULL);
	102	return NULL;
	103	}
	104
57633d23 ZJS	105	#endif
57633d23 ZJS	106
bc958a19 DDM	107	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509*, X509_free, NULL);
	108	DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY*, EVP_PKEY_free, NULL);
	109
8939d335 DDM	110	int x509_fingerprint(X509 *cert, uint8_t buffer[static X509_FINGERPRINT_SIZE]);
8939d335 DDM	111
57633d23 ZJS	112	#if PREFER_OPENSSL
	113	/* The openssl definition */
	114	typedef const EVP_MD* hash_md_t;
	115	typedef const EVP_MD* hash_algorithm_t;
	116	typedef int elliptic_curve_t;
	117	typedef EVP_MD_CTX* hash_context_t;
	118	# define OPENSSL_OR_GCRYPT(a, b) (a)
	119
	120	#elif HAVE_GCRYPT
	121
	122	# include <gcrypt.h>
d041e4fc	123
57633d23 ZJS	124	/* The gcrypt definition */
	125	typedef int hash_md_t;
	126	typedef const char* hash_algorithm_t;
	127	typedef const char* elliptic_curve_t;
	128	typedef gcry_md_hd_t hash_context_t;
	129	# define OPENSSL_OR_GCRYPT(a, b) (b)
b012a1f4	130	#endif
7e8facb3 ZJS	131
	132	#if PREFER_OPENSSL
	133	int string_hashsum(const char s, size_t len, hash_algorithm_t md_algorithm, char *ret);
	134
	135	static inline int string_hashsum_sha224(const char s, size_t len, char *ret) {
	136	return string_hashsum(s, len, EVP_sha224(), ret);
	137	}
	138
	139	static inline int string_hashsum_sha256(const char s, size_t len, char *ret) {
	140	return string_hashsum(s, len, EVP_sha256(), ret);
	141	}
	142	#endif