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 #include "librpc/rpc/dcerpc.h"
  27
  28 /*
  29  * A bunch of stuff that was put into smb.h
  30  * in the NTDOM branch - it didn't belong there.
  31  */
  32
  33 typedef struct _output_data {
  34         /*
  35          * Raw RPC output data. This does not include RPC headers or footers.
  36          */
  37         DATA_BLOB rdata;
  38
  39         /* The amount of data sent from the current rdata struct. */
  40         uint32 data_sent_length;
  41
  42         /*
  43          * The current fragment being returned. This inclues
  44          * headers, data and authentication footer.
  45          */
  46         DATA_BLOB frag;
  47
  48         /* The amount of data sent from the current PDU. */
  49         uint32 current_pdu_sent;
  50 } output_data;
  51
  52 typedef struct _input_data {
  53         /*
  54          * This is the current incoming pdu. The data here
  55          * is collected via multiple writes until a complete
  56          * pdu is seen, then the data is copied into the in_data
  57          * structure. The maximum size of this is 0x1630 (RPC_MAX_PDU_FRAG_LEN).
  58          * If length is zero, then we are at the start of a new
  59          * pdu.
  60          */
  61         DATA_BLOB pdu;
  62
  63         /*
  64          * The amount of data needed to complete the in_pdu.
  65          * If this is zero, then we are at the start of a new
  66          * pdu.
  67          */
  68         uint32 pdu_needed_len;
  69
  70         /*
  71          * This is the collection of input data with all
  72          * the rpc headers and auth footers removed.
  73          * The maximum length of this (1Mb) is strictly enforced.
  74          */
  75         DATA_BLOB data;
  76
  77 } input_data;
  78
  79 struct handle_list;
  80
  81 typedef struct pipe_rpc_fns {
  82
  83         struct pipe_rpc_fns *next, *prev;
  84
  85         /* RPC function table associated with the current rpc_bind (associated by context) */
  86
  87         const struct api_struct *cmds;
  88         int n_cmds;
  89         uint32_t context_id;
  90         struct ndr_syntax_id syntax;
  91
  92 } PIPE_RPC_FNS;
  93
  94 /*
  95  * Different auth types we support.
  96  * Can't keep in sync with wire values as spnego wraps different auth methods.
  97  */
  98
  99 struct gse_context;
 100
 101 struct dcesrv_ep_entry_list;
 102
 103 struct tsocket_address;
 104
 105 /*
 106  * DCE/RPC-specific samba-internal-specific handling of data on
 107  * NamedPipes.
 108  */
 109
 110 struct pipes_struct {
 111         struct pipes_struct *next, *prev;
 112
 113         const struct tsocket_address *local_address;
 114         const struct tsocket_address *remote_address;
 115
 116         enum dcerpc_transport_t transport;
 117
 118         struct auth_session_info *session_info;
 119         struct messaging_context *msg_ctx;
 120
 121         struct dcesrv_ep_entry_list *ep_entries;
 122
 123         /* linked list of rpc dispatch tables associated
 124            with the open rpc contexts */
 125
 126         PIPE_RPC_FNS *contexts;
 127
 128         struct pipe_auth_data auth;
 129
 130         bool ncalrpc_as_system;
 131
 132         /*
 133          * Set to true when an RPC bind has been done on this pipe.
 134          */
 135
 136         bool pipe_bound;
 137
 138         /*
 139          * Set to true when we should return fault PDU's for everything.
 140          */
 141
 142         bool fault_state;
 143
 144         /*
 145          * Set to true when we should return fault PDU's for a bad handle.
 146          */
 147
 148         bool bad_handle_fault_state;
 149
 150         /*
 151          * Set to true when the backend does not support a call.
 152          */
 153
 154         bool rng_fault_state;
 155
 156         /*
 157          * Set to RPC_BIG_ENDIAN when dealing with big-endian PDU's
 158          */
 159
 160         bool endian;
 161
 162         /*
 163          * Struct to deal with multiple pdu inputs.
 164          */
 165
 166         input_data in_data;
 167
 168         /*
 169          * Struct to deal with multiple pdu outputs.
 170          */
 171
 172         output_data out_data;
 173
 174         /* This context is used for PDU data and is freed between each pdu.
 175                 Don't use for pipe state storage. */
 176         TALLOC_CTX *mem_ctx;
 177
 178         /* handle database to use on this pipe. */
 179         struct handle_list *pipe_handles;
 180
 181         /* call id retrieved from the pdu header */
 182         uint32_t call_id;
 183
 184         /* operation number retrieved from the rpc header */
 185         uint16_t opnum;
 186
 187         /* private data for the interface implementation */
 188         void *private_data;
 189
 190 };
 191
 192 struct api_struct {
 193         const char *name;
 194         uint8 opnum;
 195         bool (*fn) (struct pipes_struct *);
 196 };
 197
 198 /* The following definitions come from rpc_server/rpc_handles.c  */
 199
 200 size_t num_pipe_handles(struct pipes_struct *p);
 201 bool init_pipe_handles(struct pipes_struct *p, const struct ndr_syntax_id *syntax);
 202 bool create_policy_hnd(struct pipes_struct *p, struct policy_handle *hnd, void *data_ptr);
 203 bool find_policy_by_hnd(struct pipes_struct *p, const struct policy_handle *hnd,
 204                         void **data_p);
 205 bool close_policy_hnd(struct pipes_struct *p, struct policy_handle *hnd);
 206 void close_policy_by_pipe(struct pipes_struct *p);
 207 bool pipe_access_check(struct pipes_struct *p);
 208
 209 void *_policy_handle_create(struct pipes_struct *p, struct policy_handle *hnd,
 210                             uint32_t access_granted, size_t data_size,
 211                             const char *type, NTSTATUS *pstatus);
 212 #define policy_handle_create(_p, _hnd, _access, _type, _pstatus) \
 213         (_type *)_policy_handle_create((_p), (_hnd), (_access), sizeof(_type), #_type, \
 214                                        (_pstatus))
 215
 216 void *_policy_handle_find(struct pipes_struct *p,
 217                           const struct policy_handle *hnd,
 218                           uint32_t access_required, uint32_t *paccess_granted,
 219                           const char *name, const char *location,
 220                           NTSTATUS *pstatus);
 221 #define policy_handle_find(_p, _hnd, _access_required, _access_granted, _type, _pstatus) \
 222         (_type *)_policy_handle_find((_p), (_hnd), (_access_required), \
 223                                      (_access_granted), #_type, __location__, (_pstatus))
 224
 225 #include "rpc_server/srv_pipe_register.h"
 226
 227 #endif /* _NT_DOMAIN_H */