| 1 |
/* Copyright (C) 1995-1998 Eric Young ([email protected]) |
| 2 |
* All rights reserved. |
| 3 |
* |
| 4 |
* This package is an SSL implementation written |
| 5 |
* by Eric Young ([email protected]). |
| 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 ([email protected]). |
| 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 ([email protected])" |
| 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 ([email protected])" |
| 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 |
#ifndef OPENSSL_HEADER_BUFFER_H |
| 58 |
#define OPENSSL_HEADER_BUFFER_H |
| 59 |
|
| 60 |
#include <openssl/base.h> |
| 61 |
|
| 62 |
#if defined(__cplusplus) |
| 63 |
extern "C" { |
| 64 |
#endif |
| 65 |
|
| 66 |
|
| 67 |
/* Memory and string functions, see also mem.h. */ |
| 68 |
|
| 69 |
|
| 70 |
/* buf_mem_st (aka |BUF_MEM|) is a generic buffer object used by OpenSSL. */ |
| 71 |
struct buf_mem_st { |
| 72 |
size_t length; /* current number of bytes */ |
| 73 |
char *data; |
| 74 |
size_t max; /* size of buffer */ |
| 75 |
}; |
| 76 |
|
| 77 |
/* BUF_MEM_new creates a new BUF_MEM which has no allocated data buffer. */ |
| 78 |
OPENSSL_EXPORT BUF_MEM *BUF_MEM_new(void); |
| 79 |
|
| 80 |
/* BUF_MEM_free frees |buf->data| if needed and then frees |buf| itself. */ |
| 81 |
OPENSSL_EXPORT void BUF_MEM_free(BUF_MEM *buf); |
| 82 |
|
| 83 |
/* BUF_MEM_reserve ensures |buf| has capacity |cap| and allocates memory if |
| 84 |
* needed. It returns one on success and zero on error. */ |
| 85 |
OPENSSL_EXPORT int BUF_MEM_reserve(BUF_MEM *buf, size_t cap); |
| 86 |
|
| 87 |
/* BUF_MEM_grow ensures that |buf| has length |len| and allocates memory if |
| 88 |
* needed. If the length of |buf| increased, the new bytes are filled with |
| 89 |
* zeros. It returns the length of |buf|, or zero if there's an error. */ |
| 90 |
OPENSSL_EXPORT size_t BUF_MEM_grow(BUF_MEM *buf, size_t len); |
| 91 |
|
| 92 |
/* BUF_MEM_grow_clean acts the same as |BUF_MEM_grow|, but clears the previous |
| 93 |
* contents of memory if reallocing. */ |
| 94 |
OPENSSL_EXPORT size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len); |
| 95 |
|
| 96 |
/* BUF_strdup returns an allocated, duplicate of |str|. */ |
| 97 |
OPENSSL_EXPORT char *BUF_strdup(const char *str); |
| 98 |
|
| 99 |
/* BUF_strnlen returns the number of characters in |str|, excluding the NUL |
| 100 |
* byte, but at most |max_len|. This function never reads more than |max_len| |
| 101 |
* bytes from |str|. */ |
| 102 |
OPENSSL_EXPORT size_t BUF_strnlen(const char *str, size_t max_len); |
| 103 |
|
| 104 |
/* BUF_strndup returns an allocated, duplicate of |str|, which is, at most, |
| 105 |
* |size| bytes. The result is always NUL terminated. */ |
| 106 |
OPENSSL_EXPORT char *BUF_strndup(const char *str, size_t size); |
| 107 |
|
| 108 |
/* BUF_memdup returns an allocated, duplicate of |size| bytes from |data|. */ |
| 109 |
OPENSSL_EXPORT void *BUF_memdup(const void *data, size_t size); |
| 110 |
|
| 111 |
/* BUF_strlcpy acts like strlcpy(3). */ |
| 112 |
OPENSSL_EXPORT size_t BUF_strlcpy(char *dst, const char *src, size_t dst_size); |
| 113 |
|
| 114 |
/* BUF_strlcat acts like strlcat(3). */ |
| 115 |
OPENSSL_EXPORT size_t BUF_strlcat(char *dst, const char *src, size_t size); |
| 116 |
|
| 117 |
|
| 118 |
#if defined(__cplusplus) |
| 119 |
} /* extern C */ |
| 120 |
#endif |
| 121 |
|
| 122 |
#endif /* OPENSSL_HEADER_BUFFER_H */ |