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