r24780: More work allowing libutil to be used by external users.
[kai/samba.git] / source4 / lib / util / data_blob.c
index c6471fbf540a3b6a322c606f50bf1ea566ebc61b..117043f95c2fd0e50480a44c1f81ce3ab13e395c 100644 (file)
@@ -6,7 +6,7 @@
    
    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
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
 
-/*******************************************************************
+/**
+ * @file
+ * @brief Manipulation of arbitrary data blobs
+ **/
+
+/**
  construct a data blob, must be freed with data_blob_free()
  you can pass NULL for p and get a blank data blob
-*******************************************************************/
-DATA_BLOB data_blob_named(const void *p, size_t length, const char *name)
+**/
+_PUBLIC_ DATA_BLOB data_blob_named(const void *p, size_t length, const char *name)
 {
        DATA_BLOB ret;
 
@@ -48,10 +52,10 @@ DATA_BLOB data_blob_named(const void *p, size_t length, const char *name)
        return ret;
 }
 
-/*******************************************************************
+/**
  construct a data blob, using supplied TALLOC_CTX
-*******************************************************************/
-DATA_BLOB data_blob_talloc_named(TALLOC_CTX *mem_ctx, const void *p, size_t length, const char *name)
+**/
+_PUBLIC_ DATA_BLOB data_blob_talloc_named(TALLOC_CTX *mem_ctx, const void *p, size_t length, const char *name)
 {
        DATA_BLOB ret = data_blob_named(p, length, name);
 
@@ -62,11 +66,11 @@ DATA_BLOB data_blob_talloc_named(TALLOC_CTX *mem_ctx, const void *p, size_t leng
 }
 
 
-/*******************************************************************
+/**
  reference a data blob, to the supplied TALLOC_CTX.  
  Returns a NULL DATA_BLOB on failure
-*******************************************************************/
-DATA_BLOB data_blob_talloc_reference(TALLOC_CTX *mem_ctx, DATA_BLOB *blob)
+**/
+_PUBLIC_ DATA_BLOB data_blob_talloc_reference(TALLOC_CTX *mem_ctx, DATA_BLOB *blob)
 {
        DATA_BLOB ret = *blob;
 
@@ -78,22 +82,22 @@ DATA_BLOB data_blob_talloc_reference(TALLOC_CTX *mem_ctx, DATA_BLOB *blob)
        return ret;
 }
 
-/*******************************************************************
+/**
  construct a zero data blob, using supplied TALLOC_CTX. 
  use this sparingly as it initialises data - better to initialise
  yourself if you want specific data in the blob
-*******************************************************************/
-DATA_BLOB data_blob_talloc_zero(TALLOC_CTX *mem_ctx, size_t length)
+**/
+_PUBLIC_ DATA_BLOB data_blob_talloc_zero(TALLOC_CTX *mem_ctx, size_t length)
 {
        DATA_BLOB blob = data_blob_talloc(mem_ctx, NULL, length);
        data_blob_clear(&blob);
        return blob;
 }
 
-/*******************************************************************
+/**
 free a data blob
-*******************************************************************/
-void data_blob_free(DATA_BLOB *d)
+**/
+_PUBLIC_ void data_blob_free(DATA_BLOB *d)
 {
        if (d) {
                talloc_free(d->data);
@@ -102,50 +106,52 @@ void data_blob_free(DATA_BLOB *d)
        }
 }
 
-/*******************************************************************
+/**
 clear a DATA_BLOB's contents
-*******************************************************************/
-void data_blob_clear(DATA_BLOB *d)
+**/
+_PUBLIC_ void data_blob_clear(DATA_BLOB *d)
 {
        if (d->data) {
                memset(d->data, 0, d->length);
        }
 }
 
-/*******************************************************************
+/**
 free a data blob and clear its contents
-*******************************************************************/
-void data_blob_clear_free(DATA_BLOB *d)
+**/
+_PUBLIC_ void data_blob_clear_free(DATA_BLOB *d)
 {
        data_blob_clear(d);
        data_blob_free(d);
 }
 
 
-/*******************************************************************
+/**
 check if two data blobs are equal
-*******************************************************************/
-BOOL data_blob_equal(const DATA_BLOB *d1, const DATA_BLOB *d2)
+**/
+_PUBLIC_ int data_blob_cmp(const DATA_BLOB *d1, const DATA_BLOB *d2)
 {
-       if (d1->length != d2->length) {
-               return False;
+       int ret;
+       if (d1->data == NULL && d2->data != NULL) {
+               return -1;
        }
-       if (d1->data == d2->data) {
-               return True;
+       if (d1->data != NULL && d2->data == NULL) {
+               return 1;
        }
-       if (d1->data == NULL || d2->data == NULL) {
-               return False;
+       if (d1->data == d2->data) {
+               return d1->length - d2->length;
        }
-       if (memcmp(d1->data, d2->data, d1->length) == 0) {
-               return True;
+       ret = memcmp(d1->data, d2->data, MIN(d1->length, d2->length));
+       if (ret == 0) {
+               return d1->length - d2->length;
        }
-       return False;
+       return ret;
 }
 
-/*******************************************************************
+/**
 print the data_blob as hex string
-*******************************************************************/
-char *data_blob_hex_string(TALLOC_CTX *mem_ctx, DATA_BLOB *blob)
+**/
+_PUBLIC_ char *data_blob_hex_string(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob)
 {
        int i;
        char *hex_string;
@@ -158,14 +164,15 @@ char *data_blob_hex_string(TALLOC_CTX *mem_ctx, DATA_BLOB *blob)
        for (i = 0; i < blob->length; i++)
                slprintf(&hex_string[i*2], 3, "%02X", blob->data[i]);
 
+       hex_string[(blob->length*2)] = '\0';
        return hex_string;
 }
 
-/*
+/**
   useful for constructing data blobs in test suites, while
   avoiding const warnings
-*/
-DATA_BLOB data_blob_string_const(const char *str)
+**/
+_PUBLIC_ DATA_BLOB data_blob_string_const(const char *str)
 {
        DATA_BLOB blob;
        blob.data = discard_const(str);
@@ -173,7 +180,11 @@ DATA_BLOB data_blob_string_const(const char *str)
        return blob;
 }
 
-DATA_BLOB data_blob_const(const void *p, size_t length)
+/**
+ * Create a new data blob from const data 
+ */
+
+_PUBLIC_ DATA_BLOB data_blob_const(const void *p, size_t length)
 {
        DATA_BLOB blob;
        blob.data = discard_const(p);
@@ -182,28 +193,40 @@ DATA_BLOB data_blob_const(const void *p, size_t length)
 }
 
 
-/*
+/**
   realloc a data_blob
-*/
-NTSTATUS data_blob_realloc(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, size_t length)
+**/
+_PUBLIC_ bool data_blob_realloc(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, size_t length)
 {
        blob->data = talloc_realloc_size(mem_ctx, blob->data, length);
-       NT_STATUS_HAVE_NO_MEMORY(blob->data);   
+       if (blob->data == NULL)
+               return false;
        blob->length = length;
-       return NT_STATUS_OK;
+       return true;
 }
 
-/*
+
+/**
   append some data to a data blob
-*/
-NTSTATUS data_blob_append(TALLOC_CTX *mem_ctx, DATA_BLOB *blob,
-                         const void *p, size_t length)
+**/
+_PUBLIC_ bool data_blob_append(TALLOC_CTX *mem_ctx, DATA_BLOB *blob,
+                                  const void *p, size_t length)
 {
-       blob->data = talloc_realloc_size(mem_ctx, blob->data,
-                                        blob->length + length);
-       NT_STATUS_HAVE_NO_MEMORY(blob->data);   
-       memcpy(blob->data + blob->length, p, length);
-       blob->length += length;
-       return NT_STATUS_OK;
+       size_t old_len = blob->length;
+       size_t new_len = old_len + length;
+       if (new_len < length || new_len < old_len) {
+               return false;
+       }
+
+       if ((const uint8_t *)p + length < (const uint8_t *)p) {
+               return false;
+       }
+       
+       if (!data_blob_realloc(mem_ctx, blob, new_len)) {
+               return false;
+       }
+
+       memcpy(blob->data + old_len, p, length);
+       return true;
 }