]>
Commit | Line | Data |
---|---|---|
0f113f3e | 1 | /* |
33388b44 | 2 | * Copyright 1999-2020 The OpenSSL Project Authors. All Rights Reserved. |
97e4a932 | 3 | * |
4a8b0c55 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
62867571 RS |
5 | * this file except in compliance with the License. You can obtain a copy |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
97e4a932 | 8 | */ |
62867571 | 9 | |
97e4a932 DSH |
10 | #include <stdio.h> |
11 | #include <stdlib.h> | |
b39fc560 | 12 | #include "internal/cryptlib.h" |
5a285add DM |
13 | #include <openssl/x509.h> |
14 | #include <openssl/evp.h> | |
15 | #include <openssl/kdf.h> | |
16 | #include <openssl/hmac.h> | |
3a9b3d2d | 17 | #include <openssl/trace.h> |
7707526b | 18 | #include <openssl/core_names.h> |
25f2138b | 19 | #include "crypto/evp.h" |
706457b7 | 20 | #include "evp_local.h" |
97e4a932 | 21 | |
d8652be0 MC |
22 | int pkcs5_pbkdf2_hmac_ex(const char *pass, int passlen, |
23 | const unsigned char *salt, int saltlen, int iter, | |
24 | const EVP_MD *digest, int keylen, unsigned char *out, | |
b4250010 | 25 | OSSL_LIB_CTX *libctx, const char *propq) |
0f113f3e | 26 | { |
fa013b65 | 27 | const char *empty = ""; |
7707526b P |
28 | int rv = 1, mode = 1; |
29 | EVP_KDF *kdf; | |
5a285add | 30 | EVP_KDF_CTX *kctx; |
7707526b P |
31 | const char *mdname = EVP_MD_name(digest); |
32 | OSSL_PARAM params[6], *p = params; | |
0f113f3e | 33 | |
5a285add | 34 | /* Keep documented behaviour. */ |
fa013b65 PB |
35 | if (pass == NULL) { |
36 | pass = empty; | |
0f113f3e | 37 | passlen = 0; |
fa013b65 | 38 | } else if (passlen == -1) { |
0f113f3e | 39 | passlen = strlen(pass); |
fa013b65 | 40 | } |
5a285add DM |
41 | if (salt == NULL && saltlen == 0) |
42 | salt = (unsigned char *)empty; | |
43 | ||
5ccada09 | 44 | kdf = EVP_KDF_fetch(libctx, OSSL_KDF_NAME_PBKDF2, propq); |
660c5344 | 45 | kctx = EVP_KDF_CTX_new(kdf); |
7707526b | 46 | EVP_KDF_free(kdf); |
5a285add | 47 | if (kctx == NULL) |
0f113f3e | 48 | return 0; |
7707526b P |
49 | *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PASSWORD, |
50 | (char *)pass, (size_t)passlen); | |
51 | *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_PKCS5, &mode); | |
52 | *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT, | |
53 | (unsigned char *)salt, saltlen); | |
54 | *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_ITER, &iter); | |
55 | *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST, | |
8b6ffd40 | 56 | (char *)mdname, 0); |
7707526b | 57 | *p = OSSL_PARAM_construct_end(); |
36fae6e8 | 58 | if (EVP_KDF_derive(kctx, out, keylen, params) != 1) |
5a285add DM |
59 | rv = 0; |
60 | ||
660c5344 | 61 | EVP_KDF_CTX_free(kctx); |
5a285add | 62 | |
3a9b3d2d RL |
63 | OSSL_TRACE_BEGIN(PKCS5V2) { |
64 | BIO_printf(trc_out, "Password:\n"); | |
65 | BIO_hex_string(trc_out, | |
66 | 0, passlen, pass, passlen); | |
67 | BIO_printf(trc_out, "\n"); | |
68 | BIO_printf(trc_out, "Salt:\n"); | |
69 | BIO_hex_string(trc_out, | |
70 | 0, saltlen, salt, saltlen); | |
71 | BIO_printf(trc_out, "\n"); | |
72 | BIO_printf(trc_out, "Iteration count %d\n", iter); | |
73 | BIO_printf(trc_out, "Key:\n"); | |
74 | BIO_hex_string(trc_out, | |
75 | 0, keylen, out, keylen); | |
76 | BIO_printf(trc_out, "\n"); | |
77 | } OSSL_TRACE_END(PKCS5V2); | |
5a285add | 78 | return rv; |
0f113f3e | 79 | } |
856640b5 | 80 | |
5ccada09 SL |
81 | int PKCS5_PBKDF2_HMAC(const char *pass, int passlen, const unsigned char *salt, |
82 | int saltlen, int iter, const EVP_MD *digest, int keylen, | |
83 | unsigned char *out) | |
84 | { | |
d8652be0 MC |
85 | return pkcs5_pbkdf2_hmac_ex(pass, passlen, salt, saltlen, iter, digest, |
86 | keylen, out, NULL, NULL); | |
5ccada09 SL |
87 | } |
88 | ||
89 | ||
856640b5 | 90 | int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen, |
0f113f3e MC |
91 | const unsigned char *salt, int saltlen, int iter, |
92 | int keylen, unsigned char *out) | |
93 | { | |
94 | return PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, EVP_sha1(), | |
95 | keylen, out); | |
96 | } | |
97 | ||
0f113f3e MC |
98 | /* |
99 | * Now the key derivation function itself. This is a bit evil because it has | |
100 | * to check the ASN1 parameters are valid: and there are quite a few of | |
101 | * them... | |
97e4a932 DSH |
102 | */ |
103 | ||
104 | int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, | |
0f113f3e MC |
105 | ASN1_TYPE *param, const EVP_CIPHER *c, |
106 | const EVP_MD *md, int en_de) | |
97e4a932 | 107 | { |
0f113f3e MC |
108 | PBE2PARAM *pbe2 = NULL; |
109 | const EVP_CIPHER *cipher; | |
d6c5462e | 110 | EVP_PBE_KEYGEN *kdf; |
0f113f3e MC |
111 | |
112 | int rv = 0; | |
113 | ||
e93c8748 DSH |
114 | pbe2 = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBE2PARAM), param); |
115 | if (pbe2 == NULL) { | |
9311d0c4 | 116 | ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR); |
0f113f3e MC |
117 | goto err; |
118 | } | |
119 | ||
120 | /* See if we recognise the key derivation function */ | |
d6c5462e | 121 | if (!EVP_PBE_find(EVP_PBE_TYPE_KDF, OBJ_obj2nid(pbe2->keyfunc->algorithm), |
dccd20d1 | 122 | NULL, NULL, &kdf)) { |
9311d0c4 | 123 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION); |
0f113f3e MC |
124 | goto err; |
125 | } | |
126 | ||
127 | /* | |
128 | * lets see if we recognise the encryption algorithm. | |
129 | */ | |
130 | ||
131 | cipher = EVP_get_cipherbyobj(pbe2->encryption->algorithm); | |
132 | ||
133 | if (!cipher) { | |
9311d0c4 | 134 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_CIPHER); |
0f113f3e MC |
135 | goto err; |
136 | } | |
137 | ||
138 | /* Fixup cipher based on AlgorithmIdentifier */ | |
139 | if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, en_de)) | |
140 | goto err; | |
141 | if (EVP_CIPHER_asn1_to_param(ctx, pbe2->encryption->parameter) < 0) { | |
9311d0c4 | 142 | ERR_raise(ERR_LIB_EVP, EVP_R_CIPHER_PARAMETER_ERROR); |
0f113f3e MC |
143 | goto err; |
144 | } | |
d6c5462e | 145 | rv = kdf(ctx, pass, passlen, pbe2->keyfunc->parameter, NULL, NULL, en_de); |
0f113f3e MC |
146 | err: |
147 | PBE2PARAM_free(pbe2); | |
148 | return rv; | |
3d63b396 DSH |
149 | } |
150 | ||
0f113f3e MC |
151 | int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, |
152 | int passlen, ASN1_TYPE *param, | |
153 | const EVP_CIPHER *c, const EVP_MD *md, int en_de) | |
3d63b396 | 154 | { |
0f113f3e | 155 | unsigned char *salt, key[EVP_MAX_KEY_LENGTH]; |
ea053ec9 | 156 | int saltlen, iter, t; |
0f113f3e MC |
157 | int rv = 0; |
158 | unsigned int keylen = 0; | |
159 | int prf_nid, hmac_md_nid; | |
160 | PBKDF2PARAM *kdf = NULL; | |
161 | const EVP_MD *prfmd; | |
162 | ||
163 | if (EVP_CIPHER_CTX_cipher(ctx) == NULL) { | |
9311d0c4 | 164 | ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET); |
0f113f3e MC |
165 | goto err; |
166 | } | |
167 | keylen = EVP_CIPHER_CTX_key_length(ctx); | |
cbe29648 | 168 | OPENSSL_assert(keylen <= sizeof(key)); |
0f113f3e MC |
169 | |
170 | /* Decode parameter */ | |
171 | ||
e93c8748 | 172 | kdf = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(PBKDF2PARAM), param); |
0f113f3e | 173 | |
e93c8748 | 174 | if (kdf == NULL) { |
9311d0c4 | 175 | ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR); |
0f113f3e MC |
176 | goto err; |
177 | } | |
178 | ||
ea053ec9 P |
179 | t = EVP_CIPHER_CTX_key_length(ctx); |
180 | if (t < 0) { | |
9311d0c4 | 181 | ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH); |
ea053ec9 P |
182 | goto err; |
183 | } | |
184 | keylen = t; | |
0f113f3e MC |
185 | |
186 | /* Now check the parameters of the kdf */ | |
187 | ||
188 | if (kdf->keylength && (ASN1_INTEGER_get(kdf->keylength) != (int)keylen)) { | |
9311d0c4 | 189 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH); |
0f113f3e MC |
190 | goto err; |
191 | } | |
192 | ||
193 | if (kdf->prf) | |
194 | prf_nid = OBJ_obj2nid(kdf->prf->algorithm); | |
195 | else | |
196 | prf_nid = NID_hmacWithSHA1; | |
197 | ||
198 | if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, prf_nid, NULL, &hmac_md_nid, 0)) { | |
9311d0c4 | 199 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_PRF); |
0f113f3e MC |
200 | goto err; |
201 | } | |
202 | ||
203 | prfmd = EVP_get_digestbynid(hmac_md_nid); | |
204 | if (prfmd == NULL) { | |
9311d0c4 | 205 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_PRF); |
0f113f3e MC |
206 | goto err; |
207 | } | |
208 | ||
209 | if (kdf->salt->type != V_ASN1_OCTET_STRING) { | |
9311d0c4 | 210 | ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_SALT_TYPE); |
0f113f3e MC |
211 | goto err; |
212 | } | |
213 | ||
214 | /* it seems that its all OK */ | |
215 | salt = kdf->salt->value.octet_string->data; | |
216 | saltlen = kdf->salt->value.octet_string->length; | |
217 | iter = ASN1_INTEGER_get(kdf->iter); | |
218 | if (!PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, iter, prfmd, | |
219 | keylen, key)) | |
220 | goto err; | |
221 | rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de); | |
222 | err: | |
223 | OPENSSL_cleanse(key, keylen); | |
224 | PBKDF2PARAM_free(kdf); | |
225 | return rv; | |
97e4a932 | 226 | } |