source3/include/rpc_misc.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Andrew Tridgell                1992-1997
   5    Copyright (C) Luke Kenneth Casson Leighton   1996-1997
   6    Copyright (C) Paul Ashton                    1997
   7    Copyright (C) Gerald (Jerry) Carter          2005
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #ifndef _RPC_MISC_H /* _RPC_MISC_H */
  25 #define _RPC_MISC_H
  26
  27 #define SMB_RPC_INTERFACE_VERSION 1
  28 #define PRS_POINTER_CAST BOOL (*)(const char*, prs_struct*, int, void*)
  29
  30 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 };
  31
  32
  33
  34 /**********************************************************************
  35  * well-known RIDs - Relative IDs
  36  **********************************************************************/
  37
  38 /* RIDs - Well-known users ... */
  39 #define DOMAIN_USER_RID_ADMIN          (0x000001F4L)
  40 #define DOMAIN_USER_RID_GUEST          (0x000001F5L)
  41 #define DOMAIN_USER_RID_KRBTGT         (0x000001F6L)
  42
  43 /* RIDs - well-known groups ... */
  44 #define DOMAIN_GROUP_RID_ADMINS        (0x00000200L)
  45 #define DOMAIN_GROUP_RID_USERS         (0x00000201L)
  46 #define DOMAIN_GROUP_RID_GUESTS        (0x00000202L)
  47 #define DOMAIN_GROUP_RID_COMPUTERS     (0x00000203L)
  48
  49 #define DOMAIN_GROUP_RID_CONTROLLERS   (0x00000204L)
  50 #define DOMAIN_GROUP_RID_CERT_ADMINS   (0x00000205L)
  51 #define DOMAIN_GROUP_RID_SCHEMA_ADMINS (0x00000206L)
  52 #define DOMAIN_GROUP_RID_ENTERPRISE_ADMINS (0x00000207L)
  53
  54 /* is the following the right number? I bet it is  --simo
  55 #define DOMAIN_GROUP_RID_POLICY_ADMINS (0x00000208L)
  56 */
  57
  58 /* RIDs - well-known aliases ... */
  59 #define BUILTIN_ALIAS_RID_ADMINS        (0x00000220L)
  60 #define BUILTIN_ALIAS_RID_USERS         (0x00000221L)
  61 #define BUILTIN_ALIAS_RID_GUESTS        (0x00000222L)
  62 #define BUILTIN_ALIAS_RID_POWER_USERS   (0x00000223L)
  63
  64 #define BUILTIN_ALIAS_RID_ACCOUNT_OPS   (0x00000224L)
  65 #define BUILTIN_ALIAS_RID_SYSTEM_OPS    (0x00000225L)
  66 #define BUILTIN_ALIAS_RID_PRINT_OPS     (0x00000226L)
  67 #define BUILTIN_ALIAS_RID_BACKUP_OPS    (0x00000227L)
  68
  69 #define BUILTIN_ALIAS_RID_REPLICATOR    (0x00000228L)
  70 #define BUILTIN_ALIAS_RID_RAS_SERVERS   (0x00000229L)
  71 #define BUILTIN_ALIAS_RID_PRE_2K_ACCESS (0x0000022aL)
  72
  73
  74 /**********************************************************************
  75  * Masks for mappings between unix uid and gid types and
  76  * NT RIDS.
  77  **********************************************************************/
  78
  79 #define BASE_RID (0x000003E8L)
  80
  81 /* Take the bottom bit. */
  82 #define RID_TYPE_MASK           1
  83 #define RID_MULTIPLIER          2
  84
  85 /* The two common types. */
  86 #define USER_RID_TYPE           0
  87 #define GROUP_RID_TYPE          1
  88
  89
  90
  91 /**********************************************************************
  92  * RPC policy handle used pretty much everywhere
  93  **********************************************************************/
  94
  95 typedef struct policy_handle POLICY_HND;
  96
  97 #define OUR_HANDLE(hnd) (((hnd)==NULL) ? "NULL" :\
  98         ( IVAL((hnd)->uuid.node,2) == (uint32)sys_getpid() ? "OURS" : \
  99                 "OTHER")), ((unsigned int)IVAL((hnd)->uuid.node,2)),\
 100                 ((unsigned int)sys_getpid() )
 101
 102
 103 /**********************************************************************
 104  * Buffer Headers -- use by SEC_DESC_BUF in winreg and netlogon code
 105  **********************************************************************/
 106
 107 /* TODO: replace this with an encompassing buffer structure */
 108 typedef struct {
 109         uint32 buf_max_len;
 110         uint32 buf_len;
 111 } BUFHDR;
 112
 113 /* this is a BUFHDR + a pointer to a buffer */
 114 typedef struct {
 115         uint32 info_level;
 116         uint32 length;          /* uint8 chars */
 117         uint32 buffer;
 118 } BUFHDR2;
 119
 120 /* generic buffer ?  wrapped around void*? */
 121 typedef struct {
 122         uint32 size;
 123         uint32 buffer;
 124 } BUFHDR4;
 125
 126
 127 /**********************************************************************
 128  * Buffers
 129  **********************************************************************/
 130
 131 /* buffer used by \winreg\ calls to fill in arbitrary REG_XXX values.
 132    It *may* look like a UNISTR2 but it is *not*.  This is not a goof
 133    by the winreg developers.  It is a generic buffer.  buffer length
 134    is stored in bytes (not # of uint16's) */
 135
 136 typedef struct {
 137         uint32 buf_max_len;
 138         uint32 offset;
 139         uint32 buf_len;
 140         uint16 *buffer;
 141 } REGVAL_BUFFER;
 142
 143 /* generic rpc version of the DATA_BLOB.  Just a length and uint8 array */
 144
 145 typedef struct {
 146         uint32 buf_len;
 147         uint8 *buffer;
 148 } RPC_DATA_BLOB;
 149
 150 /**********************************************************************
 151  * Buffers use by spoolss (i might be able to replace it with
 152  * an RPC_DATA_BLOB)
 153  **********************************************************************/
 154
 155 typedef struct {
 156         uint32 buf_len;
 157         uint16 *buffer; /* data */
 158 } BUFFER5;
 159
 160
 161 /**********************************************************************
 162  * Unicode and basic string headers
 163  **********************************************************************/
 164
 165 typedef struct {
 166         uint16 str_str_len;
 167         uint16 str_max_len;
 168         uint32 buffer; /* non-zero */
 169 } STRHDR;
 170
 171 typedef struct {
 172         uint16 uni_str_len;
 173         uint16 uni_max_len;
 174         uint32 buffer;
 175 } UNIHDR;
 176
 177 /**********************************************************************
 178  * UNICODE string variations
 179  **********************************************************************/
 180
 181
 182 typedef struct {                /* UNISTR - unicode string size and buffer */
 183         uint16 *buffer;         /* unicode characters. ***MUST*** be
 184                                    little-endian. ***MUST*** be null-terminated */
 185 } UNISTR;
 186
 187 typedef struct {                /* UNISTR2 - unicode string size (in
 188                                    uint16 unicode chars) and buffer */
 189         uint32 uni_max_len;
 190         uint32 offset;
 191         uint32 uni_str_len;
 192         uint16 *buffer;         /* unicode characters. ***MUST*** be little-endian.
 193                                   **must** be null-terminated and the uni_str_len
 194                                   should include the NULL character */
 195 } UNISTR2;
 196
 197 /* i think this is the same as a BUFFER5 used in the spoolss code --jerry */
 198 /* not sure about how the termination matches between the uint16 buffers thought */
 199
 200 typedef struct {                /* UNISTR3 - XXXX not sure about this structure */
 201         uint32 uni_str_len;
 202         UNISTR str;
 203 } UNISTR3;
 204
 205 typedef struct {                /* Buffer wrapped around a UNISTR2 */
 206         uint16 length;          /* number of bytes not counting NULL terminatation */
 207         uint16 size;            /* number of bytes including NULL terminatation */
 208         UNISTR2 *string;
 209 } UNISTR4;
 210
 211 typedef struct {
 212         uint32 count;
 213         UNISTR4 *strings;
 214 } UNISTR4_ARRAY;
 215
 216
 217 /**********************************************************************
 218  * String variations
 219  **********************************************************************/
 220
 221 typedef struct {                /* STRING2 - string size (in uint8 chars) and buffer */
 222         uint32 str_max_len;
 223         uint32 offset;
 224         uint32 str_str_len;
 225         uint8  *buffer;         /* uint8 characters. **NOT** necessarily null-terminated */
 226 } STRING2;
 227
 228
 229
 230
 231 /**********************************************************************
 232  * Domain SID structures
 233  **********************************************************************/
 234
 235 typedef struct {
 236         uint32 num_auths; /* length, bytes, including length of len :-) */
 237         DOM_SID sid;
 238 } DOM_SID2;
 239
 240
 241 /**********************************************************************
 242  * Domain SID structures
 243  **********************************************************************/
 244
 245 /* DOM_RID - domain RID structure for ntlsa pipe */
 246 typedef struct {
 247         uint16 type; /* value is SID_NAME_USE enum */
 248         uint32 rid;
 249         uint32 rid_idx; /* referenced domain index */
 250 } DOM_RID;
 251
 252 /* DOM_RID2 - second domain RID structure for ntlsa pipe */
 253 typedef struct {
 254         uint16 type; /* value is SID_NAME_USE enum */
 255         uint32 rid;
 256         uint32 rid_idx; /* referenced domain index */
 257         uint32 unknown;
 258 } DOM_RID2;
 259
 260 typedef struct {                /* DOM_RID3 - domain RID structure for samr pipe */
 261         uint32 rid;        /* domain-relative (to a SID) id */
 262         uint32 type1;      /* value is 0x1 */
 263         uint32 ptr_type;   /* undocumented pointer */
 264         uint32 type2;      /* value is 0x1 */
 265         uint32 unk; /* value is 0x2 */
 266 } DOM_RID3;
 267
 268 /* DOM_RID4 - rid + user attributes */
 269 typedef struct domrid4_info
 270 {
 271         uint32 unknown;
 272         uint16 attr;
 273         uint32 rid;  /* user RID */
 274 } DOM_RID4;
 275
 276 /* DOM_GID - group id + user attributes */
 277 typedef struct {
 278         uint32 g_rid;  /* a group RID */
 279         uint32 attr;
 280 } DOM_GID;
 281
 282 /**********************************************************************
 283  * ????
 284  **********************************************************************/
 285
 286 /* DOM_CLNT_SRV - client / server names */
 287 typedef struct clnt_srv_info {
 288         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
 289         UNISTR2 uni_logon_srv; /* logon server name */
 290         uint32  undoc_buffer2; /* undocumented 32 bit buffer pointer */
 291         UNISTR2 uni_comp_name; /* client machine name */
 292 } DOM_CLNT_SRV;
 293
 294 /* DOM_LOG_INFO - login info */
 295 typedef struct log_info {
 296         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
 297         UNISTR2 uni_logon_srv; /* logon server name */
 298         UNISTR2 uni_acct_name; /* account name */
 299         uint16  sec_chan;      /* secure channel type */
 300         UNISTR2 uni_comp_name; /* client machine name */
 301 } DOM_LOG_INFO;
 302
 303 /* DOM_CHAL - challenge info */
 304 typedef struct chal_info {
 305         unsigned char data[8]; /* credentials */
 306 } DOM_CHAL;
 307
 308 /* DOM_CREDs - timestamped client or server credentials */
 309 typedef struct cred_info {
 310         DOM_CHAL challenge; /* credentials */
 311         UTIME timestamp;    /* credential time-stamp */
 312 } DOM_CRED;
 313
 314 /* DOM_CLNT_INFO - client info */
 315 typedef struct clnt_info {
 316         DOM_LOG_INFO login;
 317         DOM_CRED     cred;
 318 } DOM_CLNT_INFO;
 319
 320 /* DOM_CLNT_INFO2 - client info */
 321 typedef struct clnt_info2 {
 322         DOM_CLNT_SRV login;
 323         uint32        ptr_cred;
 324         DOM_CRED      cred;
 325 } DOM_CLNT_INFO2;
 326
 327 /* DOM_LOGON_ID - logon id */
 328 typedef struct logon_info {
 329         uint32 low;
 330         uint32 high;
 331 } DOM_LOGON_ID;
 332
 333 /* OWF INFO */
 334 typedef struct owf_info {
 335         uint8 data[16];
 336 } OWF_INFO;
 337
 338
 339 #endif /* _RPC_MISC_H */