source/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 2 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 #include "ntdomain.h"
  25 #include "rpc_dce.h"
  26
  27 #ifndef _RPC_MISC_H /* _RPC_MISC_H */
  28 #define _RPC_MISC_H
  29
  30 #define SMB_RPC_INTERFACE_VERSION 1
  31 #define PRS_POINTER_CAST BOOL (*)(const char*, prs_struct*, int, void*)
  32
  33 enum unistr2_term_codes { UNI_FLAGS_NONE = 0, UNI_STR_TERMINATE = 1, UNI_MAXLEN_TERMINATE = 2, UNI_BROKEN_NON_NULL = 3 };
  34
  35
  36
  37 /**********************************************************************
  38  * well-known RIDs - Relative IDs
  39  **********************************************************************/
  40
  41 /* RIDs - Well-known users ... */
  42 #define DOMAIN_USER_RID_ADMIN          (0x000001F4L)
  43 #define DOMAIN_USER_RID_GUEST          (0x000001F5L)
  44 #define DOMAIN_USER_RID_KRBTGT         (0x000001F6L)
  45
  46 /* RIDs - well-known groups ... */
  47 #define DOMAIN_GROUP_RID_ADMINS        (0x00000200L)
  48 #define DOMAIN_GROUP_RID_USERS         (0x00000201L)
  49 #define DOMAIN_GROUP_RID_GUESTS        (0x00000202L)
  50 #define DOMAIN_GROUP_RID_COMPUTERS     (0x00000203L)
  51
  52 #define DOMAIN_GROUP_RID_CONTROLLERS   (0x00000204L)
  53 #define DOMAIN_GROUP_RID_CERT_ADMINS   (0x00000205L)
  54 #define DOMAIN_GROUP_RID_SCHEMA_ADMINS (0x00000206L)
  55 #define DOMAIN_GROUP_RID_ENTERPRISE_ADMINS (0x00000207L)
  56
  57 /* is the following the right number? I bet it is  --simo
  58 #define DOMAIN_GROUP_RID_POLICY_ADMINS (0x00000208L)
  59 */
  60
  61 /* RIDs - well-known aliases ... */
  62 #define BUILTIN_ALIAS_RID_ADMINS        (0x00000220L)
  63 #define BUILTIN_ALIAS_RID_USERS         (0x00000221L)
  64 #define BUILTIN_ALIAS_RID_GUESTS        (0x00000222L)
  65 #define BUILTIN_ALIAS_RID_POWER_USERS   (0x00000223L)
  66
  67 #define BUILTIN_ALIAS_RID_ACCOUNT_OPS   (0x00000224L)
  68 #define BUILTIN_ALIAS_RID_SYSTEM_OPS    (0x00000225L)
  69 #define BUILTIN_ALIAS_RID_PRINT_OPS     (0x00000226L)
  70 #define BUILTIN_ALIAS_RID_BACKUP_OPS    (0x00000227L)
  71
  72 #define BUILTIN_ALIAS_RID_REPLICATOR    (0x00000228L)
  73 #define BUILTIN_ALIAS_RID_RAS_SERVERS   (0x00000229L)
  74 #define BUILTIN_ALIAS_RID_PRE_2K_ACCESS (0x0000022aL)
  75
  76
  77 /**********************************************************************
  78  * Masks for mappings between unix uid and gid types and
  79  * NT RIDS.
  80  **********************************************************************/
  81
  82 #define BASE_RID (0x000003E8L)
  83
  84 /* Take the bottom bit. */
  85 #define RID_TYPE_MASK           1
  86 #define RID_MULTIPLIER          2
  87
  88 /* The two common types. */
  89 #define USER_RID_TYPE           0
  90 #define GROUP_RID_TYPE          1
  91
  92
  93
  94 /**********************************************************************
  95  * RPC policy handle used pretty much everywhere
  96  **********************************************************************/
  97
  98 typedef struct {
  99         uint32 ptr_hnd;          /* pointer to enumeration handle */
 100         uint32 handle;           /* enumeration handle */
 101 } ENUM_HND;
 102
 103
 104
 105 /**********************************************************************
 106  * RPC policy handle used pretty much everywhere
 107  **********************************************************************/
 108
 109 typedef struct {
 110         uint32 data1;
 111         uint32 data2;
 112         uint16 data3;
 113         uint16 data4;
 114         uint8 data5[8];
 115 #ifdef __INSURE__
 116
 117         /* To prevent the leakage of policy handles mallocate a bit of
 118            memory when a policy handle is created and free it when the
 119            handle is closed.  This should cause Insure to flag an error
 120            when policy handles are overwritten or fall out of scope without
 121            being freed. */
 122
 123         char *marker;
 124 #endif
 125 } POLICY_HND;
 126
 127
 128 /**********************************************************************
 129  * Buffer Headers -- use by SEC_DESC_BUF in winreg and netlogon code
 130  **********************************************************************/
 131
 132 /* TODO: replace this with an encompassing buffer structure */
 133 typedef struct {
 134         uint32 buf_max_len;
 135         uint32 buf_len;
 136 } BUFHDR;
 137
 138 /* this is a BUFHDR + a pointer to a buffer */
 139 typedef struct {
 140         uint32 info_level;
 141         uint32 length;          /* uint8 chars */
 142         uint32 buffer;
 143 } BUFHDR2;
 144
 145 /* generic buffer ?  wrapped around void*? */
 146 typedef struct {
 147         uint32 size;
 148         uint32 buffer;
 149 } BUFHDR4;
 150
 151
 152 /**********************************************************************
 153  * Buffers
 154  **********************************************************************/
 155
 156 /* buffer used by \winreg\ calls to fill in arbitrary REG_XXX values.
 157    It *may* look like a UNISTR2 but it is *not*.  This is not a goof
 158    by the winreg developers.  It is a generic buffer.  buffer length
 159    is stored in bytes (not # of uint16's) */
 160
 161 typedef struct {
 162         uint32 buf_max_len;
 163         uint32 offset;
 164         uint32 buf_len;
 165         uint16 *buffer;
 166 } REGVAL_BUFFER;
 167
 168 /* generic rpc version of the DATA_BLOB.  Just a length and uint8 array */
 169
 170 typedef struct {
 171         uint32 buf_len;
 172         uint8 *buffer;
 173 } RPC_DATA_BLOB;
 174
 175 /**********************************************************************
 176  * Buffers use by spoolss (i might be able to replace it with
 177  * an RPC_DATA_BLOB)
 178  **********************************************************************/
 179
 180 typedef struct {
 181         uint32 buf_len;
 182         uint16 *buffer; /* data */
 183 } BUFFER5;
 184
 185
 186 /**********************************************************************
 187  * Unicode and basic string headers
 188  **********************************************************************/
 189
 190 typedef struct {
 191         uint16 str_str_len;
 192         uint16 str_max_len;
 193         uint32 buffer; /* non-zero */
 194 } STRHDR;
 195
 196 typedef struct {
 197         uint16 uni_str_len;
 198         uint16 uni_max_len;
 199         uint32 buffer;
 200 } UNIHDR;
 201
 202 /**********************************************************************
 203  * UNICODE string variations
 204  **********************************************************************/
 205
 206
 207 typedef struct {                /* UNISTR - unicode string size and buffer */
 208         uint16 *buffer;         /* unicode characters. ***MUST*** be
 209                                    little-endian. ***MUST*** be null-terminated */
 210 } UNISTR;
 211
 212 typedef struct {                /* UNISTR2 - unicode string size (in
 213                                    uint16 unicode chars) and buffer */
 214         uint32 uni_max_len;
 215         uint32 offset;
 216         uint32 uni_str_len;
 217         uint16 *buffer;         /* unicode characters. ***MUST*** be little-endian.
 218                                   **must** be null-terminated and the uni_str_len
 219                                   should include the NULL character */
 220 } UNISTR2;
 221
 222 /* i think this is the same as a BUFFER5 used in the spoolss code --jerry */
 223 /* not sure about how the termination matches between the uint16 buffers thought */
 224
 225 typedef struct {                /* UNISTR3 - XXXX not sure about this structure */
 226         uint32 uni_str_len;
 227         UNISTR str;
 228 } UNISTR3;
 229
 230 typedef struct {                /* Buffer wrapped around a UNISTR2 */
 231         uint16 length;          /* number of bytes not counting NULL terminatation */
 232         uint16 size;            /* number of bytes including NULL terminatation */
 233         UNISTR2 *string;
 234 } UNISTR4;
 235
 236 typedef struct {
 237         uint32 count;
 238         UNISTR4 *strings;
 239 } UNISTR4_ARRAY;
 240
 241
 242 /**********************************************************************
 243  * String variations
 244  **********************************************************************/
 245
 246 typedef struct {                /* STRING2 - string size (in uint8 chars) and buffer */
 247         uint32 str_max_len;
 248         uint32 offset;
 249         uint32 str_str_len;
 250         uint8  *buffer;         /* uint8 characters. **NOT** necessarily null-terminated */
 251 } STRING2;
 252
 253
 254
 255
 256 /**********************************************************************
 257  * Domain SID structures
 258  **********************************************************************/
 259
 260 typedef struct {
 261         uint32 num_auths; /* length, bytes, including length of len :-) */
 262         DOM_SID sid;
 263 } DOM_SID2;
 264
 265
 266 /**********************************************************************
 267  * Domain SID structures
 268  **********************************************************************/
 269
 270 /* DOM_RID2 - domain RID structure for ntlsa pipe */
 271 typedef struct {
 272         uint8 type; /* value is SID_NAME_USE enum */
 273         uint32 rid;
 274         uint32 rid_idx; /* referenced domain index */
 275 } DOM_RID2;
 276
 277
 278 typedef struct {                /* DOM_RID3 - domain RID structure for samr pipe */
 279         uint32 rid;        /* domain-relative (to a SID) id */
 280         uint32 type1;      /* value is 0x1 */
 281         uint32 ptr_type;   /* undocumented pointer */
 282         uint32 type2;      /* value is 0x1 */
 283         uint32 unk; /* value is 0x2 */
 284 } DOM_RID3;
 285
 286 /* DOM_RID4 - rid + user attributes */
 287 typedef struct domrid4_info
 288 {
 289         uint32 unknown;
 290         uint16 attr;
 291         uint32 rid;  /* user RID */
 292 } DOM_RID4;
 293
 294 /* DOM_GID - group id + user attributes */
 295 typedef struct {
 296         uint32 g_rid;  /* a group RID */
 297         uint32 attr;
 298 } DOM_GID;
 299
 300 /**********************************************************************
 301  * ????
 302  **********************************************************************/
 303
 304 /* DOM_CLNT_SRV - client / server names */
 305 typedef struct clnt_srv_info
 306 {
 307         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
 308         UNISTR2 uni_logon_srv; /* logon server name */
 309         uint32  undoc_buffer2; /* undocumented 32 bit buffer pointer */
 310         UNISTR2 uni_comp_name; /* client machine name */
 311 } DOM_CLNT_SRV;
 312
 313 /* DOM_LOG_INFO - login info */
 314 typedef struct log_info
 315 {
 316         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
 317         UNISTR2 uni_logon_srv; /* logon server name */
 318         UNISTR2 uni_acct_name; /* account name */
 319         uint16  sec_chan;      /* secure channel type */
 320         UNISTR2 uni_comp_name; /* client machine name */
 321 } DOM_LOG_INFO;
 322
 323 /* DOM_CHAL - challenge info */
 324 typedef struct chal_info
 325 {
 326         uchar data[8]; /* credentials */
 327 } DOM_CHAL;
 328
 329 /* DOM_CREDs - timestamped client or server credentials */
 330 typedef struct cred_info
 331 {
 332         DOM_CHAL challenge; /* credentials */
 333         UTIME timestamp;    /* credential time-stamp */
 334 } DOM_CRED;
 335
 336 /* DOM_CLNT_INFO - client info */
 337 typedef struct clnt_info
 338 {
 339         DOM_LOG_INFO login;
 340         DOM_CRED     cred;
 341 } DOM_CLNT_INFO;
 342
 343 /* DOM_CLNT_INFO2 - client info */
 344 typedef struct clnt_info2
 345 {
 346         DOM_CLNT_SRV login;
 347         uint32        ptr_cred;
 348         DOM_CRED      cred;
 349 } DOM_CLNT_INFO2;
 350
 351 /* DOM_LOGON_ID - logon id */
 352 typedef struct logon_info
 353 {
 354         uint32 low;
 355         uint32 high;
 356 } DOM_LOGON_ID;
 357
 358 /* OWF INFO */
 359 typedef struct owf_info
 360 {
 361         uint8 data[16];
 362 } OWF_INFO;
 363
 364
 365
 366
 367
 368 /*
 369  * A client connection's state, pipe name,
 370  * user credentials, etc...
 371  */
 372 typedef struct _cli_auth_fns cli_auth_fns;
 373 struct user_creds;
 374 struct cli_connection {
 375
 376         char                    *srv_name;
 377         char                    *pipe_name;
 378         struct user_creds       usr_creds;
 379
 380         struct cli_state        *pCli_state;
 381
 382         cli_auth_fns            *auth;
 383
 384         void                    *auth_info;
 385         void                    *auth_creds;
 386 };
 387
 388
 389 /*
 390  * Associate a POLICY_HND with a cli_connection
 391  */
 392 typedef struct rpc_hnd_node {
 393
 394         POLICY_HND              hnd;
 395         struct cli_connection   *cli;
 396
 397 } RPC_HND_NODE;
 398
 399 typedef struct uint64_s
 400 {
 401         uint32 low;
 402         uint32 high;
 403 } UINT64_S;
 404
 405
 406
 407
 408
 409 #endif /* _RPC_MISC_H */