ea2ec8b7d6cb7e815754adee31592c1ac2f3c0fe
[openssl.git] / crypto / store / loader_file.c
1 /*
2  * Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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 <string.h>
11 #include <sys/stat.h>
12 #include <assert.h>
13
14 #include <openssl/bio.h>
15 #include <openssl/dsa.h>         /* For d2i_DSAPrivateKey */
16 #include <openssl/err.h>
17 #include <openssl/evp.h>
18 #include <openssl/pem.h>
19 #include <openssl/pkcs12.h>      /* For the PKCS8 stuff o.O */
20 #include <openssl/rsa.h>         /* For d2i_RSAPrivateKey */
21 #include <openssl/safestack.h>
22 #include <openssl/store.h>
23 #include <openssl/ui.h>
24 #include <openssl/x509.h>        /* For the PKCS8 stuff o.O */
25 #include "internal/asn1_int.h"
26 #include "internal/o_dir.h"
27 #include "internal/cryptlib.h"
28 #include "store_locl.h"
29
30 #include "e_os.h"
31
32 /*
33  *  Password prompting
34  */
35
36 static char *file_get_pass(const UI_METHOD *ui_method, char *pass,
37                            size_t maxsize, const char *prompt_info, void *data)
38 {
39     UI *ui = UI_new();
40     char *prompt = NULL;
41
42     if (ui == NULL) {
43         OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
44         return NULL;
45     }
46
47     if (ui_method != NULL)
48         UI_set_method(ui, ui_method);
49     UI_add_user_data(ui, data);
50
51     if ((prompt = UI_construct_prompt(ui, "pass phrase",
52                                       prompt_info)) == NULL) {
53         OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_MALLOC_FAILURE);
54         pass = NULL;
55     } else if (!UI_add_input_string(ui, prompt, UI_INPUT_FLAG_DEFAULT_PWD,
56                                     pass, 0, maxsize - 1)) {
57         OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
58         pass = NULL;
59     } else {
60         switch (UI_process(ui)) {
61         case -2:
62             OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS,
63                           OSSL_STORE_R_UI_PROCESS_INTERRUPTED_OR_CANCELLED);
64             pass = NULL;
65             break;
66         case -1:
67             OSSL_STOREerr(OSSL_STORE_F_FILE_GET_PASS, ERR_R_UI_LIB);
68             pass = NULL;
69             break;
70         default:
71             break;
72         }
73     }
74
75     OPENSSL_free(prompt);
76     UI_free(ui);
77     return pass;
78 }
79
80 struct pem_pass_data {
81     const UI_METHOD *ui_method;
82     void *data;
83     const char *prompt_info;
84 };
85 static int file_fill_pem_pass_data(struct pem_pass_data *pass_data,
86                                    const char *prompt_info,
87                                    const UI_METHOD *ui_method, void *ui_data)
88 {
89     if (pass_data == NULL)
90         return 0;
91     pass_data->ui_method = ui_method;
92     pass_data->data = ui_data;
93     pass_data->prompt_info = prompt_info;
94     return 1;
95 }
96 static int file_get_pem_pass(char *buf, int num, int w, void *data)
97 {
98     struct pem_pass_data *pass_data = data;
99     char *pass = file_get_pass(pass_data->ui_method, buf, num,
100                                pass_data->prompt_info, pass_data->data);
101
102     return pass == NULL ? 0 : strlen(pass);
103 }
104
105 /*
106  *  The file scheme handlers
107  */
108
109 /*-
110  * The try_decode function is called to check if the blob of data can
111  * be used by this handler, and if it can, decodes it into a supported
112  * OpenSSL type and returns a OSSL_STORE_INFO with the decoded data.
113  * Input:
114  *    pem_name:     If this blob comes from a PEM file, this holds
115  *                  the PEM name.  If it comes from another type of
116  *                  file, this is NULL.
117  *    pem_header:   If this blob comes from a PEM file, this holds
118  *                  the PEM headers.  If it comes from another type of
119  *                  file, this is NULL.
120  *    blob:         The blob of data to match with what this handler
121  *                  can use.
122  *    len:          The length of the blob.
123  *    handler_ctx:  For a handler marked repeatable, this pointer can
124  *                  be used to create a context for the handler.  IT IS
125  *                  THE HANDLER'S RESPONSIBILITY TO CREATE AND DESTROY
126  *                  THIS CONTEXT APPROPRIATELY, i.e. create on first call
127  *                  and destroy when about to return NULL.
128  *    matchcount:   A pointer to an int to count matches for this data.
129  *                  Usually becomes 0 (no match) or 1 (match!), but may
130  *                  be higher in the (unlikely) event that the data matches
131  *                  more than one possibility.  The int will always be
132  *                  zero when the function is called.
133  *    ui_method:    Application UI method for getting a password, pin
134  *                  or any other interactive data.
135  *    ui_data:      Application data to be passed to ui_method when
136  *                  it's called.
137  * Output:
138  *    a OSSL_STORE_INFO
139  */
140 typedef OSSL_STORE_INFO *(*file_try_decode_fn)(const char *pem_name,
141                                                const char *pem_header,
142                                                const unsigned char *blob,
143                                                size_t len, void **handler_ctx,
144                                                int *matchcount,
145                                                const UI_METHOD *ui_method,
146                                                void *ui_data);
147 /*
148  * The eof function should return 1 if there's no more data to be found
149  * with the handler_ctx, otherwise 0.  This is only used when the handler is
150  * marked repeatable.
151  */
152 typedef int (*file_eof_fn)(void *handler_ctx);
153 /*
154  * The destroy_ctx function is used to destroy the handler_ctx that was
155  * intiated by a repeatable try_decode fuction.  This is only used when
156  * the handler is marked repeatable.
157  */
158 typedef void (*file_destroy_ctx_fn)(void **handler_ctx);
159
160 typedef struct file_handler_st {
161     const char *name;
162     file_try_decode_fn try_decode;
163     file_eof_fn eof;
164     file_destroy_ctx_fn destroy_ctx;
165
166     /* flags */
167     int repeatable;
168 } FILE_HANDLER;
169
170 static OSSL_STORE_INFO *try_decode_PKCS12(const char *pem_name,
171                                           const char *pem_header,
172                                           const unsigned char *blob,
173                                           size_t len, void **pctx,
174                                           int *matchcount,
175                                           const UI_METHOD *ui_method,
176                                           void *ui_data)
177 {
178     OSSL_STORE_INFO *store_info = NULL;
179     STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
180
181     if (ctx == NULL) {
182         /* Initial parsing */
183         PKCS12 *p12;
184         int ok = 0;
185
186         if (pem_name != NULL)
187             /* No match, there is no PEM PKCS12 tag */
188             return NULL;
189
190         if ((p12 = d2i_PKCS12(NULL, &blob, len)) != NULL) {
191             char *pass = NULL;
192             char tpass[PEM_BUFSIZE];
193             EVP_PKEY *pkey = NULL;
194             X509 *cert = NULL;
195             STACK_OF(X509) *chain = NULL;
196
197             *matchcount = 1;
198
199             if (PKCS12_verify_mac(p12, "", 0)
200                 || PKCS12_verify_mac(p12, NULL, 0)) {
201                 pass = "";
202             } else {
203                 if ((pass = file_get_pass(ui_method, tpass, PEM_BUFSIZE,
204                                           "PKCS12 import password",
205                                           ui_data)) == NULL) {
206                     OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
207                                   OSSL_STORE_R_PASSPHRASE_CALLBACK_ERROR);
208                     goto p12_end;
209                 }
210                 if (!PKCS12_verify_mac(p12, pass, strlen(pass))) {
211                     OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS12,
212                                   OSSL_STORE_R_ERROR_VERIFYING_PKCS12_MAC);
213                     goto p12_end;
214                 }
215             }
216
217             if (PKCS12_parse(p12, pass, &pkey, &cert, &chain)) {
218                 OSSL_STORE_INFO *si_pkey = NULL;
219                 OSSL_STORE_INFO *si_cert = NULL;
220                 OSSL_STORE_INFO *si_ca = NULL;
221
222                 if ((ctx = sk_OSSL_STORE_INFO_new_null()) != NULL
223                     && (si_pkey = OSSL_STORE_INFO_new_PKEY(pkey)) != NULL
224                     && sk_OSSL_STORE_INFO_push(ctx, si_pkey) != 0
225                     && (si_cert = OSSL_STORE_INFO_new_CERT(cert)) != NULL
226                     && sk_OSSL_STORE_INFO_push(ctx, si_cert) != 0) {
227                     ok = 1;
228                     si_pkey = NULL;
229                     si_cert = NULL;
230
231                     while(sk_X509_num(chain) > 0) {
232                         X509 *ca = sk_X509_value(chain, 0);
233
234                         if ((si_ca = OSSL_STORE_INFO_new_CERT(ca)) == NULL
235                             || sk_OSSL_STORE_INFO_push(ctx, si_ca) == 0) {
236                             ok = 0;
237                             break;
238                         }
239                         si_ca = NULL;
240                         (void)sk_X509_shift(chain);
241                     }
242                 }
243                 if (!ok) {
244                     OSSL_STORE_INFO_free(si_ca);
245                     OSSL_STORE_INFO_free(si_cert);
246                     OSSL_STORE_INFO_free(si_pkey);
247                     sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
248                     EVP_PKEY_free(pkey);
249                     X509_free(cert);
250                     sk_X509_pop_free(chain, X509_free);
251                     ctx = NULL;
252                 }
253                 *pctx = ctx;
254             }
255         }
256      p12_end:
257         PKCS12_free(p12);
258         if (!ok)
259             return NULL;
260     }
261
262     if (ctx != NULL) {
263         *matchcount = 1;
264         store_info = sk_OSSL_STORE_INFO_shift(ctx);
265     }
266
267     return store_info;
268 }
269 static int eof_PKCS12(void *ctx_)
270 {
271     STACK_OF(OSSL_STORE_INFO) *ctx = ctx_;
272
273     return ctx == NULL || sk_OSSL_STORE_INFO_num(ctx) == 0;
274 }
275 static void destroy_ctx_PKCS12(void **pctx)
276 {
277     STACK_OF(OSSL_STORE_INFO) *ctx = *pctx;
278
279     sk_OSSL_STORE_INFO_pop_free(ctx, OSSL_STORE_INFO_free);
280     *pctx = NULL;
281 }
282 static FILE_HANDLER PKCS12_handler = {
283     "PKCS12",
284     try_decode_PKCS12,
285     eof_PKCS12,
286     destroy_ctx_PKCS12,
287     1                            /* repeatable */
288 };
289
290 static OSSL_STORE_INFO *try_decode_PKCS8Encrypted(const char *pem_name,
291                                                   const char *pem_header,
292                                                   const unsigned char *blob,
293                                                   size_t len, void **pctx,
294                                                   int *matchcount,
295                                                   const UI_METHOD *ui_method,
296                                                   void *ui_data)
297 {
298     X509_SIG *p8 = NULL;
299     char kbuf[PEM_BUFSIZE];
300     char *pass = NULL;
301     const X509_ALGOR *dalg = NULL;
302     const ASN1_OCTET_STRING *doct = NULL;
303     OSSL_STORE_INFO *store_info = NULL;
304     BUF_MEM *mem = NULL;
305     unsigned char *new_data = NULL;
306     int new_data_len;
307
308     if (pem_name != NULL) {
309         if (strcmp(pem_name, PEM_STRING_PKCS8) != 0)
310             return NULL;
311         *matchcount = 1;
312     }
313
314     if ((p8 = d2i_X509_SIG(NULL, &blob, len)) == NULL)
315         return NULL;
316
317     *matchcount = 1;
318
319     if ((mem = BUF_MEM_new()) == NULL) {
320         OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
321                       ERR_R_MALLOC_FAILURE);
322         goto nop8;
323     }
324
325     if ((pass = file_get_pass(ui_method, kbuf, PEM_BUFSIZE,
326                               "PKCS8 decrypt password", ui_data)) == NULL) {
327         OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
328                       OSSL_STORE_R_BAD_PASSWORD_READ);
329         goto nop8;
330     }
331
332     X509_SIG_get0(p8, &dalg, &doct);
333     if (!PKCS12_pbe_crypt(dalg, pass, strlen(pass), doct->data, doct->length,
334                           &new_data, &new_data_len, 0))
335         goto nop8;
336
337     mem->data = (char *)new_data;
338     mem->max = mem->length = (size_t)new_data_len;
339     X509_SIG_free(p8);
340
341     store_info = ossl_store_info_new_EMBEDDED(PEM_STRING_PKCS8INF, mem);
342     if (store_info == NULL) {
343         OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PKCS8ENCRYPTED,
344                       ERR_R_MALLOC_FAILURE);
345         goto nop8;
346     }
347
348     return store_info;
349  nop8:
350     X509_SIG_free(p8);
351     BUF_MEM_free(mem);
352     return NULL;
353 }
354 static FILE_HANDLER PKCS8Encrypted_handler = {
355     "PKCS8Encrypted",
356     try_decode_PKCS8Encrypted
357 };
358
359 int pem_check_suffix(const char *pem_str, const char *suffix);
360 static OSSL_STORE_INFO *try_decode_PrivateKey(const char *pem_name,
361                                               const char *pem_header,
362                                               const unsigned char *blob,
363                                               size_t len, void **pctx,
364                                               int *matchcount,
365                                               const UI_METHOD *ui_method,
366                                               void *ui_data)
367 {
368     OSSL_STORE_INFO *store_info = NULL;
369     EVP_PKEY *pkey = NULL;
370     const EVP_PKEY_ASN1_METHOD *ameth = NULL;
371
372     if (pem_name != NULL) {
373         if (strcmp(pem_name, PEM_STRING_PKCS8INF) == 0) {
374             PKCS8_PRIV_KEY_INFO *p8inf =
375                 d2i_PKCS8_PRIV_KEY_INFO(NULL, &blob, len);
376
377             *matchcount = 1;
378             if (p8inf != NULL)
379                 pkey = EVP_PKCS82PKEY(p8inf);
380             PKCS8_PRIV_KEY_INFO_free(p8inf);
381         } else {
382             int slen;
383
384             if ((slen = pem_check_suffix(pem_name, "PRIVATE KEY")) > 0
385                 && (ameth = EVP_PKEY_asn1_find_str(NULL, pem_name,
386                                                    slen)) != NULL) {
387                 *matchcount = 1;
388                 pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &blob, len);
389             }
390         }
391     } else {
392         int i;
393
394         for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
395             EVP_PKEY *tmp_pkey = NULL;
396             const unsigned char *tmp_blob = blob;
397
398             ameth = EVP_PKEY_asn1_get0(i);
399             if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
400                 continue;
401
402             tmp_pkey = d2i_PrivateKey(ameth->pkey_id, NULL, &tmp_blob, len);
403             if (tmp_pkey != NULL) {
404                 if (pkey != NULL)
405                     EVP_PKEY_free(tmp_pkey);
406                 else
407                     pkey = tmp_pkey;
408                 (*matchcount)++;
409             }
410         }
411
412         if (*matchcount > 1) {
413             EVP_PKEY_free(pkey);
414             pkey = NULL;
415         }
416     }
417     if (pkey == NULL)
418         /* No match */
419         return NULL;
420
421     store_info = OSSL_STORE_INFO_new_PKEY(pkey);
422     if (store_info == NULL)
423         EVP_PKEY_free(pkey);
424
425     return store_info;
426 }
427 static FILE_HANDLER PrivateKey_handler = {
428     "PrivateKey",
429     try_decode_PrivateKey
430 };
431
432 static OSSL_STORE_INFO *try_decode_PUBKEY(const char *pem_name,
433                                           const char *pem_header,
434                                           const unsigned char *blob,
435                                           size_t len, void **pctx,
436                                           int *matchcount,
437                                           const UI_METHOD *ui_method,
438                                           void *ui_data)
439 {
440     OSSL_STORE_INFO *store_info = NULL;
441     EVP_PKEY *pkey = NULL;
442
443     if (pem_name != NULL) {
444         if (strcmp(pem_name, PEM_STRING_PUBLIC) != 0)
445             /* No match */
446             return NULL;
447         *matchcount = 1;
448     }
449
450     if ((pkey = d2i_PUBKEY(NULL, &blob, len)) != NULL) {
451         *matchcount = 1;
452         store_info = OSSL_STORE_INFO_new_PKEY(pkey);
453     }
454
455     return store_info;
456 }
457 static FILE_HANDLER PUBKEY_handler = {
458     "PUBKEY",
459     try_decode_PUBKEY
460 };
461
462 static OSSL_STORE_INFO *try_decode_params(const char *pem_name,
463                                           const char *pem_header,
464                                           const unsigned char *blob,
465                                           size_t len, void **pctx,
466                                           int *matchcount,
467                                           const UI_METHOD *ui_method,
468                                           void *ui_data)
469 {
470     OSSL_STORE_INFO *store_info = NULL;
471     int slen = 0;
472     EVP_PKEY *pkey = NULL;
473     const EVP_PKEY_ASN1_METHOD *ameth = NULL;
474     int ok = 0;
475
476     if (pem_name != NULL) {
477         if ((slen = pem_check_suffix(pem_name, "PARAMETERS")) == 0)
478             return NULL;
479         *matchcount = 1;
480     }
481
482     if ((pkey = EVP_PKEY_new()) == NULL) {
483         OSSL_STOREerr(OSSL_STORE_F_TRY_DECODE_PARAMS, ERR_R_EVP_LIB);
484         return NULL;
485     }
486
487     if (slen > 0) {
488         if (EVP_PKEY_set_type_str(pkey, pem_name, slen)
489             && (ameth = EVP_PKEY_get0_asn1(pkey)) != NULL
490             && ameth->param_decode != NULL
491             && ameth->param_decode(pkey, &blob, len))
492             ok = 1;
493     } else {
494         int i;
495
496         for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
497             const unsigned char *tmp_blob = blob;
498
499             ameth = EVP_PKEY_asn1_get0(i);
500             if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
501                 continue;
502             if (EVP_PKEY_set_type(pkey, ameth->pkey_id)
503                 && (ameth = EVP_PKEY_get0_asn1(pkey)) != NULL
504                 && ameth->param_decode != NULL
505                 && ameth->param_decode(pkey, &tmp_blob, len)) {
506                 (*matchcount)++;
507                 ok = 1;
508                 break;
509             }
510         }
511     }
512
513     if (ok)
514         store_info = OSSL_STORE_INFO_new_PARAMS(pkey);
515     if (store_info == NULL)
516         EVP_PKEY_free(pkey);
517
518     return store_info;
519 }
520 static FILE_HANDLER params_handler = {
521     "params",
522     try_decode_params
523 };
524
525 static OSSL_STORE_INFO *try_decode_X509Certificate(const char *pem_name,
526                                                    const char *pem_header,
527                                                    const unsigned char *blob,
528                                                    size_t len, void **pctx,
529                                                    int *matchcount,
530                                                    const UI_METHOD *ui_method,
531                                                    void *ui_data)
532 {
533     OSSL_STORE_INFO *store_info = NULL;
534     X509 *cert = NULL;
535
536     /*
537      * In most cases, we can try to interpret the serialized data as a trusted
538      * cert (X509 + X509_AUX) and fall back to reading it as a normal cert
539      * (just X509), but if the PEM name specifically declares it as a trusted
540      * cert, then no fallback should be engaged.  |ignore_trusted| tells if
541      * the fallback can be used (1) or not (0).
542      */
543     int ignore_trusted = 1;
544
545     if (pem_name != NULL) {
546         if (strcmp(pem_name, PEM_STRING_X509_TRUSTED) == 0)
547             ignore_trusted = 0;
548         else if (strcmp(pem_name, PEM_STRING_X509_OLD) != 0
549                  && strcmp(pem_name, PEM_STRING_X509) != 0)
550             /* No match */
551             return NULL;
552         *matchcount = 1;
553     }
554
555     if ((cert = d2i_X509_AUX(NULL, &blob, len)) != NULL
556         || (ignore_trusted && (cert = d2i_X509(NULL, &blob, len)) != NULL)) {
557         *matchcount = 1;
558         store_info = OSSL_STORE_INFO_new_CERT(cert);
559     }
560
561     if (store_info == NULL)
562         X509_free(cert);
563
564     return store_info;
565 }
566 static FILE_HANDLER X509Certificate_handler = {
567     "X509Certificate",
568     try_decode_X509Certificate
569 };
570
571 static OSSL_STORE_INFO *try_decode_X509CRL(const char *pem_name,
572                                            const char *pem_header,
573                                            const unsigned char *blob,
574                                            size_t len, void **pctx,
575                                            int *matchcount,
576                                            const UI_METHOD *ui_method,
577                                            void *ui_data)
578 {
579     OSSL_STORE_INFO *store_info = NULL;
580     X509_CRL *crl = NULL;
581
582     if (pem_name != NULL) {
583         if (strcmp(pem_name, PEM_STRING_X509_CRL) != 0)
584             /* No match */
585             return NULL;
586         *matchcount = 1;
587     }
588
589     if ((crl = d2i_X509_CRL(NULL, &blob, len)) != NULL) {
590         *matchcount = 1;
591         store_info = OSSL_STORE_INFO_new_CRL(crl);
592     }
593
594     if (store_info == NULL)
595         X509_CRL_free(crl);
596
597     return store_info;
598 }
599 static FILE_HANDLER X509CRL_handler = {
600     "X509CRL",
601     try_decode_X509CRL
602 };
603
604 static const FILE_HANDLER *file_handlers[] = {
605     &PKCS12_handler,
606     &PKCS8Encrypted_handler,
607     &X509Certificate_handler,
608     &X509CRL_handler,
609     &params_handler,
610     &PUBKEY_handler,
611     &PrivateKey_handler,
612 };
613
614
615 /*
616  *  The loader itself
617  */
618
619 struct ossl_store_loader_ctx_st {
620     enum {
621         is_raw = 0,
622         is_pem,
623         is_dir
624     } type;
625     int errcnt;
626     union {
627         struct {                 /* Used with is_raw and is_pem */
628             BIO *file;
629
630             /*
631              * The following are used when the handler is marked as
632              * repeatable
633              */
634             const FILE_HANDLER *last_handler;
635             void *last_handler_ctx;
636         } file;
637         struct {                 /* Used with is_dir */
638             OPENSSL_DIR_CTX *ctx;
639             int end_reached;
640             char *uri;
641
642             /*
643              * The directory reading utility we have combines opening with
644              * reading the first name.  To make sure we can detect the end
645              * at the right time, we read early and cache the name.
646              */
647             const char *last_entry;
648             int last_errno;
649         } dir;
650     } _;
651 };
652
653 static void OSSL_STORE_LOADER_CTX_free(OSSL_STORE_LOADER_CTX *ctx)
654 {
655     if (ctx->type == is_dir) {
656         OPENSSL_free(ctx->_.dir.uri);
657     } else {
658         if (ctx->_.file.last_handler != NULL) {
659             ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
660             ctx->_.file.last_handler_ctx = NULL;
661             ctx->_.file.last_handler = NULL;
662         }
663     }
664     OPENSSL_free(ctx);
665 }
666
667 static OSSL_STORE_LOADER_CTX *file_open(const OSSL_STORE_LOADER *loader,
668                                         const char *uri,
669                                         const UI_METHOD *ui_method,
670                                         void *ui_data)
671 {
672     OSSL_STORE_LOADER_CTX *ctx = NULL;
673     struct stat st;
674     const char *path = NULL;
675
676     if (strncasecmp(uri, "file:", 5) == 0) {
677         if (strncmp(&uri[5], "//localhost/", 12) == 0) {
678             path = &uri[16];
679         } else if (strncmp(&uri[5], "///", 3) == 0) {
680             path = &uri[7];
681         } else if (strncmp(&uri[5], "//", 2) != 0) {
682             path = &uri[5];
683         } else {
684             OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
685                           OSSL_STORE_R_URI_AUTHORITY_UNSUPPORED);
686             return NULL;
687         }
688
689         /*
690          * If the scheme "file" was an explicit part of the URI, the path must
691          * be absolute.  So says RFC 8089
692          */
693         if (path[0] != '/') {
694             OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN,
695                           OSSL_STORE_R_PATH_MUST_BE_ABSOLUTE);
696             return NULL;
697         }
698
699 #ifdef _WIN32
700         /* Windows file: URIs with a drive letter start with a / */
701         if (path[0] == '/' && path[2] == ':' && path[3] == '/')
702             path++;
703 #endif
704     } else {
705         path = uri;
706     }
707
708
709     if (stat(path, &st) < 0) {
710         SYSerr(SYS_F_STAT, errno);
711         ERR_add_error_data(1, path);
712         return NULL;
713     }
714
715     ctx = OPENSSL_zalloc(sizeof(*ctx));
716     if (ctx == NULL) {
717         OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_MALLOC_FAILURE);
718         return NULL;
719     }
720
721     if ((st.st_mode & S_IFDIR) == S_IFDIR) {
722         /*
723          * Try to copy everything, even if we know that some of them must be
724          * NULL for the moment.  This prevents errors in the future, when more
725          * components may be used.
726          */
727         ctx->_.dir.uri = OPENSSL_strdup(uri);
728         ctx->type = is_dir;
729
730         if (ctx->_.dir.uri == NULL)
731             goto err;
732
733         ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx, path);
734         ctx->_.dir.last_errno = errno;
735         if (ctx->_.dir.last_entry == NULL) {
736             if (ctx->_.dir.last_errno != 0) {
737                 char errbuf[256];
738                 errno = ctx->_.dir.last_errno;
739                 openssl_strerror_r(errno, errbuf, sizeof(errbuf));
740                 OSSL_STOREerr(OSSL_STORE_F_FILE_OPEN, ERR_R_SYS_LIB);
741                 ERR_add_error_data(1, errbuf);
742                 goto err;
743             }
744             ctx->_.dir.end_reached = 1;
745         }
746     } else {
747         BIO *buff = NULL;
748         char peekbuf[4096];
749
750         if ((buff = BIO_new(BIO_f_buffer())) == NULL
751             || (ctx->_.file.file = BIO_new_file(path, "rb")) == NULL) {
752             BIO_free_all(buff);
753             goto err;
754         }
755
756         ctx->_.file.file = BIO_push(buff, ctx->_.file.file);
757         if (BIO_buffer_peek(ctx->_.file.file, peekbuf, sizeof(peekbuf)-1) > 0) {
758             peekbuf[sizeof(peekbuf)-1] = '\0';
759             if (strstr(peekbuf, "-----BEGIN ") != NULL)
760                 ctx->type = is_pem;
761         }
762     }
763
764     return ctx;
765  err:
766     OSSL_STORE_LOADER_CTX_free(ctx);
767     return NULL;
768 }
769
770 static OSSL_STORE_INFO *file_load_try_decode(OSSL_STORE_LOADER_CTX *ctx,
771                                              const char *pem_name,
772                                              const char *pem_header,
773                                              unsigned char *data, size_t len,
774                                              const UI_METHOD *ui_method,
775                                              void *ui_data, int *matchcount)
776 {
777     OSSL_STORE_INFO *result = NULL;
778     BUF_MEM *new_mem = NULL;
779     char *new_pem_name = NULL;
780     int t = 0;
781
782  again:
783     {
784         size_t i = 0;
785         void *handler_ctx = NULL;
786         const FILE_HANDLER **matching_handlers =
787             OPENSSL_zalloc(sizeof(*matching_handlers)
788                            * OSSL_NELEM(file_handlers));
789
790         if (matching_handlers == NULL) {
791             OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD_TRY_DECODE,
792                           ERR_R_MALLOC_FAILURE);
793             goto err;
794         }
795
796         *matchcount = 0;
797         for (i = 0; i < OSSL_NELEM(file_handlers); i++) {
798             const FILE_HANDLER *handler = file_handlers[i];
799             int try_matchcount = 0;
800             void *tmp_handler_ctx = NULL;
801             OSSL_STORE_INFO *tmp_result =
802                 handler->try_decode(pem_name, pem_header, data, len,
803                                     &tmp_handler_ctx, &try_matchcount,
804                                     ui_method, ui_data);
805
806             if (try_matchcount > 0) {
807                 if (matching_handlers)
808                     matching_handlers[*matchcount] = handler;
809
810                 if (handler_ctx)
811                     handler->destroy_ctx(&handler_ctx);
812                 handler_ctx = tmp_handler_ctx;
813
814                 if ((*matchcount += try_matchcount) > 1) {
815                     /* more than one match => ambiguous, kill any result */
816                     OSSL_STORE_INFO_free(result);
817                     OSSL_STORE_INFO_free(tmp_result);
818                     if (handler->destroy_ctx != NULL)
819                         handler->destroy_ctx(&handler_ctx);
820                     handler_ctx = NULL;
821                     tmp_result = NULL;
822                     result = NULL;
823                 }
824                 if (result == NULL)
825                     result = tmp_result;
826             }
827         }
828
829         if (*matchcount == 1 && matching_handlers[0]->repeatable) {
830             ctx->_.file.last_handler = matching_handlers[0];
831             ctx->_.file.last_handler_ctx = handler_ctx;
832         }
833
834         OPENSSL_free(matching_handlers);
835     }
836
837  err:
838     OPENSSL_free(new_pem_name);
839     BUF_MEM_free(new_mem);
840
841     if (result != NULL
842         && (t = OSSL_STORE_INFO_get_type(result)) == OSSL_STORE_INFO_EMBEDDED) {
843         pem_name = new_pem_name =
844             ossl_store_info_get0_EMBEDDED_pem_name(result);
845         new_mem = ossl_store_info_get0_EMBEDDED_buffer(result);
846         data = (unsigned char *)new_mem->data;
847         len = new_mem->length;
848         OPENSSL_free(result);
849         result = NULL;
850         goto again;
851     }
852
853     if (result != NULL)
854         ERR_clear_error();
855
856     return result;
857 }
858
859 static OSSL_STORE_INFO *file_load_try_repeat(OSSL_STORE_LOADER_CTX *ctx,
860                                              const UI_METHOD *ui_method,
861                                              void *ui_data)
862 {
863     OSSL_STORE_INFO *result = NULL;
864     int try_matchcount = 0;
865
866     if (ctx->_.file.last_handler != NULL) {
867         result =
868             ctx->_.file.last_handler->try_decode(NULL, NULL, NULL, 0,
869                                                  &ctx->_.file.last_handler_ctx,
870                                                  &try_matchcount,
871                                                  ui_method, ui_data);
872
873         if (result == NULL) {
874             ctx->_.file.last_handler->destroy_ctx(&ctx->_.file.last_handler_ctx);
875             ctx->_.file.last_handler_ctx = NULL;
876             ctx->_.file.last_handler = NULL;
877         }
878     }
879     return result;
880 }
881
882 static int file_read_pem(BIO *bp, char **pem_name, char **pem_header,
883                          unsigned char **data, long *len,
884                          const UI_METHOD *ui_method,
885                          void *ui_data)
886 {
887     int i = PEM_read_bio(bp, pem_name, pem_header, data, len);
888
889     if (i <= 0)
890         return 0;
891
892     /*
893      * 10 is the number of characters in "Proc-Type:", which
894      * PEM_get_EVP_CIPHER_INFO() requires to be present.
895      * If the PEM header has less characters than that, it's
896      * not worth spending cycles on it.
897      */
898     if (strlen(*pem_header) > 10) {
899         EVP_CIPHER_INFO cipher;
900         struct pem_pass_data pass_data;
901
902         if (!PEM_get_EVP_CIPHER_INFO(*pem_header, &cipher)
903             || !file_fill_pem_pass_data(&pass_data, "PEM", ui_method, ui_data)
904             || !PEM_do_header(&cipher, *data, len, file_get_pem_pass,
905                               &pass_data)) {
906             return 0;
907         }
908     }
909     return 1;
910 }
911
912 static int file_read_asn1(BIO *bp, unsigned char **data, long *len)
913 {
914     BUF_MEM *mem = NULL;
915
916     if (asn1_d2i_read_bio(bp, &mem) < 0)
917         return 0;
918
919     *data = (unsigned char *)mem->data;
920     *len = (long)mem->length;
921     OPENSSL_free(mem);
922
923     return 1;
924 }
925
926 static int ends_with_dirsep(const char *uri)
927 {
928     if (*uri != '\0')
929         uri += strlen(uri) - 1;
930 #if defined __VMS
931     if (*uri == ']' || *uri == '>' || *uri == ':')
932         return 1;
933 #elif defined _WIN32
934     if (*uri == '\\')
935         return 1;
936 #endif
937     return *uri == '/';
938 }
939
940 static int file_name_to_uri(OSSL_STORE_LOADER_CTX *ctx, const char *name,
941                             char **data)
942 {
943     assert(name != NULL);
944     assert(data != NULL);
945     {
946         const char *pathsep = ends_with_dirsep(ctx->_.dir.uri) ? "" : "/";
947         long calculated_length = strlen(ctx->_.dir.uri) + strlen(pathsep)
948             + strlen(name) + 1 /* \0 */;
949
950         *data = OPENSSL_zalloc(calculated_length);
951         if (*data == NULL) {
952             OSSL_STOREerr(OSSL_STORE_F_FILE_NAME_TO_URI, ERR_R_MALLOC_FAILURE);
953             return 0;
954         }
955
956         OPENSSL_strlcat(*data, ctx->_.dir.uri, calculated_length);
957         OPENSSL_strlcat(*data, pathsep, calculated_length);
958         OPENSSL_strlcat(*data, name, calculated_length);
959     }
960     return 1;
961 }
962
963 static int file_eof(OSSL_STORE_LOADER_CTX *ctx);
964 static int file_error(OSSL_STORE_LOADER_CTX *ctx);
965 static OSSL_STORE_INFO *file_load(OSSL_STORE_LOADER_CTX *ctx,
966                                   const UI_METHOD *ui_method, void *ui_data)
967 {
968     OSSL_STORE_INFO *result = NULL;
969
970     ctx->errcnt = 0;
971     ERR_clear_error();
972
973     if (ctx->type == is_dir) {
974         do {
975             char *newname = NULL;
976
977             if (ctx->_.dir.last_entry == NULL) {
978                 if (!ctx->_.dir.end_reached) {
979                     char errbuf[256];
980                     assert(ctx->_.dir.last_errno != 0);
981                     errno = ctx->_.dir.last_errno;
982                     ctx->errcnt++;
983                     openssl_strerror_r(errno, errbuf, sizeof(errbuf));
984                     OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_SYS_LIB);
985                     ERR_add_error_data(1, errbuf);
986                 }
987                 return NULL;
988             }
989
990             if (ctx->_.dir.last_entry[0] != '.'
991                 && !file_name_to_uri(ctx, ctx->_.dir.last_entry, &newname))
992                 return NULL;
993
994             /*
995              * On the first call (with a NULL context), OPENSSL_DIR_read()
996              * cares about the second argument.  On the following calls, it
997              * only cares that it isn't NULL.  Therefore, we can safely give
998              * it our URI here.
999              */
1000             ctx->_.dir.last_entry = OPENSSL_DIR_read(&ctx->_.dir.ctx,
1001                                                      ctx->_.dir.uri);
1002             ctx->_.dir.last_errno = errno;
1003             if (ctx->_.dir.last_entry == NULL && ctx->_.dir.last_errno == 0)
1004                 ctx->_.dir.end_reached = 1;
1005
1006             if (newname != NULL
1007                 && (result = OSSL_STORE_INFO_new_NAME(newname)) == NULL) {
1008                 OPENSSL_free(newname);
1009                 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD, ERR_R_OSSL_STORE_LIB);
1010                 return NULL;
1011             }
1012         } while (result == NULL && !file_eof(ctx));
1013     } else {
1014         int matchcount = -1;
1015
1016         result = file_load_try_repeat(ctx, ui_method, ui_data);
1017         if (result != NULL)
1018             return result;
1019
1020         if (file_eof(ctx))
1021             return NULL;
1022
1023         do {
1024             char *pem_name = NULL;      /* PEM record name */
1025             char *pem_header = NULL;    /* PEM record header */
1026             unsigned char *data = NULL; /* DER encoded data */
1027             long len = 0;               /* DER encoded data length */
1028
1029             matchcount = -1;
1030             if (ctx->type == is_pem) {
1031                 if (!file_read_pem(ctx->_.file.file, &pem_name, &pem_header,
1032                                    &data, &len, ui_method, ui_data)) {
1033                     ctx->errcnt++;
1034                     goto endloop;
1035                 }
1036             } else {
1037                 if (!file_read_asn1(ctx->_.file.file, &data, &len)) {
1038                     ctx->errcnt++;
1039                     goto endloop;
1040                 }
1041             }
1042
1043             result = file_load_try_decode(ctx, pem_name, pem_header, data, len,
1044                                           ui_method, ui_data, &matchcount);
1045
1046             if (result != NULL)
1047                 goto endloop;
1048
1049             /*
1050              * If a PEM name matches more than one handler, the handlers are
1051              * badly coded.
1052              */
1053             if (!ossl_assert(pem_name == NULL || matchcount <= 1)) {
1054                 ctx->errcnt++;
1055                 goto endloop;
1056             }
1057
1058             if (matchcount > 1) {
1059                 OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD,
1060                               OSSL_STORE_R_AMBIGUOUS_CONTENT_TYPE);
1061             } else if (matchcount == 1) {
1062                 /*
1063                  * If there are other errors on the stack, they already show
1064                  * what the problem is.
1065                  */
1066                 if (ERR_peek_error() == 0) {
1067                     OSSL_STOREerr(OSSL_STORE_F_FILE_LOAD,
1068                                   OSSL_STORE_R_UNSUPPORTED_CONTENT_TYPE);
1069                     if (pem_name != NULL)
1070                         ERR_add_error_data(3, "PEM type is '", pem_name, "'");
1071                 }
1072             }
1073             if (matchcount > 0)
1074                 ctx->errcnt++;
1075
1076          endloop:
1077             OPENSSL_free(pem_name);
1078             OPENSSL_free(pem_header);
1079             OPENSSL_free(data);
1080         } while (matchcount == 0 && !file_eof(ctx) && !file_error(ctx));
1081
1082         /* We bail out on ambiguity */
1083         if (matchcount > 1)
1084             return NULL;
1085     }
1086
1087     return result;
1088 }
1089
1090 static int file_error(OSSL_STORE_LOADER_CTX *ctx)
1091 {
1092     return ctx->errcnt > 0;
1093 }
1094
1095 static int file_eof(OSSL_STORE_LOADER_CTX *ctx)
1096 {
1097     if (ctx->type == is_dir)
1098         return ctx->_.dir.end_reached;
1099
1100     if (ctx->_.file.last_handler != NULL
1101         && !ctx->_.file.last_handler->eof(ctx->_.file.last_handler_ctx))
1102         return 0;
1103     return BIO_eof(ctx->_.file.file);
1104 }
1105
1106 static int file_close(OSSL_STORE_LOADER_CTX *ctx)
1107 {
1108     if (ctx->type == is_dir) {
1109         OPENSSL_DIR_end(&ctx->_.dir.ctx);
1110     } else {
1111         BIO_free_all(ctx->_.file.file);
1112     }
1113     OSSL_STORE_LOADER_CTX_free(ctx);
1114     return 1;
1115 }
1116
1117 static OSSL_STORE_LOADER file_loader =
1118     {
1119         "file",
1120         NULL,
1121         file_open,
1122         NULL,
1123         file_load,
1124         file_eof,
1125         file_error,
1126         file_close
1127     };
1128
1129 static void store_file_loader_deinit(void)
1130 {
1131     ossl_store_unregister_loader_int(file_loader.scheme);
1132 }
1133
1134 int ossl_store_file_loader_init(void)
1135 {
1136     int ret = ossl_store_register_loader_int(&file_loader);
1137
1138     OPENSSL_atexit(store_file_loader_deinit);
1139     return ret;
1140 }