1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
* Copyright (C) 2005-2008 Martin Willi
* Copyright (C) 2005 Jan Hutter
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* $Id: chunk.h 4276 2008-08-22 10:44:51Z martin $
*/
/**
* @defgroup chunk chunk
* @{ @ingroup libstrongswan
*/
#ifndef CHUNK_H_
#define CHUNK_H_
#include <string.h>
#include <stdarg.h>
#include <sys/types.h>
typedef struct chunk_t chunk_t;
/**
* General purpose pointer/length abstraction.
*/
struct chunk_t {
/** Pointer to start of data */
u_char *ptr;
/** Length of data in bytes */
size_t len;
};
#include <library.h>
/**
* A { NULL, 0 }-chunk handy for initialization.
*/
extern chunk_t chunk_empty;
/**
* Create a new chunk pointing to "ptr" with length "len"
*/
chunk_t chunk_create(u_char *ptr, size_t len);
/**
* Create a clone of a chunk pointing to "ptr"
*/
chunk_t chunk_create_clone(u_char *ptr, chunk_t chunk);
/**
* Calculate length of multiple chunks
*/
size_t chunk_length(const char *mode, ...);
/**
* Concatenate chunks into a chunk pointing to "ptr",
* "mode" is a string of "c" (copy) and "m" (move), which says
* how to handle the chunks in "..."
*/
chunk_t chunk_create_cat(u_char *ptr, const char* mode, ...);
/**
* Split up a chunk into parts, "mode" is a string of "a" (alloc),
* "c" (copy) and "m" (move). Each letter say for the corresponding chunk if
* it should get allocated on heap, copied into existing chunk, or the chunk
* should point into "chunk". The length of each part is an argument before
* each target chunk. E.g.:
* chunk_split(chunk, "mcac", 3, &a, 7, &b, 5, &c, d.len, &d);
*/
void chunk_split(chunk_t chunk, const char *mode, ...);
/**
* Write the binary contents of a chunk_t to a file
*/
bool chunk_write(chunk_t chunk, char *path, mode_t mask, bool force);
/**
* Convert a chunk of data to hex encoding.
*
* The resulting string is '\0' terminated, but the chunk does not include
* the '\0'. If buf is supplied, it must hold at least (chunk.len * 2 + 1).
*
* @param chunk data to convert
* @param buff buffer to write to, NULL to malloc
* @param uppercase TRUE to use uppercase letters
* @return chunk of encoded data
*/
chunk_t chunk_to_hex(chunk_t chunk, char *buf, bool uppercase);
/**
* Convert a hex encoded in a binary chunk.
*
* If buf is supplied, it must hold at least (hex.len / 2) + (hex.len % 2)
* bytes. It is filled by the right to give correct values for short inputs.
*
* @param hex hex encoded input data
* @param buf buffer to write decoded data, NULL to malloc
* @return converted data
*/
chunk_t chunk_from_hex(chunk_t hex, char *buf);
/**
* Convert a chunk of data to its base64 encoding.
*
* The resulting string is '\0' terminated, but the chunk does not include
* the '\0'. If buf is supplied, it must hold at least (chunk.len * 4 / 3 + 1).
*
* @param chunk data to convert
* @param buff buffer to write to, NULL to malloc
* @return chunk of encoded data
*/
chunk_t chunk_to_base64(chunk_t chunk, char *buf);
/**
* Convert a base64 in a binary chunk.
*
* If buf is supplied, it must hold at least (base64.len / 4 * 3).
*
* @param base64 base64 encoded input data
* @param buf buffer to write decoded data, NULL to malloc
* @return converted data
*/
chunk_t chunk_from_base64(chunk_t base64, char *buf);
/**
* Free contents of a chunk
*/
void chunk_free(chunk_t *chunk);
/**
* Overwrite the contents of a chunk and free it
*/
void chunk_clear(chunk_t *chunk);
/**
* Initialize a chunk to point to buffer inspectable by sizeof()
*/
#define chunk_from_buf(str) { str, sizeof(str) }
/**
* Initialize a chunk to point to a thing
*/
#define chunk_from_thing(thing) chunk_create((char*)&(thing), sizeof(thing))
/**
* Allocate a chunk on the heap
*/
#define chunk_alloc(bytes) chunk_create(malloc(bytes), bytes)
/**
* Allocate a chunk on the stack
*/
#define chunk_alloca(bytes) chunk_create(alloca(bytes), bytes)
/**
* Clone a chunk on heap
*/
#define chunk_clone(chunk) chunk_create_clone((chunk).len ? malloc(chunk.len) : NULL, chunk)
/**
* Clone a chunk on stack
*/
#define chunk_clonea(chunk) chunk_create_clone(alloca(chunk.len), chunk)
/**
* Concatenate chunks into a chunk on heap
*/
#define chunk_cat(mode, ...) chunk_create_cat(malloc(chunk_length(mode, __VA_ARGS__)), mode, __VA_ARGS__)
/**
* Concatenate chunks into a chunk on stack
*/
#define chunk_cata(mode, ...) chunk_create_cat(alloca(chunk_length(mode, __VA_ARGS__)), mode, __VA_ARGS__)
/**
* Skip n bytes in chunk (forward pointer, shorten length)
*/
chunk_t chunk_skip(chunk_t chunk, size_t bytes);
/**
* Compare two chunks, returns zero if a equals b
* or negative/positive if a is small/greater than b
*/
int chunk_compare(chunk_t a, chunk_t b);
/**
* Compare two chunks for equality,
* NULL chunks are never equal.
*/
bool chunk_equals(chunk_t a, chunk_t b);
/**
* Get printf hooks for a chunk.
*
* Arguments are:
* chunk_t *chunk
*/
printf_hook_functions_t chunk_get_printf_hooks();
#endif /* CHUNK_H_ @}*/
|
