Coverage Report

Created: 2026-03-17 07:14

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/crypto/bio/bss_file.c
Line
Count
Source
1
/*
2
 * Copyright 1995-2026 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
16
{
59
16
    BIO *ret;
60
16
    FILE *file = openssl_fopen(filename, mode);
61
16
    int fp_flags = BIO_CLOSE;
62
63
16
    if (strchr(mode, 'b') == NULL)
64
0
        fp_flags |= BIO_FP_TEXT;
65
66
16
    if (file == NULL) {
67
16
        ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),
68
16
            "calling fopen(%s, %s)",
69
16
            filename, mode);
70
16
        if (errno == ENOENT
71
0
#ifdef ENXIO
72
16
            || errno == ENXIO
73
16
#endif
74
16
        )
75
16
            ERR_raise(ERR_LIB_BIO, BIO_R_NO_SUCH_FILE);
76
0
        else
77
16
            ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);
78
16
        return NULL;
79
16
    }
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 != 0 && out != NULL && outl > 0) {
141
0
        if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)
142
0
            ret = (int)UP_fread(out, 1, outl, b->ptr);
143
0
        else
144
0
            ret = (int)fread(out, 1, outl, (FILE *)b->ptr);
145
0
        if (ret == 0
146
0
            && (b->flags & BIO_FLAGS_UPLINK_INTERNAL
147
0
                    ? UP_ferror((FILE *)b->ptr)
148
0
                    : ferror((FILE *)b->ptr))) {
149
0
            ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),
150
0
                "calling fread()");
151
0
            ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);
152
0
            ret = -1;
153
0
        }
154
0
    }
155
0
    return ret;
156
0
}
157
158
static int file_write(BIO *b, const char *in, int inl)
159
0
{
160
0
    int ret = 0;
161
162
0
    if (b->init && (in != NULL)) {
163
0
        if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)
164
0
            ret = (int)UP_fwrite(in, inl, 1, b->ptr);
165
0
        else
166
0
            ret = (int)fwrite(in, inl, 1, (FILE *)b->ptr);
167
0
        if (ret)
168
0
            ret = inl;
169
        /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */
170
        /*
171
         * according to Tim Hudson <tjh@openssl.org>, the commented out
172
         * version above can cause 'inl' write calls under some stupid stdio
173
         * implementations (VMS)
174
         */
175
0
    }
176
0
    return ret;
177
0
}
178
179
static long file_ctrl(BIO *b, int cmd, long num, void *ptr)
180
0
{
181
0
    long ret = 1;
182
0
    FILE *fp = (FILE *)b->ptr;
183
0
    FILE **fpp;
184
0
    char p[4];
185
0
    int st;
186
187
0
    switch (cmd) {
188
0
    case BIO_C_FILE_SEEK:
189
0
    case BIO_CTRL_RESET:
190
0
        if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)
191
0
            ret = (long)UP_fseek(b->ptr, num, 0);
192
0
        else
193
0
            ret = (long)fseek(fp, num, 0);
194
0
        break;
195
0
    case BIO_CTRL_EOF:
196
        /*
197
         * NOTE feof returns 0 if we're not in an eof condition
198
         * and a non-zero value if we are (i.e. any non-zero value
199
         * so we map the 0:non-0 return value here to 0:1 with a
200
         * double negation
201
         */
202
0
        if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)
203
0
            ret = !!(long)UP_feof(fp);
204
0
        else
205
0
            ret = !!(long)feof(fp);
206
#if defined(OPENSSL_SYS_WINDOWS)
207
        /*
208
         * Windows gives us an extra issue to contend with.
209
         * In windows feof may return 0 if it is passed an invalid
210
         * stream.  In this event, feof sets errno to EINVAL.
211
         * Check for that here, and set ret to -EINVAL if its the case.
212
         */
213
        if (ret == 0 && errno == EINVAL)
214
            ret = -EINVAL;
215
#endif
216
0
        break;
217
0
    case BIO_C_FILE_TELL:
218
0
    case BIO_CTRL_INFO:
219
0
        if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)
220
0
            ret = UP_ftell(b->ptr);
221
0
        else
222
0
            ret = ftell(fp);
223
0
        break;
224
0
    case BIO_C_SET_FILE_PTR:
