r10781: merging eventlog and svcctl code from trunk
[kai/samba.git] / source3 / include / rpc_misc.h
index 6abc85a4cac6c36fd9ec512fe64acfe217b23a84..091ba3395e027ba4ab668f8071bae9289a57be44 100644 (file)
@@ -1,9 +1,10 @@
 /* 
    Unix SMB/CIFS implementation.
-   SMB parameters and setup
-   Copyright (C) Andrew Tridgell 1992-1997
-   Copyright (C) Luke Kenneth Casson Leighton 1996-1997
-   Copyright (C) Paul Ashton 1997
+
+   Copyright (C) Andrew Tridgell                1992-1997
+   Copyright (C) Luke Kenneth Casson Leighton   1996-1997
+   Copyright (C) Paul Ashton                    1997
+   Copyright (C) Gerald (Jerry) Carter          2005
    
    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
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#include "ntdomain.h"
-#include "rpc_dce.h"
-
 #ifndef _RPC_MISC_H /* _RPC_MISC_H */
 #define _RPC_MISC_H 
 
 #define SMB_RPC_INTERFACE_VERSION 1
+#define PRS_POINTER_CAST BOOL (*)(const char*, prs_struct*, int, void*)
+
+enum unistr2_term_codes { UNI_FLAGS_NONE = 0, UNI_STR_TERMINATE = 1, UNI_MAXLEN_TERMINATE = 2, UNI_BROKEN_NON_NULL = 3, UNI_STR_DBLTERMINATE = 4 };
 
-/* well-known RIDs - Relative IDs */
+
+
+/********************************************************************** 
+ * well-known RIDs - Relative IDs
+ **********************************************************************/
 
 /* RIDs - Well-known users ... */
 #define DOMAIN_USER_RID_ADMIN          (0x000001F4L)
 #define BUILTIN_ALIAS_RID_RAS_SERVERS   (0x00000229L)
 #define BUILTIN_ALIAS_RID_PRE_2K_ACCESS (0x0000022aL)
 
-/*
+
+/********************************************************************** 
  * Masks for mappings between unix uid and gid types and
  * NT RIDS.
- */
-
+ **********************************************************************/
 
 #define BASE_RID (0x000003E8L)
 
 /* Take the bottom bit. */
-#define RID_TYPE_MASK 1
-#define RID_MULTIPLIER 2
+#define RID_TYPE_MASK          1
+#define RID_MULTIPLIER                 2
 
 /* The two common types. */
-#define USER_RID_TYPE 0
-#define GROUP_RID_TYPE 1
+#define USER_RID_TYPE          0
+#define GROUP_RID_TYPE                 1
 
