]>
Commit | Line | Data |
---|---|---|
9c6da42d | 1 | /* |
072bfcc9 | 2 | * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved. |
9c6da42d | 3 | * |
5c0d0c86 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
9c6da42d RL |
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 | ||
07016a8a | 10 | #include "e_os.h" |
9c6da42d | 11 | #include <string.h> |
970f467a | 12 | #include <sys/stat.h> |
93d2f9fa | 13 | #include <ctype.h> |
970f467a | 14 | #include <assert.h> |
9c6da42d RL |
15 | |
16 | #include <openssl/bio.h> | |
17 | #include <openssl/dsa.h> /* For d2i_DSAPrivateKey */ | |
18 | #include <openssl/err.h> | |
19 | #include <openssl/evp.h> | |
20 | #include <openssl/pem.h> | |
21 | #include <openssl/pkcs12.h> /* For the PKCS8 stuff o.O */ | |
22 | #include <openssl/rsa.h> /* For d2i_RSAPrivateKey */ | |
23 | #include <openssl/safestack.h> | |
24 | #include <openssl/store.h> | |
25 | #include <openssl/ui.h> | |
26 | #include <openssl/x509.h> /* For the PKCS8 stuff o.O */ | |
25f2138b DMSP |
27 | #include "crypto/asn1.h" |
28 | #include "crypto/ctype.h" | |
970f467a RL |
29 | #include "internal/o_dir.h" |
30 | #include "internal/cryptlib.h" | |
25f2138b | 31 | #include "crypto/store.h" |
706457b7 | 32 | #include "store_local.h" |
9c6da42d | 33 | |
71d57be5 RL |
34 | #ifdef _WIN32 |
35 | # define stat _stat | |
36 | #endif | |
37 | ||
f20aa69e AP |
38 | #ifndef S_ISDIR |
39 | # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR) | |
40 | #endif | |
41 | ||
479af767 | 42 | /*- |
9c6da42d | 43 | * Password prompting |
479af767 | 44 | * ------------------ |
9c6da42d RL |
45 | */ |
46 | ||
47 | static char *file_get_pass(const UI_METHOD *ui_method, char *pass, | |
48 | size_t maxsize, const char *prompt_info, void *data) | |
49 | { | |
50 | UI *ui = UI_new(); | |
51 | char *prompt = NULL; | |
52 | ||
53 | if (ui == NULL) { | |
54 | OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE); | |
55 | return NULL; | |
56 | } | |
57 | ||
58 | if (ui_method != NULL) | |
59 | UI_set_method(ui, ui_method); | |
60 | UI_add_user_data(ui, data); | |
61 | ||
62 | if ((prompt = UI_construct_prompt(ui, "pass phrase", | |
63 | prompt_info)) == NULL) { | |
64 | OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE); | |
65 | pass = NULL; | |
66 | } else if (!UI_add_input_string(ui, prompt, UI_INPUT_FLAG_DEFAULT_PWD, | |
67 | pass, 0, maxsize - 1)) { | |
68 | OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB); | |
69 | pass = NULL; | |
70 | } else { | |
71 | switch (UI_process(ui)) { | |
72 | case -2: | |
73 | OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, | |
74 | OSSL_STORE_R_UI_PROCESS_INTERRUPTED_OR_CANCELLED); | |
75 | pass = NULL; | |
76 | break; | |
77 | case -1: | |
78 | OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB); | |
79 | pass = NULL; | |
80 | break; | |
81 | default: | |
82 | break; | |
83 | } | |
84 | } | |
85 | ||
86 | OPENSSL_free(prompt); | |
87 | UI_free(ui); | |
88 | return pass; | |
89 | } | |
90 | ||
91 | struct pem_pass_data { | |
92 | const UI_METHOD *ui_method; | |
93 | void *data; | |
94 | const char *prompt_info; | |
95 | }; | |
479af767 | 96 | |
9c6da42d RL |
97 | static int file_fill_pem_pass_data(struct pem_pass_data *pass_data, |
98 | const char *prompt_info, | |
99 | const UI_METHOD *ui_method, void *ui_data) | |
100 | { | |
101 | if (pass_data == NULL) | |
102 | return 0; | |
103 | pass_data->ui_method = ui_method; | |
104 | pass_data->data = ui_data; | |
105 | pass_data->prompt_info = prompt_info; | |
106 | return 1; | |
107 | } | |
479af767 RL |
108 | |
109 | /* This is used anywhere a pem_password_cb is needed */ | |
9c6da42d RL |
110 | static int file_get_pem_pass(char *buf, int num, int w, void *data) |
111 | { | |
112 | struct pem_pass_data *pass_data = data; | |
113 | char *pass = file_get_pass(pass_data->ui_method, buf, num, | |
114 | pass_data->prompt_info, pass_data->data); | |
115 | ||
116 | return pass == NULL ? 0 : strlen(pass); | |
117 | } | |
118 | ||
479af767 RL |
119 | /*- |
120 | * The file scheme decoders | |
121 | * ------------------------ | |
122 | * | |
123 | * Each possible data type has its own decoder, which either operates | |
124 | * through a given PEM name, or attempts to decode to see if the blob | |
125 | * it's given is decodable for its data type. The assumption is that | |
126 | * only the correct data type will match the content. | |
9c6da42d RL |
127 | */ |
128 | ||
129 | /*- | |
130 | * The try_decode function is called to check if the blob of data can | |
131 | * be used by this handler, and if it can, decodes it into a supported | |
132 | * OpenSSL type and returns a OSSL_STORE_INFO with the decoded data. | |
133 | * Input: | |
134 | * pem_name: If this blob comes from a PEM file, this holds | |
135 | * the PEM name. If it comes from another type of | |
136 | * file, this is NULL. | |
137 | * pem_header: If this blob comes from a PEM file, this holds | |
138 | * the PEM headers. If it comes from another type of | |
139 | * file, this is NULL. | |
140 | * blob: The blob of data to match with what this handler | |
141 | * can use. | |
142 | * len: The length of the blob. | |
e61ec2d9 RL |
143 | * handler_ctx: For a handler marked repeatable, this pointer can |
144 | * be used to create a context for the handler. IT IS | |
145 | * THE HANDLER'S RESPONSIBILITY TO CREATE AND DESTROY | |
146 | * THIS CONTEXT APPROPRIATELY, i.e. create on first call | |
147 | * and destroy when about to return NULL. | |
6fc1d33c RL |
148 | * matchcount: A pointer to an int to count matches for this data. |
149 | * Usually becomes 0 (no match) or 1 (match!), but may | |
150 | * be higher in the (unlikely) event that the data matches | |
151 | * more than one possibility. The int will always be | |
152 | * zero when the function is called. | |
9c6da42d RL |
153 | * ui_method: Application UI method for getting a password, pin |
154 | * or any other interactive data. | |
155 | * ui_data: Application data to be passed to ui_method when | |
156 | * it's called. | |
157 | * Output: | |
158 | * a OSSL_STORE_INFO | |
159 | */ | |
160 | typedef OSSL_STORE_INFO *(*file_try_decode_fn)(const char *pem_name, | |
161 | const char *pem_header, | |
162 | const unsigned char *blob, | |
e61ec2d9 | 163 | size_t len, void **handler_ctx, |
6fc1d33c | 164 | int *matchcount, |
9c6da42d RL |
165 | const UI_METHOD *ui_method, |
166 | void *ui_data); | |
e61ec2d9 RL |
167 | /* |
168 | * The eof function should return 1 if there's no more data to be found | |
169 | * with the handler_ctx, otherwise 0. This is only used when the handler is | |
170 | * marked repeatable. | |
171 | */ | |
172 | typedef int (*file_eof_fn)(void *handler_ctx); | |
173 | /* | |
174 | * The destroy_ctx function is used to destroy the handler_ctx that was | |
c2969ff6 | 175 | * initiated by a repeatable try_decode function. This is only used when |
e61ec2d9 RL |
176 | * the handler is marked repeatable. |
177 | */ | |
178 | typedef void (*file_destroy_ctx_fn)(void **handler_ctx); | |
9c6da42d RL |
179 | |
180 | typedef struct file_handler_st { | |
181 | const char *name; | |
182 | file_try_decode_fn try_decode; | |
e61ec2d9 RL |
183 | file_eof_fn eof; |
184 | file_destroy_ctx_fn destroy_ctx; | |
185 | ||
186 | /* flags */ | |
187 | int repeatable; | |
9c6da42d RL |
188 | } FILE_HANDLER; |
189 | ||
479af767 RL |
190 | /* |
191 | * PKCS#12 decoder. It operates by decoding all of the blob content, | |
192 | * extracting all the interesting data from it and storing them internally, | |
193 | * then serving them one piece at a time. | |
194 | */ | |
a09003ea RL |
195 | static OSSL_STORE_INFO *try_decode_PKCS12(const char *pem_name, |
196 | const char *pem_header, | |
197 | const unsigned char *blob, | |
198 | size_t len, void **pctx, | |
6fc1d33c | 199 | int *matchcount, |
a09003ea RL |
200 | const UI_METHOD *ui_method, |
201 | void *ui_data) | |
202 | { | |
203 | OSSL_STORE_INFO *store_info = NULL; | |
204 | STACK_OF(OSSL_STORE_INFO) *ctx = *pctx; | |
205 | ||
206 | if (ctx == NULL) { | |
207 | /* Initial parsing */ | |
208 | PKCS12 *p12; | |
209 | int ok = 0; | |
210 | ||
211 | if (pem_name != NULL) | |
212 | /* No match, there is no PEM PKCS12 tag */ | |
213 | return NULL; | |
214 | ||
215 | if ((p12 = d2i_PKCS12(NULL, &blob, len)) != NULL) { | |
216 | char *pass = NULL; | |
217 | char tpass[PEM_BUFSIZE]; | |
218 | EVP_PKEY *pkey = NULL; | |
219 | X509 *cert = NULL; | |
220 | STACK_OF(X509) *chain = NULL; | |
221 | ||
6fc1d33c RL |
222 | *matchcount = 1; |
223 | ||
a09003ea RL |
224 | if (PKCS12_verify_mac(p12, "", 0) |
225 | || PKCS12_verify_mac(p12, NULL, 0)) { | |
226 | pass = ""; | |
227 | } else { | |
228 | if ((pass = file_get_pass(ui_method, tpass, PEM_BUFSIZE, | |
229 | "PKCS12 import password", | |
230 | ui_data)) == NULL) { | |
231 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12, | |
232 | OSSL_STORE_R_PASSPHRASE_CALLBACK_ERROR); | |
233 | goto p12_end; | |
234 | } | |
235 | if (!PKCS12_verify_mac(p12, pass, strlen(pass))) { | |
236 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12, | |
237 | OSSL_STORE_R_ERROR_VERIFYING_PKCS12_MAC); | |
238 | goto p12_end; | |
239 | } | |
240 | } | |
241 | ||
242 | if (PKCS12_parse(p12, pass, &pkey, &cert, &chain)) { | |
7747a49f AP |
243 | OSSL_STORE_INFO *osi_pkey = NULL; |
244 | OSSL_STORE_INFO *osi_cert = NULL; | |
245 | OSSL_STORE_INFO *osi_ca = NULL; | |
a09003ea RL |
246 | |
247 | if ((ctx = sk_OSSL_STORE_INFO_new_null()) != NULL | |
7747a49f AP |
248 | && (osi_pkey = OSSL_STORE_INFO_new_PKEY(pkey)) != NULL |
249 | && sk_OSSL_STORE_INFO_push(ctx, osi_pkey) != 0 | |
250 | && (osi_cert = OSSL_STORE_INFO_new_CERT(cert)) != NULL | |
251 | && sk_OSSL_STORE_INFO_push(ctx, osi_cert) != 0) { | |
a09003ea | 252 | ok = 1; |
7747a49f AP |
253 | osi_pkey = NULL; |
254 | osi_cert = NULL; | |
a09003ea RL |
255 | |
256 | while(sk_X509_num(chain) > 0) { | |
257 | X509 *ca = sk_X509_value(chain, 0); | |
258 | ||
7747a49f AP |
259 | if ((osi_ca = OSSL_STORE_INFO_new_CERT(ca)) == NULL |
260 | || sk_OSSL_STORE_INFO_push(ctx, osi_ca) == 0) { | |
a09003ea RL |
261 | ok = 0; |
262 | break; | |
263 | } | |
7747a49f | 264 | osi_ca = NULL; |
a09003ea RL |
265 | (void)sk_X509_shift(chain); |
266 | } | |
267 | } | |
268 | if (!ok) { | |
7747a49f AP |
269 | OSSL_STORE_INFO_free(osi_ca); |
270 | OSSL_STORE_INFO_free(osi_cert); | |
271 | OSSL_STORE_INFO_free(osi_pkey); | |
a09003ea RL |
272 | sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free); |
273 | EVP_PKEY_free(pkey); | |
274 | X509_free(cert); | |
275 | sk_X509_pop_free(chain, X509_free); | |
276 | ctx = NULL; | |
277 | } | |
278 | *pctx = ctx; | |
279 | } | |
280 | } | |
281 | p12_end: | |
282 | PKCS12_free(p12); | |
283 | if (!ok) | |
284 | return NULL; | |
285 | } | |
286 | ||
6fc1d33c RL |
287 | if (ctx != NULL) { |
288 | *matchcount = 1; | |
a09003ea | 289 | store_info = sk_OSSL_STORE_INFO_shift(ctx); |
6fc1d33c | 290 | } |
a09003ea RL |
291 | |
292 | return store_info; | |
293 | } | |
479af767 | 294 | |
a09003ea RL |
295 | static int eof_PKCS12(void *ctx_) |
296 | { | |
297 | STACK_OF(OSSL_STORE_INFO) *ctx = ctx_; | |
298 | ||
299 | return ctx == NULL || sk_OSSL_STORE_INFO_num(ctx) == 0; | |
300 | } | |
479af767 | 301 | |
a09003ea RL |
302 | static void destroy_ctx_PKCS12(void **pctx) |
303 | { | |
304 | STACK_OF(OSSL_STORE_INFO) *ctx = *pctx; | |
305 | ||
306 | sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free); | |
307 | *pctx = NULL; | |
308 | } | |
479af767 | 309 | |
a09003ea RL |
310 | static FILE_HANDLER PKCS12_handler = { |
311 | "PKCS12", | |
312 | try_decode_PKCS12, | |
313 | eof_PKCS12, | |
314 | destroy_ctx_PKCS12, | |
315 | 1 /* repeatable */ | |
316 | }; | |
317 | ||
479af767 RL |
318 | /* |
319 | * Encrypted PKCS#8 decoder. It operates by just decrypting the given blob | |
320 | * into a new blob, which is returned as an EMBEDDED STORE_INFO. The whole | |
321 | * decoding process will then start over with the new blob. | |
322 | */ | |
7ad2ef36 RL |
323 | static OSSL_STORE_INFO *try_decode_PKCS8Encrypted(const char *pem_name, |
324 | const char *pem_header, | |
325 | const unsigned char *blob, | |
326 | size_t len, void **pctx, | |
6fc1d33c | 327 | int *matchcount, |
7ad2ef36 RL |
328 | const UI_METHOD *ui_method, |
329 | void *ui_data) | |
330 | { | |
331 | X509_SIG *p8 = NULL; | |
332 | char kbuf[PEM_BUFSIZE]; | |
333 | char *pass = NULL; | |
334 | const X509_ALGOR *dalg = NULL; | |
335 | const ASN1_OCTET_STRING *doct = NULL; | |
336 | OSSL_STORE_INFO *store_info = NULL; | |
337 | BUF_MEM *mem = NULL; | |
338 | unsigned char *new_data = NULL; | |
339 | int new_data_len; | |
340 | ||
6fc1d33c RL |
341 | if (pem_name != NULL) { |
342 | if (strcmp(pem_name, PEM_STRING_PKCS8) != 0) | |
343 | return NULL; | |
344 | *matchcount = 1; | |
345 | } | |
7ad2ef36 RL |
346 | |
347 | if ((p8 = d2i_X509_SIG(NULL, &blob, len)) == NULL) | |
348 | return NULL; | |
349 | ||
6fc1d33c RL |
350 | *matchcount = 1; |
351 | ||
7ad2ef36 RL |
352 | if ((mem = BUF_MEM_new()) == NULL) { |
353 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED, | |
354 | ERR_R_MALLOC_FAILURE); | |
355 | goto nop8; | |
356 | } | |
357 | ||
358 | if ((pass = file_get_pass(ui_method, kbuf, PEM_BUFSIZE, | |
359 | "PKCS8 decrypt password", ui_data)) == NULL) { | |
360 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED, | |
361 | OSSL_STORE_R_BAD_PASSWORD_READ); | |
362 | goto nop8; | |
363 | } | |
364 | ||
365 | X509_SIG_get0(p8, &dalg, &doct); | |
366 | if (!PKCS12_pbe_crypt(dalg, pass, strlen(pass), doct->data, doct->length, | |
367 | &new_data, &new_data_len, 0)) | |
368 | goto nop8; | |
369 | ||
370 | mem->data = (char *)new_data; | |
371 | mem->max = mem->length = (size_t)new_data_len; | |
372 | X509_SIG_free(p8); | |
373 | ||
374 | store_info = ossl_store_info_new_EMBEDDED(PEM_STRING_PKCS8INF, mem); | |
375 | if (store_info == NULL) { | |
376 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED, | |
377 | ERR_R_MALLOC_FAILURE); | |
378 | goto nop8; | |
379 | } | |
380 | ||
381 | return store_info; | |
382 | nop8: | |
383 | X509_SIG_free(p8); | |
384 | BUF_MEM_free(mem); | |
385 | return NULL; | |
386 | } | |
479af767 | 387 | |
7ad2ef36 RL |
388 | static FILE_HANDLER PKCS8Encrypted_handler = { |
389 | "PKCS8Encrypted", | |
390 | try_decode_PKCS8Encrypted | |
391 | }; | |
392 | ||
479af767 RL |
393 | /* |
394 | * Private key decoder. Decodes all sorts of private keys, both PKCS#8 | |
395 | * encoded ones and old style PEM ones (with the key type is encoded into | |
396 | * the PEM name). | |
397 | */ | |
9c6da42d RL |
398 | int pem_check_suffix(const char *pem_str, const char *suffix); |
399 | static OSSL_STORE_INFO *try_decode_PrivateKey(const char *pem_name, | |
400 | const char *pem_header, | |
401 | const unsigned char *blob, | |
e61ec2d9 | 402 | size_t len, void **pctx, |
6fc1d33c | 403 | int *matchcount, |
9c6da42d RL |
404 | const UI_METHOD *ui_method, |
405 | void *ui_data) | |
406 | { | |
407 | OSSL_STORE_INFO *store_info = NULL; | |
408 | EVP_PKEY *pkey = NULL; | |
409 | const EVP_PKEY_ASN1_METHOD *ameth = NULL; | |
410 | ||
411 | if (pem_name != NULL) { | |
7ad2ef36 RL |
412 | if (strcmp(pem_name, PEM_STRING_PKCS8INF) == 0) { |
413 | PKCS8_PRIV_KEY_INFO *p8inf = | |
414 | d2i_PKCS8_PRIV_KEY_INFO(NULL, &blob, len); | |
415 | ||
6fc1d33c | 416 | *matchcount = 1; |
7ad2ef36 RL |
417 | if (p8inf != NULL) |
418 | pkey = EVP_PKCS82PKEY(p8inf); | |
419 | PKCS8_PRIV_KEY_INFO_free(p8inf); | |
420 | } else { | |
421 | int slen; | |
422 | ||
423 | if ((slen = pem_check_suffix(pem_name, "PRIVATE KEY")) > 0 | |
424 | && (ameth = EVP_PKEY_asn1_find_str(NULL, pem_name, | |
6fc1d33c RL |
425 | slen)) != NULL) { |
426 | *matchcount = 1; | |
7ad2ef36 | 427 | pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &blob, len); |
6fc1d33c | 428 | } |
7ad2ef36 | 429 | } |
9c6da42d RL |
430 | } else { |
431 | int i; | |
432 | ||
433 | for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) { | |
6fc1d33c RL |
434 | EVP_PKEY *tmp_pkey = NULL; |
435 | const unsigned char *tmp_blob = blob; | |
436 | ||
9c6da42d RL |
437 | ameth = EVP_PKEY_asn1_get0(i); |
438 | if (ameth->pkey_flags & ASN1_PKEY_ALIAS) | |
439 | continue; | |
6fc1d33c RL |
440 | |
441 | tmp_pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &tmp_blob, len); | |
442 | if (tmp_pkey != NULL) { | |
443 | if (pkey != NULL) | |
444 | EVP_PKEY_free(tmp_pkey); | |
445 | else | |
446 | pkey = tmp_pkey; | |
447 | (*matchcount)++; | |
448 | } | |
449 | } | |
450 | ||
451 | if (*matchcount > 1) { | |
452 | EVP_PKEY_free(pkey); | |
453 | pkey = NULL; | |
9c6da42d RL |
454 | } |
455 | } | |
456 | if (pkey == NULL) | |
457 | /* No match */ | |
458 | return NULL; | |
459 | ||
460 | store_info = OSSL_STORE_INFO_new_PKEY(pkey); | |
461 | if (store_info == NULL) | |
462 | EVP_PKEY_free(pkey); | |
463 | ||
464 | return store_info; | |
465 | } | |
479af767 | 466 | |
9c6da42d RL |
467 | static FILE_HANDLER PrivateKey_handler = { |
468 | "PrivateKey", | |
469 | try_decode_PrivateKey | |
470 | }; | |
471 | ||
479af767 | 472 | /* |
c2969ff6 | 473 | * Public key decoder. Only supports SubjectPublicKeyInfo formatted keys. |
479af767 | 474 | */ |
9c6da42d RL |
475 | static OSSL_STORE_INFO *try_decode_PUBKEY(const char *pem_name, |
476 | const char *pem_header, | |
477 | const unsigned char *blob, | |
e61ec2d9 | 478 | size_t len, void **pctx, |
6fc1d33c | 479 | int *matchcount, |
9c6da42d RL |
480 | const UI_METHOD *ui_method, |
481 | void *ui_data) | |
482 | { | |
483 | OSSL_STORE_INFO *store_info = NULL; | |
484 | EVP_PKEY *pkey = NULL; | |
485 | ||
6fc1d33c RL |
486 | if (pem_name != NULL) { |
487 | if (strcmp(pem_name, PEM_STRING_PUBLIC) != 0) | |
488 | /* No match */ | |
489 | return NULL; | |
490 | *matchcount = 1; | |
491 | } | |
9c6da42d | 492 | |
6fc1d33c RL |
493 | if ((pkey = d2i_PUBKEY(NULL, &blob, len)) != NULL) { |
494 | *matchcount = 1; | |
9c6da42d | 495 | store_info = OSSL_STORE_INFO_new_PKEY(pkey); |
6fc1d33c | 496 | } |
9c6da42d RL |
497 | |
498 | return store_info; | |
499 | } | |
479af767 | 500 | |
9c6da42d RL |
501 | static FILE_HANDLER PUBKEY_handler = { |
502 | "PUBKEY", | |
503 | try_decode_PUBKEY | |
504 | }; | |
505 | ||
479af767 RL |
506 | /* |
507 | * Key parameter decoder. | |
508 | */ | |
9c6da42d RL |
509 | static OSSL_STORE_INFO *try_decode_params(const char *pem_name, |
510 | const char *pem_header, | |
511 | const unsigned char *blob, | |
e61ec2d9 | 512 | size_t len, void **pctx, |
6fc1d33c | 513 | int *matchcount, |
9c6da42d RL |
514 | const UI_METHOD *ui_method, |
515 | void *ui_data) | |
516 | { | |
517 | OSSL_STORE_INFO *store_info = NULL; | |
6fc1d33c RL |
518 | int slen = 0; |
519 | EVP_PKEY *pkey = NULL; | |
9c6da42d RL |
520 | const EVP_PKEY_ASN1_METHOD *ameth = NULL; |
521 | int ok = 0; | |
522 | ||
6fc1d33c RL |
523 | if (pem_name != NULL) { |
524 | if ((slen = pem_check_suffix(pem_name, "PARAMETERS")) == 0) | |
525 | return NULL; | |
526 | *matchcount = 1; | |
527 | } | |
528 | ||
6fc1d33c | 529 | if (slen > 0) { |
11d66064 RL |
530 | if ((pkey = EVP_PKEY_new()) == NULL) { |
531 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB); | |
532 | return NULL; | |
533 | } | |
534 | ||
535 | ||
6fc1d33c | 536 | if (EVP_PKEY_set_type_str(pkey, pem_name, slen) |
9c6da42d RL |
537 | && (ameth = EVP_PKEY_get0_asn1(pkey)) != NULL |
538 | && ameth->param_decode != NULL | |
539 | && ameth->param_decode(pkey, &blob, len)) | |
540 | ok = 1; | |
541 | } else { | |
542 | int i; | |
11d66064 | 543 | EVP_PKEY *tmp_pkey = NULL; |
9c6da42d RL |
544 | |
545 | for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) { | |
6fc1d33c RL |
546 | const unsigned char *tmp_blob = blob; |
547 | ||
11d66064 RL |
548 | if (tmp_pkey == NULL && (tmp_pkey = EVP_PKEY_new()) == NULL) { |
549 | OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB); | |
550 | break; | |
551 | } | |
552 | ||
9c6da42d RL |
553 | ameth = EVP_PKEY_asn1_get0(i); |
554 | if (ameth->pkey_flags & ASN1_PKEY_ALIAS) | |
555 | continue; | |
11d66064 RL |
556 | |
557 | if (EVP_PKEY_set_type(tmp_pkey, ameth->pkey_id) | |
558 | && (ameth = EVP_PKEY_get0_asn1(tmp_pkey)) != NULL | |
9c6da42d | 559 | && ameth->param_decode != NULL |
11d66064 RL |
560 | && ameth->param_decode(tmp_pkey, &tmp_blob, len)) { |
561 | if (pkey != NULL) | |
562 | EVP_PKEY_free(tmp_pkey); | |
563 | else | |
564 | pkey = tmp_pkey; | |
565 | tmp_pkey = NULL; | |
6fc1d33c | 566 | (*matchcount)++; |
9c6da42d RL |
567 | } |
568 | } | |
11d66064 RL |
569 | |
570 | EVP_PKEY_free(tmp_pkey); | |
571 | if (*matchcount == 1) { | |
572 | ok = 1; | |
573 | } | |
9c6da42d RL |
574 | } |
575 | ||
576 | if (ok) | |
577 | store_info = OSSL_STORE_INFO_new_PARAMS(pkey); | |
578 | if (store_info == NULL) | |
579 | EVP_PKEY_free(pkey); | |
580 | ||
581 | return store_info; | |
582 | } | |
479af767 | 583 | |
9c6da42d RL |
584 | static FILE_HANDLER params_handler = { |
585 | "params", | |
586 | try_decode_params | |
587 | }; | |
588 | ||
479af767 RL |
589 | /* |
590 | * X.509 certificate decoder. | |
591 | */ | |
9c6da42d RL |
592 | static OSSL_STORE_INFO *try_decode_X509Certificate(const char *pem_name, |
593 | const char *pem_header, | |
594 | const unsigned char *blob, | |
e61ec2d9 | 595 | size_t len, void **pctx, |
6fc1d33c | 596 | int *matchcount, |
9c6da42d RL |
597 | const UI_METHOD *ui_method, |
598 | void *ui_data) | |
599 | { | |
600 | OSSL_STORE_INFO *store_info = NULL; | |
601 | X509 *cert = NULL; | |
602 | ||
603 | /* | |
604 | * In most cases, we can try to interpret the serialized data as a trusted | |
605 | * cert (X509 + X509_AUX) and fall back to reading it as a normal cert | |
606 | * (just X509), but if the PEM name specifically declares it as a trusted | |
607 | * cert, then no fallback should be engaged. |ignore_trusted| tells if | |
608 | * the fallback can be used (1) or not (0). | |
609 | */ | |
610 | int ignore_trusted = 1; | |
611 | ||
612 | if (pem_name != NULL) { | |
613 | if (strcmp(pem_name, PEM_STRING_X509_TRUSTED) == 0) | |
614 | ignore_trusted = 0; | |
615 | else if (strcmp(pem_name, PEM_STRING_X509_OLD) != 0 | |
616 | && strcmp(pem_name, PEM_STRING_X509) != 0) | |
617 | /* No match */ | |
618 | return NULL; | |
6fc1d33c | 619 | *matchcount = 1; |
9c6da42d RL |
620 | } |
621 | ||
622 | if ((cert = d2i_X509_AUX(NULL, &blob, len)) != NULL | |
6fc1d33c RL |
623 | || (ignore_trusted && (cert = d2i_X509(NULL, &blob, len)) != NULL)) { |
624 | *matchcount = 1; | |
9c6da42d | 625 | store_info = OSSL_STORE_INFO_new_CERT(cert); |
6fc1d33c | 626 | } |
9c6da42d RL |
627 | |
628 | if (store_info == NULL) | |
629 | X509_free(cert); | |
630 | ||
631 | return store_info; | |
632 | } | |
479af767 | 633 | |
9c6da42d RL |
634 | static FILE_HANDLER X509Certificate_handler = { |
635 | "X509Certificate", | |
636 | try_decode_X509Certificate | |
637 | }; | |
638 | ||
479af767 RL |
639 | /* |
640 | * X.509 CRL decoder. | |
641 | */ | |
9c6da42d RL |
642 | static OSSL_STORE_INFO *try_decode_X509CRL(const char *pem_name, |
643 | const char *pem_header, | |
644 | const unsigned char *blob, | |
e61ec2d9 | 645 | size_t len, void **pctx, |
6fc1d33c | 646 | int *matchcount, |
9c6da42d RL |
647 | const UI_METHOD *ui_method, |
648 | void *ui_data) | |
649 | { | |
650 | OSSL_STORE_INFO *store_info = NULL; | |
651 | X509_CRL *crl = NULL; | |
652 | ||
6fc1d33c RL |
653 | if (pem_name != NULL) { |
654 | if (strcmp(pem_name, PEM_STRING_X509_CRL) != 0) | |
655 | /* No match */ | |
656 | return NULL; | |
657 | *matchcount = 1; | |
658 | } | |
9c6da42d | 659 | |
6fc1d33c RL |
660 | if ((crl = d2i_X509_CRL(NULL, &blob, len)) != NULL) { |
661 | *matchcount = 1; | |
9c6da42d | 662 | store_info = OSSL_STORE_INFO_new_CRL(crl); |
6fc1d33c | 663 | } |
9c6da42d RL |
664 | |
665 | if (store_info == NULL) | |
666 | X509_CRL_free(crl); | |
667 | ||
668 | return store_info; | |
669 | } | |
479af767 | 670 | |
9c6da42d RL |
671 | static FILE_HANDLER X509CRL_handler = { |
672 | "X509CRL", | |
673 | try_decode_X509CRL | |
674 | }; | |
675 | ||
479af767 RL |
676 | /* |
677 | * To finish it all off, we collect all the handlers. | |
678 | */ | |
9c6da42d | 679 | static const FILE_HANDLER *file_handlers[] = { |
a09003ea | 680 | &PKCS12_handler, |
7ad2ef36 | 681 | &PKCS8Encrypted_handler, |
9c6da42d RL |
682 | &X509Certificate_handler, |
683 | &X509CRL_handler, | |
684 | ¶ms_handler, | |
685 | &PUBKEY_handler, | |
686 | &PrivateKey_handler, | |
687 | }; | |
688 | ||
689 | ||
479af767 | 690 | /*- |
9c6da42d | 691 | * The loader itself |
479af767 | 692 | * ----------------- |
9c6da42d RL |
693 | */ |
694 | ||
695 | struct ossl_store_loader_ctx_st { | |
970f467a RL |
696 | enum { |
697 | is_raw = 0, | |
698 | is_pem, | |
699 | is_dir | |
700 | } type; | |
9c6da42d | 701 | int errcnt; |
7852f588 RL |
702 | #define FILE_FLAG_SECMEM (1<<0) |
703 | unsigned int flags; | |
970f467a RL |
704 | union { |
705 | struct { /* Used with is_raw and is_pem */ | |
706 | BIO *file; | |
707 | ||
708 | /* | |
709 | * The following are used when the handler is marked as | |
710 | * repeatable | |
711 | */ | |
712 | const FILE_HANDLER *last_handler; | |
713 | void *last_handler_ctx; | |
714 | } file; | |
715 | struct { /* Used with is_dir */ | |
716 | OPENSSL_DIR_CTX *ctx; | |
717 | int end_reached; | |
718 | char *uri; | |
719 | ||
93d2f9fa RL |
720 | /* |
721 | * When a search expression is given, these are filled in. | |
722 | * |search_name| contains the file basename to look for. | |
723 | * The string is exactly 8 characters long. | |
724 | */ | |
725 | char search_name[9]; | |
726 | ||
970f467a RL |
727 | /* |
728 | * The directory reading utility we have combines opening with | |
729 | * reading the first name. To make sure we can detect the end | |
730 | * at the right time, we read early and cache the name. | |
731 | */ | |
732 | const char *last_entry; | |
733 | int last_errno; | |
734 | } dir; | |
735 | } _; | |
6541d9e2 RL |
736 | |
737 | /* Expected object type. May be unspecified */ | |
738 | int expected_type; | |
9c6da42d RL |
739 | }; |
740 | ||
970f467a RL |
741 | static void OSSL_STORE_LOADER_CTX_free(OSSL_STORE_LOADER_CTX *ctx) |
742 | { | |
743 | if (ctx->type == is_dir) { | |
744 | OPENSSL_free(ctx->_.dir.uri); | |
745 | } else { | |
746 | if (ctx->_.file.last_handler != NULL) { | |
747 | ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx); | |
748 | ctx->_.file.last_handler_ctx = NULL; | |
749 | ctx->_.file.last_handler = NULL; | |
750 | } | |
751 | } | |
752 | OPENSSL_free(ctx); | |
753 | } | |
754 | ||
9c6da42d RL |
755 | static OSSL_STORE_LOADER_CTX *file_open(const OSSL_STORE_LOADER *loader, |
756 | const char *uri, | |
757 | const UI_METHOD *ui_method, | |
758 | void *ui_data) | |
759 | { | |
9c6da42d | 760 | OSSL_STORE_LOADER_CTX *ctx = NULL; |
970f467a | 761 | struct stat st; |
6eaebfaa RL |
762 | struct { |
763 | const char *path; | |
764 | unsigned int check_absolute:1; | |
765 | } path_data[2]; | |
766 | size_t path_data_n = 0, i; | |
767 | const char *path; | |
9c6da42d | 768 | |
ae9c39d8 RL |
769 | /* |
770 | * First step, just take the URI as is. | |
771 | */ | |
6eaebfaa RL |
772 | path_data[path_data_n].check_absolute = 0; |
773 | path_data[path_data_n++].path = uri; | |
ae9c39d8 RL |
774 | |
775 | /* | |
776 | * Second step, if the URI appears to start with the 'file' scheme, | |
777 | * extract the path and make that the second path to check. | |
778 | * There's a special case if the URI also contains an authority, then | |
779 | * the full URI shouldn't be used as a path anywhere. | |
780 | */ | |
9c6da42d | 781 | if (strncasecmp(uri, "file:", 5) == 0) { |
ae9c39d8 RL |
782 | const char *p = &uri[5]; |
783 | ||
784 | if (strncmp(&uri[5], "//", 2) == 0) { | |
6eaebfaa | 785 | path_data_n--; /* Invalidate using the full URI */ |
ae9c39d8 RL |
786 | if (strncasecmp(&uri[7], "localhost/", 10) == 0) { |
787 | p = &uri[16]; | |
788 | } else if (uri[7] == '/') { | |
789 | p = &uri[7]; | |
790 | } else { | |
791 | OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, | |
792 | OSSL_STORE_R_URI_AUTHORITY_UNSUPPORTED); | |
793 | return NULL; | |
794 | } | |
9c6da42d RL |
795 | } |
796 | ||
6eaebfaa RL |
797 | path_data[path_data_n].check_absolute = 1; |
798 | #ifdef _WIN32 | |
799 | /* Windows file: URIs with a drive letter start with a / */ | |
800 | if (p[0] == '/' && p[2] == ':' && p[3] == '/') { | |
a1df06b3 | 801 | char c = ossl_tolower(p[1]); |
11459953 RL |
802 | |
803 | if (c >= 'a' && c <= 'z') { | |
804 | p++; | |
805 | /* We know it's absolute, so no need to check */ | |
806 | path_data[path_data_n].check_absolute = 0; | |
807 | } | |
6eaebfaa RL |
808 | } |
809 | #endif | |
810 | path_data[path_data_n++].path = p; | |
811 | } | |
812 | ||
813 | ||
814 | for (i = 0, path = NULL; path == NULL && i < path_data_n; i++) { | |
9c6da42d RL |
815 | /* |
816 | * If the scheme "file" was an explicit part of the URI, the path must | |
817 | * be absolute. So says RFC 8089 | |
818 | */ | |
6eaebfaa | 819 | if (path_data[i].check_absolute && path_data[i].path[0] != '/') { |
9c6da42d RL |
820 | OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, |
821 | OSSL_STORE_R_PATH_MUST_BE_ABSOLUTE); | |
6eaebfaa | 822 | ERR_add_error_data(1, path_data[i].path); |
9c6da42d RL |
823 | return NULL; |
824 | } | |
825 | ||
6eaebfaa | 826 | if (stat(path_data[i].path, &st) < 0) { |
ff988500 RS |
827 | ERR_raise_data(ERR_LIB_SYS, errno, |
828 | "calling stat(%s)", | |
829 | path_data[i].path); | |
ae9c39d8 | 830 | } else { |
6eaebfaa | 831 | path = path_data[i].path; |
ae9c39d8 RL |
832 | } |
833 | } | |
834 | if (path == NULL) { | |
970f467a RL |
835 | return NULL; |
836 | } | |
837 | ||
ae9c39d8 RL |
838 | /* Successfully found a working path, clear possible collected errors */ |
839 | ERR_clear_error(); | |
840 | ||
9c6da42d RL |
841 | ctx = OPENSSL_zalloc(sizeof(*ctx)); |
842 | if (ctx == NULL) { | |
843 | OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_MALLOC_FAILURE); | |
844 | return NULL; | |
845 | } | |
846 | ||
f20aa69e | 847 | if (S_ISDIR(st.st_mode)) { |
970f467a RL |
848 | /* |
849 | * Try to copy everything, even if we know that some of them must be | |
850 | * NULL for the moment. This prevents errors in the future, when more | |
851 | * components may be used. | |
852 | */ | |
853 | ctx->_.dir.uri = OPENSSL_strdup(uri); | |
854 | ctx->type = is_dir; | |
855 | ||
856 | if (ctx->_.dir.uri == NULL) | |
857 | goto err; | |
858 | ||
859 | ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx, path); | |
860 | ctx->_.dir.last_errno = errno; | |
861 | if (ctx->_.dir.last_entry == NULL) { | |
862 | if (ctx->_.dir.last_errno != 0) { | |
863 | char errbuf[256]; | |
970f467a | 864 | OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_SYS_LIB); |
e7a4682d BE |
865 | errno = ctx->_.dir.last_errno; |
866 | if (openssl_strerror_r(errno, errbuf, sizeof(errbuf))) | |
867 | ERR_add_error_data(1, errbuf); | |
970f467a RL |
868 | goto err; |
869 | } | |
870 | ctx->_.dir.end_reached = 1; | |
871 | } | |
872 | } else { | |
873 | BIO *buff = NULL; | |
94b5d7aa | 874 | char peekbuf[4096] = { 0, }; |
970f467a RL |
875 | |
876 | if ((buff = BIO_new(BIO_f_buffer())) == NULL | |
877 | || (ctx->_.file.file = BIO_new_file(path, "rb")) == NULL) { | |
878 | BIO_free_all(buff); | |
879 | goto err; | |
880 | } | |
881 | ||
882 | ctx->_.file.file = BIO_push(buff, ctx->_.file.file); | |
7af42628 BK |
883 | if (BIO_buffer_peek(ctx->_.file.file, peekbuf, sizeof(peekbuf) - 1) > 0) { |
884 | peekbuf[sizeof(peekbuf) - 1] = '\0'; | |
970f467a RL |
885 | if (strstr(peekbuf, "-----BEGIN ") != NULL) |
886 | ctx->type = is_pem; | |
887 | } | |
9c6da42d RL |
888 | } |
889 | ||
890 | return ctx; | |
891 | err: | |
970f467a | 892 | OSSL_STORE_LOADER_CTX_free(ctx); |
9c6da42d RL |
893 | return NULL; |
894 | } | |
895 | ||
7852f588 RL |
896 | static int file_ctrl(OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args) |
897 | { | |
898 | int ret = 1; | |
899 | ||
900 | switch (cmd) { | |
901 | case OSSL_STORE_C_USE_SECMEM: | |
902 | { | |
903 | int on = *(va_arg(args, int *)); | |
904 | ||
905 | switch (on) { | |
906 | case 0: | |
907 | ctx->flags &= ~FILE_FLAG_SECMEM; | |
908 | break; | |
909 | case 1: | |
910 | ctx->flags |= FILE_FLAG_SECMEM; | |
911 | break; | |
912 | default: | |
913 | OSSL_STOREerr(OSSL_STORE_F_FILE_CTRL, | |
914 | ERR_R_PASSED_INVALID_ARGUMENT); | |
915 | ret = 0; | |
916 | break; | |
917 | } | |
918 | } | |
919 | break; | |
920 | default: | |
921 | break; | |
922 | } | |
923 | ||
924 | return ret; | |
925 | } | |
926 | ||
6541d9e2 RL |
927 | static int file_expect(OSSL_STORE_LOADER_CTX *ctx, int expected) |
928 | { | |
929 | ctx->expected_type = expected; | |
930 | return 1; | |
931 | } | |
932 | ||
93d2f9fa RL |
933 | static int file_find(OSSL_STORE_LOADER_CTX *ctx, OSSL_STORE_SEARCH *search) |
934 | { | |
935 | /* | |
936 | * If ctx == NULL, the library is looking to know if this loader supports | |
937 | * the given search type. | |
938 | */ | |
939 | ||
940 | if (OSSL_STORE_SEARCH_get_type(search) == OSSL_STORE_SEARCH_BY_NAME) { | |
941 | unsigned long hash = 0; | |
942 | ||
943 | if (ctx == NULL) | |
944 | return 1; | |
945 | ||
946 | if (ctx->type != is_dir) { | |
947 | OSSL_STOREerr(OSSL_STORE_F_FILE_FIND, | |
948 | OSSL_STORE_R_SEARCH_ONLY_SUPPORTED_FOR_DIRECTORIES); | |
949 | return 0; | |
950 | } | |
951 | ||
952 | hash = X509_NAME_hash(OSSL_STORE_SEARCH_get0_name(search)); | |
953 | BIO_snprintf(ctx->_.dir.search_name, sizeof(ctx->_.dir.search_name), | |
954 | "%08lx", hash); | |
955 | return 1; | |
956 | } | |
957 | ||
958 | if (ctx != NULL) | |
959 | OSSL_STOREerr(OSSL_STORE_F_FILE_FIND, | |
960 | OSSL_STORE_R_UNSUPPORTED_SEARCH_TYPE); | |
961 | return 0; | |
962 | } | |
963 | ||
4c17819c RL |
964 | /* Internal function to decode an already opened PEM file */ |
965 | OSSL_STORE_LOADER_CTX *ossl_store_file_attach_pem_bio_int(BIO *bp) | |
966 | { | |
967 | OSSL_STORE_LOADER_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx)); | |
968 | ||
969 | if (ctx == NULL) { | |
970 | OSSL_STOREerr(OSSL_STORE_F_OSSL_STORE_FILE_ATTACH_PEM_BIO_INT, | |
971 | ERR_R_MALLOC_FAILURE); | |
972 | return NULL; | |
973 | } | |
974 | ||
975 | ctx->_.file.file = bp; | |
976 | ctx->type = is_pem; | |
977 | ||
978 | return ctx; | |
979 | } | |
980 | ||
1aabc244 RL |
981 | static OSSL_STORE_INFO *file_load_try_decode(OSSL_STORE_LOADER_CTX *ctx, |
982 | const char *pem_name, | |
983 | const char *pem_header, | |
984 | unsigned char *data, size_t len, | |
985 | const UI_METHOD *ui_method, | |
986 | void *ui_data, int *matchcount) | |
987 | { | |
988 | OSSL_STORE_INFO *result = NULL; | |
989 | BUF_MEM *new_mem = NULL; | |
990 | char *new_pem_name = NULL; | |
991 | int t = 0; | |
992 | ||
993 | again: | |
994 | { | |
995 | size_t i = 0; | |
996 | void *handler_ctx = NULL; | |
997 | const FILE_HANDLER **matching_handlers = | |
998 | OPENSSL_zalloc(sizeof(*matching_handlers) | |
999 | * OSSL_NELEM(file_handlers)); | |
1000 | ||
1001 | if (matching_handlers == NULL) { | |
1002 | OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD_TRY_DECODE, | |
1003 | ERR_R_MALLOC_FAILURE); | |
1004 | goto err; | |
1005 | } | |
1006 | ||
1007 | *matchcount = 0; | |
1008 | for (i = 0; i < OSSL_NELEM(file_handlers); i++) { | |
1009 | const FILE_HANDLER *handler = file_handlers[i]; | |
6fc1d33c | 1010 | int try_matchcount = 0; |
1aabc244 RL |
1011 | void *tmp_handler_ctx = NULL; |
1012 | OSSL_STORE_INFO *tmp_result = | |
1013 | handler->try_decode(pem_name, pem_header, data, len, | |
6fc1d33c RL |
1014 | &tmp_handler_ctx, &try_matchcount, |
1015 | ui_method, ui_data); | |
1aabc244 | 1016 | |
6fc1d33c | 1017 | if (try_matchcount > 0) { |
a0fda2cf F |
1018 | |
1019 | matching_handlers[*matchcount] = handler; | |
1aabc244 RL |
1020 | |
1021 | if (handler_ctx) | |
1022 | handler->destroy_ctx(&handler_ctx); | |
1023 | handler_ctx = tmp_handler_ctx; | |
1024 | ||
6fc1d33c | 1025 | if ((*matchcount += try_matchcount) > 1) { |
1aabc244 RL |
1026 | /* more than one match => ambiguous, kill any result */ |
1027 | OSSL_STORE_INFO_free(result); | |
1028 | OSSL_STORE_INFO_free(tmp_result); | |
1029 | if (handler->destroy_ctx != NULL) | |
1030 | handler->destroy_ctx(&handler_ctx); | |
1031 | handler_ctx = NULL; | |
6fc1d33c | 1032 | tmp_result = NULL; |
1aabc244 RL |
1033 | result = NULL; |
1034 | } | |
6fc1d33c RL |
1035 | if (result == NULL) |
1036 | result = tmp_result; | |
1aabc244 RL |
1037 | } |
1038 | } | |
1039 | ||
6fc1d33c RL |
1040 | if (*matchcount == 1 && matching_handlers[0]->repeatable) { |
1041 | ctx->_.file.last_handler = matching_handlers[0]; | |
1042 | ctx->_.file.last_handler_ctx = handler_ctx; | |
1aabc244 RL |
1043 | } |
1044 | ||
1045 | OPENSSL_free(matching_handlers); | |
1046 | } | |
1047 | ||
1048 | err: | |
1049 | OPENSSL_free(new_pem_name); | |
1050 | BUF_MEM_free(new_mem); | |
1051 | ||
1052 | if (result != NULL | |
1053 | && (t = OSSL_STORE_INFO_get_type(result)) == OSSL_STORE_INFO_EMBEDDED) { | |
1054 | pem_name = new_pem_name = | |
1055 | ossl_store_info_get0_EMBEDDED_pem_name(result); | |
1056 | new_mem = ossl_store_info_get0_EMBEDDED_buffer(result); | |
1057 | data = (unsigned char *)new_mem->data; | |
1058 | len = new_mem->length; | |
1059 | OPENSSL_free(result); | |
1060 | result = NULL; | |
1061 | goto again; | |
1062 | } | |
1063 | ||
1064 | if (result != NULL) | |
1065 | ERR_clear_error(); | |
1066 | ||
1067 | return result; | |
1068 | } | |
1069 | ||
1070 | static OSSL_STORE_INFO *file_load_try_repeat(OSSL_STORE_LOADER_CTX *ctx, | |
1071 | const UI_METHOD *ui_method, | |
1072 | void *ui_data) | |
9c6da42d RL |
1073 | { |
1074 | OSSL_STORE_INFO *result = NULL; | |
6fc1d33c | 1075 | int try_matchcount = 0; |
9c6da42d | 1076 | |
970f467a RL |
1077 | if (ctx->_.file.last_handler != NULL) { |
1078 | result = | |
1079 | ctx->_.file.last_handler->try_decode(NULL, NULL, NULL, 0, | |
1080 | &ctx->_.file.last_handler_ctx, | |
6fc1d33c | 1081 | &try_matchcount, |
970f467a | 1082 | ui_method, ui_data); |
e61ec2d9 | 1083 | |
1aabc244 | 1084 | if (result == NULL) { |
970f467a RL |
1085 | ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx); |
1086 | ctx->_.file.last_handler_ctx = NULL; | |
1087 | ctx->_.file.last_handler = NULL; | |
1aabc244 RL |
1088 | } |
1089 | } | |
1090 | return result; | |
1091 | } | |
e61ec2d9 | 1092 | |
358d446f | 1093 | static void pem_free_flag(void *pem_data, int secure, size_t num) |
7852f588 RL |
1094 | { |
1095 | if (secure) | |
358d446f | 1096 | OPENSSL_secure_clear_free(pem_data, num); |
7852f588 RL |
1097 | else |
1098 | OPENSSL_free(pem_data); | |
1099 | } | |
1aabc244 RL |
1100 | static int file_read_pem(BIO *bp, char **pem_name, char **pem_header, |
1101 | unsigned char **data, long *len, | |
1102 | const UI_METHOD *ui_method, | |
7852f588 | 1103 | void *ui_data, int secure) |
1aabc244 | 1104 | { |
7852f588 RL |
1105 | int i = secure |
1106 | ? PEM_read_bio_ex(bp, pem_name, pem_header, data, len, | |
1107 | PEM_FLAG_SECURE | PEM_FLAG_EAY_COMPATIBLE) | |
1108 | : PEM_read_bio(bp, pem_name, pem_header, data, len); | |
1aabc244 RL |
1109 | |
1110 | if (i <= 0) | |
1111 | return 0; | |
1112 | ||
1113 | /* | |
1114 | * 10 is the number of characters in "Proc-Type:", which | |
1115 | * PEM_get_EVP_CIPHER_INFO() requires to be present. | |
1116 | * If the PEM header has less characters than that, it's | |
1117 | * not worth spending cycles on it. | |
1118 | */ | |
1119 | if (strlen(*pem_header) > 10) { | |
1120 | EVP_CIPHER_INFO cipher; | |
1121 | struct pem_pass_data pass_data; | |
1122 | ||
1123 | if (!PEM_get_EVP_CIPHER_INFO(*pem_header, &cipher) | |
1124 | || !file_fill_pem_pass_data(&pass_data, "PEM", ui_method, ui_data) | |
1125 | || !PEM_do_header(&cipher, *data, len, file_get_pem_pass, | |
1126 | &pass_data)) { | |
1127 | return 0; | |
1128 | } | |
e61ec2d9 | 1129 | } |
1aabc244 RL |
1130 | return 1; |
1131 | } | |
1132 | ||
1133 | static int file_read_asn1(BIO *bp, unsigned char **data, long *len) | |
1134 | { | |
1135 | BUF_MEM *mem = NULL; | |
1136 | ||
1137 | if (asn1_d2i_read_bio(bp, &mem) < 0) | |
1138 | return 0; | |
1139 | ||
1140 | *data = (unsigned char *)mem->data; | |
1141 | *len = (long)mem->length; | |
1142 | OPENSSL_free(mem); | |
1143 | ||
1144 | return 1; | |
1145 | } | |
1146 | ||
970f467a RL |
1147 | static int ends_with_dirsep(const char *uri) |
1148 | { | |
1149 | if (*uri != '\0') | |
1150 | uri += strlen(uri) - 1; | |
1151 | #if defined __VMS | |
1152 | if (*uri == ']' || *uri == '>' || *uri == ':') | |
1153 | return 1; | |
1154 | #elif defined _WIN32 | |
1155 | if (*uri == '\\') | |
1156 | return 1; | |
1157 | #endif | |
1158 | return *uri == '/'; | |
1159 | } | |
1160 | ||
1161 | static int file_name_to_uri(OSSL_STORE_LOADER_CTX *ctx, const char *name, | |
1162 | char **data) | |
1163 | { | |
1164 | assert(name != NULL); | |
1165 | assert(data != NULL); | |
1166 | { | |
1167 | const char *pathsep = ends_with_dirsep(ctx->_.dir.uri) ? "" : "/"; | |
1168 | long calculated_length = strlen(ctx->_.dir.uri) + strlen(pathsep) | |
1169 | + strlen(name) + 1 /* \0 */; | |
1170 | ||
1171 | *data = OPENSSL_zalloc(calculated_length); | |
1172 | if (*data == NULL) { | |
1173 | OSSL_STOREerr(OSSL_STORE_F_FILE_NAME_TO_URI, ERR_R_MALLOC_FAILURE); | |
1174 | return 0; | |
1175 | } | |
1176 | ||
1177 | OPENSSL_strlcat(*data, ctx->_.dir.uri, calculated_length); | |
1178 | OPENSSL_strlcat(*data, pathsep, calculated_length); | |
1179 | OPENSSL_strlcat(*data, name, calculated_length); | |
1180 | } | |
1181 | return 1; | |
1182 | } | |
1183 | ||
93d2f9fa RL |
1184 | static int file_name_check(OSSL_STORE_LOADER_CTX *ctx, const char *name) |
1185 | { | |
1186 | const char *p = NULL; | |
1187 | ||
1188 | /* If there are no search criteria, all names are accepted */ | |
1189 | if (ctx->_.dir.search_name[0] == '\0') | |
1190 | return 1; | |
1191 | ||
1192 | /* If the expected type isn't supported, no name is accepted */ | |
1193 | if (ctx->expected_type != 0 | |
1194 | && ctx->expected_type != OSSL_STORE_INFO_CERT | |
1195 | && ctx->expected_type != OSSL_STORE_INFO_CRL) | |
1196 | return 0; | |
1197 | ||
1198 | /* | |
1199 | * First, check the basename | |
1200 | */ | |
1201 | if (strncasecmp(name, ctx->_.dir.search_name, | |
1202 | sizeof(ctx->_.dir.search_name) - 1) != 0 | |
1203 | || name[sizeof(ctx->_.dir.search_name) - 1] != '.') | |
1204 | return 0; | |
1205 | p = &name[sizeof(ctx->_.dir.search_name)]; | |
1206 | ||
1207 | /* | |
1208 | * Then, if the expected type is a CRL, check that the extension starts | |
1209 | * with 'r' | |
1210 | */ | |
1211 | if (*p == 'r') { | |
1212 | p++; | |
1213 | if (ctx->expected_type != 0 | |
1214 | && ctx->expected_type != OSSL_STORE_INFO_CRL) | |
1215 | return 0; | |
1216 | } else if (ctx->expected_type == OSSL_STORE_INFO_CRL) { | |
1217 | return 0; | |
1218 | } | |
1219 | ||
1220 | /* | |
1221 | * Last, check that the rest of the extension is a decimal number, at | |
1222 | * least one digit long. | |
1223 | */ | |
fa339c69 | 1224 | if (!ossl_isdigit(*p)) |
93d2f9fa | 1225 | return 0; |
fa339c69 | 1226 | while (ossl_isdigit(*p)) |
93d2f9fa RL |
1227 | p++; |
1228 | ||
1229 | # ifdef __VMS | |
1230 | /* | |
1231 | * One extra step here, check for a possible generation number. | |
1232 | */ | |
1233 | if (*p == ';') | |
1234 | for (p++; *p != '\0'; p++) | |
fa339c69 | 1235 | if (!ossl_isdigit(*p)) |
93d2f9fa RL |
1236 | break; |
1237 | # endif | |
1238 | ||
1239 | /* | |
1240 | * If we've reached the end of the string at this point, we've successfully | |
1241 | * found a fitting file name. | |
1242 | */ | |
1243 | return *p == '\0'; | |
1244 | } | |
1245 | ||
1aabc244 RL |
1246 | static int file_eof(OSSL_STORE_LOADER_CTX *ctx); |
1247 | static int file_error(OSSL_STORE_LOADER_CTX *ctx); | |
1248 | static OSSL_STORE_INFO *file_load(OSSL_STORE_LOADER_CTX *ctx, | |
1249 | const UI_METHOD *ui_method, void *ui_data) | |
1250 | { | |
1251 | OSSL_STORE_INFO *result = NULL; | |
1aabc244 | 1252 | |
6fc1d33c RL |
1253 | ctx->errcnt = 0; |
1254 | ERR_clear_error(); | |
1255 | ||
970f467a RL |
1256 | if (ctx->type == is_dir) { |
1257 | do { | |
1258 | char *newname = NULL; | |
e61ec2d9 | 1259 | |
970f467a RL |
1260 | if (ctx->_.dir.last_entry == NULL) { |
1261 | if (!ctx->_.dir.end_reached) { | |
1262 | char errbuf[256]; | |
1263 | assert(ctx->_.dir.last_errno != 0); | |
e7a4682d | 1264 | OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_SYS_LIB); |
970f467a | 1265 | errno = ctx->_.dir.last_errno; |
9c6da42d | 1266 | ctx->errcnt++; |
e7a4682d BE |
1267 | if (openssl_strerror_r(errno, errbuf, sizeof(errbuf))) |
1268 | ERR_add_error_data(1, errbuf); | |
970f467a RL |
1269 | } |
1270 | return NULL; | |
9c6da42d | 1271 | } |
970f467a RL |
1272 | |
1273 | if (ctx->_.dir.last_entry[0] != '.' | |
93d2f9fa | 1274 | && file_name_check(ctx, ctx->_.dir.last_entry) |
970f467a RL |
1275 | && !file_name_to_uri(ctx, ctx->_.dir.last_entry, &newname)) |
1276 | return NULL; | |
1277 | ||
1278 | /* | |
1279 | * On the first call (with a NULL context), OPENSSL_DIR_read() | |
1280 | * cares about the second argument. On the following calls, it | |
1281 | * only cares that it isn't NULL. Therefore, we can safely give | |
1282 | * it our URI here. | |
1283 | */ | |
1284 | ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx, | |
1285 | ctx->_.dir.uri); | |
1286 | ctx->_.dir.last_errno = errno; | |
1287 | if (ctx->_.dir.last_entry == NULL && ctx->_.dir.last_errno == 0) | |
1288 | ctx->_.dir.end_reached = 1; | |
1289 | ||
1290 | if (newname != NULL | |
1291 | && (result = OSSL_STORE_INFO_new_NAME(newname)) == NULL) { | |
1292 | OPENSSL_free(newname); | |
1293 | OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_OSSL_STORE_LIB); | |
1294 | return NULL; | |
9c6da42d | 1295 | } |
970f467a RL |
1296 | } while (result == NULL && !file_eof(ctx)); |
1297 | } else { | |
1298 | int matchcount = -1; | |
9c6da42d | 1299 | |
6541d9e2 | 1300 | again: |
970f467a RL |
1301 | result = file_load_try_repeat(ctx, ui_method, ui_data); |
1302 | if (result != NULL) | |
1303 | return result; | |
9c6da42d | 1304 | |
6fc1d33c | 1305 | if (file_eof(ctx)) |
970f467a | 1306 | return NULL; |
9c6da42d | 1307 | |
970f467a RL |
1308 | do { |
1309 | char *pem_name = NULL; /* PEM record name */ | |
1310 | char *pem_header = NULL; /* PEM record header */ | |
1311 | unsigned char *data = NULL; /* DER encoded data */ | |
1312 | long len = 0; /* DER encoded data length */ | |
1313 | ||
1314 | matchcount = -1; | |
1315 | if (ctx->type == is_pem) { | |
1316 | if (!file_read_pem(ctx->_.file.file, &pem_name, &pem_header, | |
7852f588 RL |
1317 | &data, &len, ui_method, ui_data, |
1318 | (ctx->flags & FILE_FLAG_SECMEM) != 0)) { | |
6fc1d33c RL |
1319 | ctx->errcnt++; |
1320 | goto endloop; | |
970f467a RL |
1321 | } |
1322 | } else { | |
1323 | if (!file_read_asn1(ctx->_.file.file, &data, &len)) { | |
6fc1d33c RL |
1324 | ctx->errcnt++; |
1325 | goto endloop; | |
970f467a RL |
1326 | } |
1327 | } | |
1328 | ||
1329 | result = file_load_try_decode(ctx, pem_name, pem_header, data, len, | |
1330 | ui_method, ui_data, &matchcount); | |
1331 | ||
6fc1d33c RL |
1332 | if (result != NULL) |
1333 | goto endloop; | |
1334 | ||
1335 | /* | |
1336 | * If a PEM name matches more than one handler, the handlers are | |
1337 | * badly coded. | |
1338 | */ | |
1339 | if (!ossl_assert(pem_name == NULL || matchcount <= 1)) { | |
1340 | ctx->errcnt++; | |
1341 | goto endloop; | |
1342 | } | |
1343 | ||
1344 | if (matchcount > 1) { | |
1345 | OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, | |
1346 | OSSL_STORE_R_AMBIGUOUS_CONTENT_TYPE); | |
1347 | } else if (matchcount == 1) { | |
1348 | /* | |
1349 | * If there are other errors on the stack, they already show | |
1350 | * what the problem is. | |
1351 | */ | |
1352 | if (ERR_peek_error() == 0) { | |
1353 | OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, | |
1354 | OSSL_STORE_R_UNSUPPORTED_CONTENT_TYPE); | |
1355 | if (pem_name != NULL) | |
1356 | ERR_add_error_data(3, "PEM type is '", pem_name, "'"); | |
1357 | } | |
1358 | } | |
1359 | if (matchcount > 0) | |
1360 | ctx->errcnt++; | |
1361 | ||
1362 | endloop: | |
358d446f BE |
1363 | pem_free_flag(pem_name, (ctx->flags & FILE_FLAG_SECMEM) != 0, 0); |
1364 | pem_free_flag(pem_header, (ctx->flags & FILE_FLAG_SECMEM) != 0, 0); | |
1365 | pem_free_flag(data, (ctx->flags & FILE_FLAG_SECMEM) != 0, len); | |
970f467a RL |
1366 | } while (matchcount == 0 && !file_eof(ctx) && !file_error(ctx)); |
1367 | ||
1368 | /* We bail out on ambiguity */ | |
1369 | if (matchcount > 1) | |
1370 | return NULL; | |
6541d9e2 RL |
1371 | |
1372 | if (result != NULL | |
1373 | && ctx->expected_type != 0 | |
1374 | && ctx->expected_type != OSSL_STORE_INFO_get_type(result)) { | |
1375 | OSSL_STORE_INFO_free(result); | |
1376 | goto again; | |
1377 | } | |
970f467a | 1378 | } |
9c6da42d | 1379 | |
9c6da42d RL |
1380 | return result; |
1381 | } | |
1382 | ||
1383 | static int file_error(OSSL_STORE_LOADER_CTX *ctx) | |
1384 | { | |
1385 | return ctx->errcnt > 0; | |
1386 | } | |
1387 | ||
1388 | static int file_eof(OSSL_STORE_LOADER_CTX *ctx) | |
1389 | { | |
970f467a RL |
1390 | if (ctx->type == is_dir) |
1391 | return ctx->_.dir.end_reached; | |
1392 | ||
1393 | if (ctx->_.file.last_handler != NULL | |
1394 | && !ctx->_.file.last_handler->eof(ctx->_.file.last_handler_ctx)) | |
e61ec2d9 | 1395 | return 0; |
970f467a | 1396 | return BIO_eof(ctx->_.file.file); |
9c6da42d RL |
1397 | } |
1398 | ||
1399 | static int file_close(OSSL_STORE_LOADER_CTX *ctx) | |
1400 | { | |
970f467a RL |
1401 | if (ctx->type == is_dir) { |
1402 | OPENSSL_DIR_end(&ctx->_.dir.ctx); | |
1403 | } else { | |
1404 | BIO_free_all(ctx->_.file.file); | |
e61ec2d9 | 1405 | } |
970f467a | 1406 | OSSL_STORE_LOADER_CTX_free(ctx); |
9c6da42d RL |
1407 | return 1; |
1408 | } | |
1409 | ||
4c17819c RL |
1410 | int ossl_store_file_detach_pem_bio_int(OSSL_STORE_LOADER_CTX *ctx) |
1411 | { | |
1412 | OSSL_STORE_LOADER_CTX_free(ctx); | |
1413 | return 1; | |
1414 | } | |
1415 | ||
9c6da42d RL |
1416 | static OSSL_STORE_LOADER file_loader = |
1417 | { | |
1418 | "file", | |
f91ded1f | 1419 | NULL, |
9c6da42d | 1420 | file_open, |
7852f588 | 1421 | file_ctrl, |
6541d9e2 | 1422 | file_expect, |
93d2f9fa | 1423 | file_find, |
9c6da42d RL |
1424 | file_load, |
1425 | file_eof, | |
1426 | file_error, | |
1427 | file_close | |
1428 | }; | |
1429 | ||
1430 | static void store_file_loader_deinit(void) | |
1431 | { | |
1432 | ossl_store_unregister_loader_int(file_loader.scheme); | |
1433 | } | |
1434 | ||
1435 | int ossl_store_file_loader_init(void) | |
1436 | { | |
1437 | int ret = ossl_store_register_loader_int(&file_loader); | |
1438 | ||
1439 | OPENSSL_atexit(store_file_loader_deinit); | |
1440 | return ret; | |
1441 | } |