include/openssl/buffer.h

   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
  58 #ifndef HEADER_BUFFER_H
  59 # define HEADER_BUFFER_H
  60
  61 # include <openssl/ossl_typ.h>
  62 # ifndef HEADER_CRYPTO_H
  63 #  include <openssl/crypto.h>
  64 # endif
  65
  66
  67 #ifdef  __cplusplus
  68 extern "C" {
  69 #endif
  70
  71 # include <stddef.h>
  72
  73 # if !defined(NO_SYS_TYPES_H)
  74 #  include <sys/types.h>
  75 # endif
  76
  77 /*
  78  * These names are outdated as of OpenSSL 1.1; a future release
  79  * will move them to be deprecated.
  80  */
  81 # define BUF_strdup(s) OPENSSL_strdup(s)
  82 # define BUF_strndup(s, size) OPENSSL_strndup(s, size)
  83 # define BUF_memdup(data, size) OPENSSL_memdup(data, size)
  84 # define BUF_strlcpy(dst, src, size)  OPENSSL_strlcpy(dst, src, size)
  85 # define BUF_strlcat(dst, src, size) OPENSSL_strlcat(dst, src, size)
  86 # define BUF_strnlen(str, maxlen) OPENSSL_strnlen(str, maxlen)
  87
  88 struct buf_mem_st {
  89     size_t length;              /* current number of bytes */
  90     char *data;
  91     size_t max;                 /* size of buffer */
  92     unsigned long flags;
  93 };
  94
  95 # define BUF_MEM_FLAG_SECURE  0x01
  96
  97 BUF_MEM *BUF_MEM_new(void);
  98 BUF_MEM *BUF_MEM_new_ex(unsigned long flags);
  99 void BUF_MEM_free(BUF_MEM *a);
 100 size_t BUF_MEM_grow(BUF_MEM *str, size_t len);
 101 size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
 102 void BUF_reverse(unsigned char *out, const unsigned char *in, size_t siz);
 103
 104 /* BEGIN ERROR CODES */
 105 /*
 106  * The following lines are auto generated by the script mkerr.pl. Any changes
 107  * made after this point may be overwritten when the script is next run.
 108  */
 109 void ERR_load_BUF_strings(void);
 110
 111 /* Error codes for the BUF functions. */
 112
 113 /* Function codes. */
 114 # define BUF_F_BUF_MEM_GROW                               100
 115 # define BUF_F_BUF_MEM_GROW_CLEAN                         105
 116 # define BUF_F_BUF_MEM_NEW                                101
 117
 118 /* Reason codes. */
 119
 120 #ifdef  __cplusplus
 121 }
 122 #endif
 123 #endif