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 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, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _NT_DOMAIN_H /* _NT_DOMAIN_H */
  24 #define _NT_DOMAIN_H
  25
  26 /*
  27  * A bunch of stuff that was put into smb.h
  28  * in the NTDOM branch - it didn't belong there.
  29  */
  30
  31 #define prs_init_empty( _ps_, _ctx_, _io_ ) (void) prs_init((_ps_), 0, (_ctx_), (_io_))
  32
  33 typedef struct _prs_struct {
  34         bool io; /* parsing in or out of data stream */
  35         /*
  36          * If the (incoming) data is big-endian. On output we are
  37          * always little-endian.
  38          */
  39         bool bigendian_data;
  40         uint8 align; /* data alignment */
  41         bool is_dynamic; /* Do we own this memory or not ? */
  42         uint32 data_offset; /* Current working offset into data. */
  43         uint32 buffer_size; /* Current allocated size of the buffer. */
  44         uint32 grow_size; /* size requested via prs_grow() calls */
  45         char *data_p; /* The buffer itself. */
  46         TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
  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 fragment being returned. This inclues
  75          * headers, data and authentication footer.
  76          */
  77         prs_struct frag;
  78
  79         /* The amount of data sent from the current PDU. */
  80         uint32 current_pdu_sent;
  81 } output_data;
  82
  83 typedef struct _input_data {
  84         /*
  85          * This is the current incoming pdu. The data here
  86          * is collected via multiple writes until a complete
  87          * pdu is seen, then the data is copied into the in_data
  88          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
  89          */
  90         uint8_t *current_in_pdu;
  91
  92         /*
  93          * The amount of data needed to complete the in_pdu.
  94          * If this is zero, then we are at the start of a new
  95          * pdu.
  96          */
  97         uint32 pdu_needed_len;
  98
  99         /*
 100          * The amount of data received so far in the in_pdu.
 101          * If this is zero, then we are at the start of a new
 102          * pdu.
 103          */
 104         uint32 pdu_received_len;
 105
 106         /*
 107          * This is the collection of input data with all
 108          * the rpc headers and auth footers removed.
 109          * The maximum length of this (1Mb) is strictly enforced.
 110          */
 111         prs_struct data;
 112 } input_data;
 113
 114 struct handle_list;
 115
 116 typedef struct pipe_rpc_fns {
 117
 118         struct pipe_rpc_fns *next, *prev;
 119
 120         /* RPC function table associated with the current rpc_bind (associated by context) */
 121
 122         const struct api_struct *cmds;
 123         int n_cmds;
 124         uint32 context_id;
 125
 126 } PIPE_RPC_FNS;
 127
 128 /*
 129  * Different auth types we support.
 130  * Can't keep in sync with wire values as spnego wraps different auth methods.
 131  */
 132
 133 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
 134                         PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
 135
 136 /* auth state for krb5. */
 137 struct kerberos_auth_struct {
 138         const char *service_principal;
 139         DATA_BLOB session_key;
 140 };
 141
 142 /* auth state for all bind types. */
 143
 144 struct pipe_auth_data {
 145         enum pipe_auth_type auth_type; /* switch for union below. */
 146         enum dcerpc_AuthLevel auth_level;
 147         union {
 148                 struct schannel_state *schannel_auth;
 149                 struct auth_ntlmssp_state *auth_ntlmssp_state;
 150 /*              struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
 151         } a_u;
 152         void (*auth_data_free_func)(struct pipe_auth_data *);
 153 };
 154
 155 /*
 156  * DCE/RPC-specific samba-internal-specific handling of data on
 157  * NamedPipes.
 158  */
 159
 160 typedef struct pipes_struct {
 161         struct pipes_struct *next, *prev;
 162
 163         char client_address[INET6_ADDRSTRLEN];
 164
 165         struct auth_serversupplied_info *server_info;
 166
 167         struct ndr_syntax_id syntax;
 168
 169         /* linked list of rpc dispatch tables associated
 170            with the open rpc contexts */
 171
 172         PIPE_RPC_FNS *contexts;
 173
 174         RPC_HDR hdr; /* Incoming RPC header. */
 175         RPC_HDR_REQ hdr_req; /* Incoming request header. */
 176
 177         struct pipe_auth_data auth;
 178
 179         /*
 180          * Set to true when an RPC bind has been done on this pipe.
 181          */
 182
 183         bool pipe_bound;
 184
 185         /*
 186          * Set to true when we should return fault PDU's for everything.
 187          */
 188
 189         bool fault_state;
 190
 191         /*
 192          * Set to true when we should return fault PDU's for a bad handle.
 193          */
 194
 195         bool bad_handle_fault_state;
 196
 197         /*
 198          * Set to true when the backend does not support a call.
 199          */
 200
 201         bool rng_fault_state;
 202
 203         /*
 204          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
 205          */
 206
 207         bool endian;
 208
 209         /*
 210          * Struct to deal with multiple pdu inputs.
 211          */
 212
 213         input_data in_data;
 214
 215         /*
 216          * Struct to deal with multiple pdu outputs.
 217          */
 218
 219         output_data out_data;
 220
 221         /* This context is used for PDU data and is freed between each pdu.
 222                 Don't use for pipe state storage. */
 223         TALLOC_CTX *mem_ctx;
 224
 225         /* handle database to use on this pipe. */
 226         struct handle_list *pipe_handles;
 227
 228         /* private data for the interface implementation */
 229         void *private_data;
 230
 231 } pipes_struct;
 232
 233 struct api_struct {
 234         const char *name;
 235         uint8 opnum;
 236         bool (*fn) (pipes_struct *);
 237 };
 238
 239 #endif /* _NT_DOMAIN_H */