2 * Copyright (c) 2019 Andreas Schneider <asn@samba.org>
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #ifndef _GNUTLS_HELPERS_H
19 #define _GNUTLS_HELPERS_H
21 #include <gnutls/gnutls.h>
23 #include "libcli/util/ntstatus.h"
24 #include "libcli/util/werror.h"
25 #include "lib/util/data_blob.h"
27 /* Those macros are only available in GnuTLS >= 3.6.4 */
28 #ifndef GNUTLS_FIPS140_SET_LAX_MODE
29 #define GNUTLS_FIPS140_SET_LAX_MODE()
32 #ifndef GNUTLS_FIPS140_SET_STRICT_MODE
33 #define GNUTLS_FIPS140_SET_STRICT_MODE()
38 * @brief Convert a gnutls error code to a corresponding NTSTATUS.
40 * @param[in] gnutls_rc The GnuTLS return code.
42 * @param[in] blocked_status The NTSTATUS return code which should be returned
43 * in case the e.g. the cipher might be blocked due
46 * @return A corresponding NTSTATUS code.
48 NTSTATUS
gnutls_error_to_ntstatus(int gnutls_rc
, NTSTATUS blocked_status
);
50 NTSTATUS
_gnutls_error_to_ntstatus(int gnutls_rc
,
51 NTSTATUS blocked_status
,
53 const char *location
);
54 #define gnutls_error_to_ntstatus(gnutls_rc, blocked_status) \
55 _gnutls_error_to_ntstatus(gnutls_rc, \
63 * @brief Convert a gnutls error code to a corresponding WERROR.
65 * @param[in] gnutls_rc The GnuTLS return code.
67 * @param[in] blocked_werr The WERROR code which should be returned if e.g
68 * the cipher we want to used it not allowed to be
69 * used because of FIPS mode.
71 * @return A corresponding WERROR code.
73 WERROR
gnutls_error_to_werror(int gnutls_rc
, WERROR blocked_werr
);
75 WERROR
_gnutls_error_to_werror(int gnutls_rc
,
78 const char *location
);
79 #define gnutls_error_to_werror(gnutls_rc, blocked_werr) \
80 _gnutls_error_to_werror(gnutls_rc, \
86 enum samba_gnutls_direction
{ SAMBA_GNUTLS_ENCRYPT
, SAMBA_GNUTLS_DECRYPT
};
89 * @brief Encrypt or decrypt a data blob using RC4 with a key and salt.
91 * One of the key input should be a session key and the other a confounder
92 * (aka salt). Which one depends on the implementation details of the
95 * @param[in] key_input1 Either a session_key or a confounder.
97 * @param[in] key_input2 Either a session_key or a confounder.
99 * @param[in] data The data blob to either encrypt or decrypt. The data
100 * will be encrypted or decrypted in place.
102 * @param[in] encrypt The encryption direction.
104 * @return A gnutls error code.
106 int samba_gnutls_arcfour_confounded_md5(const DATA_BLOB
*key_input1
,
107 const DATA_BLOB
*key_input2
,
109 enum samba_gnutls_direction encrypt
);
112 * @brief Encrypted a secret plaintext using AEAD_AES_256_CBC_HMAC_SHA512 and
115 * This encrypts a secret plaintext using AEAD_AES_256_CBC_HMAC_SHA512 with a
116 * key (can be the session key or PBKDF2 password). This is used in SAMR and
119 * @param mem_ctx The memory context to allocate the cipher text pointer.
121 * @param plaintext The secret to encrypt
123 * @param cek The content encryption key to encrypt the secret.
125 * @param key_salt The salt used to calculate the encryption key.
127 * @param key_salt The salt used to calculate the mac key.
129 * @param iv The initialization vector used for the encryption.
131 * @param pciphertext A pointer to store the cipher text.
133 * @param pauth_tag[64] An array to store the auth tag.
135 * @return NT_STATUS_OK on success, an nt status error code otherwise.
138 samba_gnutls_aead_aes_256_cbc_hmac_sha512_encrypt(TALLOC_CTX
*mem_ctx
,
139 const DATA_BLOB
*plaintext
,
140 const DATA_BLOB
*cek
,
141 const DATA_BLOB
*key_salt
,
142 const DATA_BLOB
*mac_salt
,
144 DATA_BLOB
*pciphertext
,
145 uint8_t pauth_tag
[64]);
148 * @brief Decypt cipher text using AEAD_AES_256_CBC_HMAC_SHA512 and the session
151 * This decrypts the cipher text using AEAD_AES_256_CBC_HMAC_SHA512 with the
152 * given content decryption key key. The plaintext will be zeroed as soon as the
153 * data blob is freed.
155 * @param mem_ctx The memory context to allocate the plaintext on.
157 * @param ciphertext The cipher text to decrypt.
159 * @param cdk The content decryption key.
161 * @param key_salt The salt used to calculate the encryption key.
163 * @param key_salt The salt used to calculate the mac key.
165 * @param iv The initialization vector used for the encryption.
167 * @param auth_tag[64] The authentication blob to be verified.
169 * @param pplaintext A pointer to a DATA_BLOB to store the plaintext.
171 * @return NT_STATUS_OK on success, an nt status error code otherwise.
174 samba_gnutls_aead_aes_256_cbc_hmac_sha512_decrypt(TALLOC_CTX
*mem_ctx
,
175 const DATA_BLOB
*ciphertext
,
176 const DATA_BLOB
*cdk
,
177 const DATA_BLOB
*key_salt
,
178 const DATA_BLOB
*mac_salt
,
180 const uint8_t auth_tag
[64],
181 DATA_BLOB
*pplaintext
);
184 * @brief Check if weak crypto is allowed.
186 * @return true if weak crypo is allowed, false otherwise.
188 bool samba_gnutls_weak_crypto_allowed(void);
190 #endif /* _GNUTLS_HELPERS_H */