r4139: 2nd attempt at fixing the null ptr in size_is() problem.
[samba.git] / source4 / librpc / ndr / ndr.c
index 32836c941198d3726b2d0d45d5f6ed59ccb4da1b..0543fbf0d36125384e9162aff499750ac39c8d2e 100644 (file)
@@ -28,6 +28,7 @@
 */
 
 #include "includes.h"
+#include "dlinklist.h"
 
 #define NDR_BASE_MARSHALL_SIZE 1024
 
@@ -47,15 +48,11 @@ struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
 {
        struct ndr_pull *ndr;
 
-       ndr = talloc(mem_ctx, sizeof(*ndr));
+       ndr = talloc_zero_p(mem_ctx, struct ndr_pull);
        if (!ndr) return NULL;
 
-       ndr->flags = 0;
        ndr->data = blob->data;
        ndr->data_size = blob->length;
-       ndr->offset = 0;
-       ndr->ptr_count = 0;
-       ndr->relative_list = NULL;
 
        return ndr;
 }
@@ -124,7 +121,7 @@ struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx)
 {
        struct ndr_push *ndr;
 
-       ndr = talloc(mem_ctx, sizeof(*ndr));
+       ndr = talloc_zero_p(mem_ctx, struct ndr_push);
        if (!ndr) {
                return NULL;
        }
@@ -135,9 +132,6 @@ struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx)
        if (!ndr->data) {
                return NULL;
        }
-       ndr->offset = 0;
-       ndr->ptr_count = 0;
-       ndr->relative_list = NULL;
 
        return ndr;
 }
@@ -146,20 +140,13 @@ struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx)
 /* create a ndr_push structure, ready for some marshalling */
 struct ndr_push *ndr_push_init(void)
 {
-       struct ndr_push *ndr;
-       TALLOC_CTX *mem_ctx = talloc_init("ndr_push_init");
-       if (!mem_ctx) return NULL;
-       ndr = ndr_push_init_ctx(mem_ctx);
-       if (!ndr) {
-               talloc_destroy(mem_ctx);
-       }
-       return ndr;
+       return ndr_push_init_ctx(NULL);
 }
 
 /* free a ndr_push structure */
 void ndr_push_free(struct ndr_push *ndr)
 {
-       talloc_destroy(ndr);
+       talloc_free(ndr);
 }
 
 
@@ -186,7 +173,7 @@ NTSTATUS ndr_push_expand(struct ndr_push *ndr, uint32_t size)
        if (size > ndr->alloc_size) {
                ndr->alloc_size = size;
        }
-       ndr->data = talloc_realloc(ndr->data, ndr->alloc_size);
+       ndr->data = talloc_realloc(ndr, ndr->data, ndr->alloc_size);
        if (!ndr->data) {
                return ndr_push_error(ndr, NDR_ERR_ALLOC, "Failed to push_expand to %u",
                                      ndr->alloc_size);
@@ -256,6 +243,27 @@ done:
        return NT_STATUS_OK;
 }
 
+/*
+  pull a constant size array of structures
+*/
+NTSTATUS ndr_pull_struct_array(struct ndr_pull *ndr, uint32_t count,
+                              size_t elsize, void **info,
+                              NTSTATUS (*pull_fn)(struct ndr_pull *, int, void *))
+{
+       int i;
+       char *base;
+
+       NDR_ALLOC_N_SIZE(ndr, *info, count, elsize);
+       base = (char *)*info;
+
+       for (i = 0; i < count; i++) {
+               ndr->data += ndr->offset;
+               ndr->offset = 0;
+               NDR_CHECK(pull_fn(ndr, NDR_SCALARS|NDR_BUFFERS, &base[count * elsize]));
+       }
+
+       return NT_STATUS_OK;
+}
 
 /*
   print a generic array
@@ -282,7 +290,7 @@ void ndr_print_array(struct ndr_print *ndr, const char *name, void *base,
 
 
 
-void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...)
+void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) _PRINTF_ATTRIBUTE(2,3)
 {
        va_list ap;
        char *s = NULL;
@@ -303,9 +311,7 @@ void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...)
 /*
   a useful helper function for printing idl structures via DEBUG()
 */
