fix a typo
[tprouty/samba.git] / source / include / rpc_dce.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    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #ifndef _DCE_RPC_H /* _DCE_RPC_H */
24 #define _DCE_RPC_H 
25
26 /* DCE/RPC packet types */
27
28 enum RPC_PKT_TYPE {
29         RPC_REQUEST  = 0x00,    /* Ordinary request. */
30         RPC_PING     = 0x01,    /* Connectionless is server alive ? */
31         RPC_RESPONSE = 0x02,    /* Ordinary reply. */
32         RPC_FAULT    = 0x03,    /* Fault in processing of call. */
33         RPC_WORKING  = 0x04,    /* Connectionless reply to a ping when server busy. */
34         RPC_NOCALL   = 0x05,    /* Connectionless reply to a ping when server has lost part of clients call. */
35         RPC_REJECT   = 0x06,    /* Refuse a request with a code. */
36         RPC_ACK      = 0x07,    /* Connectionless client to server code. */
37         RPC_CL_CANCEL= 0x08,    /* Connectionless cancel. */
38         RPC_FACK     = 0x09,    /* Connectionless fragment ack. Both client and server send. */
39         RPC_CANCEL_ACK = 0x0A,  /* Server ACK to client cancel request. */
40         RPC_BIND     = 0x0B,    /* Bind to interface. */
41         RPC_BINDACK  = 0x0C,    /* Server ack of bind. */
42         RPC_BINDNACK = 0x0D,    /* Server nack of bind. */
43         RPC_ALTCONT  = 0x0E,    /* Alter auth. */
44         RPC_ALTCONTRESP = 0x0F, /* Reply to alter auth. */
45         RPC_AUTH3    = 0x10,    /* not the real name!  this is undocumented! */
46         RPC_SHUTDOWN = 0x11,    /* Server to client request to shutdown. */
47         RPC_CO_CANCEL= 0x12,    /* Connection-oriented cancel request. */
48         RPC_ORPHANED = 0x13     /* Client telling server it's aborting a partially sent request or telling
49                                    server to stop sending replies. */
50 };
51
52 /* DCE/RPC flags */
53 #define RPC_FLG_FIRST 0x01
54 #define RPC_FLG_LAST  0x02
55 #define RPC_FLG_NOCALL 0x20
56
57
58 #define SMBD_NTLMSSP_NEG_FLAGS 0x000082b1 /* ALWAYS_SIGN|NEG_NTLM|NEG_LM|NEG_SEAL|NEG_SIGN|NEG_UNICODE */
59
60 /* NTLMSSP signature version */
61 #define NTLMSSP_SIGN_VERSION 0x01
62
63 /* DCE RPC auth types - extended by Microsoft. */
64 #define RPC_ANONYMOUS_AUTH_TYPE    0
65 #define RPC_AUTH_TYPE_KRB5_1       1
66 #define RPC_SPNEGO_AUTH_TYPE       9 
67 #define RPC_NTLMSSP_AUTH_TYPE     10
68 #define RPC_KRB5_AUTH_TYPE        16 /* Not yet implemented. */ 
69 #define RPC_SCHANNEL_AUTH_TYPE    68 /* 0x44 */
70
71 /* DCE-RPC standard identifiers to indicate 
72    signing or sealing of an RPC pipe */
73 #define RPC_AUTH_LEVEL_NONE      1
74 #define RPC_AUTH_LEVEL_CONNECT   2
75 #define RPC_AUTH_LEVEL_CALL      3
76 #define RPC_AUTH_LEVEL_PACKET    4
77 #define RPC_AUTH_LEVEL_INTEGRITY 5
78 #define RPC_AUTH_LEVEL_PRIVACY   6
79
80 #if 0
81 #define RPC_PIPE_AUTH_SIGN_LEVEL 0x5
82 #define RPC_PIPE_AUTH_SEAL_LEVEL 0x6
83 #endif
84
85 #define DCERPC_FAULT_OP_RNG_ERROR       0x1c010002
86 #define DCERPC_FAULT_UNK_IF             0x1c010003
87 #define DCERPC_FAULT_INVALID_TAG        0x1c000006
88 #define DCERPC_FAULT_CONTEXT_MISMATCH   0x1c00001a
89 #define DCERPC_FAULT_OTHER              0x00000001
90 #define DCERPC_FAULT_ACCESS_DENIED      0x00000005
91 #define DCERPC_FAULT_CANT_PERFORM       0x000006d8
92 #define DCERPC_FAULT_NDR                0x000006f7
93
94
95 /* Netlogon schannel auth type and level */
96 #define SCHANNEL_SIGN_SIGNATURE { 0x77, 0x00, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00 }
97 #define SCHANNEL_SEAL_SIGNATURE { 0x77, 0x00, 0x7a, 0x00, 0xff, 0xff, 0x00, 0x00 }
98
99 #define RPC_AUTH_SCHANNEL_SIGN_OR_SEAL_CHK_LEN  0x20
100 #define RPC_AUTH_SCHANNEL_SIGN_ONLY_CHK_LEN     0x18
101
102
103 #define NETLOGON_NEG_ARCFOUR                    0x00000004
104 #define NETLOGON_NEG_128BIT                     0x00004000
105 #define NETLOGON_NEG_SCHANNEL                   0x40000000
106
107 /* The 7 here seems to be required to get Win2k not to downgrade us
108    to NT4.  Actually, anything other than 1ff would seem to do... */
109 #define NETLOGON_NEG_AUTH2_FLAGS 0x000701ff
110 #define NETLOGON_NEG_DOMAIN_TRUST_ACCOUNT       0x2010b000
111
112 /* these are the flags that ADS clients use */
113 #define NETLOGON_NEG_AUTH2_ADS_FLAGS 0x600fffff
114
115 enum schannel_direction {
116         SENDER_IS_INITIATOR,
117         SENDER_IS_ACCEPTOR
118 };
119
120 /* Maximum size of the signing data in a fragment. */
121 #define RPC_MAX_SIGN_SIZE 0x20 /* 32 */
122
123 /* Maximum PDU fragment size. */
124 /* #define MAX_PDU_FRAG_LEN 0x1630              this is what wnt sets */
125 #define RPC_MAX_PDU_FRAG_LEN 0x10b8                     /* this is what w2k sets */
126
127 /* RPC_IFACE */
128 typedef struct rpc_iface_info {
129         struct GUID uuid;  /* 16 bytes of rpc interface identification */
130         uint32 version;    /* the interface version number */
131 } RPC_IFACE;
132
133 #define RPC_IFACE_LEN (UUID_SIZE + 4)
134
135 struct pipe_id_info {
136         /* the names appear not to matter: the syntaxes _do_ matter */
137
138         const char *client_pipe;
139         RPC_IFACE abstr_syntax; /* this one is the abstract syntax id */
140
141         const char *server_pipe;  /* this one is the secondary syntax name */
142         RPC_IFACE trans_syntax; /* this one is the primary syntax id */
143 };
144
145 /* RPC_HDR - dce rpc header */
146 typedef struct rpc_hdr_info {
147         uint8  major; /* 5 - RPC major version */
148         uint8  minor; /* 0 - RPC minor version */
149         uint8  pkt_type; /* RPC_PKT_TYPE - RPC response packet */
150         uint8  flags; /* DCE/RPC flags */
151         uint8  pack_type[4]; /* 0x1000 0000 - little-endian packed data representation */
152         uint16 frag_len; /* fragment length - data size (bytes) inc header and tail. */
153         uint16 auth_len; /* 0 - authentication length  */
154         uint32 call_id; /* call identifier.  matches 12th uint32 of incoming RPC data. */
155 } RPC_HDR;
156
157 #define RPC_HEADER_LEN 16
158
159 /* RPC_HDR_REQ - ms request rpc header */
160 typedef struct rpc_hdr_req_info {
161         uint32 alloc_hint;   /* allocation hint - data size (bytes) minus header and tail. */
162         uint16 context_id;   /* presentation context identifier */
163         uint16  opnum;       /* opnum */
164 } RPC_HDR_REQ;
165
166 #define RPC_HDR_REQ_LEN 8
167
168 /* RPC_HDR_RESP - ms response rpc header */
169 typedef struct rpc_hdr_resp_info {
170         uint32 alloc_hint;   /* allocation hint - data size (bytes) minus header and tail. */
171         uint16 context_id;   /* 0 - presentation context identifier */
172         uint8  cancel_count; /* 0 - cancel count */
173         uint8  reserved;     /* 0 - reserved. */
174 } RPC_HDR_RESP;
175
176 #define RPC_HDR_RESP_LEN 8
177
178 /* RPC_HDR_FAULT - fault rpc header */
179 typedef struct rpc_hdr_fault_info {
180         NTSTATUS status;
181         uint32 reserved; /* 0x0000 0000 */
182 } RPC_HDR_FAULT;
183
184 #define RPC_HDR_FAULT_LEN 8
185
186 /* this seems to be the same string name depending on the name of the pipe,
187  * but is more likely to be linked to the interface name
188  * "srvsvc", "\\PIPE\\ntsvcs"
189  * "samr", "\\PIPE\\lsass"
190  * "wkssvc", "\\PIPE\\wksvcs"
191  * "NETLOGON", "\\PIPE\\NETLOGON"
192  */
193 /* RPC_ADDR_STR */
194 typedef struct rpc_addr_info {
195         uint16 len;   /* length of the string including null terminator */
196         fstring str; /* the string above in single byte, null terminated form */
197 } RPC_ADDR_STR;
198
199 /* RPC_HDR_BBA - bind acknowledge, and alter context response. */
200 typedef struct rpc_hdr_bba_info {
201         uint16 max_tsize;       /* maximum transmission fragment size (0x1630) */
202         uint16 max_rsize;       /* max receive fragment size (0x1630) */
203         uint32 assoc_gid;       /* associated group id (0x0) */
204 } RPC_HDR_BBA;
205
206 #define RPC_HDR_BBA_LEN 8
207
208 /* RPC_HDR_AUTH */
209 typedef struct rpc_hdr_auth_info {
210         uint8 auth_type; /* See XXX_AUTH_TYPE above. */
211         uint8 auth_level; /* See RPC_PIPE_AUTH_XXX_LEVEL above. */
212         uint8 auth_pad_len;
213         uint8 auth_reserved;
214         uint32 auth_context_id;
215 } RPC_HDR_AUTH;
216
217 #define RPC_HDR_AUTH_LEN 8
218
219 /* this is TEMPORARILY coded up as a specific structure */
220 /* this structure comes after the bind request */
221 /* RPC_AUTH_SCHANNEL_NEG */
222 typedef struct rpc_auth_schannel_neg_info {
223         uint32 type1;   /* Always zero ? */
224         uint32 type2;   /* Types 0x3 and 0x13 seen. Check AcquireSecurityContext() docs.... */
225         fstring domain; /* calling workstations's domain */
226         fstring myname; /* calling workstation's name */
227 } RPC_AUTH_SCHANNEL_NEG;
228
229 /* attached to the end of encrypted rpc requests and responses */
230 /* RPC_AUTH_SCHANNEL_CHK */
231 typedef struct rpc_auth_schannel_chk_info {
232         uint8 sig  [8]; /* 77 00 7a 00 ff ff 00 00 */
233         uint8 packet_digest[8]; /* checksum over the packet, MD5'ed with session key */
234         uint8 seq_num[8]; /* verifier, seq num */
235         uint8 confounder[8]; /* random 8-byte nonce */
236 } RPC_AUTH_SCHANNEL_CHK;
237
238 typedef struct rpc_context {
239         uint16 context_id;              /* presentation context identifier. */
240         uint8 num_transfer_syntaxes;    /* the number of syntaxes */
241         RPC_IFACE abstract;             /* num and vers. of interface client is using */
242         RPC_IFACE *transfer;            /* Array of transfer interfaces. */
243 } RPC_CONTEXT;
244
245 /* RPC_BIND_REQ - ms req bind */
246 typedef struct rpc_bind_req_info {
247         RPC_HDR_BBA bba;
248         uint8 num_contexts;    /* the number of contexts */
249         RPC_CONTEXT *rpc_context;
250 } RPC_HDR_RB;
251
252 /* 
253  * The following length is 8 bytes RPC_HDR_BBA_LEN + 
254  * 4 bytes size of context count +
255  * (context_count * (4 bytes of context_id, size of transfer syntax count + RPC_IFACE_LEN bytes +
256  *                    (transfer_syntax_count * RPC_IFACE_LEN bytes)))
257  */
258
259 #define RPC_HDR_RB_LEN(rpc_hdr_rb) (RPC_HDR_BBA_LEN + 4 + \
260         ((rpc_hdr_rb)->num_contexts) * (4 + RPC_IFACE_LEN + (((rpc_hdr_rb)->rpc_context->num_transfer_syntaxes)*RPC_IFACE_LEN)))
261
262 /* RPC_RESULTS - can only cope with one reason, right now... */
263 typedef struct rpc_results_info {
264         /* uint8[] # 4-byte alignment padding, against SMB header */
265
266         uint8 num_results; /* the number of results (0x01) */
267
268         /* uint8[] # 4-byte alignment padding, against SMB header */
269
270         uint16 result; /* result (0x00 = accept) */
271         uint16 reason; /* reason (0x00 = no reason specified) */
272 } RPC_RESULTS;
273
274 /* RPC_HDR_BA */
275 typedef struct rpc_hdr_ba_info {
276         RPC_HDR_BBA bba;
277
278         RPC_ADDR_STR addr    ;  /* the secondary address string, as described earlier */
279         RPC_RESULTS  res     ; /* results and reasons */
280         RPC_IFACE    transfer; /* the transfer syntax from the request */
281 } RPC_HDR_BA;
282
283 /* RPC_AUTH_VERIFIER */
284 typedef struct rpc_auth_verif_info {
285         fstring signature; /* "NTLMSSP".. Ok, not quite anymore */
286         uint32  msg_type; /* NTLMSSP_MESSAGE_TYPE (1,2,3) and 5 for schannel */
287 } RPC_AUTH_VERIFIER;
288
289 #endif /* _DCE_RPC_H */