Coverage Report

Created: 2022-11-30 06:20

/src/openssl/crypto/bio/bss_file.c
Line
Count
Source (jump to first uncovered line)
1
/* crypto/bio/bss_file.c */
2
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3
 * All rights reserved.
4
 *
5
 * This package is an SSL implementation written
6
 * by Eric Young (eay@cryptsoft.com).
7
 * The implementation was written so as to conform with Netscapes SSL.
8
 *
9
 * This library is free for commercial and non-commercial use as long as
10
 * the following conditions are aheared to.  The following conditions
11
 * apply to all code found in this distribution, be it the RC4, RSA,
12
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13
 * included with this distribution is covered by the same copyright terms
14
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15
 *
16
 * Copyright remains Eric Young's, and as such any Copyright notices in
17
 * the code are not to be removed.
18
 * If this package is used in a product, Eric Young should be given attribution
19
 * as the author of the parts of the library used.
20
 * This can be in the form of a textual message at program startup or
21
 * in documentation (online or textual) provided with the package.
22
 *
23
 * Redistribution and use in source and binary forms, with or without
24
 * modification, are permitted provided that the following conditions
25
 * are met:
26
 * 1. Redistributions of source code must retain the copyright
27
 *    notice, this list of conditions and the following disclaimer.
28
 * 2. Redistributions in binary form must reproduce the above copyright
29
 *    notice, this list of conditions and the following disclaimer in the
30
 *    documentation and/or other materials provided with the distribution.
31
 * 3. All advertising materials mentioning features or use of this software
32
 *    must display the following acknowledgement:
33
 *    "This product includes cryptographic software written by
34
 *     Eric Young (eay@cryptsoft.com)"
35
 *    The word 'cryptographic' can be left out if the rouines from the library
36
 *    being used are not cryptographic related :-).
37
 * 4. If you include any Windows specific code (or a derivative thereof) from
38
 *    the apps directory (application code) you must include an acknowledgement:
39
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40
 *
41
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51
 * SUCH DAMAGE.
52
 *
53
 * The licence and distribution terms for any publically available version or
54
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
55
 * copied and put under another distribution licence
56
 * [including the GNU Public Licence.]
57
 */
58
59
/*-
60
 * 03-Dec-1997  rdenny@dc3.com  Fix bug preventing use of stdin/stdout
61
 *              with binary data (e.g. asn1parse -inform DER < xxx) under
62
 *              Windows
63
 */
64
65
#ifndef HEADER_BSS_FILE_C
66
# define HEADER_BSS_FILE_C
67
68
# if defined(__linux) || defined(__sun) || defined(__hpux)
69
/*
70
 * Following definition aliases fopen to fopen64 on above mentioned
71
 * platforms. This makes it possible to open and sequentially access files
72
 * larger than 2GB from 32-bit application. It does not allow to traverse
73
 * them beyond 2GB with fseek/ftell, but on the other hand *no* 32-bit
74
 * platform permits that, not with fseek/ftell. Not to mention that breaking
75
 * 2GB limit for seeking would require surgery to *our* API. But sequential
76
 * access suffices for practical cases when you can run into large files,
77
 * such as fingerprinting, so we can let API alone. For reference, the list
78
 * of 32-bit platforms which allow for sequential access of large files
79
 * without extra "magic" comprise *BSD, Darwin, IRIX...
80
 */
