crypto/openssl/crypto/buffer/buffer.h

   1 /* crypto/buffer/buffer.h */
   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 #ifndef HEADER_BUFFER_H
  60 # define HEADER_BUFFER_H
  61
  62 # include <openssl/ossl_typ.h>
  63
  64 #ifdef  __cplusplus
  65 extern "C" {
  66 #endif
  67
  68 # include <stddef.h>
  69
  70 # if !defined(NO_SYS_TYPES_H)
  71 #  include <sys/types.h>
  72 # endif
  73
  74 /* Already declared in ossl_typ.h */
  75 /* typedef struct buf_mem_st BUF_MEM; */
  76
  77 struct buf_mem_st {
  78     size_t length;              /* current number of bytes */
  79     char *data;
  80     size_t max;                 /* size of buffer */
  81 };
  82
  83 BUF_MEM *BUF_MEM_new(void);
  84 void BUF_MEM_free(BUF_MEM *a);
  85 int BUF_MEM_grow(BUF_MEM *str, size_t len);
  86 int BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
  87 char *BUF_strdup(const char *str);
  88
  89 /*
  90  * Like strndup, but in addition, explicitly guarantees to never read past the
  91  * first |siz| bytes of |str|.
  92  */
  93 char *BUF_strndup(const char *str, size_t siz);
  94
  95 void *BUF_memdup(const void *data, size_t siz);
  96 void BUF_reverse(unsigned char *out, const unsigned char *in, size_t siz);
  97
  98 /* safe string functions */
  99 size_t BUF_strlcpy(char *dst, const char *src, size_t siz);
 100 size_t BUF_strlcat(char *dst, const char *src, size_t siz);
 101
 102 /* BEGIN ERROR CODES */
 103 /*
 104  * The following lines are auto generated by the script mkerr.pl. Any changes
 105  * made after this point may be overwritten when the script is next run.
 106  */
 107 void ERR_load_BUF_strings(void);
 108
 109 /* Error codes for the BUF functions. */
 110
 111 /* Function codes. */
 112 # define BUF_F_BUF_MEMDUP                                 103
 113 # define BUF_F_BUF_MEM_GROW                               100
 114 # define BUF_F_BUF_MEM_GROW_CLEAN                         105
 115 # define BUF_F_BUF_MEM_NEW                                101
 116 # define BUF_F_BUF_STRDUP                                 102
 117 # define BUF_F_BUF_STRNDUP                                104
 118
 119 /* Reason codes. */
 120
 121 #ifdef  __cplusplus
 122 }
 123 #endif
 124 #endif