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 typedef struct {
 133         uint32 buf_max_len;
 134         uint32 buf_len;
 135 } BUFHDR;
 136
 137 typedef struct {
 138         uint32 info_level;
 139         uint32 length;          /* uint8 chars */
 140         uint32 buffer;
 141 } BUFHDR2;
 142
 143 typedef struct {
 144         uint32 size;
 145         uint32 buffer;
 146 } BUFHDR4;
 147
 148
 149 /**********************************************************************
 150  * Buffers
 151  **********************************************************************/
 152
 153 /* buffer used by \winreg\ calls to fill in arbitrary REG_XXX values.
 154    It *may* look like a UNISTR2 but it is *not*.  This is not a goof
 155    by the winreg developers.  It is a generic buffer */
 156
 157 typedef struct {
 158         uint32 buf_max_len;
 159         uint32 offset;
 160         uint32 buf_len;
 161         uint16 *buffer;
 162 } REGVAL_BUFFER;
 163
 164 /* generic rpc version of the DATA_BLOB.  Just a length and uint8 array */
 165
 166 typedef struct {
 167         uint32 buf_len;
 168         uint8 *buffer;
 169 } RPC_DATA_BLOB;
 170
 171 /**********************************************************************
 172  * Buffers use by spoolss (i might be able to replace it with
 173  * an RPC_DATA_BLOB)
 174  **********************************************************************/
 175
 176 typedef struct {
 177         uint32 buf_len;
 178         uint16 *buffer; /* data */
 179 } BUFFER5;
 180
 181
 182 /**********************************************************************
 183  * Unicode and basic string headers
 184  **********************************************************************/
 185
 186 typedef struct {
 187         uint16 str_str_len;
 188         uint16 str_max_len;
 189         uint32 buffer; /* non-zero */
 190 } STRHDR;
 191
 192 typedef struct {
 193         uint16 uni_str_len;
 194         uint16 uni_max_len;
 195         uint32 buffer;
 196 } UNIHDR;
 197
 198 /**********************************************************************
 199  * UNICODE string variations
 200  **********************************************************************/
 201
 202
 203 typedef struct {                /* UNISTR - unicode string size and buffer */
 204         uint16 *buffer;         /* unicode characters. ***MUST*** be
 205                                    little-endian. ***MUST*** be null-terminated */
 206 } UNISTR;
 207
 208 typedef struct {                /* UNISTR2 - unicode string size (in
 209                                    uint16 unicode chars) and buffer */
 210         uint32 uni_max_len;
 211         uint32 offset;
 212         uint32 uni_str_len;
 213         uint16 *buffer;         /* unicode characters. ***MUST*** be little-endian.
 214                                   **must** be null-terminated and the uni_str_len
 215                                   should include the NULL character */
 216 } UNISTR2;
 217
 218 typedef struct {                /* UNISTR3 - XXXX not sure about this structure */
 219         uint32 uni_str_len;
 220         UNISTR str;
 221
 222 } UNISTR3;
 223
 224 typedef struct {                /* Buffer wrapped around a UNISTR2 */
 225         uint16 length;          /* number of bytes not counting NULL terminatation */
 226         uint16 size;            /* number of bytes including NULL terminatation */
 227         UNISTR2 *string;
 228 } UNISTR4;
 229
 230 typedef struct {
 231         uint32 count;
 232         UNISTR4 *strings;
 233 } UNISTR4_ARRAY;
 234
 235
 236 /**********************************************************************
 237  * String variations
 238  **********************************************************************/
 239
 240 typedef struct {                /* STRING2 - string size (in uint8 chars) and buffer */
 241         uint32 str_max_len;
 242         uint32 offset;
 243         uint32 str_str_len;
 244         uint8  *buffer;         /* uint8 characters. **NOT** necessarily null-terminated */
 245 } STRING2;
 246
 247
 248
 249
 250 /**********************************************************************
 251  * Domain SID structures
 252  **********************************************************************/
 253
 254 typedef struct {
 255         uint32 num_auths; /* length, bytes, including length of len :-) */
 256         DOM_SID sid;
 257 } DOM_SID2;
 258
 259
 260 /**********************************************************************
 261  * Domain SID structures
 262  **********************************************************************/
 263
 264 /* DOM_RID2 - domain RID structure for ntlsa pipe */
 265 typedef struct {
 266         uint8 type; /* value is SID_NAME_USE enum */
 267         uint32 rid;
 268         uint32 rid_idx; /* referenced domain index */
 269 } DOM_RID2;
 270
 271
 272 typedef struct {                /* DOM_RID3 - domain RID structure for samr pipe */
 273         uint32 rid;        /* domain-relative (to a SID) id */
 274         uint32 type1;      /* value is 0x1 */
 275         uint32 ptr_type;   /* undocumented pointer */
 276         uint32 type2;      /* value is 0x1 */
 277         uint32 unk; /* value is 0x2 */
 278 } DOM_RID3;
 279
 280 /* DOM_RID4 - rid + user attributes */
 281 typedef struct domrid4_info
 282 {
 283         uint32 unknown;
 284         uint16 attr;
 285         uint32 rid;  /* user RID */
 286 } DOM_RID4;
 287
 288 /* DOM_GID - group id + user attributes */
 289 typedef struct {
 290         uint32 g_rid;  /* a group RID */
 291         uint32 attr;
 292 } DOM_GID;
 293
 294 /**********************************************************************
 295  * ????
 296  **********************************************************************/
 297
 298 /* DOM_CLNT_SRV - client / server names */
 299 typedef struct clnt_srv_info
 300 {
 301         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
 302         UNISTR2 uni_logon_srv; /* logon server name */
 303         uint32  undoc_buffer2; /* undocumented 32 bit buffer pointer */
 304         UNISTR2 uni_comp_name; /* client machine name */
 305 } DOM_CLNT_SRV;
 306
 307 /* DOM_LOG_INFO - login info */
 308 typedef struct log_info
 309 {
 310         uint32  undoc_buffer; /* undocumented 32 bit buffer pointer */
 311         UNISTR2 uni_logon_srv; /* logon server name */
 312         UNISTR2 uni_acct_name; /* account name */
 313         uint16  sec_chan;      /* secure channel type */
 314         UNISTR2 uni_comp_name; /* client machine name */
 315 } DOM_LOG_INFO;
 316
 317 /* DOM_CHAL - challenge info */
 318 typedef struct chal_info
 319 {
 320         uchar data[8]; /* credentials */
 321 } DOM_CHAL;
 322
 323 /* DOM_CREDs - timestamped client or server credentials */
 324 typedef struct cred_info
 325 {
 326         DOM_CHAL challenge; /* credentials */
 327         UTIME timestamp;    /* credential time-stamp */
 328 } DOM_CRED;
 329
 330 /* DOM_CLNT_INFO - client info */
 331 typedef struct clnt_info
 332 {
 333         DOM_LOG_INFO login;
 334         DOM_CRED     cred;
 335 } DOM_CLNT_INFO;
 336
 337 /* DOM_CLNT_INFO2 - client info */
 338 typedef struct clnt_info2
 339 {
 340         DOM_CLNT_SRV login;
 341         uint32        ptr_cred;
 342         DOM_CRED      cred;
 343 } DOM_CLNT_INFO2;
 344
 345 /* DOM_LOGON_ID - logon id */
 346 typedef struct logon_info
 347 {
 348         uint32 low;
 349         uint32 high;
 350 } DOM_LOGON_ID;
 351
 352 /* OWF INFO */
 353 typedef struct owf_info
 354 {
 355         uint8 data[16];
 356 } OWF_INFO;
 357
 358
 359
 360
 361
 362 /*
 363  * A client connection's state, pipe name,
 364  * user credentials, etc...
 365  */
 366 typedef struct _cli_auth_fns cli_auth_fns;
 367 struct user_creds;
 368 struct cli_connection {
 369
 370         char                    *srv_name;
 371         char                    *pipe_name;
 372         struct user_creds       usr_creds;
 373
 374         struct cli_state        *pCli_state;
 375
 376         cli_auth_fns            *auth;
 377
 378         void                    *auth_info;
 379         void                    *auth_creds;
 380 };
 381
 382
 383 /*
 384  * Associate a POLICY_HND with a cli_connection
 385  */
 386 typedef struct rpc_hnd_node {
 387
 388         POLICY_HND              hnd;
 389         struct cli_connection   *cli;
 390
 391 } RPC_HND_NODE;
 392
 393 typedef struct uint64_s
 394 {
 395         uint32 low;
 396         uint32 high;
 397 } UINT64_S;
 398
 399
 400
 401
 402
 403 #endif /* _RPC_MISC_H */