fixed two doxygen warnings
[strongswan.git] / src / libstrongswan / chunk.h
1 /*
2 * Copyright (C) 2008-2009 Tobias Brunner
3 * Copyright (C) 2005-2008 Martin Willi
4 * Copyright (C) 2005 Jan Hutter
5 * Hochschule fuer Technik Rapperswil
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * for more details.
16 */
17
18 /**
19 * @defgroup chunk chunk
20 * @{ @ingroup libstrongswan
21 */
22
23 #ifndef CHUNK_H_
24 #define CHUNK_H_
25
26 #include <string.h>
27 #include <stdarg.h>
28 #include <sys/types.h>
29
30 typedef struct chunk_t chunk_t;
31
32 /**
33 * General purpose pointer/length abstraction.
34 */
35 struct chunk_t {
36 /** Pointer to start of data */
37 u_char *ptr;
38 /** Length of data in bytes */
39 size_t len;
40 };
41
42 #include <utils.h>
43
44 /**
45 * A { NULL, 0 }-chunk handy for initialization.
46 */
47 extern chunk_t chunk_empty;
48
49 /**
50 * Create a new chunk pointing to "ptr" with length "len"
51 */
52 static inline chunk_t chunk_create(u_char *ptr, size_t len)
53 {
54 chunk_t chunk = {ptr, len};
55 return chunk;
56 }
57
58 /**
59 * Create a clone of a chunk pointing to "ptr"
60 */
61 chunk_t chunk_create_clone(u_char *ptr, chunk_t chunk);
62
63 /**
64 * Calculate length of multiple chunks
65 */
66 size_t chunk_length(const char *mode, ...);
67
68 /**
69 * Concatenate chunks into a chunk pointing to "ptr",
70 * "mode" is a string of "c" (copy) and "m" (move), which says
71 * how to handle the chunks in "..."
72 */
73 chunk_t chunk_create_cat(u_char *ptr, const char* mode, ...);
74
75 /**
76 * Split up a chunk into parts, "mode" is a string of "a" (alloc),
77 * "c" (copy) and "m" (move). Each letter say for the corresponding chunk if
78 * it should get allocated on heap, copied into existing chunk, or the chunk
79 * should point into "chunk". The length of each part is an argument before
80 * each target chunk. E.g.:
81 * chunk_split(chunk, "mcac", 3, &a, 7, &b, 5, &c, d.len, &d);
82 */
83 void chunk_split(chunk_t chunk, const char *mode, ...);
84
85 /**
86 * Write the binary contents of a chunk_t to a file
87 *
88 * @param chunk contents to write to file
89 * @param path path where file is written to
90 * @param label label specifying file type
91 * @param mask file mode creation mask
92 * @param force overwrite existing file by force
93 * @return TRUE if write operation was successful
94 */
95 bool chunk_write(chunk_t chunk, char *path, char *label, mode_t mask, bool force);
96
97 /**
98 * Convert a chunk of data to hex encoding.
99 *
100 * The resulting string is '\\0' terminated, but the chunk does not include
101 * the '\\0'. If buf is supplied, it must hold at least (chunk.len * 2 + 1).
102 *
103 * @param chunk data to convert to hex encoding
104 * @param buf buffer to write to, NULL to malloc
105 * @param uppercase TRUE to use uppercase letters
106 * @return chunk of encoded data
107 */
108 chunk_t chunk_to_hex(chunk_t chunk, char *buf, bool uppercase);
109
110 /**
111 * Convert a hex encoded in a binary chunk.
112 *
113 * If buf is supplied, it must hold at least (hex.len / 2) + (hex.len % 2)
114 * bytes. It is filled by the right to give correct values for short inputs.
115 *
116 * @param hex hex encoded input data
117 * @param buf buffer to write decoded data, NULL to malloc
118 * @return converted data
119 */
120 chunk_t chunk_from_hex(chunk_t hex, char *buf);
121
122 /**
123 * Convert a chunk of data to its base64 encoding.
124 *
125 * The resulting string is '\\0' terminated, but the chunk does not include
126 * the '\\0'. If buf is supplied, it must hold at least (chunk.len * 4 / 3 + 1).
127 *
128 * @param chunk data to convert
129 * @param buf buffer to write to, NULL to malloc
130 * @return chunk of encoded data
131 */
132 chunk_t chunk_to_base64(chunk_t chunk, char *buf);
133
134 /**
135 * Convert a base64 in a binary chunk.
136 *
137 * If buf is supplied, it must hold at least (base64.len / 4 * 3).
138 *
139 * @param base64 base64 encoded input data
140 * @param buf buffer to write decoded data, NULL to malloc
141 * @return converted data
142 */
143 chunk_t chunk_from_base64(chunk_t base64, char *buf);
144
145 /**
146 * Free contents of a chunk
147 */
148 static inline void chunk_free(chunk_t *chunk)
149 {
150 free(chunk->ptr);
151 *chunk = chunk_empty;
152 }
153
154 /**
155 * Overwrite the contents of a chunk and free it
156 */
157 static inline void chunk_clear(chunk_t *chunk)
158 {
159 if (chunk->ptr)
160 {
161 memset(chunk->ptr, 0, chunk->len);
162 chunk_free(chunk);
163 }
164 }
165
166 /**
167 * Initialize a chunk to point to buffer inspectable by sizeof()
168 */
169 #define chunk_from_buf(str) { str, sizeof(str) }
170
171 /**
172 * Initialize a chunk to point to a thing
173 */
174 #define chunk_from_thing(thing) chunk_create((char*)&(thing), sizeof(thing))
175
176 /**
177 * Allocate a chunk on the heap
178 */
179 #define chunk_alloc(bytes) chunk_create(malloc(bytes), bytes)
180
181 /**
182 * Allocate a chunk on the stack
183 */
184 #define chunk_alloca(bytes) chunk_create(alloca(bytes), bytes)
185
186 /**
187 * Clone a chunk on heap
188 */
189 #define chunk_clone(chunk) chunk_create_clone((chunk).len ? malloc((chunk).len) : NULL, chunk)
190
191 /**
192 * Clone a chunk on stack
193 */
194 #define chunk_clonea(chunk) chunk_create_clone(alloca((chunk).len), chunk)
195
196 /**
197 * Concatenate chunks into a chunk on heap
198 */
199 #define chunk_cat(mode, ...) chunk_create_cat(malloc(chunk_length(mode, __VA_ARGS__)), mode, __VA_ARGS__)
200
201 /**
202 * Concatenate chunks into a chunk on stack
203 */
204 #define chunk_cata(mode, ...) chunk_create_cat(alloca(chunk_length(mode, __VA_ARGS__)), mode, __VA_ARGS__)
205
206 /**
207 * Skip n bytes in chunk (forward pointer, shorten length)
208 */
209 static inline chunk_t chunk_skip(chunk_t chunk, size_t bytes)
210 {
211 if (chunk.len > bytes)
212 {
213 chunk.ptr += bytes;
214 chunk.len -= bytes;
215 return chunk;
216 }
217 return chunk_empty;
218 }
219
220 /**
221 * Compare two chunks, returns zero if a equals b
222 * or negative/positive if a is small/greater than b
223 */
224 int chunk_compare(chunk_t a, chunk_t b);
225
226 /**
227 * Compare two chunks for equality,
228 * NULL chunks are never equal.
229 */
230 static inline bool chunk_equals(chunk_t a, chunk_t b)
231 {
232 return a.ptr != NULL && b.ptr != NULL &&
233 a.len == b.len && memeq(a.ptr, b.ptr, a.len);
234 }
235
236 /**
237 * Check if a chunk has printable characters only.
238 *
239 * If sane is given, chunk is cloned into sane and all non printable characters
240 * get replaced by "replace".
241 *
242 * @param chunk chunk to check for printability
243 * @param sane pointer where sane version is allocated, or NULL
244 * @param replace character to use for replaceing unprintable characters
245 * @return TRUE if all characters in chunk are printable
246 */
247 bool chunk_printable(chunk_t chunk, chunk_t *sane, char replace);
248
249 /**
250 * Computes a 32 bit hash of the given chunk.
251 * Note: This hash is only intended for hash tables not for cryptographic purposes.
252 */
253 u_int32_t chunk_hash(chunk_t chunk);
254
255 /**
256 * Incremental version of chunk_hash. Use this to hash two or more chunks.
257 */
258 u_int32_t chunk_hash_inc(chunk_t chunk, u_int32_t hash);
259
260 /**
261 * printf hook function for chunk_t.
262 *
263 * Arguments are:
264 * chunk_t *chunk
265 * Use #-modifier to print a compact version
266 */
267 int chunk_printf_hook(char *dst, size_t len, printf_hook_spec_t *spec,
268 const void *const *args);
269
270 #endif /** CHUNK_H_ @}*/