2 Unix SMB/CIFS implementation.
3 Easy management of byte-length data
4 Copyright (C) Andrew Tridgell 2001
5 Copyright (C) Andrew Bartlett 2001
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "data_blob.h"
26 const DATA_BLOB data_blob_null = { NULL, 0 };
30 * @brief Manipulation of arbitrary data blobs
34 construct a data blob, must be freed with data_blob_free()
35 you can pass NULL for p and get a blank data blob
37 _PUBLIC_ DATA_BLOB data_blob_named(const void *p, size_t length, const char *name)
41 if (p == NULL && length == 0) {
47 ret.data = (uint8_t *)talloc_memdup(NULL, p, length);
49 ret.data = talloc_array(NULL, uint8_t, length);
51 if (ret.data == NULL) {
55 talloc_set_name_const(ret.data, name);
61 construct a data blob, using supplied TALLOC_CTX
63 _PUBLIC_ DATA_BLOB data_blob_talloc_named(TALLOC_CTX *mem_ctx, const void *p, size_t length, const char *name)
65 DATA_BLOB ret = data_blob_named(p, length, name);
68 talloc_steal(mem_ctx, ret.data);
74 construct a zero data blob, using supplied TALLOC_CTX.
75 use this sparingly as it initialises data - better to initialise
76 yourself if you want specific data in the blob
78 _PUBLIC_ DATA_BLOB data_blob_talloc_zero(TALLOC_CTX *mem_ctx, size_t length)
80 DATA_BLOB blob = data_blob_talloc(mem_ctx, NULL, length);
81 data_blob_clear(&blob);
88 _PUBLIC_ void data_blob_free(DATA_BLOB *d)
98 clear a DATA_BLOB's contents
100 _PUBLIC_ void data_blob_clear(DATA_BLOB *d)
103 memset(d->data, 0, d->length);
108 free a data blob and clear its contents
110 _PUBLIC_ void data_blob_clear_free(DATA_BLOB *d)
118 check if two data blobs are equal
120 _PUBLIC_ int data_blob_cmp(const DATA_BLOB *d1, const DATA_BLOB *d2)
123 if (d1->data == NULL && d2->data != NULL) {
126 if (d1->data != NULL && d2->data == NULL) {
129 if (d1->data == d2->data) {
130 return d1->length - d2->length;
132 ret = memcmp(d1->data, d2->data, MIN(d1->length, d2->length));
134 return d1->length - d2->length;
140 print the data_blob as hex string
142 _PUBLIC_ char *data_blob_hex_string_lower(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob)
147 hex_string = talloc_array(mem_ctx, char, (blob->length*2)+1);
152 /* this must be lowercase or w2k8 cannot join a samba domain,
153 as this routine is used to encode extended DNs and windows
154 only accepts lowercase hexadecimal numbers */
155 for (i = 0; i < blob->length; i++)
156 slprintf(&hex_string[i*2], 3, "%02x", blob->data[i]);
158 hex_string[(blob->length*2)] = '\0';
162 _PUBLIC_ char *data_blob_hex_string_upper(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob)
167 hex_string = talloc_array(mem_ctx, char, (blob->length*2)+1);
172 for (i = 0; i < blob->length; i++)
173 slprintf(&hex_string[i*2], 3, "%02X", blob->data[i]);
175 hex_string[(blob->length*2)] = '\0';
180 useful for constructing data blobs in test suites, while
181 avoiding const warnings
183 _PUBLIC_ DATA_BLOB data_blob_string_const(const char *str)
186 blob.data = discard_const_p(uint8_t, str);
187 blob.length = str ? strlen(str) : 0;
192 useful for constructing data blobs in test suites, while
193 avoiding const warnings
195 _PUBLIC_ DATA_BLOB data_blob_string_const_null(const char *str)
198 blob.data = discard_const_p(uint8_t, str);
199 blob.length = str ? strlen(str)+1 : 0;
204 * Create a new data blob from const data
207 _PUBLIC_ DATA_BLOB data_blob_const(const void *p, size_t length)
210 blob.data = discard_const_p(uint8_t, p);
211 blob.length = length;
219 _PUBLIC_ bool data_blob_realloc(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, size_t length)
221 blob->data = talloc_realloc(mem_ctx, blob->data, uint8_t, length);
222 if (blob->data == NULL)
224 blob->length = length;
230 append some data to a data blob
232 _PUBLIC_ bool data_blob_append(TALLOC_CTX *mem_ctx, DATA_BLOB *blob,
233 const void *p, size_t length)
235 size_t old_len = blob->length;
236 size_t new_len = old_len + length;
237 if (new_len < length || new_len < old_len) {
241 if ((const uint8_t *)p + length < (const uint8_t *)p) {
245 if (!data_blob_realloc(mem_ctx, blob, new_len)) {
249 memcpy(blob->data + old_len, p, length);