Coverage Report

Created: 2023-06-07 07:11

/src/boringssl/crypto/bio/file.c
Line
Count
Source (jump to first uncovered line)
1
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2
 * All rights reserved.
3
 *
4
 * This package is an SSL implementation written
5
 * by Eric Young (eay@cryptsoft.com).
6
 * The implementation was written so as to conform with Netscapes SSL.
7
 *
8
 * This library is free for commercial and non-commercial use as long as
9
 * the following conditions are aheared to.  The following conditions
10
 * apply to all code found in this distribution, be it the RC4, RSA,
11
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12
 * included with this distribution is covered by the same copyright terms
13
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14
 *
15
 * Copyright remains Eric Young's, and as such any Copyright notices in
16
 * the code are not to be removed.
17
 * If this package is used in a product, Eric Young should be given attribution
18
 * as the author of the parts of the library used.
19
 * This can be in the form of a textual message at program startup or
20
 * in documentation (online or textual) provided with the package.
21
 *
22
 * Redistribution and use in source and binary forms, with or without
23
 * modification, are permitted provided that the following conditions
24
 * are met:
25
 * 1. Redistributions of source code must retain the copyright
26
 *    notice, this list of conditions and the following disclaimer.
27
 * 2. Redistributions in binary form must reproduce the above copyright
28
 *    notice, this list of conditions and the following disclaimer in the
29
 *    documentation and/or other materials provided with the distribution.
30
 * 3. All advertising materials mentioning features or use of this software
31
 *    must display the following acknowledgement:
32
 *    "This product includes cryptographic software written by
33
 *     Eric Young (eay@cryptsoft.com)"
34
 *    The word 'cryptographic' can be left out if the rouines from the library
35
 *    being used are not cryptographic related :-).
36
 * 4. If you include any Windows specific code (or a derivative thereof) from
37
 *    the apps directory (application code) you must include an acknowledgement:
38
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39
 *
40
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50
 * SUCH DAMAGE.
51
 *
52
 * The licence and distribution terms for any publically available version or
53
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
54
 * copied and put under another distribution licence
55
 * [including the GNU Public Licence.] */