-void ndr_print_debug(void (*fn)(struct ndr_print *, const char *, void *),
-                    const char *name,
-                    void *ptr)
+void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr)
 {
        struct ndr_print *ndr;
 
@@ -322,10 +328,7 @@ void ndr_print_debug(void (*fn)(struct ndr_print *, const char *, void *),
 /*
   a useful helper function for printing idl unions via DEBUG()
 */
-void ndr_print_union_debug(void (*fn)(struct ndr_print *, const char *, uint32_t, void *),
-                          const char *name,
-                          uint32_t level,
-                          void *ptr)
+void ndr_print_union_debug(ndr_print_union_fn_t fn, const char *name, uint32_t level, void *ptr)
 {
        struct ndr_print *ndr;
 
@@ -341,10 +344,7 @@ void ndr_print_union_debug(void (*fn)(struct ndr_print *, const char *, uint32_t
 /*
   a useful helper function for printing idl function calls via DEBUG()
 */
-void ndr_print_function_debug(void (*fn)(struct ndr_print *, const char *, int , void *),
-                             const char *name,
-                             int flags,
-                             void *ptr)
+void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr)
 {
        struct ndr_print *ndr;
 
@@ -357,14 +357,31 @@ void ndr_print_function_debug(void (*fn)(struct ndr_print *, const char *, int ,
        talloc_free(ndr);
 }
 
+void ndr_set_flags(uint32_t *pflags, uint32_t new_flags)
+{
+       /* the big/little endian flags are inter-dependent */
+       if (new_flags & LIBNDR_FLAG_LITTLE_ENDIAN) {
+               (*pflags) &= ~LIBNDR_FLAG_BIGENDIAN;
+       }
+       if (new_flags & LIBNDR_FLAG_BIGENDIAN) {
+               (*pflags) &= ~LIBNDR_FLAG_LITTLE_ENDIAN;
+       }
+       (*pflags) |= new_flags;
+}
 
 static NTSTATUS ndr_map_error(enum ndr_err_code err)
 {
        switch (err) {
        case NDR_ERR_BUFSIZE:
                return NT_STATUS_BUFFER_TOO_SMALL;
+       case NDR_ERR_TOKEN:
+               return NT_STATUS_INTERNAL_ERROR;
        case NDR_ERR_ALLOC:
                return NT_STATUS_NO_MEMORY;
+       case NDR_ERR_ARRAY_SIZE:
+               return NT_STATUS_ARRAY_BOUNDS_EXCEEDED;
+       default:
+               break;
        }
 
        /* we should all error codes to different status codes */
@@ -394,7 +411,7 @@ NTSTATUS ndr_pull_error(struct ndr_pull *ndr,
 /*
   return and possibly log an NDR error
 */
-NTSTATUS ndr_push_error(struct ndr_push *ndr, enum ndr_err_code err, const char *format, ...)
+NTSTATUS ndr_push_error(struct ndr_push *ndr, enum ndr_err_code err, const char *format, ...)  _PRINTF_ATTRIBUTE(3,4)
 {
        char *s=NULL;
        va_list ap;
@@ -453,10 +470,8 @@ static NTSTATUS ndr_pull_subcontext_header(struct ndr_pull *ndr,
   handle subcontext buffers, which in midl land are user-marshalled, but
   we use magic in pidl to make them easier to cope with
 */
-NTSTATUS ndr_pull_subcontext_fn(struct ndr_pull *ndr, 
-                               size_t sub_size,
-                               void *base,
-                               NTSTATUS (*fn)(struct ndr_pull *, void *))
+NTSTATUS ndr_pull_subcontext_fn(struct ndr_pull *ndr, size_t sub_size, 
+                               void *base, ndr_pull_fn_t fn)
 {
        struct ndr_pull *ndr2;
        NDR_ALLOC(ndr, ndr2);
@@ -471,10 +486,8 @@ NTSTATUS ndr_pull_subcontext_fn(struct ndr_pull *ndr,
 }
 
 
-NTSTATUS ndr_pull_subcontext_flags_fn(struct ndr_pull *ndr, 
-                                     size_t sub_size,
-                                     void *base,
-                                     NTSTATUS (*fn)(struct ndr_pull *, int , void *))
+NTSTATUS ndr_pull_subcontext_flags_fn(struct ndr_pull *ndr, size_t sub_size,
+                                     void *base, ndr_pull_flags_fn_t fn)
 {
        struct ndr_pull *ndr2;
        NDR_ALLOC(ndr, ndr2);
@@ -488,11 +501,8 @@ NTSTATUS ndr_pull_subcontext_flags_fn(struct ndr_pull *ndr,
        return NT_STATUS_OK;
 }
 
-NTSTATUS ndr_pull_subcontext_union_fn(struct ndr_pull *ndr, 
-                                     size_t sub_size,
-                                     uint32_t level,
-                                     void *base,
-                                     NTSTATUS (*fn)(struct ndr_pull *, int , uint32_t , void *))
+NTSTATUS ndr_pull_subcontext_union_fn(struct ndr_pull *ndr, size_t sub_size,
+                                     uint32_t level, void *base, ndr_pull_union_fn_t fn)
 {
        struct ndr_pull *ndr2;
 
@@ -538,10 +548,8 @@ static NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr,
   handle subcontext buffers, which in midl land are user-marshalled, but
   we use magic in pidl to make them easier to cope with
 */
-NTSTATUS ndr_push_subcontext_fn(struct ndr_push *ndr, 
-                               size_t sub_size,
-                               void *base,
-                               NTSTATUS (*fn)(struct ndr_push *, void *))
+NTSTATUS ndr_push_subcontext_fn(struct ndr_push *ndr, size_t sub_size, 
+                               void *base, ndr_push_fn_t fn)
 {
        struct ndr_push *ndr2;
 
@@ -558,10 +566,8 @@ NTSTATUS ndr_push_subcontext_fn(struct ndr_push *ndr,
 /*
   handle subcontext buffers for function that take a flags arg
 */
-NTSTATUS ndr_push_subcontext_flags_fn(struct ndr_push *ndr, 
-                                     size_t sub_size,
-                                     void *base,
-                                     NTSTATUS (*fn)(struct ndr_push *, int, void *))
+NTSTATUS ndr_push_subcontext_flags_fn(struct ndr_push *ndr, size_t sub_size,
+                                     void *base, ndr_push_flags_fn_t fn)
 {
        struct ndr_push *ndr2;
 
@@ -578,11 +584,8 @@ NTSTATUS ndr_push_subcontext_flags_fn(struct ndr_push *ndr,
 /*
   handle subcontext buffers for function that take a union
 */
-NTSTATUS ndr_push_subcontext_union_fn(struct ndr_push *ndr, 
-                                     size_t sub_size,
-                                     uint32_t level,
-                                     void *base,
-                                     NTSTATUS (*fn)(struct ndr_push *, int, uint32_t, void *))
+NTSTATUS ndr_push_subcontext_union_fn(struct ndr_push *ndr, size_t sub_size,
+                                     uint32_t level, void *base, ndr_push_union_fn_t fn)
 {
        struct ndr_push *ndr2;
 
@@ -627,45 +630,6 @@ void ndr_push_struct_end(struct ndr_push *ndr)
 {
 }
 
-
-/*
-  pull a relative structure
-*/
-NTSTATUS ndr_pull_relative(struct ndr_pull *ndr, const void **buf, size_t size, 
-                          NTSTATUS (*fn)(struct ndr_pull *, int ndr_flags, void *))
-{
-       struct ndr_pull *ndr2;
-       uint32_t ofs;
-       struct ndr_pull_save save;
-       void *p;
-
-       NDR_ALLOC(ndr, ndr2);
-       NDR_CHECK(ndr_pull_uint32(ndr, &ofs));
-       if (ofs == 0) {
-               (*buf) = NULL;
-               return NT_STATUS_OK;
-       }
-       ndr_pull_save(ndr, &save);
-        /* the old way of handling relative pointers appears to be
-          wrong, and there doesn't seem to be anything relying on it,
-          but I am keeping the code around in case I missed a
-          critical use for it (tridge, august 2004) */
-       NDR_CHECK(ndr_pull_set_offset(ndr, ofs));
-       NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, ndr->data_size - ndr->offset));
-       /* strings must be allocated by the backend functions */
-       if (ndr->flags & LIBNDR_STRING_FLAGS) {
-               NDR_CHECK(fn(ndr2, NDR_SCALARS|NDR_BUFFERS, &p));
-       } else {
-               NDR_ALLOC_SIZE(ndr, p, size);
-               NDR_CHECK(fn(ndr2, NDR_SCALARS|NDR_BUFFERS, p));
-       }
-       (*buf) = p;
-       ndr_pull_restore(ndr, &save);
-       talloc_free(ndr2);
-       return NT_STATUS_OK;
-}
-
-
 /*
   store a token in the ndr context, for later retrieval
 */
@@ -688,18 +652,103 @@ static NTSTATUS ndr_token_store(TALLOC_CTX *mem_ctx,
 /*
   retrieve a token from a ndr context
 */
-static uint32_t ndr_token_retrieve(struct ndr_token_list **list, const void *key)
+static NTSTATUS ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
 {
        struct ndr_token_list *tok;
        for (tok=*list;tok;tok=tok->next) {
                if (tok->key == key) {
                        DLIST_REMOVE((*list), tok);
+                       *v = tok->value;
+                       return NT_STATUS_OK;
+               }
+       }
+       return ndr_map_error(NDR_ERR_TOKEN);
+}
+
+/*
+  peek at but don't removed a token from a ndr context
+*/
+static uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
+{
+       struct ndr_token_list *tok;
+       for (tok=*list;tok;tok=tok->next) {
+               if (tok->key == key) {
                        return tok->value;
                }
        }
        return 0;
 }
 
+/*
+  pull an array size field and add it to the array_size_list token list
+*/
+NTSTATUS ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
+{
+       uint32_t size;
+       NDR_CHECK(ndr_pull_uint32(ndr, &size));
+       return ndr_token_store(ndr, &ndr->array_size_list, p, size);
+}
+
+/*
+  get the stored array size field
+*/
+uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
+{
+       return ndr_token_peek(&ndr->array_size_list, p);
+}
+
+/*
+  check the stored array size field
+*/
+NTSTATUS ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
+{
+       uint32_t stored;
+       NDR_CHECK(ndr_token_retrieve(&ndr->array_size_list, p, &stored));
+       if (stored != size) {
+               return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, 
+                                     "Bad array size - got %u expected %u\n",
+                                     stored, size);
+       }
+       return NT_STATUS_OK;
+}
+
+/*
+  pull an array length field and add it to the array_length_list token list
+*/
+NTSTATUS ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
+{
+       uint32_t length, offset;
+       NDR_CHECK(ndr_pull_uint32(ndr, &offset));
+       if (offset != 0) {
+               return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, 
+                                     "non-zero array offset %u\n", offset);
+       }
+       NDR_CHECK(ndr_pull_uint32(ndr, &length));
+       return ndr_token_store(ndr, &ndr->array_length_list, p, length);
+}
+
+/*
+  get the stored array length field
+*/
+uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
+{
+       return ndr_token_peek(&ndr->array_length_list, p);
+}
+
+/*
+  check the stored array length field
+*/
+NTSTATUS ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
+{
+       uint32_t stored;
+       NDR_CHECK(ndr_token_retrieve(&ndr->array_length_list, p, &stored));
+       if (stored != length) {
+               return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, 
+                                     "Bad array length - got %u expected %u\n",
+                                     stored, length);
+       }
+       return NT_STATUS_OK;
+}
 
 /*
   pull a relative object - stage1
@@ -707,7 +756,12 @@ static uint32_t ndr_token_retrieve(struct ndr_token_list **list, const void *key
 */
 NTSTATUS ndr_pull_relative1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
 {
-       return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
+       if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
+               return ndr_token_store(ndr, &ndr->relative_list, p, 
+                                      rel_offset + ndr->offset - 4);
+       } else {
+               return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
+       }
 }
 
 /*
@@ -717,10 +771,7 @@ NTSTATUS ndr_pull_relative1(struct ndr_pull *ndr, const void *p, uint32_t rel_of
 NTSTATUS ndr_pull_relative2(struct ndr_pull *ndr, const void *p)
 {
        uint32_t rel_offset;
-       rel_offset = ndr_token_retrieve(&ndr->relative_list, p);
-       if (rel_offset == 0) {
-               return NT_STATUS_INTERNAL_ERROR;
-       }
+       NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
        return ndr_pull_set_offset(ndr, rel_offset);
 }
 
@@ -751,11 +802,12 @@ NTSTATUS ndr_push_relative2(struct ndr_push *ndr, const void *p)
        }
        NDR_CHECK(ndr_push_align(ndr, 4));
        ndr_push_save(ndr, &save);
-       ndr->offset = ndr_token_retrieve(&ndr->relative_list, p);
-       if (ndr->offset == 0) {
-               return NT_STATUS_INTERNAL_ERROR;
+       NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ndr->offset));
+       if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
+               NDR_CHECK(ndr_push_uint32(ndr, save.offset - ndr->offset));
+       } else {
+               NDR_CHECK(ndr_push_uint32(ndr, save.offset));
        }
-       NDR_CHECK(ndr_push_uint32(ndr, save.offset));
        ndr_push_restore(ndr, &save);
        return NT_STATUS_OK;
 }
@@ -765,7 +817,7 @@ NTSTATUS ndr_push_relative2(struct ndr_push *ndr, const void *p)
   pull a union from a blob using NDR
 */
 NTSTATUS ndr_pull_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, uint32_t level, void *p,
-                            NTSTATUS (*fn)(struct ndr_pull *, int ndr_flags, uint32_t, void *))
+                            ndr_pull_union_fn_t fn)
 {
        struct ndr_pull *ndr;
        ndr = ndr_pull_init_blob(blob, mem_ctx);
@@ -779,7 +831,7 @@ NTSTATUS ndr_pull_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, uint32_t leve
   pull a struct from a blob using NDR
 */
 NTSTATUS ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
-                             NTSTATUS (*fn)(struct ndr_pull *, int , void *))
+                             ndr_pull_flags_fn_t fn)
 {
        struct ndr_pull *ndr;
        ndr = ndr_pull_init_blob(blob, mem_ctx);
@@ -793,7 +845,7 @@ NTSTATUS ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *
   push a struct to a blob using NDR
 */
 NTSTATUS ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
-                             NTSTATUS (*fn)(struct ndr_push *, int , void *))
+                             ndr_push_flags_fn_t fn)
 {
        NTSTATUS status;
        struct ndr_push *ndr;