Revert "librpc/ndr: change ndr_pull/push/print flags to uint64_t"
[metze/samba/wip.git] / librpc / ndr / libndr.h
index b349c82fb79176e8bb12184b981d8847c007da96..8a15fccfe09ae6846cee4ee26ab5409be9f9ab40 100644 (file)
@@ -26,7 +26,7 @@
 #define __LIBNDR_H__
 
 #include <talloc.h>
-#include "../lib/util/memory.h" /* for discard_const */
+#include "../lib/util/discard.h" /* for discard_const */
 #include "../lib/util/byteorder.h"
 #include "../lib/util/data_blob.h"
 #include "../lib/util/time.h"
 
 
 /*
-  this is used by the token store/retrieve code
+  We store the token mapping in an array that is resized as necessary.
 */
+struct ndr_token;
+
 struct ndr_token_list {
-       struct ndr_token_list *next, *prev;
-       const void *key;
-       uint32_t value;
+       struct ndr_token *tokens;
+       uint32_t count;
 };
 
-/* this is the base structure passed to routines that 
-   parse MSRPC formatted data 
+struct ndr_compression_state;
+
+/* this is the base structure passed to routines that
+   parse MSRPC formatted data
 
    note that in Samba4 we use separate routines and structures for
    MSRPC marshalling and unmarshalling. Also note that these routines
@@ -63,12 +66,14 @@ struct ndr_pull {
        uint32_t relative_highest_offset;
        uint32_t relative_base_offset;
        uint32_t relative_rap_convert;
-       struct ndr_token_list *relative_base_list;
+       struct ndr_token_list relative_base_list;
+
+       struct ndr_token_list relative_list;
+       struct ndr_token_list array_size_list;
+       struct ndr_token_list array_length_list;
+       struct ndr_token_list switch_list;
 
-       struct ndr_token_list *relative_list;
-       struct ndr_token_list *array_size_list;
-       struct ndr_token_list *array_length_list;
-       struct ndr_token_list *switch_list;
+       struct ndr_compression_state *cstate;
 
        TALLOC_CTX *current_mem_ctx;
 
@@ -84,17 +89,19 @@ struct ndr_push {
        uint32_t alloc_size;
        uint32_t offset;
        bool fixed_buf_size;
-       
+
        uint32_t relative_base_offset;
        uint32_t relative_end_offset;
-       struct ndr_token_list *relative_base_list;
+       struct ndr_token_list relative_base_list;
+
+       struct ndr_token_list switch_list;
+       struct ndr_token_list relative_list;
+       struct ndr_token_list relative_begin_list;
+       struct ndr_token_list nbt_string_list;
+       struct ndr_token_list dns_string_list;
+       struct ndr_token_list full_ptr_list;
 
-       struct ndr_token_list *switch_list;
-       struct ndr_token_list *relative_list;
-       struct ndr_token_list *relative_begin_list;
-       struct ndr_token_list *nbt_string_list;
-       struct ndr_token_list *dns_string_list;
-       struct ndr_token_list *full_ptr_list;
+       struct ndr_compression_state *cstate;
 
        /* this is used to ensure we generate unique reference IDs */
        uint32_t ptr_count;