56
57
#if defined(__linux) || defined(__sun) || defined(__hpux)
58
// Following definition aliases fopen to fopen64 on above mentioned
59
// platforms. This makes it possible to open and sequentially access
60
// files larger than 2GB from 32-bit application. It does not allow to
61
// traverse them beyond 2GB with fseek/ftell, but on the other hand *no*
62
// 32-bit platform permits that, not with fseek/ftell. Not to mention
63
// that breaking 2GB limit for seeking would require surgery to *our*
64
// API. But sequential access suffices for practical cases when you
65
// can run into large files, such as fingerprinting, so we can let API
66
// alone. For reference, the list of 32-bit platforms which allow for
67
// sequential access of large files without extra "magic" comprise *BSD,
68
// Darwin, IRIX...
69
#ifndef _FILE_OFFSET_BITS
70
#define _FILE_OFFSET_BITS 64
71
#endif
72
#endif
73
74
#include <openssl/bio.h>
75
76
#if !defined(OPENSSL_TRUSTY)
77
78
#include <errno.h>
79
#include <stdio.h>
80
#include <string.h>
81
82
#include <openssl/err.h>
83
#include <openssl/mem.h>
84
85
#include "../internal.h"
86
87
88
0
#define BIO_FP_READ 0x02
89
0
#define BIO_FP_WRITE 0x04
90
0
#define BIO_FP_APPEND 0x08
91
92
0
BIO *BIO_new_file(const char *filename, const char *mode) {
93
0
  BIO *ret;
94
0
  FILE *file;
95
96
0
  file = fopen(filename, mode);
97
0
  if (file == NULL) {
98
0
    OPENSSL_PUT_SYSTEM_ERROR();
99
100
0
    ERR_add_error_data(5, "fopen('", filename, "','", mode, "')");
101
0
    if (errno == ENOENT) {
102
0
      OPENSSL_PUT_ERROR(BIO, BIO_R_NO_SUCH_FILE);
103
0
    } else {
104
0
      OPENSSL_PUT_ERROR(BIO, BIO_R_SYS_LIB);
105
0
    }
106
0
    return NULL;
107
0
  }
108
109
0
  ret = BIO_new_fp(file, BIO_CLOSE);
110
0
  if (ret == NULL) {
111
0
    fclose(file);
112
0
    return NULL;
113
0
  }
114
115
0
  return ret;
116
0
}
117
118
0
BIO *BIO_new_fp(FILE *stream, int close_flag) {
119
0
  BIO *ret = BIO_new(BIO_s_file());
120
121
0
  if (ret == NULL) {
122
0
    return NULL;
123
0
  }
124
125
0
  BIO_set_fp(ret, stream, close_flag);
126
0
  return ret;
127
0
}
128
129
0
static int file_free(BIO *bio) {
130
0
  if (!bio->shutdown) {
131
0
    return 1;
132
0
  }
133
134
0
  if (bio->init && bio->ptr != NULL) {
135
0
    fclose(bio->ptr);
136
0
    bio->ptr = NULL;
137
0
  }
138
0
  bio->init = 0;
139
140
0
  return 1;
141
0
}
142
143
0
static int file_read(BIO *b, char *out, int outl) {
144
0
  if (!b->init) {
145
0
    return 0;
146
0
  }
147
148
0
  size_t ret = fread(out, 1, outl, (FILE *)b->ptr);
149
0
  if (ret == 0 && ferror((FILE *)b->ptr)) {
150
0
    OPENSSL_PUT_SYSTEM_ERROR();
151
0
    OPENSSL_PUT_ERROR(BIO, ERR_R_SYS_LIB);
152
0
    return -1;
153
0
  }
154
155
  // fread reads at most |outl| bytes, so |ret| fits in an int.
156
0
  return (int)ret;
157
0
}
158
159
0
static int file_write(BIO *b, const char *in, int inl) {
160
0
  if (!b->init) {
161
0
    return 0;
162
0
  }
163
164
0
  int ret = (int)fwrite(in, inl, 1, (FILE *)b->ptr);
165
0
  if (ret > 0) {
166
0
    ret = inl;
167
0
  }
168
0
  return ret;
169
0
}
170
171
0
static long file_ctrl(BIO *b, int cmd, long num, void *ptr) {
172
0
  long ret = 1;
173
0
  FILE *fp = (FILE *)b->ptr;
174
0
  FILE **fpp;
175
0
  char p[4];
176
177
0
  switch (cmd) {
178
0
    case BIO_CTRL_RESET:
179
0
      num = 0;
180
0
      OPENSSL_FALLTHROUGH;
181
0
    case BIO_C_FILE_SEEK:
182
0
      ret = (long)fseek(fp, num, 0);
183
0
      break;
184
0
    case BIO_CTRL_EOF:
185
0
      ret = (long)feof(fp);
186
0
      break;
187
0
    case BIO_C_FILE_TELL:
188
0
    case BIO_CTRL_INFO:
189
0
      ret = ftell(fp);
190
0
      break;
191
0
    case BIO_C_SET_FILE_PTR:
192
0
      file_free(b);
193
0
      b->shutdown = (int)num & BIO_CLOSE;
194
0
      b->ptr = ptr;
195
0
      b->init = 1;
196
0
      break;
197
0
    case BIO_C_SET_FILENAME:
198
0
      file_free(b);
199
0
      b->shutdown = (int)num & BIO_CLOSE;
200
0
      if (num & BIO_FP_APPEND) {
201
0
        if (num & BIO_FP_READ) {
202
0
          OPENSSL_strlcpy(p, "a+", sizeof(p));
203
0
        } else {
204
0
          OPENSSL_strlcpy(p, "a", sizeof(p));
205
0
        }
206
0
      } else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE)) {
207
0
        OPENSSL_strlcpy(p, "r+", sizeof(p));
208
0
      } else if (num & BIO_FP_WRITE) {
209
0
        OPENSSL_strlcpy(p, "w", sizeof(p));
210
0
      } else if (num & BIO_FP_READ) {
211
0
        OPENSSL_strlcpy(p, "r", sizeof(p));
212
0
      } else {
213
0
        OPENSSL_PUT_ERROR(BIO, BIO_R_BAD_FOPEN_MODE);
214
0
        ret = 0;
215
0
        break;
216
0
      }
217
0
      fp = fopen(ptr, p);