225
0
        file_free(b);
226
0
        b->shutdown = (int)num & BIO_CLOSE;
227
0
        b->ptr = ptr;
228
0
        b->init = 1;
229
#if BIO_FLAGS_UPLINK_INTERNAL != 0
230
#if defined(__MINGW32__) && defined(__MSVCRT__) && !defined(_IOB_ENTRIES)
231
#define _IOB_ENTRIES 20
232
#endif
233
        /* Safety net to catch purely internal BIO_set_fp calls */
234
#if (defined(_MSC_VER) && _MSC_VER >= 1900) || defined(__BORLANDC__)
235
        if (ptr == stdin || ptr == stdout || ptr == stderr)
236
            BIO_clear_flags(b, BIO_FLAGS_UPLINK_INTERNAL);
237
#elif defined(_IOB_ENTRIES)
238
        if ((size_t)ptr >= (size_t)stdin && (size_t)ptr < (size_t)(stdin + _IOB_ENTRIES))
239
            BIO_clear_flags(b, BIO_FLAGS_UPLINK_INTERNAL);
240
#endif
241
#endif
242
#ifdef UP_fsetmod
243
        if (b->flags & BIO_FLAGS_UPLINK_INTERNAL)
244
            UP_fsetmod(b->ptr, (char)((num & BIO_FP_TEXT) ? 't' : 'b'));
245
        else
246
#endif
247
0
        {
248
#if defined(OPENSSL_SYS_WINDOWS)
249
            int fd = _fileno((FILE *)ptr);
250
            if (num & BIO_FP_TEXT)
251
                _setmode(fd, _O_TEXT);
252
            else
253
                _setmode(fd, _O_BINARY);
254
#elif defined(OPENSSL_SYS_MSDOS)
255
            int fd = fileno((FILE *)ptr);
256
            /* Set correct text/binary mode */
257
            if (num & BIO_FP_TEXT)
258
                _setmode(fd, _O_TEXT);
259
            /* Dangerous to set stdin/stdout to raw (unless redirected) */
260
            else {
261
                if (fd == STDIN_FILENO || fd == STDOUT_FILENO) {
262
                    if (isatty(fd) <= 0)
263
                        _setmode(fd, _O_BINARY);
264
                } else
265
                    _setmode(fd, _O_BINARY);
266
            }
267
#elif defined(OPENSSL_SYS_WIN32_CYGWIN)
268
            int fd = fileno((FILE *)ptr);
269
            if (!(num & BIO_FP_TEXT))
270
                setmode(fd, O_BINARY);
271
#endif
272
0
        }
273
0
        break;
274
0
    case BIO_C_SET_FILENAME:
275
0
        file_free(b);
276
0
        b->shutdown = (int)num & BIO_CLOSE;
277
0
        if (num & BIO_FP_APPEND) {
278
0
            if (num & BIO_FP_READ)
279
0
                OPENSSL_strlcpy(p, "a+", sizeof(p));
280
0
            else
281
0
                OPENSSL_strlcpy(p, "a", sizeof(p));
282
0
        } else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
283
0
            OPENSSL_strlcpy(p, "r+", sizeof(p));
284
0
        else if (num & BIO_FP_WRITE)
285
0
            OPENSSL_strlcpy(p, "w", sizeof(p));
286
0
        else if (num & BIO_FP_READ)
287
0
            OPENSSL_strlcpy(p, "r", sizeof(p));
288
0
        else {
289
0
            ERR_raise(ERR_LIB_BIO, BIO_R_BAD_FOPEN_MODE);
290
0
            ret = 0;
291
0
            break;
292
0
        }
293
#if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS)
294
        if (!(num & BIO_FP_TEXT))
295
            OPENSSL_strlcat(p, "b", sizeof(p));
296
        else
297
            OPENSSL_strlcat(p, "t", sizeof(p));
298
#elif defined(OPENSSL_SYS_WIN32_CYGWIN)
299
        if (!(num & BIO_FP_TEXT))
300
            OPENSSL_strlcat(p, "b", sizeof(p));
301
#endif
302
0
        fp = openssl_fopen(ptr, p);
303
0
        if (fp == NULL) {
304
0
            ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),
305
0
                "calling fopen(%s, %s)",