@@ -104,30 +111,49 @@ struct ndr_push {
 struct ndr_print {
        uint32_t flags; /* LIBNDR_FLAG_* */
        uint32_t depth;
-       struct ndr_token_list *switch_list;
+       struct ndr_token_list switch_list;
        void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
        void *private_data;
        bool no_newline;
+       bool print_secrets;
 };
 
-#define LIBNDR_FLAG_BIGENDIAN  (1<<0)
-#define LIBNDR_FLAG_NOALIGN    (1<<1)
-
-#define LIBNDR_FLAG_STR_ASCII          (1<<2)
-#define LIBNDR_FLAG_STR_LEN4           (1<<3)
-#define LIBNDR_FLAG_STR_SIZE4          (1<<4)
-#define LIBNDR_FLAG_STR_NOTERM         (1<<5)
-#define LIBNDR_FLAG_STR_NULLTERM       (1<<6)
-#define LIBNDR_FLAG_STR_SIZE2          (1<<7)
-#define LIBNDR_FLAG_STR_BYTESIZE       (1<<8)
-#define LIBNDR_FLAG_STR_CONFORMANT     (1<<10)
-#define LIBNDR_FLAG_STR_CHARLEN                (1<<11)
-#define LIBNDR_FLAG_STR_UTF8           (1<<12)
-#define LIBNDR_FLAG_STR_RAW8           (1<<13)
-#define LIBNDR_STRING_FLAGS            (0x7FFC)
+#define LIBNDR_FLAG_BIGENDIAN  (1U<<0)
+#define LIBNDR_FLAG_NOALIGN    (1U<<1)
+
+#define LIBNDR_FLAG_STR_ASCII          (1U<<2)
+#define LIBNDR_FLAG_STR_LEN4           (1U<<3)
+#define LIBNDR_FLAG_STR_SIZE4          (1U<<4)
+#define LIBNDR_FLAG_STR_NOTERM         (1U<<5)
+#define LIBNDR_FLAG_STR_NULLTERM       (1U<<6)
+#define LIBNDR_FLAG_STR_SIZE2          (1U<<7)
+#define LIBNDR_FLAG_STR_BYTESIZE       (1U<<8)
+#define LIBNDR_FLAG_STR_CONFORMANT     (1U<<10)
+#define LIBNDR_FLAG_STR_CHARLEN                (1U<<11)
+#define LIBNDR_FLAG_STR_UTF8           (1U<<12)
+#define LIBNDR_FLAG_STR_RAW8           (1U<<13)
+#define LIBNDR_STRING_FLAGS            (0U | \
+               LIBNDR_FLAG_STR_ASCII | \
+               LIBNDR_FLAG_STR_LEN4 | \
+               LIBNDR_FLAG_STR_SIZE4 | \
+               LIBNDR_FLAG_STR_NOTERM | \
+               LIBNDR_FLAG_STR_NULLTERM | \
+               LIBNDR_FLAG_STR_SIZE2 | \
+               LIBNDR_FLAG_STR_BYTESIZE | \
+               LIBNDR_FLAG_STR_CONFORMANT | \
+               LIBNDR_FLAG_STR_CHARLEN | \
+               LIBNDR_FLAG_STR_UTF8 | \
+               LIBNDR_FLAG_STR_RAW8 | \
+               0)
+
+/*
+ * Mark an element as SECRET, it won't be printed by
+ * via ndr_print* unless NDR_PRINT_SECRETS is specified.
+ */
+#define LIBNDR_FLAG_IS_SECRET          (1U<<14)
 
 /* Disable string token compression  */
-#define LIBNDR_FLAG_NO_COMPRESSION     (1<<15)
+#define LIBNDR_FLAG_NO_COMPRESSION     (1U<<15)
 
 /*
  * don't debug NDR_ERR_BUFSIZE failures,
@@ -135,25 +161,25 @@ struct ndr_print {
  *
  * return NDR_ERR_INCOMPLETE_BUFFER instead.
  */
-#define LIBNDR_FLAG_INCOMPLETE_BUFFER (1<<16)
+#define LIBNDR_FLAG_INCOMPLETE_BUFFER (1U<<16)
 
 /*
  * This lets ndr_pull_subcontext_end() return
  * NDR_ERR_UNREAD_BYTES.
  */
-#define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1<<17)
+#define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1U<<17)
 
 /* set if relative pointers should *not* be marshalled in reverse order */
-#define LIBNDR_FLAG_NO_RELATIVE_REVERSE        (1<<18)
+#define LIBNDR_FLAG_NO_RELATIVE_REVERSE        (1U<<18)
 
 /* set if relative pointers are marshalled in reverse order */
-#define LIBNDR_FLAG_RELATIVE_REVERSE   (1<<19)
+#define LIBNDR_FLAG_RELATIVE_REVERSE   (1U<<19)
 
