Fix breakage for connect function after API change (connect -> connect_fn)
[Samba.git] / source3 / rpc_parse / parse_rpc.c
blob651a5915b838406fa79c7de5b3f230d783993a4e
1 /*
2 * Unix SMB/CIFS implementation.
3 * RPC Pipe client / server routines
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 1999.
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.
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.
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/>.
23 #include "includes.h"
25 #undef DBGC_CLASS
26 #define DBGC_CLASS DBGC_RPC_PARSE
28 /*******************************************************************
29 Inits an RPC_HDR structure.
30 ********************************************************************/
32 void init_rpc_hdr(RPC_HDR *hdr, enum RPC_PKT_TYPE pkt_type, uint8 flags,
33 uint32 call_id, int data_len, int auth_len)
35 hdr->major = 5; /* RPC version 5 */
36 hdr->minor = 0; /* minor version 0 */
37 hdr->pkt_type = pkt_type; /* RPC packet type */
38 hdr->flags = flags; /* dce/rpc flags */
39 hdr->pack_type[0] = 0x10; /* little-endian data representation */
40 hdr->pack_type[1] = 0; /* packed data representation */
41 hdr->pack_type[2] = 0; /* packed data representation */
42 hdr->pack_type[3] = 0; /* packed data representation */
43 hdr->frag_len = data_len; /* fragment length, fill in later */
44 hdr->auth_len = auth_len; /* authentication length */
45 hdr->call_id = call_id; /* call identifier - match incoming RPC */
48 /*******************************************************************
49 Reads or writes an RPC_HDR structure.
50 ********************************************************************/
52 bool smb_io_rpc_hdr(const char *desc, RPC_HDR *rpc, prs_struct *ps, int depth)
54 if (rpc == NULL)
55 return False;
57 prs_debug(ps, depth, desc, "smb_io_rpc_hdr");
58 depth++;
60 if(!prs_uint8 ("major ", ps, depth, &rpc->major))
61 return False;
63 if(!prs_uint8 ("minor ", ps, depth, &rpc->minor))
64 return False;
65 if(!prs_uint8 ("pkt_type ", ps, depth, &rpc->pkt_type))
66 return False;
67 if(!prs_uint8 ("flags ", ps, depth, &rpc->flags))
68 return False;
70 /* We always marshall in little endian format. */
71 if (MARSHALLING(ps))
72 rpc->pack_type[0] = 0x10;
74 if(!prs_uint8("pack_type0", ps, depth, &rpc->pack_type[0]))
75 return False;
76 if(!prs_uint8("pack_type1", ps, depth, &rpc->pack_type[1]))
77 return False;
78 if(!prs_uint8("pack_type2", ps, depth, &rpc->pack_type[2]))
79 return False;
80 if(!prs_uint8("pack_type3", ps, depth, &rpc->pack_type[3]))
81 return False;
84 * If reading and pack_type[0] == 0 then the data is in big-endian
85 * format. Set the flag in the prs_struct to specify reverse-endainness.
88 if (UNMARSHALLING(ps) && rpc->pack_type[0] == 0) {
89 DEBUG(10,("smb_io_rpc_hdr: PDU data format is big-endian. Setting flag.\n"));
90 prs_set_endian_data(ps, RPC_BIG_ENDIAN);
93 if(!prs_uint16("frag_len ", ps, depth, &rpc->frag_len))
94 return False;
95 if(!prs_uint16("auth_len ", ps, depth, &rpc->auth_len))
96 return False;
97 if(!prs_uint32("call_id ", ps, depth, &rpc->call_id))
98 return False;
99 return True;
102 /*******************************************************************
103 Reads or writes an struct ndr_syntax_id structure.
104 ********************************************************************/
106 static bool smb_io_rpc_iface(const char *desc, struct ndr_syntax_id *ifc,
107 prs_struct *ps, int depth)
109 if (ifc == NULL)
110 return False;
112 prs_debug(ps, depth, desc, "smb_io_rpc_iface");
113 depth++;
115 if (!prs_align(ps))
116 return False;
118 if (!smb_io_uuid( "uuid", &ifc->uuid, ps, depth))
119 return False;
121 if(!prs_uint32 ("version", ps, depth, &ifc->if_version))
122 return False;
124 return True;
127 /*******************************************************************
128 Inits an RPC_ADDR_STR structure.
129 ********************************************************************/
131 static void init_rpc_addr_str(RPC_ADDR_STR *str, const char *name)
133 str->len = strlen(name) + 1;
134 fstrcpy(str->str, name);
137 /*******************************************************************
138 Reads or writes an RPC_ADDR_STR structure.
139 ********************************************************************/
141 static bool smb_io_rpc_addr_str(const char *desc, RPC_ADDR_STR *str, prs_struct *ps, int depth)
143 if (str == NULL)
144 return False;
146 prs_debug(ps, depth, desc, "smb_io_rpc_addr_str");
147 depth++;
148 if(!prs_align(ps))
149 return False;
151 if(!prs_uint16 ( "len", ps, depth, &str->len))
152 return False;
153 if(!prs_uint8s (True, "str", ps, depth, (uchar*)str->str, MIN(str->len, sizeof(str->str)) ))
154 return False;
155 return True;
158 /*******************************************************************
159 Inits an RPC_HDR_BBA structure.
160 ********************************************************************/
162 static void init_rpc_hdr_bba(RPC_HDR_BBA *bba, uint16 max_tsize, uint16 max_rsize, uint32 assoc_gid)
164 bba->max_tsize = max_tsize; /* maximum transmission fragment size (0x1630) */
165 bba->max_rsize = max_rsize; /* max receive fragment size (0x1630) */
166 bba->assoc_gid = assoc_gid; /* associated group id (0x0) */
169 /*******************************************************************
170 Reads or writes an RPC_HDR_BBA structure.
171 ********************************************************************/
173 static bool smb_io_rpc_hdr_bba(const char *desc, RPC_HDR_BBA *rpc, prs_struct *ps, int depth)
175 if (rpc == NULL)
176 return False;
178 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_bba");
179 depth++;
181 if(!prs_uint16("max_tsize", ps, depth, &rpc->max_tsize))
182 return False;
183 if(!prs_uint16("max_rsize", ps, depth, &rpc->max_rsize))
184 return False;
185 if(!prs_uint32("assoc_gid", ps, depth, &rpc->assoc_gid))
186 return False;
187 return True;
190 /*******************************************************************
191 Inits an RPC_CONTEXT structure.
192 Note the transfer pointer must remain valid until this is marshalled.
193 ********************************************************************/
195 void init_rpc_context(RPC_CONTEXT *rpc_ctx, uint16 context_id,
196 const struct ndr_syntax_id *abstract,
197 const struct ndr_syntax_id *transfer)
199 rpc_ctx->context_id = context_id ; /* presentation context identifier (0x0) */
200 rpc_ctx->num_transfer_syntaxes = 1 ; /* the number of syntaxes (has always been 1?)(0x1) */
202 /* num and vers. of interface client is using */
203 rpc_ctx->abstract = *abstract;
205 /* vers. of interface to use for replies */
206 rpc_ctx->transfer = CONST_DISCARD(struct ndr_syntax_id *, transfer);
209 /*******************************************************************
210 Inits an RPC_HDR_RB structure.
211 Note the context pointer must remain valid until this is marshalled.
212 ********************************************************************/
214 void init_rpc_hdr_rb(RPC_HDR_RB *rpc,
215 uint16 max_tsize, uint16 max_rsize, uint32 assoc_gid,
216 RPC_CONTEXT *context)
218 init_rpc_hdr_bba(&rpc->bba, max_tsize, max_rsize, assoc_gid);
220 rpc->num_contexts = 1;
221 rpc->rpc_context = context;
224 /*******************************************************************
225 Reads or writes an RPC_CONTEXT structure.
226 ********************************************************************/
228 bool smb_io_rpc_context(const char *desc, RPC_CONTEXT *rpc_ctx, prs_struct *ps, int depth)
230 int i;
232 if (rpc_ctx == NULL)
233 return False;
235 if(!prs_align(ps))
236 return False;
237 if(!prs_uint16("context_id ", ps, depth, &rpc_ctx->context_id ))
238 return False;
239 if(!prs_uint8 ("num_transfer_syntaxes", ps, depth, &rpc_ctx->num_transfer_syntaxes))
240 return False;
242 /* num_transfer_syntaxes must not be zero. */
243 if (rpc_ctx->num_transfer_syntaxes == 0)
244 return False;
246 if(!smb_io_rpc_iface("", &rpc_ctx->abstract, ps, depth))
247 return False;
249 if (UNMARSHALLING(ps)) {
250 if (!(rpc_ctx->transfer = PRS_ALLOC_MEM(ps, struct ndr_syntax_id, rpc_ctx->num_transfer_syntaxes))) {
251 return False;
255 for (i = 0; i < rpc_ctx->num_transfer_syntaxes; i++ ) {
256 if (!smb_io_rpc_iface("", &rpc_ctx->transfer[i], ps, depth))
257 return False;
259 return True;
262 /*******************************************************************
263 Reads or writes an RPC_HDR_RB structure.
264 ********************************************************************/
266 bool smb_io_rpc_hdr_rb(const char *desc, RPC_HDR_RB *rpc, prs_struct *ps, int depth)
268 int i;
270 if (rpc == NULL)
271 return False;
273 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_rb");
274 depth++;
276 if(!smb_io_rpc_hdr_bba("", &rpc->bba, ps, depth))
277 return False;
279 if(!prs_uint8("num_contexts", ps, depth, &rpc->num_contexts))
280 return False;
282 /* 3 pad bytes following - will be mopped up by the prs_align in smb_io_rpc_context(). */
284 /* num_contexts must not be zero. */
285 if (rpc->num_contexts == 0)
286 return False;
288 if (UNMARSHALLING(ps)) {
289 if (!(rpc->rpc_context = PRS_ALLOC_MEM(ps, RPC_CONTEXT, rpc->num_contexts))) {
290 return False;
294 for (i = 0; i < rpc->num_contexts; i++ ) {
295 if (!smb_io_rpc_context("", &rpc->rpc_context[i], ps, depth))
296 return False;
299 return True;
302 /*******************************************************************
303 Inits an RPC_RESULTS structure.
305 lkclXXXX only one reason at the moment!
306 ********************************************************************/
308 static void init_rpc_results(RPC_RESULTS *res,
309 uint8 num_results, uint16 result, uint16 reason)
311 res->num_results = num_results; /* the number of results (0x01) */
312 res->result = result ; /* result (0x00 = accept) */
313 res->reason = reason ; /* reason (0x00 = no reason specified) */
316 /*******************************************************************
317 Reads or writes an RPC_RESULTS structure.
319 lkclXXXX only one reason at the moment!
320 ********************************************************************/
322 static bool smb_io_rpc_results(const char *desc, RPC_RESULTS *res, prs_struct *ps, int depth)
324 if (res == NULL)
325 return False;
327 prs_debug(ps, depth, desc, "smb_io_rpc_results");
328 depth++;
330 if(!prs_align(ps))
331 return False;
333 if(!prs_uint8 ("num_results", ps, depth, &res->num_results))
334 return False;
336 if(!prs_align(ps))
337 return False;
339 if(!prs_uint16("result ", ps, depth, &res->result))
340 return False;
341 if(!prs_uint16("reason ", ps, depth, &res->reason))
342 return False;
343 return True;
346 /*******************************************************************
347 Init an RPC_HDR_BA structure.
349 lkclXXXX only one reason at the moment!
351 ********************************************************************/
353 void init_rpc_hdr_ba(RPC_HDR_BA *rpc,
354 uint16 max_tsize, uint16 max_rsize, uint32 assoc_gid,
355 const char *pipe_addr,
356 uint8 num_results, uint16 result, uint16 reason,
357 const struct ndr_syntax_id *transfer)
359 init_rpc_hdr_bba (&rpc->bba, max_tsize, max_rsize, assoc_gid);
360 init_rpc_addr_str(&rpc->addr, pipe_addr);
361 init_rpc_results (&rpc->res, num_results, result, reason);
363 /* the transfer syntax from the request */
364 memcpy(&rpc->transfer, transfer, sizeof(rpc->transfer));
367 /*******************************************************************
368 Reads or writes an RPC_HDR_BA structure.
369 ********************************************************************/
371 bool smb_io_rpc_hdr_ba(const char *desc, RPC_HDR_BA *rpc, prs_struct *ps, int depth)
373 if (rpc == NULL)
374 return False;
376 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_ba");
377 depth++;
379 if(!smb_io_rpc_hdr_bba("", &rpc->bba, ps, depth))
380 return False;
381 if(!smb_io_rpc_addr_str("", &rpc->addr, ps, depth))
382 return False;
383 if(!smb_io_rpc_results("", &rpc->res, ps, depth))
384 return False;
385 if(!smb_io_rpc_iface("", &rpc->transfer, ps, depth))
386 return False;
387 return True;
390 /*******************************************************************
391 Init an RPC_HDR_REQ structure.
392 ********************************************************************/
394 void init_rpc_hdr_req(RPC_HDR_REQ *hdr, uint32 alloc_hint, uint16 opnum)
396 hdr->alloc_hint = alloc_hint; /* allocation hint */
397 hdr->context_id = 0; /* presentation context identifier */
398 hdr->opnum = opnum; /* opnum */
401 /*******************************************************************
402 Reads or writes an RPC_HDR_REQ structure.
403 ********************************************************************/
405 bool smb_io_rpc_hdr_req(const char *desc, RPC_HDR_REQ *rpc, prs_struct *ps, int depth)
407 if (rpc == NULL)
408 return False;
410 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_req");
411 depth++;
413 if(!prs_uint32("alloc_hint", ps, depth, &rpc->alloc_hint))
414 return False;
415 if(!prs_uint16("context_id", ps, depth, &rpc->context_id))
416 return False;
417 if(!prs_uint16("opnum ", ps, depth, &rpc->opnum))
418 return False;
419 return True;
422 /*******************************************************************
423 Reads or writes an RPC_HDR_RESP structure.
424 ********************************************************************/
426 bool smb_io_rpc_hdr_resp(const char *desc, RPC_HDR_RESP *rpc, prs_struct *ps, int depth)
428 if (rpc == NULL)
429 return False;
431 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_resp");
432 depth++;
434 if(!prs_uint32("alloc_hint", ps, depth, &rpc->alloc_hint))
435 return False;
436 if(!prs_uint16("context_id", ps, depth, &rpc->context_id))
437 return False;
438 if(!prs_uint8 ("cancel_ct ", ps, depth, &rpc->cancel_count))
439 return False;
440 if(!prs_uint8 ("reserved ", ps, depth, &rpc->reserved))
441 return False;
442 return True;
445 /*******************************************************************
446 Reads or writes an RPC_HDR_FAULT structure.
447 ********************************************************************/
449 bool smb_io_rpc_hdr_fault(const char *desc, RPC_HDR_FAULT *rpc, prs_struct *ps, int depth)
451 if (rpc == NULL)
452 return False;
454 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_fault");
455 depth++;
457 if(!prs_dcerpc_status("status ", ps, depth, &rpc->status))
458 return False;
459 if(!prs_uint32("reserved", ps, depth, &rpc->reserved))
460 return False;
462 return True;
465 /*******************************************************************
466 Inits an RPC_HDR_AUTH structure.
467 ********************************************************************/
469 void init_rpc_hdr_auth(RPC_HDR_AUTH *rai,
470 uint8 auth_type, uint8 auth_level,
471 uint8 auth_pad_len,
472 uint32 auth_context_id)
474 rai->auth_type = auth_type;
475 rai->auth_level = auth_level;
476 rai->auth_pad_len = auth_pad_len;
477 rai->auth_reserved = 0;
478 rai->auth_context_id = auth_context_id;
481 /*******************************************************************
482 Reads or writes an RPC_HDR_AUTH structure.
483 ********************************************************************/
485 bool smb_io_rpc_hdr_auth(const char *desc, RPC_HDR_AUTH *rai, prs_struct *ps, int depth)
487 if (rai == NULL)
488 return False;
490 prs_debug(ps, depth, desc, "smb_io_rpc_hdr_auth");
491 depth++;
493 if(!prs_align(ps))
494 return False;
496 if(!prs_uint8 ("auth_type ", ps, depth, &rai->auth_type))
497 return False;
498 if(!prs_uint8 ("auth_level ", ps, depth, &rai->auth_level))
499 return False;
500 if(!prs_uint8 ("auth_pad_len ", ps, depth, &rai->auth_pad_len))
501 return False;
502 if(!prs_uint8 ("auth_reserved", ps, depth, &rai->auth_reserved))
503 return False;
504 if(!prs_uint32("auth_context_id", ps, depth, &rai->auth_context_id))
505 return False;
507 return True;
510 /*******************************************************************
511 Checks an RPC_AUTH_VERIFIER structure.
512 ********************************************************************/
514 bool rpc_auth_verifier_chk(RPC_AUTH_VERIFIER *rav,
515 const char *signature, uint32 msg_type)
517 return (strequal(rav->signature, signature) && rav->msg_type == msg_type);
520 /*******************************************************************
521 Inits an RPC_AUTH_VERIFIER structure.
522 ********************************************************************/
524 void init_rpc_auth_verifier(RPC_AUTH_VERIFIER *rav,
525 const char *signature, uint32 msg_type)
527 fstrcpy(rav->signature, signature); /* "NTLMSSP" */
528 rav->msg_type = msg_type; /* NTLMSSP_MESSAGE_TYPE */
531 /*******************************************************************
532 Reads or writes an RPC_AUTH_VERIFIER structure.
533 ********************************************************************/
535 bool smb_io_rpc_auth_verifier(const char *desc, RPC_AUTH_VERIFIER *rav, prs_struct *ps, int depth)
537 if (rav == NULL)
538 return False;
540 prs_debug(ps, depth, desc, "smb_io_rpc_auth_verifier");
541 depth++;
543 /* "NTLMSSP" */
544 if(!prs_string("signature", ps, depth, rav->signature,
545 sizeof(rav->signature)))
546 return False;
547 if(!prs_uint32("msg_type ", ps, depth, &rav->msg_type)) /* NTLMSSP_MESSAGE_TYPE */
548 return False;
550 return True;
553 /*******************************************************************
554 This parses an RPC_AUTH_VERIFIER for schannel. I think
555 ********************************************************************/
557 bool smb_io_rpc_schannel_verifier(const char *desc, RPC_AUTH_VERIFIER *rav, prs_struct *ps, int depth)
559 if (rav == NULL)
560 return False;
562 prs_debug(ps, depth, desc, "smb_io_rpc_schannel_verifier");
563 depth++;
565 if(!prs_string("signature", ps, depth, rav->signature, sizeof(rav->signature)))
566 return False;
567 if(!prs_uint32("msg_type ", ps, depth, &rav->msg_type))
568 return False;
570 return True;
573 /*******************************************************************
574 creates an RPC_AUTH_SCHANNEL_NEG structure.
575 ********************************************************************/
577 void init_rpc_auth_schannel_neg(RPC_AUTH_SCHANNEL_NEG *neg,
578 const char *domain, const char *myname)
580 neg->type1 = 0;
581 neg->type2 = 0x3;
582 fstrcpy(neg->domain, domain);
583 fstrcpy(neg->myname, myname);
586 /*******************************************************************
587 Reads or writes an RPC_AUTH_SCHANNEL_NEG structure.
588 ********************************************************************/
590 bool smb_io_rpc_auth_schannel_neg(const char *desc, RPC_AUTH_SCHANNEL_NEG *neg,
591 prs_struct *ps, int depth)
593 if (neg == NULL)
594 return False;
596 prs_debug(ps, depth, desc, "smb_io_rpc_auth_schannel_neg");
597 depth++;
599 if(!prs_align(ps))
600 return False;
602 if(!prs_uint32("type1", ps, depth, &neg->type1))
603 return False;
604 if(!prs_uint32("type2", ps, depth, &neg->type2))
605 return False;
606 if(!prs_string("domain ", ps, depth, neg->domain, sizeof(neg->domain)))
607 return False;
608 if(!prs_string("myname ", ps, depth, neg->myname, sizeof(neg->myname)))
609 return False;
611 return True;
614 /*******************************************************************
615 reads or writes an RPC_AUTH_SCHANNEL_CHK structure.
616 ********************************************************************/
618 bool smb_io_rpc_auth_schannel_chk(const char *desc, int auth_len,
619 RPC_AUTH_SCHANNEL_CHK * chk,
620 prs_struct *ps, int depth)
622 if (chk == NULL)
623 return False;
625 prs_debug(ps, depth, desc, "smb_io_rpc_auth_schannel_chk");
626 depth++;
628 if ( !prs_uint8s(False, "sig ", ps, depth, chk->sig, sizeof(chk->sig)) )
629 return False;
631 if ( !prs_uint8s(False, "seq_num", ps, depth, chk->seq_num, sizeof(chk->seq_num)) )
632 return False;
634 if ( !prs_uint8s(False, "packet_digest", ps, depth, chk->packet_digest, sizeof(chk->packet_digest)) )
635 return False;
637 if ( auth_len == RPC_AUTH_SCHANNEL_SIGN_OR_SEAL_CHK_LEN ) {
638 if ( !prs_uint8s(False, "confounder", ps, depth, chk->confounder, sizeof(chk->confounder)) )
639 return False;
642 return True;