306
0
                (const char *)ptr, p);
307
0
            ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);
308
0
            ret = 0;
309
0
            break;
310
0
        }
311
0
        b->ptr = fp;
312
0
        b->init = 1;
313
        /* we did fopen -> we disengage UPLINK */
314
0
        BIO_clear_flags(b, BIO_FLAGS_UPLINK_INTERNAL);
315
0
        break;
316
0
    case BIO_C_GET_FILE_PTR:
317
        /* the ptr parameter is actually a FILE ** in this case. */
318
0
        if (ptr != NULL) {
319
0
            fpp = (FILE **)ptr;
320
0
            *fpp = (FILE *)b->ptr;
321
0
        }
322
0
        break;
323
0
    case BIO_CTRL_GET_CLOSE:
324
0
        ret = (long)b->shutdown;
325
0
        break;
326
0
    case BIO_CTRL_SET_CLOSE:
327
0
        b->shutdown = (int)num;
328
0
        break;
329
0
    case BIO_CTRL_FLUSH:
330
0
        st = b->flags & BIO_FLAGS_UPLINK_INTERNAL
331
0
            ? UP_fflush(b->ptr)
332
0
            : fflush((FILE *)b->ptr);
333
0
        if (st == EOF) {
334
0
            ERR_raise_data(ERR_LIB_SYS, get_last_sys_error(),
335
0
                "calling fflush()");
336
0
            ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);
337
0
            ret = 0;
338
0
        }
339
0
        break;
340
0
    case BIO_CTRL_DUP:
341
0
        ret = 1;
342
0
        break;
343
344
0
    case BIO_CTRL_WPENDING:
345
0
    case BIO_CTRL_PENDING:
346
0
    case BIO_CTRL_PUSH:
347
0
    case BIO_CTRL_POP:
348
0
    default:
349
0
        ret = 0;
350
0
        break;
351
0
    }
352
0
    return ret;
353
0
}
354
355
static int file_gets(BIO *bp, char *buf, int size)
356
0
{
357
0
    int ret = 0;
358
359
0
    buf[0] = '\0';
360
0
    if (bp->flags & BIO_FLAGS_UPLINK_INTERNAL) {
361
0
        if (!UP_fgets(buf, size, bp->ptr))
362
0
            goto err;
363
0
    } else {
364
0
        if (!fgets(buf, size, (FILE *)bp->ptr))
365
0
            goto err;
366
0
    }
367
0
    if (buf[0] != '\0')
368
0
        ret = (int)strlen(buf);
369
0
err:
370
0
    return ret;
371
0
}
372
373
static int file_puts(BIO *bp, const char *str)
374
0
{
375
0
    int ret;
376
0
    size_t n = strlen(str);
377
378
0
    if (n > INT_MAX)
379
0
        return -1;
380
0
    ret = file_write(bp, str, (int)n);
381
0
    return ret;
382
0
}
383
384
#else
385
386
static int file_write(BIO *b, const char *in, int inl)
387
{
388
    return -1;
389
}
390
static int file_read(BIO *b, char *out, int outl)
391
{
392
    return -1;
393
}
394
static int file_puts(BIO *bp, const char *str)
395
{
396
    return -1;
397
}
398
static int file_gets(BIO *bp, char *buf, int size)
399
{
400
    return 0;
401
}
402
static long file_ctrl(BIO *b, int cmd, long num, void *ptr)
403
{
404
    return 0;
405
}
406
static int file_new(BIO *bi)
407
{
408
    return 0;
409
}
410
static int file_free(BIO *a)
411
{
412
    return 0;
413
}
414
415
static const BIO_METHOD methods_filep = {
416
    BIO_TYPE_FILE,
417
    "FILE pointer",
418
    bwrite_conv,
419
    file_write,
420
    bread_conv,
421
    file_read,
422
    file_puts,
423
    file_gets,
424
    file_ctrl,
425
    file_new,
426
    file_free,
427
    NULL, /* file_callback_ctrl */
428
};
429
430
const BIO_METHOD *BIO_s_file(void)
431
{
432
    return &methods_filep;
433
}
434
435
BIO *BIO_new_file(const char *filename, const char *mode)
436
{
437
    return NULL;
438
}
439
440
#endif /* OPENSSL_NO_STDIO */