-#define LIBNDR_FLAG_REF_ALLOC    (1<<20)
-#define LIBNDR_FLAG_REMAINING    (1<<21)
-#define LIBNDR_FLAG_ALIGN2       (1<<22)
-#define LIBNDR_FLAG_ALIGN4       (1<<23)
-#define LIBNDR_FLAG_ALIGN8       (1<<24)
+#define LIBNDR_FLAG_REF_ALLOC    (1U<<20)
+#define LIBNDR_FLAG_REMAINING    (1U<<21)
+#define LIBNDR_FLAG_ALIGN2       (1U<<22)
+#define LIBNDR_FLAG_ALIGN4       (1U<<23)
+#define LIBNDR_FLAG_ALIGN8       (1U<<24)
 
 #define LIBNDR_ALIGN_FLAGS ( 0        | \
                LIBNDR_FLAG_NOALIGN   | \
@@ -163,22 +189,22 @@ struct ndr_print {
                LIBNDR_FLAG_ALIGN8    | \
                0)
 
-#define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
-#define LIBNDR_PRINT_SET_VALUES  (1<<26)
+#define LIBNDR_PRINT_ARRAY_HEX   (1U<<25)
+#define LIBNDR_PRINT_SET_VALUES  (1U<<26)
 
 /* used to force a section of IDL to be little-endian */
-#define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
+#define LIBNDR_FLAG_LITTLE_ENDIAN (1U<<27)
 
 /* used to check if alignment padding is zero */
-#define LIBNDR_FLAG_PAD_CHECK     (1<<28)
+#define LIBNDR_FLAG_PAD_CHECK     (1U<<28)
 
-#define LIBNDR_FLAG_NDR64         (1<<29)
+#define LIBNDR_FLAG_NDR64         (1U<<29)
 
 /* set if an object uuid will be present */
-#define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
+#define LIBNDR_FLAG_OBJECT_PRESENT    (1U<<30)
 
 /* set to avoid recursion in ndr_size_*() calculation */
-#define LIBNDR_FLAG_NO_NDR_SIZE                (1<<31)
+#define LIBNDR_FLAG_NO_NDR_SIZE                (1U<<31)
 
 /* useful macro for debugging */
 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
@@ -197,6 +223,9 @@ struct ndr_print {
 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
 
+#define NDR_HIDE_SECRET(ndr) \
+       (unlikely(((ndr)->flags & LIBNDR_FLAG_IS_SECRET) && !(ndr)->print_secrets))
+
 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
 
 enum ndr_err_code {
@@ -233,6 +262,7 @@ enum ndr_err_code {
 } while (0)
 
 enum ndr_compression_alg {
+       NDR_COMPRESSION_MSZIP_CAB = 1,
        NDR_COMPRESSION_MSZIP   = 2,
        NDR_COMPRESSION_XPRESS  = 3
 };
@@ -381,6 +411,13 @@ enum ndr_compression_alg {
        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
 } while (0)
 
+#define NDR_ZERO_STRUCT(x) ndr_zero_memory(&(x), sizeof(x))
+#define NDR_ZERO_STRUCTP(x) do { \
+       if ((x) != NULL) { \
+               ndr_zero_memory((x), sizeof(*(x))); \
+       } \
+} while(0)
+
 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
@@ -463,6 +500,7 @@ void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct do
 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
 void ndr_print_sockaddr_storage(struct ndr_print *ndr, const char *name, const struct sockaddr_storage *ss);
+void ndr_zero_memory(void *ptr, size_t len);
 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
 char *ndr_syntax_id_to_string(TALLOC_CTX *mem_ctx, const struct ndr_syntax_id *id);
 bool ndr_syntax_id_from_string(const char *s, struct ndr_syntax_id *id);
@@ -534,12 +572,13 @@ enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
                                 size_t header_size,
                                 ssize_t size_is);
 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
-                        struct ndr_token_list **list, 
-                        const void *key, 
+                        struct ndr_token_list *list,
+                        const void *key,
                         uint32_t value);
-enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list **list, const void *key, uint32_t *v, int(*_cmp_fn)(const void*,const void*), bool _remove_tok);
-enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v);
-uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key);
+enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list *list, const void *key, uint32_t *v,
+                                           int(*_cmp_fn)(const void*,const void*), bool erase);
+enum ndr_err_code ndr_token_retrieve(struct ndr_token_list *list, const void *key, uint32_t *v);
+uint32_t ndr_token_peek(struct ndr_token_list *list, const void *key);
 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);