-/* ENUM_HND */
-typedef struct enum_hnd_info
-{
+
+
+/********************************************************************** 
+ * RPC policy handle used pretty much everywhere
+ **********************************************************************/
+typedef struct {
        uint32 ptr_hnd;          /* pointer to enumeration handle */
        uint32 handle;           /* enumeration handle */
 } ENUM_HND;
 
-/* LOOKUP_LEVEL - switch value */
-typedef struct lookup_level_info
-{
-       uint16 value;
-} LOOKUP_LEVEL;
 
-/* DOM_SID2 - security id */
-typedef struct sid_info_2
-{
-       uint32 num_auths; /* length, bytes, including length of len :-) */
-       DOM_SID sid;
-} DOM_SID2;
 
-/* STRHDR - string header */
-typedef struct header_info
-{
-       uint16 str_str_len;
-       uint16 str_max_len;
-       uint32 buffer; /* non-zero */
-} STRHDR;
+/********************************************************************** 
+ * RPC policy handle used pretty much everywhere
+ **********************************************************************/
 
-/* UNIHDR - unicode string header */
-typedef struct unihdr_info
-{
-       uint16 uni_str_len;
-       uint16 uni_max_len;
-       uint32 buffer; /* usually has a value of 4 */
-} UNIHDR;
+typedef struct {
+       uint32 data1;
+       uint32 data2;
+       uint16 data3;
+       uint16 data4;
+       uint8 data5[8];
+#ifdef __INSURE__
 
-/* UNIHDR2 - unicode string header and undocumented buffer */
-typedef struct unihdr2_info
-{
-       UNIHDR unihdr;
-       uint32 buffer; /* 32 bit buffer pointer */
-} UNIHDR2;
+       /* To prevent the leakage of policy handles mallocate a bit of
+          memory when a policy handle is created and free it when the
+          handle is closed.  This should cause Insure to flag an error
+          when policy handles are overwritten or fall out of scope without
+          being freed. */
 
-/* UNISTR - unicode string size and buffer */
-typedef struct unistr_info
-{
-       /* unicode characters. ***MUST*** be little-endian. ***MUST*** be null-terminated */
-       uint16 *buffer;
-} UNISTR;
+       char *marker;
+#endif
+} POLICY_HND;
 
-/* BUFHDR - buffer header */
-typedef struct bufhdr_info
-{
+
+/********************************************************************** 
+ * Buffer Headers -- use by SEC_DESC_BUF in winreg and netlogon code
+ **********************************************************************/
+/* TODO: replace this with an encompassing buffer structure */
+typedef struct {
        uint32 buf_max_len;
        uint32 buf_len;
 } BUFHDR;
 
-/* BUFFER2 - unicode string, size (in uint8 ascii chars) and buffer */
-/* pathetic.  some stupid team of \PIPE\winreg writers got the concept */
-/* of a unicode string different from the other \PIPE\ writers */
-typedef struct buffer2_info
-{
+/* this is a BUFHDR + a pointer to a buffer */
+typedef struct {
+       uint32 info_level;
+       uint32 length;          /* uint8 chars */
+       uint32 buffer;
+} BUFHDR2;
+
+/* generic buffer ?  wrapped around void*? */
+typedef struct {
+       uint32 size;
+       uint32 buffer;
+} BUFHDR4;
+
+
+/********************************************************************** 
+ * Buffers 
+ **********************************************************************/
+
+/* buffer used by \winreg\ calls to fill in arbitrary REG_XXX values.
+   It *may* look like a UNISTR2 but it is *not*.  This is not a goof
+   by the winreg developers.  It is a generic buffer.  buffer length
+   is stored in bytes (not # of uint16's) */
+
+typedef struct {
        uint32 buf_max_len;
        uint32 offset;
        uint32 buf_len;
-       /* unicode characters. ***MUST*** be little-endian. **NOT** necessarily null-terminated */
        uint16 *buffer;
-} BUFFER2;
+} REGVAL_BUFFER;
 
-/* BUFFER3 */
-typedef struct buffer3_info
-{
-       uint32 buf_max_len;
-       uint8  *buffer; /* Data */
+/* generic rpc version of the DATA_BLOB.  Just a length and uint8 array */
+
+typedef struct {
        uint32 buf_len;
-} BUFFER3;
+       uint8 *buffer;
+} RPC_DATA_BLOB;
 
-/* BUFFER5 */
-typedef struct buffer5_info
-{
+/********************************************************************** 
+ * Buffers use by spoolss (i might be able to replace it with
+ * an RPC_DATA_BLOB)
+ **********************************************************************/
+
+typedef struct {
        uint32 buf_len;
        uint16 *buffer; /* data */
 } BUFFER5;
 
-/* UNISTR2 - unicode string size (in uint16 unicode chars) and buffer */
-typedef struct unistr2_info
-{
+
+/********************************************************************** 
+ * Unicode and basic string headers 
+ **********************************************************************/
+typedef struct {
+       uint16 str_str_len;
+       uint16 str_max_len;
+       uint32 buffer; /* non-zero */
+} STRHDR;
+
+typedef struct {
+       uint16 uni_str_len;
+       uint16 uni_max_len;
+       uint32 buffer; 
+} UNIHDR;
+
+/********************************************************************** 
+ * UNICODE string variations
+ **********************************************************************/
+
+
+typedef struct {               /* UNISTR - unicode string size and buffer */
+       uint16 *buffer;         /* unicode characters. ***MUST*** be 
+                                  little-endian. ***MUST*** be null-terminated */
+} UNISTR;
+
+typedef struct {               /* UNISTR2 - unicode string size (in 
+                                  uint16 unicode chars) and buffer */
        uint32 uni_max_len;
        uint32 offset;
        uint32 uni_str_len;
-       /* unicode characters. ***MUST*** be little-endian. 
-               **must** be null-terminated and the uni_str_len should include
-               the NULL character */
-       uint16 *buffer;
+       uint16 *buffer;         /* unicode characters. ***MUST*** be little-endian. 
+                                 **must** be null-terminated and the uni_str_len 
+                                 should include the NULL character */
 } UNISTR2;
 
-/* STRING2 - string size (in uint8 chars) and buffer */
-typedef struct string2_info
-{
+/* i think this is the same as a BUFFER5 used in the spoolss code --jerry */
+/* not sure about how the termination matches between the uint16 buffers thought */
+
+typedef struct {               /* UNISTR3 - XXXX not sure about this structure */
+       uint32 uni_str_len;
+       UNISTR str;
+} UNISTR3;
+
+typedef struct {               /* Buffer wrapped around a UNISTR2 */
+       uint16 length;          /* number of bytes not counting NULL terminatation */
+       uint16 size;            /* number of bytes including NULL terminatation */
+       UNISTR2 *string;
+} UNISTR4;
+
+typedef struct {
+       uint32 count;
+       UNISTR4 *strings;
+} UNISTR4_ARRAY;
+
+
+/********************************************************************** 
+ * String variations
+ **********************************************************************/
+
+typedef struct {               /* STRING2 - string size (in uint8 chars) and buffer */
        uint32 str_max_len;
        uint32 offset;
        uint32 str_str_len;
-       uint8  *buffer; /* uint8 characters. **NOT** necessarily null-terminated */
+       uint8  *buffer;         /* uint8 characters. **NOT** necessarily null-terminated */
 } STRING2;
 
-/* UNISTR3 - XXXX not sure about this structure */
-typedef struct unistr3_info
-{
-       uint32 uni_str_len;
-       UNISTR str;
 
-} UNISTR3;
 
-/* an element in a unicode string array */
-typedef struct
-{
-       uint16 length;
-       uint16 size;
-       uint32 ref_id;
-       UNISTR2 string;
-} UNISTR2_ARRAY_EL;
-
-/* an array of unicode strings */
-typedef struct 
-{
-       uint32 ref_id;
-       uint32 count;
-       UNISTR2_ARRAY_EL *strings;
-} UNISTR2_ARRAY;
 
+/********************************************************************** 
+ * Domain SID structures
+ **********************************************************************/
 
-/* an element in a sid array */
-typedef struct
-{
-       uint32 ref_id;
-       DOM_SID2 sid;
-} SID_ARRAY_EL;
+typedef struct {
+       uint32 num_auths; /* length, bytes, including length of len :-) */
+       DOM_SID sid;
+} DOM_SID2;
 
-/* an array of sids */
-typedef struct 
-{
-       uint32 ref_id;
-       uint32 count;
-       SID_ARRAY_EL *sids;
-} SID_ARRAY;
+
+/********************************************************************** 
+ * Domain SID structures
+ **********************************************************************/
 
 /* DOM_RID2 - domain RID structure for ntlsa pipe */
-typedef struct domrid2_info
-{
+typedef struct {
        uint8 type; /* value is SID_NAME_USE enum */
        uint32 rid;
        uint32 rid_idx; /* referenced domain index */
-
 } DOM_RID2;
 
-/* DOM_RID3 - domain RID structure for samr pipe */
-typedef struct domrid3_info
-{
+
+typedef struct {               /* DOM_RID3 - domain RID structure for samr pipe */
        uint32 rid;        /* domain-relative (to a SID) id */
        uint32 type1;      /* value is 0x1 */
        uint32 ptr_type;   /* undocumented pointer */
        uint32 type2;      /* value is 0x1 */
        uint32 unk; /* value is 0x2 */
-
 } DOM_RID3;
 
 /* DOM_RID4 - rid + user attributes */
@@ -255,9 +288,18 @@ typedef struct domrid4_info
        uint32 rid;  /* user RID */
 } DOM_RID4;
 
+/* DOM_GID - group id + user attributes */
+typedef struct {
+       uint32 g_rid;  /* a group RID */
+       uint32 attr;
+} DOM_GID;
+
+/********************************************************************** 
+ * ????
+ **********************************************************************/
+
 /* DOM_CLNT_SRV - client / server names */
-typedef struct clnt_srv_info
-{
+typedef struct clnt_srv_info {
        uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
        UNISTR2 uni_logon_srv; /* logon server name */
        uint32  undoc_buffer2; /* undocumented 32 bit buffer pointer */
@@ -265,8 +307,7 @@ typedef struct clnt_srv_info
 } DOM_CLNT_SRV;
 
 /* DOM_LOG_INFO - login info */
-typedef struct log_info
-{
+typedef struct log_info {
        uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
        UNISTR2 uni_logon_srv; /* logon server name */
        UNISTR2 uni_acct_name; /* account name */
@@ -275,138 +316,44 @@ typedef struct log_info
 } DOM_LOG_INFO;
 
 /* DOM_CHAL - challenge info */
-typedef struct chal_info
-{
+typedef struct chal_info {
        uchar data[8]; /* credentials */
 } DOM_CHAL;
  
 /* DOM_CREDs - timestamped client or server credentials */
-typedef struct cred_info
-{
+typedef struct cred_info {
        DOM_CHAL challenge; /* credentials */
        UTIME timestamp;    /* credential time-stamp */
 } DOM_CRED;
 
 /* DOM_CLNT_INFO - client info */
-typedef struct clnt_info
-{
+typedef struct clnt_info {
        DOM_LOG_INFO login;
        DOM_CRED     cred;
 } DOM_CLNT_INFO;
 
 /* DOM_CLNT_INFO2 - client info */
-typedef struct clnt_info2
-{
+typedef struct clnt_info2 {
        DOM_CLNT_SRV login;
        uint32        ptr_cred;
        DOM_CRED      cred;
 } DOM_CLNT_INFO2;
 
 /* DOM_LOGON_ID - logon id */
-typedef struct logon_info
-{
+typedef struct logon_info {
        uint32 low;
        uint32 high;
 } DOM_LOGON_ID;
 
 /* OWF INFO */
-typedef struct owf_info
-{
+typedef struct owf_info {
        uint8 data[16];
 } OWF_INFO;
 
-
-/* DOM_GID - group id + user attributes */
-typedef struct gid_info
-{
-       uint32 g_rid;  /* a group RID */
-       uint32 attr;
-} DOM_GID;
-
-/* POLICY_HND */
-typedef struct lsa_policy_info
-{
-       uint32 data1;
-       uint32 data2;
-       uint16 data3;
-       uint16 data4;
-       uint8 data5[8];
-#ifdef __INSURE__
-
-       /* To prevent the leakage of policy handles mallocate a bit of
-          memory when a policy handle is created and free it when the
-          handle is closed.  This should cause Insure to flag an error
-          when policy handles are overwritten or fall out of scope without
-          being freed. */
-
-       char *marker;
-#endif
-} POLICY_HND;
-
-/*
- * A client connection's state, pipe name, 
- * user credentials, etc...
- */
-typedef struct _cli_auth_fns cli_auth_fns;
-struct user_creds;
-struct cli_connection {
-
-        char                    *srv_name;
-        char                    *pipe_name;
-        struct user_creds       usr_creds;
-
-        struct cli_state        *pCli_state;
-
-        cli_auth_fns            *auth;
-
-        void                    *auth_info;
-        void                    *auth_creds;
-};
-
-
-/* 
- * Associate a POLICY_HND with a cli_connection
- */
-typedef struct rpc_hnd_node {
-
-       POLICY_HND              hnd;
-       struct cli_connection   *cli;
-
-} RPC_HND_NODE;
-
 typedef struct uint64_s
 {
        uint32 low;
        uint32 high;
 } UINT64_S;
 
-/* BUFHDR2 - another buffer header, with info level */
-typedef struct bufhdr2_info
-{
-       uint32 info_level;
-       uint32 length;          /* uint8 chars */
-       uint32 buffer;
-
-}
-BUFHDR2;
-
-/* BUFHDR4 - another buffer header */
-typedef struct bufhdr4_info
-{
-       uint32 size;
-       uint32 buffer;
-
-}
-BUFHDR4;
-
-/* BUFFER4 - simple length and buffer */
-typedef struct buffer4_info
-{
-       uint32 buf_len;
-       uint8 *buffer;
-
-}
-BUFFER4;
-
-enum unistr2_term_codes { UNI_FLAGS_NONE = 0, UNI_STR_TERMINATE = 1, UNI_MAXLEN_TERMINATE = 2, UNI_BROKEN_NON_NULL = 3 };
 #endif /* _RPC_MISC_H */