]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/shared/openssl-util.h
openssl: add helper to load key from provider/engine
[thirdparty/systemd.git] / src / shared / openssl-util.h
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
3f637019
LP
2#pragma once
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>
dba0afa1 14# include <openssl/engine.h>
57633d23 15# include <openssl/err.h>
4ef65db3 16# include <openssl/evp.h>
d9b5841d 17# include <openssl/opensslv.h>
c2fa92e7
LP
18# include <openssl/pkcs7.h>
19# include <openssl/ssl.h>
20# include <openssl/x509v3.h>
d9b5841d
LP
21# ifndef OPENSSL_VERSION_MAJOR
22/* OPENSSL_VERSION_MAJOR macro was added in OpenSSL 3. Thus, if it doesn't exist, we must be before OpenSSL 3. */
23# define OPENSSL_VERSION_MAJOR 1
24# endif
25# if OPENSSL_VERSION_MAJOR >= 3
26# include <openssl/core_names.h>
a65a25be 27# include <openssl/kdf.h>
dcec950c 28# include <openssl/param_build.h>
dba0afa1
LB
29# include <openssl/provider.h>
30# include <openssl/store.h>
d9b5841d 31# endif
3f637019 32
900e73f8 33DEFINE_TRIVIAL_CLEANUP_FUNC_FULL_MACRO(void*, OPENSSL_free, NULL);
fd421c4a
ZJS
34DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509_NAME*, X509_NAME_free, NULL);
35DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY_CTX*, EVP_PKEY_CTX_free, NULL);
36DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER_CTX*, EVP_CIPHER_CTX_free, NULL);
57633d23
ZJS
37DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_POINT*, EC_POINT_free, NULL);
38DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_GROUP*, EC_GROUP_free, NULL);
39DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIGNUM*, BN_free, NULL);
40DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BN_CTX*, BN_CTX_free, NULL);
41DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(ECDSA_SIG*, ECDSA_SIG_free, NULL);
c2fa92e7
LP
42DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(PKCS7*, PKCS7_free, NULL);
43DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(SSL*, SSL_free, NULL);
44DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(BIO*, BIO_free, NULL);
18f568b8 45DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD_CTX*, EVP_MD_CTX_free, NULL);
85686b37 46DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(ASN1_OCTET_STRING*, ASN1_OCTET_STRING_free, NULL);
dba0afa1
LB
47DISABLE_WARNING_DEPRECATED_DECLARATIONS;
48DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(ENGINE*, ENGINE_free, NULL);
49REENABLE_WARNING;
dcec950c 50#if OPENSSL_VERSION_MAJOR >= 3
58f215a0 51DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_CIPHER*, EVP_CIPHER_free, NULL);
a65a25be
DS
52DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_KDF*, EVP_KDF_free, NULL);
53DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_KDF_CTX*, EVP_KDF_CTX_free, NULL);
a95e8fa2
DS
54DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MAC*, EVP_MAC_free, NULL);
55DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MAC_CTX*, EVP_MAC_CTX_free, NULL);
c52a003d 56DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_MD*, EVP_MD_free, NULL);
dcec950c
DS
57DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM*, OSSL_PARAM_free, NULL);
58DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_PARAM_BLD*, OSSL_PARAM_BLD_free, NULL);
dba0afa1
LB
59DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_STORE_CTX*, OSSL_STORE_close, NULL);
60DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(OSSL_STORE_INFO*, OSSL_STORE_INFO_free, NULL);
dcec950c
DS
61#else
62DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EC_KEY*, EC_KEY_free, NULL);
a95e8fa2 63DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(HMAC_CTX*, HMAC_CTX_free, NULL);
dcec950c
DS
64DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(RSA*, RSA_free, NULL);
65#endif
c2fa92e7
LP
66
67static inline void sk_X509_free_allp(STACK_OF(X509) **sk) {
68 if (!sk || !*sk)
69 return;
70
71 sk_X509_pop_free(*sk, X509_free);
72}
b012a1f4 73
4af788c7
DS
74int openssl_pkey_from_pem(const void *pem, size_t pem_size, EVP_PKEY **ret);
75
c52a003d
DS
76int openssl_digest_size(const char *digest_alg, size_t *ret_digest_size);
77
bed4831c
DS
78int openssl_digest_many(const char *digest_alg, const struct iovec data[], size_t n_data, void **ret_digest, size_t *ret_digest_size);
79
80static inline int openssl_digest(const char *digest_alg, const void *buf, size_t len, void **ret_digest, size_t *ret_digest_size) {
81 return openssl_digest_many(digest_alg, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
82}
83
a95e8fa2
DS
84int 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);
85
86static 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) {
87 return openssl_hmac_many(digest_alg, key, key_size, &IOVEC_MAKE((void*) buf, len), 1, ret_digest, ret_digest_size);
88}
89
58f215a0
DS
90int 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);
91
92static 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) {
93 return openssl_cipher_many(alg, bits, mode, key, key_size, iv, iv_size, &IOVEC_MAKE((void*) buf, len), 1, ret, ret_size);
94}
95
8c2205bb
DS
96int 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);
97
a65a25be
DS
98int 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);
99
f2d5df8a
LP
100int 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);
101
816b1dc4
DS
102int 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);
103
d041e4fc 104int rsa_pkey_to_suitable_key_size(EVP_PKEY *pkey, size_t *ret_suitable_key_size);
e8ccb5c7 105
dcec950c
DS
106int rsa_pkey_new(size_t bits, EVP_PKEY **ret);
107
108int rsa_pkey_from_n_e(const void *n, size_t n_size, const void *e, size_t e_size, EVP_PKEY **ret);
109
110int 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);
111
900e73f8
DS
112int 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);
113
114int 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);
115
116int ecc_pkey_new(int curve_id, EVP_PKEY **ret);
117
779b80d8
DS
118int ecc_ecdh(const EVP_PKEY *private_pkey, const EVP_PKEY *peer_pkey, void **ret_shared_secret, size_t *ret_shared_secret_size);
119
85686b37 120int pkey_generate_volume_keys(EVP_PKEY *pkey, void **ret_decrypted_key, size_t *ret_decrypted_key_size, void **ret_saved_key, size_t *ret_saved_key_size);
876206f2 121
e8ccb5c7
LP
122int pubkey_fingerprint(EVP_PKEY *pk, const EVP_MD *md, void **ret, size_t *ret_size);
123
ef65c0f6
LP
124int digest_and_sign(const EVP_MD *md, EVP_PKEY *privkey, const void *data, size_t size, void **ret, size_t *ret_size);
125
dba0afa1
LB
126int openssl_load_key_from_token(const char *private_key_uri, EVP_PKEY **ret);
127
bc958a19
DDM
128#else
129
130typedef struct X509 X509;
131typedef struct EVP_PKEY EVP_PKEY;
132
133static inline void *X509_free(X509 *p) {
134 assert(p == NULL);
135 return NULL;
136}
137
138static inline void *EVP_PKEY_free(EVP_PKEY *p) {
139 assert(p == NULL);
140 return NULL;
141}
142
dba0afa1
LB
143static inline int openssl_load_key_from_token(const char *private_key_uri, EVP_PKEY **ret) {
144 return -EOPNOTSUPP;
145}
146
57633d23
ZJS
147#endif
148
bc958a19
DDM
149DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(X509*, X509_free, NULL);
150DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY*, EVP_PKEY_free, NULL);
151
8939d335
DDM
152int x509_fingerprint(X509 *cert, uint8_t buffer[static X509_FINGERPRINT_SIZE]);
153
57633d23
ZJS
154#if PREFER_OPENSSL
155/* The openssl definition */
156typedef const EVP_MD* hash_md_t;
157typedef const EVP_MD* hash_algorithm_t;
158typedef int elliptic_curve_t;
159typedef EVP_MD_CTX* hash_context_t;
160# define OPENSSL_OR_GCRYPT(a, b) (a)
161
162#elif HAVE_GCRYPT
163
164# include <gcrypt.h>
d041e4fc 165
57633d23
ZJS
166/* The gcrypt definition */
167typedef int hash_md_t;
168typedef const char* hash_algorithm_t;
169typedef const char* elliptic_curve_t;
170typedef gcry_md_hd_t hash_context_t;
171# define OPENSSL_OR_GCRYPT(a, b) (b)
b012a1f4 172#endif
7e8facb3
ZJS
173
174#if PREFER_OPENSSL
11f7bc5e 175int string_hashsum(const char *s, size_t len, const char *md_algorithm, char **ret);
7e8facb3
ZJS
176
177static inline int string_hashsum_sha224(const char *s, size_t len, char **ret) {
11f7bc5e 178 return string_hashsum(s, len, "SHA224", ret);
7e8facb3
ZJS
179}
180
181static inline int string_hashsum_sha256(const char *s, size_t len, char **ret) {
11f7bc5e 182 return string_hashsum(s, len, "SHA256", ret);
7e8facb3
ZJS
183}
184#endif