Implement BUF_strnlen() and use it instead of strlen().
[openssl.git] / 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         {
79         size_t length;  /* current number of bytes */
80         char *data;
81         size_t max;     /* size of buffer */
82         };
83
84 BUF_MEM *BUF_MEM_new(void);
85 void    BUF_MEM_free(BUF_MEM *a);
86 int     BUF_MEM_grow(BUF_MEM *str, size_t len);
87 int     BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
88 size_t  BUF_strnlen(const char *str, size_t maxlen);
89 char *  BUF_strdup(const char *str);
90 char *  BUF_strndup(const char *str, size_t siz);
91 void *  BUF_memdup(const void *data, size_t siz);
92 void    BUF_reverse(unsigned char *out, unsigned char *in, size_t siz);
93
94 /* safe string functions */
95 size_t BUF_strlcpy(char *dst,const char *src,size_t siz);
96 size_t BUF_strlcat(char *dst,const char *src,size_t siz);
97
98
99 /* BEGIN ERROR CODES */
100 /* The following lines are auto generated by the script mkerr.pl. Any changes
101  * made after this point may be overwritten when the script is next run.
102  */
103 void ERR_load_BUF_strings(void);
104
105 /* Error codes for the BUF functions. */
106
107 /* Function codes. */
108 #define BUF_F_BUF_MEMDUP                                 103
109 #define BUF_F_BUF_MEM_GROW                               100
110 #define BUF_F_BUF_MEM_GROW_CLEAN                         105
111 #define BUF_F_BUF_MEM_NEW                                101
112 #define BUF_F_BUF_STRDUP                                 102
113 #define BUF_F_BUF_STRNDUP                                104
114
115 /* Reason codes. */
116
117 #ifdef  __cplusplus
118 }
119 #endif
120 #endif