/src/openssl/crypto/bio/bss_file.c
Line  | Count  | Source (jump to first uncovered line)  | 
1  |  | /*  | 
2  |  |  * Copyright 1995-2025 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  |  | #if defined(__linux) || defined(__sun) || defined(__hpux)  | 
11  |  | /*  | 
12  |  |  * Following definition aliases fopen to fopen64 on above mentioned  | 
13  |  |  * platforms. This makes it possible to open and sequentially access files  | 
14  |  |  * larger than 2GB from 32-bit application. It does not allow one to traverse  | 
15  |  |  * them beyond 2GB with fseek/ftell, but on the other hand *no* 32-bit  | 
16  |  |  * platform permits that, not with fseek/ftell. Not to mention that breaking  | 
17  |  |  * 2GB limit for seeking would require surgery to *our* API. But sequential  | 
18  |  |  * access suffices for practical cases when you can run into large files,  | 
19  |  |  * such as fingerprinting, so we can let API alone. For reference, the list  | 
20  |  |  * of 32-bit platforms which allow for sequential access of large files  | 
21  |  |  * without extra "magic" comprise *BSD, Darwin, IRIX...  | 
22  |  |  */  | 
23  |  | # ifndef _FILE_OFFSET_BITS  | 
24  |  | #  define _FILE_OFFSET_BITS 64  | 
25  |  | # endif  | 
26  |  | #endif  | 
27  |  |  | 
28  |  | #include <stdio.h>  | 
29  |  | #include <errno.h>  | 
30  |  | #include "bio_local.h"  | 
31  |  | #include <openssl/err.h>  | 
32  |  |  | 
33  |  | #if !defined(OPENSSL_NO_STDIO)  | 
34  |  |  | 
35  |  | static int file_write(BIO *h, const char *buf, int num);  | 
36  |  | static int file_read(BIO *h, char *buf, int size);  | 
37  |  | static int file_puts(BIO *h, const char *str);  | 
38  |  | static int file_gets(BIO *h, char *str, int size);  | 
39  |  | static long file_ctrl(BIO *h, int cmd, long arg1, void *arg2);  | 
40  |  | static int file_new(BIO *h);  | 
41  |  | static int file_free(BIO *data);  | 
42  |  | static const BIO_METHOD methods_filep = { | 
43  |  |     BIO_TYPE_FILE,  | 
44  |  |     "FILE pointer",  | 
45  |  |     bwrite_conv,  | 
46  |  |     file_write,  | 
47  |  |     bread_conv,  | 
48  |  |     file_read,  | 
49  |  |     file_puts,  | 
50  |  |     file_gets,  | 
51  |  |     file_ctrl,  | 
52  |  |     file_new,  | 
53  |  |     file_free,  | 
54  |  |     NULL,                      /* file_callback_ctrl */  | 
55  |  | };  | 
56  |  |  | 
57  |  | BIO *BIO_new_file(const char *filename, const char *mode)  | 
58  | 2  | { | 
59  | 2  |     BIO  *ret;  | 
60  | 2  |     FILE *file = openssl_fopen(filename, mode);  | 
61  | 2  |     int fp_flags = BIO_CLOSE;  | 
62  |  |  | 
63  | 2  |     if (strchr(mode, 'b') == NULL)  | 
64  | 0  |         fp_flags |= BIO_FP_TEXT;  | 
65  |  |  | 
66  | 2  |     if (file == NULL) { | 
67  | 2  |         ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),  | 
68  | 2  |                        "calling fopen(%s, %s)",  | 
69  | 2  |                        filename, mode);  | 
70  | 2  |         if (errno == ENOENT  | 
71  | 2  | #ifdef ENXIO  | 
72  | 2  |             || errno == ENXIO  | 
73  | 2  | #endif  | 
74  | 2  |             )  | 
75  | 2  |             ERR_raise(ERR_LIB_BIO, BIO_R_NO_SUCH_FILE);  | 
76  | 0  |         else  | 
77  | 2  |             ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);  | 
78  | 2  |         return NULL;  | 
79  | 2  |     }  | 
80  | 0  |     if ((ret = BIO_new(BIO_s_file())) == NULL) { | 
81  | 0  |         fclose(file);  | 
82  | 0  |         return NULL;  | 
83  | 0  |     }  | 
84  |  |  | 
85  |  |     /* we did fopen -> we disengage UPLINK */  | 
86  | 0  |     BIO_clear_flags(ret, BIO_FLAGS_UPLINK_INTERNAL);  | 
87  | 0  |     BIO_set_fp(ret, file, fp_flags);  | 
88  | 0  |     return ret;  | 
89  | 0  | }  | 
90  |  |  | 
91  |  | BIO *BIO_new_fp(FILE *stream, int close_flag)  | 
92  | 0  | { | 
93  | 0  |     BIO *ret;  | 
94  |  | 
  | 
95  | 0  |     if ((ret = BIO_new(BIO_s_file())) == NULL)  | 
96  | 0  |         return NULL;  | 
97  |  |  | 
98  |  |     /* redundant flag, left for documentation purposes */  | 
99  | 0  |     BIO_set_flags(ret, BIO_FLAGS_UPLINK_INTERNAL);  | 
100  | 0  |     BIO_set_fp(ret, stream, close_flag);  | 
101  | 0  |     return ret;  | 
102  | 0  | }  | 
103  |  |  | 
104  |  | const BIO_METHOD *BIO_s_file(void)  | 
105  | 0  | { | 
106  | 0  |     return &methods_filep;  | 
107  | 0  | }  | 
108  |  |  | 
109  |  | static int file_new(BIO *bi)  | 
110  | 0  | { | 
111  | 0  |     bi->init = 0;  | 
112  | 0  |     bi->num = 0;  | 
113  | 0  |     bi->ptr = NULL;  | 
114  | 0  |     bi->flags = BIO_FLAGS_UPLINK_INTERNAL; /* default to UPLINK */  | 
115  | 0  |     return 1;  | 
116  | 0  | }  | 
117  |  |  | 
118  |  | static int file_free(BIO *a)  | 
119  | 0  | { | 
120  | 0  |     if (a == NULL)  | 
121  | 0  |         return 0;  | 
122  | 0  |     if (a->shutdown) { | 
123  | 0  |         if ((a->init) && (a->ptr != NULL)) { | 
124  | 0  |             if (a->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
125  | 0  |                 UP_fclose(a->ptr);  | 
126  | 0  |             else  | 
127  | 0  |                 fclose(a->ptr);  | 
128  | 0  |             a->ptr = NULL;  | 
129  | 0  |             a->flags = BIO_FLAGS_UPLINK_INTERNAL;  | 
130  | 0  |         }  | 
131  | 0  |         a->init = 0;  | 
132  | 0  |     }  | 
133  | 0  |     return 1;  | 
134  | 0  | }  | 
135  |  |  | 
136  |  | static int file_read(BIO *b, char *out, int outl)  | 
137  | 0  | { | 
138  | 0  |     int ret = 0;  | 
139  |  | 
  | 
140  | 0  |     if (b->init && (out != NULL)) { | 
141  | 0  |         if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
142  | 0  |             ret = UP_fread(out, 1, (int)outl, b->ptr);  | 
143  | 0  |         else  | 
144  | 0  |             ret = fread(out, 1, (int)outl, (FILE *)b->ptr);  | 
145  | 0  |         if (ret == 0  | 
146  | 0  |             && (b->flags & BIO_FLAGS_UPLINK_INTERNAL  | 
147  | 0  |                 ? UP_ferror((FILE *)b->ptr) : ferror((FILE *)b->ptr))) { | 
148  | 0  |             ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),  | 
149  | 0  |                            "calling fread()");  | 
150  | 0  |             ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);  | 
151  | 0  |             ret = -1;  | 
152  | 0  |         }  | 
153  | 0  |     }  | 
154  | 0  |     return ret;  | 
155  | 0  | }  | 
156  |  |  | 
157  |  | static int file_write(BIO *b, const char *in, int inl)  | 
158  | 0  | { | 
159  | 0  |     int ret = 0;  | 
160  |  | 
  | 
161  | 0  |     if (b->init && (in != NULL)) { | 
162  | 0  |         if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
163  | 0  |             ret = UP_fwrite(in, (int)inl, 1, b->ptr);  | 
164  | 0  |         else  | 
165  | 0  |             ret = fwrite(in, (int)inl, 1, (FILE *)b->ptr);  | 
166  | 0  |         if (ret)  | 
167  | 0  |             ret = inl;  | 
168  |  |         /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */  | 
169  |  |         /*  | 
170  |  |          * according to Tim Hudson <tjh@openssl.org>, the commented out  | 
171  |  |          * version above can cause 'inl' write calls under some stupid stdio  | 
172  |  |          * implementations (VMS)  | 
173  |  |          */  | 
174  | 0  |     }  | 
175  | 0  |     return ret;  | 
176  | 0  | }  | 
177  |  |  | 
178  |  | static long file_ctrl(BIO *b, int cmd, long num, void *ptr)  | 
179  | 0  | { | 
180  | 0  |     long ret = 1;  | 
181  | 0  |     FILE *fp = (FILE *)b->ptr;  | 
182  | 0  |     FILE **fpp;  | 
183  | 0  |     char p[4];  | 
184  | 0  |     int st;  | 
185  |  | 
  | 
186  | 0  |     switch (cmd) { | 
187  | 0  |     case BIO_C_FILE_SEEK:  | 
188  | 0  |     case BIO_CTRL_RESET:  | 
189  | 0  |         if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
190  | 0  |             ret = (long)UP_fseek(b->ptr, num, 0);  | 
191  | 0  |         else  | 
192  | 0  |             ret = (long)fseek(fp, num, 0);  | 
193  | 0  |         break;  | 
194  | 0  |     case BIO_CTRL_EOF:  | 
195  | 0  |         if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
196  | 0  |             ret = (long)UP_feof(fp);  | 
197  | 0  |         else  | 
198  | 0  |             ret = (long)feof(fp);  | 
199  | 0  |         break;  | 
200  | 0  |     case BIO_C_FILE_TELL:  | 
201  | 0  |     case BIO_CTRL_INFO:  | 
202  | 0  |         if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
203  | 0  |             ret = UP_ftell(b->ptr);  | 
204  | 0  |         else  | 
205  | 0  |             ret = ftell(fp);  | 
206  | 0  |         break;  | 
207  | 0  |     case BIO_C_SET_FILE_PTR:  | 
208  | 0  |         file_free(b);  | 
209  | 0  |         b->shutdown = (int)num & BIO_CLOSE;  | 
210  | 0  |         b->ptr = ptr;  | 
211  | 0  |         b->init = 1;  | 
212  |  | # if BIO_FLAGS_UPLINK_INTERNAL!=0  | 
213  |  | #  if defined(__MINGW32__) && defined(__MSVCRT__) && !defined(_IOB_ENTRIES)  | 
214  |  | #   define _IOB_ENTRIES 20  | 
215  |  | #  endif  | 
216  |  |         /* Safety net to catch purely internal BIO_set_fp calls */  | 
217  |  | #  if (defined(_MSC_VER) && _MSC_VER>=1900) || defined(__BORLANDC__)  | 
218  |  |         if (ptr == stdin || ptr == stdout || ptr == stderr)  | 
219  |  |             BIO_clear_flags(b, BIO_FLAGS_UPLINK_INTERNAL);  | 
220  |  | #  elif defined(_IOB_ENTRIES)  | 
221  |  |         if ((size_t)ptr >= (size_t)stdin &&  | 
222  |  |             (size_t)ptr < (size_t)(stdin + _IOB_ENTRIES))  | 
223  |  |             BIO_clear_flags(b, BIO_FLAGS_UPLINK_INTERNAL);  | 
224  |  | #  endif  | 
225  |  | # endif  | 
226  |  | # ifdef UP_fsetmod  | 
227  |  |         if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)  | 
228  |  |             UP_fsetmod(b->ptr, (char)((num & BIO_FP_TEXT) ? 't' : 'b'));  | 
229  |  |         else  | 
230  |  | # endif  | 
231  | 0  |         { | 
232  |  | # if defined(OPENSSL_SYS_WINDOWS)  | 
233  |  |             int fd = _fileno((FILE *)ptr);  | 
234  |  |             if (num & BIO_FP_TEXT)  | 
235  |  |                 _setmode(fd, _O_TEXT);  | 
236  |  |             else  | 
237  |  |                 _setmode(fd, _O_BINARY);  | 
238  |  | # elif defined(OPENSSL_SYS_MSDOS)  | 
239  |  |             int fd = fileno((FILE *)ptr);  | 
240  |  |             /* Set correct text/binary mode */  | 
241  |  |             if (num & BIO_FP_TEXT)  | 
242  |  |                 _setmode(fd, _O_TEXT);  | 
243  |  |             /* Dangerous to set stdin/stdout to raw (unless redirected) */  | 
244  |  |             else { | 
245  |  |                 if (fd == STDIN_FILENO || fd == STDOUT_FILENO) { | 
246  |  |                     if (isatty(fd) <= 0)  | 
247  |  |                         _setmode(fd, _O_BINARY);  | 
248  |  |                 } else  | 
249  |  |                     _setmode(fd, _O_BINARY);  | 
250  |  |             }  | 
251  |  | # elif defined(OPENSSL_SYS_WIN32_CYGWIN)  | 
252  |  |             int fd = fileno((FILE *)ptr);  | 
253  |  |             if (!(num & BIO_FP_TEXT))  | 
254  |  |                 setmode(fd, O_BINARY);  | 
255  |  | # endif  | 
256  | 0  |         }  | 
257  | 0  |         break;  | 
258  | 0  |     case BIO_C_SET_FILENAME:  | 
259  | 0  |         file_free(b);  | 
260  | 0  |         b->shutdown = (int)num & BIO_CLOSE;  | 
261  | 0  |         if (num & BIO_FP_APPEND) { | 
262  | 0  |             if (num & BIO_FP_READ)  | 
263  | 0  |                 OPENSSL_strlcpy(p, "a+", sizeof(p));  | 
264  | 0  |             else  | 
265  | 0  |                 OPENSSL_strlcpy(p, "a", sizeof(p));  | 
266  | 0  |         } else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))  | 
267  | 0  |             OPENSSL_strlcpy(p, "r+", sizeof(p));  | 
268  | 0  |         else if (num & BIO_FP_WRITE)  | 
269  | 0  |             OPENSSL_strlcpy(p, "w", sizeof(p));  | 
270  | 0  |         else if (num & BIO_FP_READ)  | 
271  | 0  |             OPENSSL_strlcpy(p, "r", sizeof(p));  | 
272  | 0  |         else { | 
273  | 0  |             ERR_raise(ERR_LIB_BIO, BIO_R_BAD_FOPEN_MODE);  | 
274  | 0  |             ret = 0;  | 
275  | 0  |             break;  | 
276  | 0  |         }  | 
277  |  | # if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS)  | 
278  |  |         if (!(num & BIO_FP_TEXT))  | 
279  |  |             OPENSSL_strlcat(p, "b", sizeof(p));  | 
280  |  |         else  | 
281  |  |             OPENSSL_strlcat(p, "t", sizeof(p));  | 
282  |  | # elif defined(OPENSSL_SYS_WIN32_CYGWIN)  | 
283  |  |         if (!(num & BIO_FP_TEXT))  | 
284  |  |             OPENSSL_strlcat(p, "b", sizeof(p));  | 
285  |  | # endif  | 
286  | 0  |         fp = openssl_fopen(ptr, p);  | 
287  | 0  |         if (fp == NULL) { | 
288  | 0  |             ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),  | 
289  | 0  |                            "calling fopen(%s, %s)",  | 
290  | 0  |                            ptr, p);  | 
291  | 0  |             ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);  | 
292  | 0  |             ret = 0;  | 
293  | 0  |             break;  | 
294  | 0  |         }  | 
295  | 0  |         b->ptr = fp;  | 
296  | 0  |         b->init = 1;  | 
297  |  |         /* we did fopen -> we disengage UPLINK */  | 
298  | 0  |         BIO_clear_flags(b, BIO_FLAGS_UPLINK_INTERNAL);  | 
299  | 0  |         break;  | 
300  | 0  |     case BIO_C_GET_FILE_PTR:  | 
301  |  |         /* the ptr parameter is actually a FILE ** in this case. */  | 
302  | 0  |         if (ptr != NULL) { | 
303  | 0  |             fpp = (FILE **)ptr;  | 
304  | 0  |             *fpp = (FILE *)b->ptr;  | 
305  | 0  |         }  | 
306  | 0  |         break;  | 
307  | 0  |     case BIO_CTRL_GET_CLOSE:  | 
308  | 0  |         ret = (long)b->shutdown;  | 
309  | 0  |         break;  | 
310  | 0  |     case BIO_CTRL_SET_CLOSE:  | 
311  | 0  |         b->shutdown = (int)num;  | 
312  | 0  |         break;  | 
313  | 0  |     case BIO_CTRL_FLUSH:  | 
314  | 0  |         st = b->flags & BIO_FLAGS_UPLINK_INTERNAL  | 
315  | 0  |                 ? UP_fflush(b->ptr) : fflush((FILE *)b->ptr);  | 
316  | 0  |         if (st == EOF) { | 
317  | 0  |             ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),  | 
318  | 0  |                            "calling fflush()");  | 
319  | 0  |             ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);  | 
320  | 0  |             ret = 0;  | 
321  | 0  |         }  | 
322  | 0  |         break;  | 
323  | 0  |     case BIO_CTRL_DUP:  | 
324  | 0  |         ret = 1;  | 
325  | 0  |         break;  | 
326  |  |  | 
327  | 0  |     case BIO_CTRL_WPENDING:  | 
328  | 0  |     case BIO_CTRL_PENDING:  | 
329  | 0  |     case BIO_CTRL_PUSH:  | 
330  | 0  |     case BIO_CTRL_POP:  | 
331  | 0  |     default:  | 
332  | 0  |         ret = 0;  | 
333  | 0  |         break;  | 
334  | 0  |     }  | 
335  | 0  |     return ret;  | 
336  | 0  | }  | 
337  |  |  | 
338  |  | static int file_gets(BIO *bp, char *buf, int size)  | 
339  | 0  | { | 
340  | 0  |     int ret = 0;  | 
341  |  | 
  | 
342  | 0  |     buf[0] = '\0';  | 
343  | 0  |     if (bp->flags & BIO_FLAGS_UPLINK_INTERNAL) { | 
344  | 0  |         if (!UP_fgets(buf, size, bp->ptr))  | 
345  | 0  |             goto err;  | 
346  | 0  |     } else { | 
347  | 0  |         if (!fgets(buf, size, (FILE *)bp->ptr))  | 
348  | 0  |             goto err;  | 
349  | 0  |     }  | 
350  | 0  |     if (buf[0] != '\0')  | 
351  | 0  |         ret = strlen(buf);  | 
352  | 0  |  err:  | 
353  | 0  |     return ret;  | 
354  | 0  | }  | 
355  |  |  | 
356  |  | static int file_puts(BIO *bp, const char *str)  | 
357  | 0  | { | 
358  | 0  |     int n, ret;  | 
359  |  | 
  | 
360  | 0  |     n = strlen(str);  | 
361  | 0  |     ret = file_write(bp, str, n);  | 
362  | 0  |     return ret;  | 
363  | 0  | }  | 
364  |  |  | 
365  |  | #else  | 
366  |  |  | 
367  |  | static int file_write(BIO *b, const char *in, int inl)  | 
368  |  | { | 
369  |  |     return -1;  | 
370  |  | }  | 
371  |  | static int file_read(BIO *b, char *out, int outl)  | 
372  |  | { | 
373  |  |     return -1;  | 
374  |  | }  | 
375  |  | static int file_puts(BIO *bp, const char *str)  | 
376  |  | { | 
377  |  |     return -1;  | 
378  |  | }  | 
379  |  | static int file_gets(BIO *bp, char *buf, int size)  | 
380  |  | { | 
381  |  |     return 0;  | 
382  |  | }  | 
383  |  | static long file_ctrl(BIO *b, int cmd, long num, void *ptr)  | 
384  |  | { | 
385  |  |     return 0;  | 
386  |  | }  | 
387  |  | static int file_new(BIO *bi)  | 
388  |  | { | 
389  |  |     return 0;  | 
390  |  | }  | 
391  |  | static int file_free(BIO *a)  | 
392  |  | { | 
393  |  |     return 0;  | 
394  |  | }  | 
395  |  |  | 
396  |  | static const BIO_METHOD methods_filep = { | 
397  |  |     BIO_TYPE_FILE,  | 
398  |  |     "FILE pointer",  | 
399  |  |     bwrite_conv,  | 
400  |  |     file_write,  | 
401  |  |     bread_conv,  | 
402  |  |     file_read,  | 
403  |  |     file_puts,  | 
404  |  |     file_gets,  | 
405  |  |     file_ctrl,  | 
406  |  |     file_new,  | 
407  |  |     file_free,  | 
408  |  |     NULL,                      /* file_callback_ctrl */  | 
409  |  | };  | 
410  |  |  | 
411  |  | const BIO_METHOD *BIO_s_file(void)  | 
412  |  | { | 
413  |  |     return &methods_filep;  | 
414  |  | }  | 
415  |  |  | 
416  |  | BIO *BIO_new_file(const char *filename, const char *mode)  | 
417  |  | { | 
418  |  |     return NULL;  | 
419  |  | }  | 
420  |  |  | 
421  |  | #endif                         /* OPENSSL_NO_STDIO */  |