r610: - Merge the Samba3 'ntlm_auth --diagnostics' testsuite to Samba4.
[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 enum dcerpc_transport_t {NCACN_NP, NCACN_IP_TCP};
24
25 /*
26   this defines a generic security context for signed/sealed dcerpc pipes.
27 */
28 struct dcerpc_security {
29         void *private;
30         NTSTATUS (*unseal_packet)(struct dcerpc_security *, 
31                                   uchar *data, size_t length, DATA_BLOB *sig);
32         NTSTATUS (*check_packet)(struct dcerpc_security *, 
33                                  const uchar *data, size_t length, const DATA_BLOB *sig);
34         NTSTATUS (*seal_packet)(struct dcerpc_security *, 
35                                  uchar *data, size_t length, DATA_BLOB *sig);
36         NTSTATUS (*sign_packet)(struct dcerpc_security *, 
37                                 const uchar *data, size_t length, DATA_BLOB *sig);
38         NTSTATUS (*session_key)(struct dcerpc_security *, DATA_BLOB *session_key);
39         void (*security_end)(struct dcerpc_security *);
40 };
41
42
43 struct dcerpc_pipe {
44         TALLOC_CTX *mem_ctx;
45         int reference_count;
46         uint32 call_id;
47         uint32 srv_max_xmit_frag;
48         uint32 srv_max_recv_frag;
49         unsigned flags;
50         struct dcerpc_security *security_state;
51         struct dcerpc_auth *auth_info;
52         const char *binding_string;
53         
54         struct dcerpc_transport {
55                 enum dcerpc_transport_t transport;
56                 void *private;
57                 NTSTATUS (*full_request)(struct dcerpc_pipe *, 
58                                          TALLOC_CTX *, DATA_BLOB *, DATA_BLOB *);
59                 NTSTATUS (*secondary_request)(struct dcerpc_pipe *, TALLOC_CTX *, DATA_BLOB *);
60                 NTSTATUS (*initial_request)(struct dcerpc_pipe *, TALLOC_CTX *, DATA_BLOB *);
61                 NTSTATUS (*shutdown_pipe)(struct dcerpc_pipe *);
62                 const char *(*peer_name)(struct dcerpc_pipe *);
63         } transport;
64
65         /* the last fault code from a DCERPC fault */
66         uint32 last_fault_code;
67 };
68
69 /* dcerpc pipe flags */
70 #define DCERPC_DEBUG_PRINT_IN  (1<<0)
71 #define DCERPC_DEBUG_PRINT_OUT (1<<1)
72 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
73
74 #define DCERPC_DEBUG_VALIDATE_IN  4
75 #define DCERPC_DEBUG_VALIDATE_OUT 8
76 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
77
78 #define DCERPC_SIGN            16
79 #define DCERPC_SEAL            32
80
81 #define DCERPC_PUSH_BIGENDIAN   64
82 #define DCERPC_PULL_BIGENDIAN  128
83
84 #define DCERPC_SCHANNEL        256
85
86 /*
87   this is used to find pointers to calls
88 */
89 struct dcerpc_interface_call {
90         const char *name;
91         size_t struct_size;
92         NTSTATUS (*ndr_push)(struct ndr_push *, int , void *);
93         NTSTATUS (*ndr_pull)(struct ndr_pull *, int , void *);
94         void (*ndr_print)(struct ndr_print *, const char *, int, void *);       
95 };
96
97 struct dcerpc_endpoint_list {
98         uint32 count;
99         const char * const *names;
100 };
101
102 struct dcerpc_interface_table {
103         const char *name;
104         const char *uuid;
105         uint32 if_version;
106         uint32 num_calls;
107         const struct dcerpc_interface_call *calls;
108         const struct dcerpc_endpoint_list *endpoints;
109 };
110
111
112 /* this describes a binding to a particular transport/pipe */
113 struct dcerpc_binding {
114         enum dcerpc_transport_t transport;
115         const char *host;
116         const char **options;
117         uint32 flags;
118 };