lib/libcrypto/bio/bss_file.c

   1 /* $OpenBSD: bss_file.c,v 1.32 2017/01/29 17:49:22 beck Exp $ */
   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 /* Following definition aliases fopen to fopen64 on above mentioned
  70  * platforms. This makes it possible to open and sequentially access
  71  * files larger than 2GB from 32-bit application. It does not allow to
  72  * traverse them beyond 2GB with fseek/ftell, but on the other hand *no*
  73  * 32-bit platform permits that, not with fseek/ftell. Not to mention
  74  * that breaking 2GB limit for seeking would require surgery to *our*
  75  * API. But sequential access suffices for practical cases when you
  76  * can run into large files, such as fingerprinting, so we can let API
  77  * alone. For reference, the list of 32-bit platforms which allow for
  78  * sequential access of large files without extra "magic" comprise *BSD,
  79  * Darwin, IRIX...
  80  */
  81 #ifndef _FILE_OFFSET_BITS
  82 #define _FILE_OFFSET_BITS 64
  83 #endif
  84 #endif
  85
  86 #include <errno.h>
  87 #include <stdio.h>
  88 #include <string.h>
  89
  90 #include <openssl/bio.h>
  91 #include <openssl/err.h>
  92
  93 static int file_write(BIO *h, const char *buf, int num);
  94 static int file_read(BIO *h, char *buf, int size);
  95 static int file_puts(BIO *h, const char *str);
  96 static int file_gets(BIO *h, char *str, int size);
  97 static long file_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  98 static int file_new(BIO *h);
  99 static int file_free(BIO *data);
 100
 101 static BIO_METHOD methods_filep = {
 102         .type = BIO_TYPE_FILE,
 103         .name = "FILE pointer",
 104         .bwrite = file_write,
 105         .bread = file_read,
 106         .bputs = file_puts,
 107         .bgets = file_gets,
 108         .ctrl = file_ctrl,
 109         .create = file_new,
 110         .destroy = file_free
 111 };
 112
 113 BIO *
 114 BIO_new_file(const char *filename, const char *mode)
 115 {
 116         BIO  *ret;
 117         FILE *file = NULL;
 118
 119         file = fopen(filename, mode);
 120
 121         if (file == NULL) {
 122                 SYSerror(errno);
 123                 ERR_asprintf_error_data("fopen('%s', '%s')", filename, mode);
 124                 if (errno == ENOENT)
 125                         BIOerror(BIO_R_NO_SUCH_FILE);
 126                 else
 127                         BIOerror(ERR_R_SYS_LIB);
 128                 return (NULL);
 129         }
 130         if ((ret = BIO_new(BIO_s_file())) == NULL) {
 131                 fclose(file);
 132                 return (NULL);
 133         }
 134
 135         BIO_set_fp(ret, file, BIO_CLOSE);
 136         return (ret);
 137 }
 138
 139 BIO *
 140 BIO_new_fp(FILE *stream, int close_flag)
 141 {
 142         BIO *ret;
 143
 144         if ((ret = BIO_new(BIO_s_file())) == NULL)
 145                 return (NULL);
 146
 147         BIO_set_fp(ret, stream, close_flag);
 148         return (ret);
 149 }
 150
 151 BIO_METHOD *
 152 BIO_s_file(void)
 153 {
 154         return (&methods_filep);
 155 }
 156
 157 static int
 158 file_new(BIO *bi)
 159 {
 160         bi->init = 0;
 161         bi->num = 0;
 162         bi->ptr = NULL;
 163         bi->flags=0;
 164         return (1);
 165 }
 166
 167 static int
 168 file_free(BIO *a)
 169 {
 170         if (a == NULL)
 171                 return (0);
 172         if (a->shutdown) {
 173                 if ((a->init) && (a->ptr != NULL)) {
 174                         fclose (a->ptr);
 175                         a->ptr = NULL;
 176                         a->flags = 0;
 177                 }
 178                 a->init = 0;
 179         }
 180         return (1);
 181 }
 182
 183 static int
 184 file_read(BIO *b, char *out, int outl)
 185 {
 186         int ret = 0;
 187
 188         if (b->init && out != NULL) {
 189                 ret = fread(out, 1, outl, (FILE *)b->ptr);
 190                 if (ret == 0 && ferror((FILE *)b->ptr)) {
 191                         SYSerror(errno);
 192                         BIOerror(ERR_R_SYS_LIB);
 193                         ret = -1;
 194                 }
 195         }
 196         return (ret);
 197 }
 198
 199 static int
 200 file_write(BIO *b, const char *in, int inl)
 201 {
 202         int ret = 0;
 203
 204         if (b->init && in != NULL)
 205                 ret = fwrite(in, 1, inl, (FILE *)b->ptr);
 206         return (ret);
 207 }
 208
 209 static long
 210 file_ctrl(BIO *b, int cmd, long num, void *ptr)
 211 {
 212         long ret = 1;
 213         FILE *fp = (FILE *)b->ptr;
 214         FILE **fpp;
 215         char p[4];
 216
 217         switch (cmd) {
 218         case BIO_C_FILE_SEEK:
 219         case BIO_CTRL_RESET:
 220                 ret = (long)fseek(fp, num, 0);
 221                 break;
 222         case BIO_CTRL_EOF:
 223                 ret = (long)feof(fp);
 224                 break;
 225         case BIO_C_FILE_TELL:
 226         case BIO_CTRL_INFO:
 227                 ret = ftell(fp);
 228                 break;
 229         case BIO_C_SET_FILE_PTR:
 230                 file_free(b);
 231                 b->shutdown = (int)num&BIO_CLOSE;
 232                 b->ptr = ptr;
 233                 b->init = 1;
 234                 break;
 235         case BIO_C_SET_FILENAME:
 236                 file_free(b);
 237                 b->shutdown = (int)num&BIO_CLOSE;
 238                 if (num & BIO_FP_APPEND) {
 239                         if (num & BIO_FP_READ)
 240                                 strlcpy(p, "a+", sizeof p);
 241                         else    strlcpy(p, "a", sizeof p);
 242                 } else if ((num & BIO_FP_READ) && (num & BIO_FP_WRITE))
 243                         strlcpy(p, "r+", sizeof p);
 244                 else if (num & BIO_FP_WRITE)
 245                         strlcpy(p, "w", sizeof p);
 246                 else if (num & BIO_FP_READ)
 247                         strlcpy(p, "r", sizeof p);
 248                 else {
 249                         BIOerror(BIO_R_BAD_FOPEN_MODE);
 250                         ret = 0;
 251                         break;
 252                 }
 253                 fp = fopen(ptr, p);
 254                 if (fp == NULL) {
 255                         SYSerror(errno);
 256                         ERR_asprintf_error_data("fopen('%s', '%s')", ptr, p);
 257                         BIOerror(ERR_R_SYS_LIB);
 258                         ret = 0;
 259                         break;
 260                 }
 261                 b->ptr = fp;
 262                 b->init = 1;
 263                 break;
 264         case BIO_C_GET_FILE_PTR:
 265                 /* the ptr parameter is actually a FILE ** in this case. */
 266                 if (ptr != NULL) {
 267                         fpp = (FILE **)ptr;
 268                         *fpp = (FILE *)b->ptr;
 269                 }
 270                 break;
 271         case BIO_CTRL_GET_CLOSE:
 272                 ret = (long)b->shutdown;
 273                 break;
 274         case BIO_CTRL_SET_CLOSE:
 275                 b->shutdown = (int)num;
 276                 break;
 277         case BIO_CTRL_FLUSH:
 278                 fflush((FILE *)b->ptr);
 279                 break;
 280         case BIO_CTRL_DUP:
 281                 ret = 1;
 282                 break;
 283
 284         case BIO_CTRL_WPENDING:
 285         case BIO_CTRL_PENDING:
 286         case BIO_CTRL_PUSH:
 287         case BIO_CTRL_POP:
 288         default:
 289                 ret = 0;
 290                 break;
 291         }
 292         return (ret);
 293 }
 294
 295 static int
 296 file_gets(BIO *bp, char *buf, int size)
 297 {
 298         int ret = 0;
 299
 300         buf[0] = '\0';
 301         if (!fgets(buf, size,(FILE *)bp->ptr))
 302                 goto err;
 303         if (buf[0] != '\0')
 304                 ret = strlen(buf);
 305 err:
 306         return (ret);
 307 }
 308
 309 static int
 310 file_puts(BIO *bp, const char *str)
 311 {
 312         int n, ret;
 313
 314         n = strlen(str);
 315         ret = file_write(bp, str, n);
 316         return (ret);
 317 }
 318
 319
 320 #endif /* HEADER_BSS_FILE_C */