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         /* The buffer itself. If "is_dynamic" is true this
  46          * MUST BE TALLOC'ed off mem_ctx. */
  47         char *data_p;
  48         TALLOC_CTX *mem_ctx; /* When unmarshalling, use this.... */
  49 } prs_struct;
  50
  51 /*
  52  * Defines for io member of prs_struct.
  53  */
  54
  55 #define MARSHALL 0
  56 #define UNMARSHALL 1
  57
  58 #define MARSHALLING(ps) (!(ps)->io)
  59 #define UNMARSHALLING(ps) ((ps)->io)
  60
  61 #define RPC_BIG_ENDIAN          1
  62 #define RPC_LITTLE_ENDIAN       0
  63
  64 #define RPC_PARSE_ALIGN 4
  65
  66 typedef struct _output_data {
  67         /*
  68          * Raw RPC output data. This does not include RPC headers or footers.
  69          */
  70         DATA_BLOB rdata;
  71
  72         /* The amount of data sent from the current rdata struct. */
  73         uint32 data_sent_length;
  74
  75         /*
  76          * The current fragment being returned. This inclues
  77          * headers, data and authentication footer.
  78          */
  79         prs_struct frag;
  80
  81         /* The amount of data sent from the current PDU. */
  82         uint32 current_pdu_sent;
  83 } output_data;
  84
  85 typedef struct _input_data {
  86         /*
  87          * This is the current incoming pdu. The data here
  88          * is collected via multiple writes until a complete
  89          * pdu is seen, then the data is copied into the in_data
  90          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
  91          * If length is zero, then we are at the start of a new
  92          * pdu.
  93          */
  94         DATA_BLOB pdu;
  95
  96         /*
  97          * The amount of data needed to complete the in_pdu.
  98          * If this is zero, then we are at the start of a new
  99          * pdu.
 100          */
 101         uint32 pdu_needed_len;
 102
 103         /*
 104          * This is the collection of input data with all
 105          * the rpc headers and auth footers removed.
 106          * The maximum length of this (1Mb) is strictly enforced.
 107          */
 108         prs_struct data;
 109 } input_data;
 110
 111 struct handle_list;
 112
 113 typedef struct pipe_rpc_fns {
 114
 115         struct pipe_rpc_fns *next, *prev;
 116
 117         /* RPC function table associated with the current rpc_bind (associated by context) */
 118
 119         const struct api_struct *cmds;
 120         int n_cmds;
 121         uint32 context_id;
 122
 123 } PIPE_RPC_FNS;
 124
 125 /*
 126  * Different auth types we support.
 127  * Can't keep in sync with wire values as spnego wraps different auth methods.
 128  */
 129
 130 enum pipe_auth_type { PIPE_AUTH_TYPE_NONE = 0, PIPE_AUTH_TYPE_NTLMSSP, PIPE_AUTH_TYPE_SCHANNEL,
 131                         PIPE_AUTH_TYPE_SPNEGO_NTLMSSP, PIPE_AUTH_TYPE_KRB5, PIPE_AUTH_TYPE_SPNEGO_KRB5 };
 132
 133 /* auth state for krb5. */
 134 struct kerberos_auth_struct {
 135         const char *service_principal;
 136         DATA_BLOB session_key;
 137 };
 138
 139 /* auth state for all bind types. */
 140
 141 struct pipe_auth_data {
 142         enum pipe_auth_type auth_type; /* switch for union below. */
 143         enum dcerpc_AuthLevel auth_level;
 144         union {
 145                 struct schannel_state *schannel_auth;
 146                 struct auth_ntlmssp_state *auth_ntlmssp_state;
 147 /*              struct kerberos_auth_struct *kerberos_auth; TO BE ADDED... */
 148         } a_u;
 149         void (*auth_data_free_func)(struct pipe_auth_data *);
 150 };
 151
 152 /*
 153  * DCE/RPC-specific samba-internal-specific handling of data on
 154  * NamedPipes.
 155  */
 156
 157 typedef struct pipes_struct {
 158         struct pipes_struct *next, *prev;
 159
 160         char client_address[INET6_ADDRSTRLEN];
 161
 162         struct auth_serversupplied_info *server_info;
 163
 164         struct ndr_syntax_id syntax;
 165
 166         /* linked list of rpc dispatch tables associated
 167            with the open rpc contexts */
 168
 169         PIPE_RPC_FNS *contexts;
 170
 171         struct pipe_auth_data auth;
 172
 173         /*
 174          * Set to true when an RPC bind has been done on this pipe.
 175          */
 176
 177         bool pipe_bound;
 178
 179         /*
 180          * Set to true when we should return fault PDU's for everything.
 181          */
 182
 183         bool fault_state;
 184
 185         /*
 186          * Set to true when we should return fault PDU's for a bad handle.
 187          */
 188
 189         bool bad_handle_fault_state;
 190
 191         /*
 192          * Set to true when the backend does not support a call.
 193          */
 194
 195         bool rng_fault_state;
 196
 197         /*
 198          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
 199          */
 200
 201         bool endian;
 202
 203         /*
 204          * Struct to deal with multiple pdu inputs.
 205          */
 206
 207         input_data in_data;
 208
 209         /*
 210          * Struct to deal with multiple pdu outputs.
 211          */
 212
 213         output_data out_data;
 214
 215         /* This context is used for PDU data and is freed between each pdu.
 216                 Don't use for pipe state storage. */
 217         TALLOC_CTX *mem_ctx;
 218
 219         /* handle database to use on this pipe. */
 220         struct handle_list *pipe_handles;
 221
 222         /* call id retrieved from the pdu header */
 223         uint32_t call_id;
 224
 225         /* operation number retrieved from the rpc header */
 226         uint16_t opnum;
 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 */