/src/openssl/crypto/passphrase.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved. |
3 | | * |
4 | | * Licensed under the Apache License 2.0 (the "License"). You may not use |
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 |
8 | | */ |
9 | | |
10 | | #include <openssl/err.h> |
11 | | #include <openssl/ui.h> |
12 | | #include <openssl/core_names.h> |
13 | | #include "internal/cryptlib.h" |
14 | | #include "internal/passphrase.h" |
15 | | |
16 | | void ossl_pw_clear_passphrase_data(struct ossl_passphrase_data_st *data) |
17 | 68.4k | { |
18 | 68.4k | if (data != NULL) { |
19 | 68.4k | if (data->type == is_expl_passphrase) |
20 | 0 | OPENSSL_clear_free(data->_.expl_passphrase.passphrase_copy, |
21 | 68.4k | data->_.expl_passphrase.passphrase_len); |
22 | 68.4k | ossl_pw_clear_passphrase_cache(data); |
23 | 68.4k | memset(data, 0, sizeof(*data)); |
24 | 68.4k | } |
25 | 68.4k | } |
26 | | |
27 | | void ossl_pw_clear_passphrase_cache(struct ossl_passphrase_data_st *data) |
28 | 95.8k | { |
29 | 95.8k | OPENSSL_clear_free(data->cached_passphrase, data->cached_passphrase_len); |
30 | 95.8k | data->cached_passphrase = NULL; |
31 | 95.8k | } |
32 | | |
33 | | int ossl_pw_set_passphrase(struct ossl_passphrase_data_st *data, |
34 | | const unsigned char *passphrase, |
35 | | size_t passphrase_len) |
36 | 0 | { |
37 | 0 | if (!ossl_assert(data != NULL && passphrase != NULL)) { |
38 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER); |
39 | 0 | return 0; |
40 | 0 | } |
41 | 0 | ossl_pw_clear_passphrase_data(data); |
42 | 0 | data->type = is_expl_passphrase; |
43 | 0 | data->_.expl_passphrase.passphrase_copy = |
44 | 0 | passphrase_len != 0 ? OPENSSL_memdup(passphrase, passphrase_len) |
45 | 0 | : OPENSSL_malloc(1); |
46 | 0 | if (data->_.expl_passphrase.passphrase_copy == NULL) |
47 | 0 | return 0; |
48 | 0 | data->_.expl_passphrase.passphrase_len = passphrase_len; |
49 | 0 | return 1; |
50 | 0 | } |
51 | | |
52 | | int ossl_pw_set_pem_password_cb(struct ossl_passphrase_data_st *data, |
53 | | pem_password_cb *cb, void *cbarg) |
54 | 27.3k | { |
55 | 27.3k | if (!ossl_assert(data != NULL && cb != NULL)) { |
56 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER); |
57 | 0 | return 0; |
58 | 0 | } |
59 | 27.3k | ossl_pw_clear_passphrase_data(data); |
60 | 27.3k | data->type = is_pem_password; |
61 | 27.3k | data->_.pem_password.password_cb = cb; |
62 | 27.3k | data->_.pem_password.password_cbarg = cbarg; |
63 | 27.3k | return 1; |
64 | 27.3k | } |
65 | | |
66 | | int ossl_pw_set_ossl_passphrase_cb(struct ossl_passphrase_data_st *data, |
67 | | OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg) |
68 | 0 | { |
69 | 0 | if (!ossl_assert(data != NULL && cb != NULL)) { |
70 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER); |
71 | 0 | return 0; |
72 | 0 | } |
73 | 0 | ossl_pw_clear_passphrase_data(data); |
74 | 0 | data->type = is_ossl_passphrase; |
75 | 0 | data->_.ossl_passphrase.passphrase_cb = cb; |
76 | 0 | data->_.ossl_passphrase.passphrase_cbarg = cbarg; |
77 | 0 | return 1; |
78 | 0 | } |
79 | | |
80 | | int ossl_pw_set_ui_method(struct ossl_passphrase_data_st *data, |
81 | | const UI_METHOD *ui_method, void *ui_data) |
82 | 0 | { |
83 | 0 | if (!ossl_assert(data != NULL && ui_method != NULL)) { |
84 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER); |
85 | 0 | return 0; |
86 | 0 | } |
87 | 0 | ossl_pw_clear_passphrase_data(data); |
88 | 0 | data->type = is_ui_method; |
89 | 0 | data->_.ui_method.ui_method = ui_method; |
90 | 0 | data->_.ui_method.ui_method_data = ui_data; |
91 | 0 | return 1; |
92 | 0 | } |
93 | | |
94 | | int ossl_pw_enable_passphrase_caching(struct ossl_passphrase_data_st *data) |
95 | 41.0k | { |
96 | 41.0k | data->flag_cache_passphrase = 1; |
97 | 41.0k | return 1; |
98 | 41.0k | } |
99 | | |
100 | | int ossl_pw_disable_passphrase_caching(struct ossl_passphrase_data_st *data) |
101 | 0 | { |
102 | 0 | data->flag_cache_passphrase = 0; |
103 | 0 | return 1; |
104 | 0 | } |
105 | | |
106 | | |
107 | | /*- |
108 | | * UI_METHOD processor. It differs from UI_UTIL_read_pw() like this: |
109 | | * |
110 | | * 1. It constructs a prompt on its own, based on |prompt_info|. |
111 | | * 2. It allocates a buffer for password and verification on its own |
112 | | * to compensate for NUL terminator in UI password strings. |
113 | | * 3. It raises errors. |
114 | | * 4. It reports back the length of the prompted pass phrase. |
115 | | */ |
116 | | static int do_ui_passphrase(char *pass, size_t pass_size, size_t *pass_len, |
117 | | const char *prompt_info, int verify, |
118 | | const UI_METHOD *ui_method, void *ui_data) |
119 | 0 | { |
120 | 0 | char *prompt = NULL, *ipass = NULL, *vpass = NULL; |
121 | 0 | int prompt_idx = -1, verify_idx = -1, res; |
122 | 0 | UI *ui = NULL; |
123 | 0 | int ret = 0; |
124 | |
|
125 | 0 | if (!ossl_assert(pass != NULL && pass_size != 0 && pass_len != NULL)) { |
126 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER); |
127 | 0 | return 0; |
128 | 0 | } |
129 | | |
130 | 0 | if ((ui = UI_new()) == NULL) { |
131 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
132 | 0 | return 0; |
133 | 0 | } |
134 | | |
135 | 0 | if (ui_method != NULL) { |
136 | 0 | UI_set_method(ui, ui_method); |
137 | 0 | if (ui_data != NULL) |
138 | 0 | UI_add_user_data(ui, ui_data); |
139 | 0 | } |
140 | | |
141 | | /* Get an application constructed prompt */ |
142 | 0 | prompt = UI_construct_prompt(ui, "pass phrase", prompt_info); |
143 | 0 | if (prompt == NULL) { |
144 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
145 | 0 | goto end; |
146 | 0 | } |
147 | | |
148 | | /* Get a buffer for verification prompt */ |
149 | 0 | ipass = OPENSSL_zalloc(pass_size + 1); |
150 | 0 | if (ipass == NULL) |
151 | 0 | goto end; |
152 | | |
153 | 0 | prompt_idx = UI_add_input_string(ui, prompt, |
154 | 0 | UI_INPUT_FLAG_DEFAULT_PWD, |
155 | 0 | ipass, 0, pass_size) - 1; |
156 | 0 | if (prompt_idx < 0) { |
157 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
158 | 0 | goto end; |
159 | 0 | } |
160 | | |
161 | 0 | if (verify) { |
162 | | /* Get a buffer for verification prompt */ |
163 | 0 | vpass = OPENSSL_zalloc(pass_size + 1); |
164 | 0 | if (vpass == NULL) |
165 | 0 | goto end; |
166 | 0 | verify_idx = UI_add_verify_string(ui, prompt, |
167 | 0 | UI_INPUT_FLAG_DEFAULT_PWD, |
168 | 0 | vpass, 0, pass_size, |
169 | 0 | ipass) - 1; |
170 | 0 | if (verify_idx < 0) { |
171 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
172 | 0 | goto end; |
173 | 0 | } |
174 | 0 | } |
175 | | |
176 | 0 | switch (UI_process(ui)) { |
177 | 0 | case -2: |
178 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_INTERRUPTED_OR_CANCELLED); |
179 | 0 | break; |
180 | 0 | case -1: |
181 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
182 | 0 | break; |
183 | 0 | default: |
184 | 0 | res = UI_get_result_length(ui, prompt_idx); |
185 | 0 | if (res < 0) { |
186 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
187 | 0 | break; |
188 | 0 | } |
189 | 0 | *pass_len = (size_t)res; |
190 | 0 | memcpy(pass, ipass, *pass_len); |
191 | 0 | ret = 1; |
192 | 0 | break; |
193 | 0 | } |
194 | | |
195 | 0 | end: |
196 | 0 | OPENSSL_clear_free(vpass, pass_size + 1); |
197 | 0 | OPENSSL_clear_free(ipass, pass_size + 1); |
198 | 0 | OPENSSL_free(prompt); |
199 | 0 | UI_free(ui); |
200 | 0 | return ret; |
201 | 0 | } |
202 | | |
203 | | /* Central pw prompting dispatcher */ |
204 | | int ossl_pw_get_passphrase(char *pass, size_t pass_size, size_t *pass_len, |
205 | | const OSSL_PARAM params[], int verify, |
206 | | struct ossl_passphrase_data_st *data) |
207 | 0 | { |
208 | 0 | const char *source = NULL; |
209 | 0 | size_t source_len = 0; |
210 | 0 | const char *prompt_info = NULL; |
211 | 0 | const UI_METHOD *ui_method = NULL; |
212 | 0 | UI_METHOD *allocated_ui_method = NULL; |
213 | 0 | void *ui_data = NULL; |
214 | 0 | const OSSL_PARAM *p = NULL; |
215 | 0 | int ret; |
216 | | |
217 | | /* Handle explicit and cached passphrases */ |
218 | |
|
219 | 0 | if (data->type == is_expl_passphrase) { |
220 | 0 | source = data->_.expl_passphrase.passphrase_copy; |
221 | 0 | source_len = data->_.expl_passphrase.passphrase_len; |
222 | 0 | } else if (data->flag_cache_passphrase && data->cached_passphrase != NULL) { |
223 | 0 | source = data->cached_passphrase; |
224 | 0 | source_len = data->cached_passphrase_len; |
225 | 0 | } |
226 | |
|
227 | 0 | if (source != NULL) { |
228 | 0 | if (source_len > pass_size) |
229 | 0 | source_len = pass_size; |
230 | 0 | memcpy(pass, source, source_len); |
231 | 0 | *pass_len = source_len; |
232 | 0 | return 1; |
233 | 0 | } |
234 | | |
235 | | /* Handle the is_ossl_passphrase case... that's pretty direct */ |
236 | | |
237 | 0 | if (data->type == is_ossl_passphrase) { |
238 | 0 | OSSL_PASSPHRASE_CALLBACK *cb = data->_.ossl_passphrase.passphrase_cb; |
239 | 0 | void *cbarg = data->_.ossl_passphrase.passphrase_cbarg; |
240 | |
|
241 | 0 | ret = cb(pass, pass_size, pass_len, params, cbarg); |
242 | 0 | goto do_cache; |
243 | 0 | } |
244 | | |
245 | | /* Handle the is_pem_password and is_ui_method cases */ |
246 | | |
247 | 0 | if ((p = OSSL_PARAM_locate_const(params, |
248 | 0 | OSSL_PASSPHRASE_PARAM_INFO)) != NULL) { |
249 | 0 | if (p->data_type != OSSL_PARAM_UTF8_STRING) { |
250 | 0 | ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_PASSED_INVALID_ARGUMENT, |
251 | 0 | "Prompt info data type incorrect"); |
252 | 0 | return 0; |
253 | 0 | } |
254 | 0 | prompt_info = p->data; |
255 | 0 | } |
256 | | |
257 | 0 | if (data->type == is_pem_password) { |
258 | | /* We use a UI wrapper for PEM */ |
259 | 0 | pem_password_cb *cb = data->_.pem_password.password_cb; |
260 | |
|
261 | 0 | ui_method = allocated_ui_method = |
262 | 0 | UI_UTIL_wrap_read_pem_callback(cb, verify); |
263 | 0 | ui_data = data->_.pem_password.password_cbarg; |
264 | |
|
265 | 0 | if (ui_method == NULL) { |
266 | 0 | ERR_raise(ERR_LIB_CRYPTO, ERR_R_UI_LIB); |
267 | 0 | return 0; |
268 | 0 | } |
269 | 0 | } else if (data->type == is_ui_method) { |
270 | 0 | ui_method = data->_.ui_method.ui_method; |
271 | 0 | ui_data = data->_.ui_method.ui_method_data; |
272 | 0 | } |
273 | | |
274 | 0 | if (ui_method == NULL) { |
275 | 0 | ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_PASSED_INVALID_ARGUMENT, |
276 | 0 | "No password method specified"); |
277 | 0 | return 0; |
278 | 0 | } |
279 | | |
280 | 0 | ret = do_ui_passphrase(pass, pass_size, pass_len, prompt_info, verify, |
281 | 0 | ui_method, ui_data); |
282 | |
|
283 | 0 | UI_destroy_method(allocated_ui_method); |
284 | |
|
285 | 0 | do_cache: |
286 | 0 | if (ret && data->flag_cache_passphrase) { |
287 | 0 | if (data->cached_passphrase == NULL |
288 | 0 | || *pass_len > data->cached_passphrase_len) { |
289 | 0 | void *new_cache = |
290 | 0 | OPENSSL_clear_realloc(data->cached_passphrase, |
291 | 0 | data->cached_passphrase_len, |
292 | 0 | *pass_len + 1); |
293 | |
|
294 | 0 | if (new_cache == NULL) { |
295 | 0 | OPENSSL_cleanse(pass, *pass_len); |
296 | 0 | return 0; |
297 | 0 | } |
298 | 0 | data->cached_passphrase = new_cache; |
299 | 0 | } |
300 | 0 | memcpy(data->cached_passphrase, pass, *pass_len); |
301 | 0 | data->cached_passphrase[*pass_len] = '\0'; |
302 | 0 | data->cached_passphrase_len = *pass_len; |
303 | 0 | } |
304 | | |
305 | 0 | return ret; |
306 | 0 | } |
307 | | |
308 | | static int ossl_pw_get_password(char *buf, int size, int rwflag, |
309 | | void *userdata, const char *info) |
310 | 0 | { |
311 | 0 | size_t password_len = 0; |
312 | 0 | OSSL_PARAM params[] = { |
313 | 0 | OSSL_PARAM_utf8_string(OSSL_PASSPHRASE_PARAM_INFO, NULL, 0), |
314 | 0 | OSSL_PARAM_END |
315 | 0 | }; |
316 | |
|
317 | 0 | params[0].data = (void *)info; |
318 | 0 | if (ossl_pw_get_passphrase(buf, (size_t)size, &password_len, params, |
319 | 0 | rwflag, userdata)) |
320 | 0 | return (int)password_len; |
321 | 0 | return -1; |
322 | 0 | } |
323 | | |
324 | | int ossl_pw_pem_password(char *buf, int size, int rwflag, void *userdata) |
325 | 0 | { |
326 | 0 | return ossl_pw_get_password(buf, size, rwflag, userdata, "PEM"); |
327 | 0 | } |
328 | | |
329 | | int ossl_pw_pvk_password(char *buf, int size, int rwflag, void *userdata) |
330 | 0 | { |
331 | 0 | return ossl_pw_get_password(buf, size, rwflag, userdata, "PVK"); |
332 | 0 | } |
333 | | |
334 | | int ossl_pw_passphrase_callback_enc(char *pass, size_t pass_size, |
335 | | size_t *pass_len, |
336 | | const OSSL_PARAM params[], void *arg) |
337 | 0 | { |
338 | 0 | return ossl_pw_get_passphrase(pass, pass_size, pass_len, params, 1, arg); |
339 | 0 | } |
340 | | |
341 | | int ossl_pw_passphrase_callback_dec(char *pass, size_t pass_size, |
342 | | size_t *pass_len, |
343 | | const OSSL_PARAM params[], void *arg) |
344 | 0 | { |
345 | 0 | return ossl_pw_get_passphrase(pass, pass_size, pass_len, params, 0, arg); |
346 | 0 | } |