source3/include/ntdomain.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   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) Jeremy Allison 2000-2004
   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 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
  25 #define _NT_DOMAIN_H
  26
  27 /*
  28  * A bunch of stuff that was put into smb.h
  29  * in the NTDOM branch - it didn't belong there.
  30  */
  31
  32 typedef struct _prs_struct {
  33         BOOL io; /* parsing in or out of data stream */
  34         /*
  35          * If the (incoming) data is big-endian. On output we are
  36          * always little-endian.
  37          */
  38         BOOL bigendian_data;
  39         uint8 align; /* data alignment */
  40         BOOL is_dynamic; /* Do we own this memory or not ? */
  41         uint32 data_offset; /* Current working offset into data. */
  42         uint32 buffer_size; /* Current allocated size of the buffer. */
  43         uint32 grow_size; /* size requested via prs_grow() calls */
  44         char *data_p; /* The buffer itself. */
  45         TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
  46         const char *sess_key; /* If we have to do encrypt/decrypt on the fly. */
  47 } prs_struct;
  48
  49 /*
  50  * Defines for io member of prs_struct.
  51  */
  52
  53 #define MARSHALL 0
  54 #define UNMARSHALL 1
  55
  56 #define MARSHALLING(ps) (!(ps)->io)
  57 #define UNMARSHALLING(ps) ((ps)->io)
  58
  59 #define RPC_BIG_ENDIAN          1
  60 #define RPC_LITTLE_ENDIAN       0
  61
  62 #define RPC_PARSE_ALIGN 4
  63
  64 typedef struct _output_data {
  65         /*
  66          * Raw RPC output data. This does not include RPC headers or footers.
  67          */
  68         prs_struct rdata;
  69
  70         /* The amount of data sent from the current rdata struct. */
  71         uint32 data_sent_length;
  72
  73         /*
  74          * The current PDU being returned. This inclues
  75          * headers, data and authentication footer.
  76          */
  77         unsigned char current_pdu[RPC_MAX_PDU_FRAG_LEN];
  78
  79         /* The amount of data in the current_pdu buffer. */
  80         uint32 current_pdu_len;
  81
  82         /* The amount of data sent from the current PDU. */
  83         uint32 current_pdu_sent;
  84 } output_data;
  85
  86 typedef struct _input_data {
  87         /*
  88          * This is the current incoming pdu. The data here
  89          * is collected via multiple writes until a complete
  90          * pdu is seen, then the data is copied into the in_data
  91          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
  92          */
  93         unsigned char current_in_pdu[RPC_MAX_PDU_FRAG_LEN];
  94
  95         /*
  96          * The amount of data needed to complete the in_pdu.
  97          * If this is zero, then we are at the start of a new
  98          * pdu.
  99          */
 100         uint32 pdu_needed_len;
 101
 102         /*
 103          * The amount of data received so far in the in_pdu.
 104          * If this is zero, then we are at the start of a new
 105          * pdu.
 106          */
 107         uint32 pdu_received_len;
 108
 109         /*
 110          * This is the collection of input data with all
 111          * the rpc headers and auth footers removed.
 112          * The maximum length of this (1Mb) is strictly enforced.
 113          */
 114         prs_struct data;
 115 } input_data;
 116
 117 /*
 118  * Handle database - stored per pipe.
 119  */
 120
 121 struct policy {
 122         struct policy *next, *prev;
 123
 124         POLICY_HND pol_hnd;
 125
 126         void *data_ptr;
 127         void (*free_fn)(void *);
 128 };
 129
 130 struct handle_list {
 131         struct policy *Policy;  /* List of policies. */
 132         size_t count;                   /* Current number of handles. */
 133         size_t pipe_ref_count;  /* Number of pipe handles referring to this list. */
 134 };
 135
 136 /* Domain controller authentication protocol info */
 137 struct dcinfo {
 138         uint32 sequence; /* "timestamp" from client. */
 139         DOM_CHAL seed_chal;
 140         DOM_CHAL clnt_chal; /* Client credential */
 141         DOM_CHAL srv_chal;  /* Server credential */
 142
 143         unsigned char  sess_key[16]; /* Session key - 8 bytes followed by 8 zero bytes */
 144         unsigned char  mach_pw[16];   /* md4(machine password) */
 145
 146         fstring mach_acct;  /* Machine name we've authenticated. */
 147
 148         fstring remote_machine;  /* Machine name we've authenticated. */
 149         fstring domain;
 150
 151         BOOL challenge_sent;
 152         BOOL authenticated;
 153 };
 154
 155 typedef struct pipe_rpc_fns {
 156
 157         struct pipe_rpc_fns *next, *prev;
 158
 159         /* RPC function table associated with the current rpc_bind (associated by context) */
 160
 161         struct api_struct *cmds;
 162         int n_cmds;
 163         uint32 context_id;
 164
 165 } PIPE_RPC_FNS;
 166
 167 /*
 168  * Different auth types we support.
 169  * Can't keep in sync with wire values as spnego wraps different auth methods.
 170  */
 171
 172 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
 173                         PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
 174
 175 /* Possible auth levels - keep these in sync with the wire values. */
 176 enum pipe_auth_level { PIPE_AUTH_LEVEL_NONE = 0,
 177                         PIPE_AUTH_LEVEL_CONNECT = 1,    /* We treat as NONE. */
 178                         PIPE_AUTH_LEVEL_INTEGRITY = 5,  /* Sign. */
 179                         PIPE_AUTH_LEVEL_PRIVACY = 6     /* Seal. */
 180 };
 181
 182 /* auth state for krb5. */
 183 struct kerberos_auth_struct {
 184         const char *service_principal;
 185         DATA_BLOB session_key;
 186 };
 187
 188 /* auth state for schannel. */
 189 struct schannel_auth_struct {
 190         unsigned char sess_key[16];
 191         uint32 seq_num;
 192 };
 193
 194 /* auth state for all bind types. */
 195
 196 struct pipe_auth_data {
 197         enum pipe_auth_type auth_type; /* switch for union below. */
 198         enum pipe_auth_level auth_level;
 199         union {
 200                 struct schannel_auth_struct *schannel_auth;
 201                 AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
 202 /*              struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
 203         } a_u;
 204         void (*auth_data_free_func)(struct pipe_auth_data *);
 205 };
 206
 207 /*
 208  * DCE/RPC-specific samba-internal-specific handling of data on
 209  * NamedPipes.
 210  */
 211
 212 typedef struct pipes_struct {
 213         struct pipes_struct *next, *prev;
 214
 215         connection_struct *conn;
 216         uint16 vuid; /* points to the unauthenticated user that opened this pipe. */
 217
 218         fstring name;
 219         fstring pipe_srv_name;
 220
 221         /* linked list of rpc dispatch tables associated
 222            with the open rpc contexts */
 223
 224         PIPE_RPC_FNS *contexts;
 225
 226         RPC_HDR hdr; /* Incoming RPC header. */
 227         RPC_HDR_REQ hdr_req; /* Incoming request header. */
 228
 229         /* This context is used for pipe state storage and is freed when the pipe is closed. */
 230         TALLOC_CTX *pipe_state_mem_ctx;
 231
 232         struct pipe_auth_data auth;
 233
 234         struct dcinfo *dc; /* Keeps the creds data from netlogon. */
 235
 236         /*
 237          * Credentials used for the pipe operations
 238          */
 239
 240         struct current_user pipe_user;
 241         DATA_BLOB session_key;
 242
 243         /*
 244          * Set to true when an RPC bind has been done on this pipe.
 245          */
 246
 247         BOOL pipe_bound;
 248
 249         /*
 250          * Set to true when we should return fault PDU's for everything.
 251          */
 252
 253         BOOL fault_state;
 254
 255         /*
 256          * Set to true when we should return fault PDU's for a bad handle.
 257          */
 258
 259         BOOL bad_handle_fault_state;
 260
 261         /*
 262          * Set to true when the backend does not support a call.
 263          */
 264
 265         BOOL rng_fault_state;
 266
 267         /*
 268          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
 269          */
 270
 271         BOOL endian;
 272
 273         /*
 274          * Struct to deal with multiple pdu inputs.
 275          */
 276
 277         input_data in_data;
 278
 279         /*
 280          * Struct to deal with multiple pdu outputs.
 281          */
 282
 283         output_data out_data;
 284
 285         /* This context is used for PDU data and is freed between each pdu.
 286                 Don't use for pipe state storage. */
 287         TALLOC_CTX *mem_ctx;
 288
 289         /* handle database to use on this pipe. */
 290         struct handle_list *pipe_handles;
 291
 292 } pipes_struct;
 293
 294 typedef struct smb_np_struct {
 295         struct smb_np_struct *next, *prev;
 296         int pnum;
 297         connection_struct *conn;
 298         uint16 vuid; /* points to the unauthenticated user that opened this pipe. */
 299         BOOL open; /* open connection */
 300         uint16 device_state;
 301         uint16 priority;
 302         fstring name;
 303
 304         /* When replying to an SMBtrans, this is the maximum amount of
 305            data that can be sent in the initial reply. */
 306         int max_trans_reply;
 307
 308         /*
 309          * NamedPipe state information.
 310          *
 311          * (e.g. typecast a np_struct, above).
 312          */
 313         void *np_state;
 314
 315         /*
 316          * NamedPipe functions, to be called to perform
 317          * Named Pipe transactions on request from an
 318          * SMB client.
 319          */
 320
 321         /* call to create a named pipe connection.
 322          * returns: state information representing the connection.
 323          *          is stored in np_state, above.
 324          */
 325         void *   (*namedpipe_create)(char *pipe_name,
 326                                           connection_struct *conn, uint16 vuid);
 327
 328         /* call to perform a write / read namedpipe transaction.
 329          * TransactNamedPipe is weird: it returns whether there
 330          * is more data outstanding to be read, and the
 331          * caller is expected to take note and follow up with
 332          * read requests.
 333          */
 334         ssize_t  (*namedpipe_transact)(void *np_state,
 335                                        char *data, int len,
 336                                        char *rdata, int rlen,
 337                                        BOOL *pipe_outstanding);
 338
 339         /* call to perform a write namedpipe operation
 340          */
 341         ssize_t  (*namedpipe_write)(void * np_state,
 342                                     char *data, size_t n);
 343
 344         /* call to perform a read namedpipe operation.
 345          *
 346          * NOTE: the only reason that the pipe_outstanding
 347          * argument is here is because samba does not use
 348          * the namedpipe_transact function yet: instead,
 349          * it performs the same as what namedpipe_transact
 350          * does - a write, followed by a read.
 351          *
 352          * when samba is modified to use namedpipe_transact,
 353          * the pipe_outstanding argument may be removed.
 354          */
 355         ssize_t  (*namedpipe_read)(void * np_state,
 356                                    char *data, size_t max_len,
 357                                    BOOL *pipe_outstanding);
 358
 359         /* call to close a namedpipe.
 360          * function is expected to perform all cleanups
 361          * necessary, free all memory etc.
 362          *
 363          * returns True if cleanup was successful (not that
 364          * we particularly care).
 365          */
 366         BOOL     (*namedpipe_close)(void * np_state);
 367
 368 } smb_np_struct;
 369
 370 struct api_struct {
 371         const char *name;
 372         uint8 opnum;
 373         BOOL (*fn) (pipes_struct *);
 374 };
 375
 376 typedef struct {
 377         uint32 rid;
 378         const char *name;
 379 } rid_name;
 380
 381 /*
 382  * higher order functions for use with msrpc client code
 383  */
 384
 385 #define PRINT_INFO_FN(fn)\
 386         void (*fn)(const char*, uint32, uint32, void  *const *const)
 387 #define JOB_INFO_FN(fn)\
 388         void (*fn)(const char*, const char*, uint32, uint32, void *const *const)
 389
 390 /* end higher order functions */
 391
 392 typedef struct {
 393         uint32 size;
 394         prs_struct prs;
 395         uint32 struct_start;
 396         uint32 string_at_end;
 397 } RPC_BUFFER;
 398
 399 #endif /* _NT_DOMAIN_H */