2 Unix SMB/CIFS implementation.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 /* This is a public header file that is installed as part of Samba.
20 * If you remove any functions or change their signature, update
21 * the so version number. */
23 #ifndef _SAMBA_DATABLOB_H_
24 #define _SAMBA_DATABLOB_H_
33 /* used to hold an arbitrary blob of data */
34 typedef struct datablob {
39 struct data_blob_list_item {
40 struct data_blob_list_item *prev,*next;
44 /* by making struct ldb_val and DATA_BLOB the same, we can simplify
46 #define ldb_val datablob
48 #define data_blob(ptr, size) data_blob_named(ptr, size, "DATA_BLOB: "__location__)
49 #define data_blob_talloc(ctx, ptr, size) data_blob_talloc_named(ctx, ptr, size, "DATA_BLOB: "__location__)
50 #define data_blob_dup_talloc(ctx, blob) data_blob_talloc_named(ctx, (blob)->data, (blob)->length, "DATA_BLOB: "__location__)
53 construct a data blob, must be freed with data_blob_free()
54 you can pass NULL for p and get a blank data blob
56 _PUBLIC_ DATA_BLOB data_blob_named(const void *p, size_t length, const char *name);
59 construct a data blob, using supplied TALLOC_CTX
61 _PUBLIC_ DATA_BLOB data_blob_talloc_named(TALLOC_CTX *mem_ctx, const void *p, size_t length, const char *name);
64 construct a zero data blob, using supplied TALLOC_CTX.
65 use this sparingly as it initialises data - better to initialise
66 yourself if you want specific data in the blob
68 _PUBLIC_ DATA_BLOB data_blob_talloc_zero(TALLOC_CTX *mem_ctx, size_t length);
73 _PUBLIC_ void data_blob_free(DATA_BLOB *d);
76 clear a DATA_BLOB's contents
78 _PUBLIC_ void data_blob_clear(DATA_BLOB *d);
81 free a data blob and clear its contents
83 _PUBLIC_ void data_blob_clear_free(DATA_BLOB *d);
86 check if two data blobs are equal
88 _PUBLIC_ int data_blob_cmp(const DATA_BLOB *d1, const DATA_BLOB *d2);
91 print the data_blob as hex string
93 _PUBLIC_ char *data_blob_hex_string_upper(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob);
96 print the data_blob as hex string
98 _PUBLIC_ char *data_blob_hex_string_lower(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob);
101 useful for constructing data blobs in test suites, while
102 avoiding const warnings
104 _PUBLIC_ DATA_BLOB data_blob_string_const(const char *str);
107 useful for constructing data blobs in test suites, while
108 avoiding const warnings
110 includes the terminating null character (as opposed to data_blo_string_const)
112 _PUBLIC_ DATA_BLOB data_blob_string_const_null(const char *str);
115 * Create a new data blob from const data
117 _PUBLIC_ DATA_BLOB data_blob_const(const void *p, size_t length);
122 _PUBLIC_ bool data_blob_realloc(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, size_t length);
125 append some data to a data blob
127 _PUBLIC_ bool data_blob_append(TALLOC_CTX *mem_ctx, DATA_BLOB *blob,
128 const void *p, size_t length);
130 extern const DATA_BLOB data_blob_null;
132 #endif /* _SAMBA_DATABLOB_H_ */