allow the specification of full dcerpc endpoint binding strings on the
[samba.git] / source4 / librpc / rpc / dcerpc.h
1 /* 
2    Unix SMB/CIFS implementation.
3    DCERPC interface structures
4
5    Copyright (C) Tim Potter 2003
6    Copyright (C) Andrew Tridgell 2003
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 /*
24   see http://www.opengroup.org/onlinepubs/9629399/chap12.htm for details
25   of these structures
26
27   note that the structure definitions here don't include some of the
28   fields that are wire-artifacts. Those are put on the wire by the
29   marshalling/unmarshalling routines in decrpc.c
30 */
31
32 struct dcerpc_pipe {
33         TALLOC_CTX *mem_ctx;
34         int reference_count;
35         uint32 call_id;
36         uint32 srv_max_xmit_frag;
37         uint32 srv_max_recv_frag;
38         unsigned flags;
39         struct ntlmssp_state *ntlmssp_state;
40         struct dcerpc_auth *auth_info;
41
42         struct dcerpc_transport {
43                 void *private;
44                 NTSTATUS (*full_request)(struct dcerpc_pipe *, 
45                                          TALLOC_CTX *, DATA_BLOB *, DATA_BLOB *);
46                 NTSTATUS (*secondary_request)(struct dcerpc_pipe *, TALLOC_CTX *, DATA_BLOB *);
47                 NTSTATUS (*initial_request)(struct dcerpc_pipe *, TALLOC_CTX *, DATA_BLOB *);
48                 NTSTATUS (*shutdown_pipe)(struct dcerpc_pipe *);
49                 const char *(*peer_name)(struct dcerpc_pipe *);
50         } transport;
51
52         /* the last fault code from a DCERPC fault */
53         uint32 last_fault_code;
54 };
55
56 /* dcerpc pipe flags */
57 #define DCERPC_DEBUG_PRINT_IN  (1<<0)
58 #define DCERPC_DEBUG_PRINT_OUT (1<<1)
59 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
60
61 #define DCERPC_DEBUG_VALIDATE_IN  4
62 #define DCERPC_DEBUG_VALIDATE_OUT 8
63 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
64
65 #define DCERPC_SIGN            16
66 #define DCERPC_SEAL            32
67
68 /*
69   this is used to find pointers to calls
70 */
71 struct dcerpc_interface_call {
72         const char *name;
73         size_t struct_size;
74         NTSTATUS (*ndr_push)(struct ndr_push *, int , void *);
75         NTSTATUS (*ndr_pull)(struct ndr_pull *, int , void *);
76         void (*ndr_print)(struct ndr_print *, const char *, int, void *);       
77 };
78
79 struct dcerpc_endpoint_list {
80         uint32 count;
81         const char **names;
82 };
83
84 struct dcerpc_interface_table {
85         const char *name;
86         const char *uuid;
87         uint32 if_version;
88         uint32 num_calls;
89         const struct dcerpc_interface_call *calls;
90         const struct dcerpc_endpoint_list *endpoints;
91 };
92
93
94 enum dcerpc_transport_t {NCACN_NP, NCACN_IP_TCP};
95
96 /* this describes a binding to a particular transport/pipe */
97 struct dcerpc_binding {
98         enum dcerpc_transport_t transport;
99         const char *host;
100         const char **options;
101         uint32 flags;
102 };