218
0
      if (fp == NULL) {
219
0
        OPENSSL_PUT_SYSTEM_ERROR();
220
0
        ERR_add_error_data(5, "fopen('", ptr, "','", p, "')");
221
0
        OPENSSL_PUT_ERROR(BIO, ERR_R_SYS_LIB);
222
0
        ret = 0;
223
0
        break;
224
0
      }
225
0
      b->ptr = fp;
226
0
      b->init = 1;
227
0
      break;
228
0
    case BIO_C_GET_FILE_PTR:
229
      // the ptr parameter is actually a FILE ** in this case.
230
0
      if (ptr != NULL) {
231
0
        fpp = (FILE **)ptr;
232
0
        *fpp = (FILE *)b->ptr;
233
0
      }
234
0
      break;
235
0
    case BIO_CTRL_GET_CLOSE:
236
0
      ret = (long)b->shutdown;
237
0
      break;
238
0
    case BIO_CTRL_SET_CLOSE:
239
0
      b->shutdown = (int)num;
240
0
      break;
241
0
    case BIO_CTRL_FLUSH:
242
0
      ret = 0 == fflush((FILE *)b->ptr);
243
0
      break;
244
0
    case BIO_CTRL_WPENDING:
245
0
    case BIO_CTRL_PENDING:
246
0
    default:
247
0
      ret = 0;
248
0
      break;
249
0
  }
250
0
  return ret;
251
0
}
252
253
0
static int file_gets(BIO *bp, char *buf, int size) {
254
0
  if (size == 0) {
255
0
    return 0;
256
0
  }
257
258
0
  if (!fgets(buf, size, (FILE *)bp->ptr)) {
259
0
    buf[0] = 0;
260
    // TODO(davidben): This doesn't distinguish error and EOF. This should check
261
    // |ferror| as in |file_read|.
262
0
    return 0;
263
0
  }
264
265
0
  return (int)strlen(buf);
266
0
}
267
268
static const BIO_METHOD methods_filep = {
269
    BIO_TYPE_FILE,   "FILE pointer",
270
    file_write,      file_read,
271
    NULL /* puts */, file_gets,
272
    file_ctrl,       NULL /* create */,
273
    file_free,       NULL /* callback_ctrl */,
274
};
275
276
0
const BIO_METHOD *BIO_s_file(void) { return &methods_filep; }
277
278
279
0
int BIO_get_fp(BIO *bio, FILE **out_file) {
280
0
  return (int)BIO_ctrl(bio, BIO_C_GET_FILE_PTR, 0, (char *)out_file);
281
0
}
282
283
0
int BIO_set_fp(BIO *bio, FILE *file, int close_flag) {
284
0
  return (int)BIO_ctrl(bio, BIO_C_SET_FILE_PTR, close_flag, (char *)file);
285
0
}
286
287
0
int BIO_read_filename(BIO *bio, const char *filename) {
288
0
  return (int)BIO_ctrl(bio, BIO_C_SET_FILENAME, BIO_CLOSE | BIO_FP_READ,
289
0
                       (char *)filename);
290
0
}
291
292
0
int BIO_write_filename(BIO *bio, const char *filename) {
293
0
  return (int)BIO_ctrl(bio, BIO_C_SET_FILENAME, BIO_CLOSE | BIO_FP_WRITE,
294
0
                       (char *)filename);
295
0
}
296
297
0
int BIO_append_filename(BIO *bio, const char *filename) {
298
0
  return (int)BIO_ctrl(bio, BIO_C_SET_FILENAME, BIO_CLOSE | BIO_FP_APPEND,
299
0
                       (char *)filename);
300
0
}
301
302
0
int BIO_rw_filename(BIO *bio, const char *filename) {
303
0
  return (int)BIO_ctrl(bio, BIO_C_SET_FILENAME,
304
0
                       BIO_CLOSE | BIO_FP_READ | BIO_FP_WRITE,
305
0
                       (char *)filename);
306
0
}
307
308
0
long BIO_tell(BIO *bio) { return BIO_ctrl(bio, BIO_C_FILE_TELL, 0, NULL); }
309
310
0
long BIO_seek(BIO *bio, long offset) {
311
0
  return BIO_ctrl(bio, BIO_C_FILE_SEEK, offset, NULL);
312
0
}
313
314
#endif  // OPENSSL_TRUSTY