81
#  ifndef _FILE_OFFSET_BITS
82
#   define _FILE_OFFSET_BITS 64
83
#  endif
84
# endif
85
86
# include <stdio.h>
87
# include <errno.h>
88
# include "cryptlib.h"
89
# include "bio_lcl.h"
90
# include <openssl/err.h>
91
92
# if defined(OPENSSL_SYS_NETWARE) && defined(NETWARE_CLIB)
93
#  include <nwfileio.h>
94
# endif
95
96
# if !defined(OPENSSL_NO_STDIO)
97
98
static int MS_CALLBACK file_write(BIO *h, const char *buf, int num);
99
static int MS_CALLBACK file_read(BIO *h, char *buf, int size);
100
static int MS_CALLBACK file_puts(BIO *h, const char *str);
101
static int MS_CALLBACK file_gets(BIO *h, char *str, int size);
102
static long MS_CALLBACK file_ctrl(BIO *h, int cmd, long arg1, void *arg2);
103
static int MS_CALLBACK file_new(BIO *h);
104
static int MS_CALLBACK file_free(BIO *data);
105
static BIO_METHOD methods_filep = {
106
    BIO_TYPE_FILE,
107
    "FILE pointer",
108
    file_write,
109
    file_read,
110
    file_puts,
111
    file_gets,
112
    file_ctrl,
113
    file_new,
114
    file_free,
115
    NULL,
116
};
117
118
static FILE *file_fopen(const char *filename, const char *mode)
119
2.50k
{
120
2.50k
    FILE *file = NULL;
121
122
#  if defined(_WIN32) && defined(CP_UTF8)
123
    int sz, len_0 = (int)strlen(filename) + 1;
124
    DWORD flags;
125
126
    /*
127
     * Basically there are three cases to cover: a) filename is
128
     * pure ASCII string; b) actual UTF-8 encoded string and
129
     * c) locale-ized string, i.e. one containing 8-bit
130
     * characters that are meaningful in current system locale.
131
     * If filename is pure ASCII or real UTF-8 encoded string,
132
     * MultiByteToWideChar succeeds and _wfopen works. If
133
     * filename is locale-ized string, chances are that
134
     * MultiByteToWideChar fails reporting
135
     * ERROR_NO_UNICODE_TRANSLATION, in which case we fall
136
     * back to fopen...
137
     */
138
    if ((sz = MultiByteToWideChar(CP_UTF8, (flags = MB_ERR_INVALID_CHARS),
139
                                  filename, len_0, NULL, 0)) > 0 ||
140
        (GetLastError() == ERROR_INVALID_FLAGS &&
141
         (sz = MultiByteToWideChar(CP_UTF8, (flags = 0),
142
                                   filename, len_0, NULL, 0)) > 0)
143
        ) {
144
        WCHAR wmode[8];
145
        WCHAR *wfilename = _alloca(sz * sizeof(WCHAR));
146
147
        if (MultiByteToWideChar(CP_UTF8, flags,
148
                                filename, len_0, wfilename, sz) &&
149
            MultiByteToWideChar(CP_UTF8, 0, mode, strlen(mode) + 1,
150
                                wmode, sizeof(wmode) / sizeof(wmode[0])) &&
151
            (file = _wfopen(wfilename, wmode)) == NULL &&
152
            (errno == ENOENT || errno == EBADF)
153
            ) {
154
            /*
155
             * UTF-8 decode succeeded, but no file, filename
156
             * could still have been locale-ized...
157
             */
158
            file = fopen(filename, mode);
159
        }
160
    } else if (GetLastError() == ERROR_NO_UNICODE_TRANSLATION) {
161
        file = fopen(filename, mode);
162
    }
163
#  else
164
2.50k
    file = fopen(filename, mode);
165
2.50k
#  endif
166
2.50k
    return (file);
167
2.50k
}
168
169
BIO *BIO_new_file(const char *filename, const char *mode)
170
1.26k
{
171
1.26k
    BIO  *ret;
172
1.26k
    FILE *file = file_fopen(filename, mode);
173
174
1.26k
    if (file == NULL) {
175
19
        SYSerr(SYS_F_FOPEN, get_last_sys_error());
176
19
        ERR_add_error_data(5, "fopen('", filename, "','", mode, "')");
177
19
        if (errno == ENOENT
178
19
# ifdef ENXIO
179
19
            || errno == ENXIO
180
19
# endif
181
19
            )
182
19
            BIOerr(BIO_F_BIO_NEW_FILE, BIO_R_NO_SUCH_FILE);
183
0
        else
184
19
            BIOerr(BIO_F_BIO_NEW_FILE, ERR_R_SYS_LIB);
185
19
        return (NULL);
186
19
    }
187
1.24k
    if ((ret = BIO_new(BIO_s_file())) == NULL) {
188
0
        fclose(file);
189
0
        return (NULL);
190
0
    }
191
192
1.24k
    BIO_clear_flags(ret, BIO_FLAGS_UPLINK); /* we did fopen -> we disengage
193
                                             * UPLINK */
194
1.24k
    BIO_set_fp(ret, file, BIO_CLOSE);
195
1.24k
    return (ret);
196
1.24k
}
197
198
BIO *BIO_new_fp(FILE *stream, int close_flag)
199
0
{
200
0
    BIO *ret;
201
202
0
    if ((ret = BIO_new(BIO_s_file())) == NULL)
203
0
        return (NULL);
204
205
0
    BIO_set_flags(ret, BIO_FLAGS_UPLINK); /* redundant, left for
206
                                           * documentation puposes */
207
0
    BIO_set_fp(ret, stream, close_flag);
208
0
    return (ret);
209
0
}
210
211
BIO_METHOD *BIO_s_file(void)
212
2.48k
{
213
2.48k
    return (&methods_filep);
214
2.48k
}
215
216
static int MS_CALLBACK file_new(BIO *bi)
217
2.48k
{
218
2.48k
    bi->init = 0;
219
2.48k
    bi->num = 0;
220
2.48k
    bi->ptr = NULL;
221
2.48k
    bi->flags = BIO_FLAGS_UPLINK; /* default to UPLINK */
222
2.48k
    return (1);
223
2.48k
}
224
225
static int MS_CALLBACK file_free(BIO *a)
226
4.97k
{
227
4.97k
    if (a == NULL)
228
0
        return (0);
229
4.97k
    if (a->shutdown) {
230
4.97k
        if ((a->init) && (a->ptr != NULL)) {
231
2.48k
            if (a->flags & BIO_FLAGS_UPLINK)
232
0
                UP_fclose(a->ptr);
233
2.48k
            else
234
2.48k
                fclose(a->ptr);
235
2.48k
            a->ptr = NULL;
236
2.48k
            a->flags = BIO_FLAGS_UPLINK;
237
2.48k
        }
238
4.97k
        a->init = 0;
239
4.97k
    }
240
4.97k
    return (1);
241
4.97k
}
242
243
static int MS_CALLBACK file_read(BIO *b, char *out, int outl)
244
0
{
245
0
    int ret = 0;
246
247
0
    if (b->init && (out != NULL)) {
248
0
        if (b->flags & BIO_FLAGS_UPLINK)
249
0
            ret = UP_fread(out, 1, (int)outl, b->ptr);
250
0
        else
251
0
            ret = fread(out, 1, (int)outl, (FILE *)b->ptr);
252
0
        if (ret == 0
253
0
            && (b->flags & BIO_FLAGS_UPLINK) ? UP_ferror((FILE *)b->ptr) :
254
0
                                               ferror((FILE *)b->ptr)) {
255
0
            SYSerr(SYS_F_FREAD, get_last_sys_error());
256
0
            BIOerr(BIO_F_FILE_READ, ERR_R_SYS_LIB);
257
0
            ret = -1;
258
0
        }
259
0
    }
260
0
    return (ret);
261
0
}
262
263
static int MS_CALLBACK file_write(BIO *b, const char *in, int inl)
264
0
{
265
0
    int ret = 0;
266
267
0
    if (b->init && (in != NULL)) {
268
0
        if (b->flags & BIO_FLAGS_UPLINK)
269
0
            ret = UP_fwrite(in, (int)inl, 1, b->ptr);
270
0
        else
271
0
            ret = fwrite(in, (int)inl, 1, (FILE *)b->ptr);
272
0
        if (ret)
273
0
            ret = inl;
274
        /* ret=fwrite(in,1,(int)inl,(FILE *)b->ptr); */
275
        /*
276
         * according to Tim Hudson <tjh@cryptsoft.com>, the commented out
277
         * version above can cause 'inl' write calls under some stupid stdio
278
         * implementations (VMS)
279
         */
280
0
    }
281
0
    return (ret);
282
0
}
283
284
static long MS_CALLBACK file_ctrl(BIO *b, int cmd, long num, void *ptr)
285
2.48k
{
286
2.48k
    long ret = 1;
287
2.48k
    FILE *fp = (FILE *)b->ptr;
288
2.48k
    FILE **fpp;
289
2.48k
    char p[4];
290
2.48k
    int st;
291
292
2.48k
    switch (cmd) {
293
0
    case BIO_C_FILE_SEEK:
294
0
    case BIO_CTRL_RESET:
295
0
        if (b->flags & BIO_FLAGS_UPLINK)
296
0
            ret = (long)UP_fseek(b->ptr, num, 0);
297
0
        else
298
0
            ret = (long)fseek(fp, num, 0);
299
0
        break;
300
0
    case BIO_CTRL_EOF:
301
0
        if (b->flags & BIO_FLAGS_UPLINK)
302
0
            ret = (long)UP_feof(fp);
303
0
        else
304
0
            ret = (long)feof(fp);
305
0
        break;
306
0
    case BIO_C_FILE_TELL:
307
0
    case BIO_CTRL_INFO:
308
0
        if (b->flags & BIO_FLAGS_UPLINK)
309
0
            ret = UP_ftell(b->ptr);
310
0
        else
311
0
            ret = ftell(fp);
312
0
        break;
313
1.24k
    case BIO_C_SET_FILE_PTR:
314
1.24k
        file_free(b);
315
1.24k
        b->shutdown = (int)num & BIO_CLOSE;
316
1.24k
        b->ptr = ptr;
317
1.24k
        b->init = 1;
318
#  if BIO_FLAGS_UPLINK!=0
319
#   if defined(__MINGW32__) && defined(__MSVCRT__) && !defined(_IOB_ENTRIES)
320
#    define _IOB_ENTRIES 20
321
#   endif
322
        /* Safety net to catch purely internal BIO_set_fp calls */
323
#   if defined(_MSC_VER) && _MSC_VER>=1900
324
        if (ptr == stdin || ptr == stdout || ptr == stderr)
325
            BIO_clear_flags(b, BIO_FLAGS_UPLINK);
326
#   elif defined(_IOB_ENTRIES)
327
        if ((size_t)ptr >= (size_t)stdin &&
328
            (size_t)ptr < (size_t)(stdin + _IOB_ENTRIES))
329
            BIO_clear_flags(b, BIO_FLAGS_UPLINK);
330
#   endif
331
#  endif
332
#  ifdef UP_fsetmod
333
        if (b->flags & BIO_FLAGS_UPLINK)
334
            UP_fsetmod(b->ptr, (char)((num & BIO_FP_TEXT) ? 't' : 'b'));
335
        else
336
#  endif
337
1.24k
        {
338
#  if defined(OPENSSL_SYS_WINDOWS)
339
            int fd = _fileno((FILE *)ptr);
340
            if (num & BIO_FP_TEXT)
341
                _setmode(fd, _O_TEXT);
342
            else
343
                _setmode(fd, _O_BINARY);
344
#  elif defined(OPENSSL_SYS_NETWARE) && defined(NETWARE_CLIB)
345
            int fd = fileno((FILE *)ptr);
346
            /* Under CLib there are differences in file modes */
347
            if (num & BIO_FP_TEXT)
348
                setmode(fd, O_TEXT);
349
            else
350
                setmode(fd, O_BINARY);
351
#  elif defined(OPENSSL_SYS_MSDOS)
352
            int fd = fileno((FILE *)ptr);
353
            /* Set correct text/binary mode */
354
            if (num & BIO_FP_TEXT)
355
                _setmode(fd, _O_TEXT);
356
            /* Dangerous to set stdin/stdout to raw (unless redirected) */
357
            else {
358
                if (fd == STDIN_FILENO || fd == STDOUT_FILENO) {
359
                    if (isatty(fd) <= 0)
360
                        _setmode(fd, _O_BINARY);
361
                } else
362
                    _setmode(fd, _O_BINARY);
363
            }
364
#  elif defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_WIN32_CYGWIN)
365
            int fd = fileno((FILE *)ptr);
366
            if (num & BIO_FP_TEXT)
367
                setmode(fd, O_TEXT);
368
            else
369
                setmode(fd, O_BINARY);
370
#  endif
371
1.24k
        }
372
1.24k
        break;
373
1.24k
    case BIO_C_SET_FILENAME:
374
1.24k
        file_free(b);
375
1.24k
        b->shutdown = (int)num & BIO_CLOSE;
376
1.24k
        if (num & BIO_FP_APPEND) {
377
0
            if (num & BIO_FP_READ)
378
0
                BUF_strlcpy(p, "a+", sizeof p);
379
0
            else
380
0
                BUF_strlcpy(p, "a", sizeof p);
381
1.24k
        } else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
382
0
            BUF_strlcpy(p, "r+", sizeof p);
383
1.24k
        else if (num & BIO_FP_WRITE)
384
0
            BUF_strlcpy(p, "w", sizeof p);
385
1.24k
        else if (num & BIO_FP_READ)
386
1.24k
            BUF_strlcpy(p, "r", sizeof p);
387
0
        else {
388
0
            BIOerr(BIO_F_FILE_CTRL, BIO_R_BAD_FOPEN_MODE);
389
0
            ret = 0;
390
0
            break;
391
0
        }
392
#  if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_WIN32_CYGWIN)
393
        if (!(num & BIO_FP_TEXT))
394
            strcat(p, "b");
395
        else
396
            strcat(p, "t");
397
#  endif
398
#  if defined(OPENSSL_SYS_NETWARE)
399
        if (!(num & BIO_FP_TEXT))
400
            strcat(p, "b");
401
        else
402
            strcat(p, "t");
403
#  endif
404
1.24k
        fp = file_fopen(ptr, p);
405
1.24k
        if (fp == NULL) {
406
0
            SYSerr(SYS_F_FOPEN, get_last_sys_error());
407
0
            ERR_add_error_data(5, "fopen('", ptr, "','", p, "')");
408
0
            BIOerr(BIO_F_FILE_CTRL, ERR_R_SYS_LIB);
409
0
            ret = 0;
410
0
            break;
411
0
        }
412
1.24k
        b->ptr = fp;
413
1.24k
        b->init = 1;
414
1.24k
        BIO_clear_flags(b, BIO_FLAGS_UPLINK); /* we did fopen -> we disengage
415
                                               * UPLINK */
416
1.24k
        break;
417
0
    case BIO_C_GET_FILE_PTR:
418
        /* the ptr parameter is actually a FILE ** in this case. */
419
0
        if (ptr != NULL) {
420
0
            fpp = (FILE **)ptr;
421
0
            *fpp = (FILE *)b->ptr;
422
0
        }
423
0
        break;
424
0
    case BIO_CTRL_GET_CLOSE:
425
0
        ret = (long)b->shutdown;
426
0
        break;
427
0
    case BIO_CTRL_SET_CLOSE:
428
0
        b->shutdown = (int)num;
429
0
        break;
430
0
    case BIO_CTRL_FLUSH:
431
0
        st = b->flags & BIO_FLAGS_UPLINK
432
0
                ? UP_fflush(b->ptr) : fflush((FILE *)b->ptr);
433
0
        if (st == EOF) {
434
0
            SYSerr(SYS_F_FFLUSH, get_last_sys_error());
435
0
            ERR_add_error_data(1, "fflush()");
436
0
            BIOerr(BIO_F_FILE_CTRL, ERR_R_SYS_LIB);
437
0
            ret = 0;
438
0
        }
439
0
        break;
440
0
    case BIO_CTRL_DUP:
441
0
        ret = 1;
442
0
        break;
443
444
0
    case BIO_CTRL_WPENDING:
445
0
    case BIO_CTRL_PENDING:
446
0
    case BIO_CTRL_PUSH:
447
0
    case BIO_CTRL_POP:
448
0
    default:
449
0
        ret = 0;
450
0
        break;
451
2.48k
    }
452
2.48k
    return (ret);
453
2.48k
}
454
455
static int MS_CALLBACK file_gets(BIO *bp, char *buf, int size)
456
3.99M
{
457
3.99M
    int ret = 0;
458
459
3.99M
    buf[0] = '\0';
460
3.99M
    if (bp->flags & BIO_FLAGS_UPLINK) {
461
0
        if (!UP_fgets(buf, size, bp->ptr))
462
0
            goto err;
463
3.99M
    } else {
464
3.99M
        if (!fgets(buf, size, (FILE *)bp->ptr))
465
2.48k
            goto err;
466
3.99M
    }
467
3.99M
    if (buf[0] != '\0')
468
3.99M
        ret = strlen(buf);
469
3.99M
 err:
470
3.99M
    return (ret);
471
3.99M
}
472
473
static int MS_CALLBACK file_puts(BIO *bp, const char *str)
474
0
{
475
0
    int n, ret;
476
477
0
    n = strlen(str);
478
0
    ret = file_write(bp, str, n);
479
0
    return (ret);
480
0
}
481
482
# endif                         /* OPENSSL_NO_STDIO */
483
484
#endif                          /* HEADER_BSS_FILE_C */