4f449c6a77d6bbfe28440cca0f6be444cf91200d
[samba.git] / source3 / librpc / rpc / dcerpc.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    DCERPC client side interface structures
5
6    Copyright (C) 2008 Jelmer Vernooij
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 3 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, see <http://www.gnu.org/licenses/>.
20 */
21
22 /* This is a public header file that is installed as part of Samba. 
23  * If you remove any functions or change their signature, update 
24  * the so version number. */
25
26 #ifndef _S3_DCERPC_H__
27 #define _S3_DCERPC_H__
28
29 #include "../librpc/rpc/rpc_common.h"
30
31 #define SMB_RPC_INTERFACE_VERSION 1
32
33 /** this describes a binding to a particular transport/pipe */
34 struct dcerpc_binding {
35         enum dcerpc_transport_t transport;
36         struct ndr_syntax_id object;
37         const char *host;
38         const char *target_hostname;
39         const char *target_principal;
40         const char *endpoint;
41         const char **options;
42         const char *localaddress;
43         uint32_t flags;
44         uint32_t assoc_group_id;
45 };
46
47
48 /* dcerpc pipe flags */
49 #define DCERPC_DEBUG_PRINT_IN          (1<<0)
50 #define DCERPC_DEBUG_PRINT_OUT         (1<<1)
51 #define DCERPC_DEBUG_PRINT_BOTH (DCERPC_DEBUG_PRINT_IN | DCERPC_DEBUG_PRINT_OUT)
52
53 #define DCERPC_DEBUG_VALIDATE_IN       (1<<2)
54 #define DCERPC_DEBUG_VALIDATE_OUT      (1<<3)
55 #define DCERPC_DEBUG_VALIDATE_BOTH (DCERPC_DEBUG_VALIDATE_IN | DCERPC_DEBUG_VALIDATE_OUT)
56
57 #define DCERPC_CONNECT                 (1<<4)
58 #define DCERPC_SIGN                    (1<<5)
59 #define DCERPC_SEAL                    (1<<6)
60
61 #define DCERPC_PUSH_BIGENDIAN          (1<<7)
62 #define DCERPC_PULL_BIGENDIAN          (1<<8)
63
64 #define DCERPC_SCHANNEL                (1<<9)
65
66 /* use a 128 bit session key */
67 #define DCERPC_SCHANNEL_128            (1<<12)
68
69 /* check incoming pad bytes */
70 #define DCERPC_DEBUG_PAD_CHECK         (1<<13)
71
72 /* set LIBNDR_FLAG_REF_ALLOC flag when decoding NDR */
73 #define DCERPC_NDR_REF_ALLOC           (1<<14)
74
75 #define DCERPC_AUTH_OPTIONS    (DCERPC_SEAL|DCERPC_SIGN|DCERPC_SCHANNEL|DCERPC_AUTH_SPNEGO|DCERPC_AUTH_KRB5|DCERPC_AUTH_NTLM)
76
77 /* select spnego auth */
78 #define DCERPC_AUTH_SPNEGO             (1<<15)
79
80 /* select krb5 auth */
81 #define DCERPC_AUTH_KRB5               (1<<16)
82
83 #define DCERPC_SMB2                    (1<<17)
84
85 /* select NTLM auth */
86 #define DCERPC_AUTH_NTLM               (1<<18)
87
88 /* this triggers the DCERPC_PFC_FLAG_CONC_MPX flag in the bind request */
89 #define DCERPC_CONCURRENT_MULTIPLEX     (1<<19)
90
91 /* this triggers the DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN flag in the bind request */
92 #define DCERPC_HEADER_SIGNING          (1<<20)
93
94 /* use NDR64 transport */
95 #define DCERPC_NDR64                   (1<<21)
96
97 /* specify binding interface */
98 #define DCERPC_LOCALADDRESS            (1<<22)
99
100 /* The following definitions come from librpc/rpc/binding.c  */
101
102 struct epm_floor;
103 struct epm_tower;
104 const char *epm_floor_string(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
105 _PUBLIC_ char *dcerpc_binding_string(TALLOC_CTX *mem_ctx, const struct dcerpc_binding *b);
106 _PUBLIC_ NTSTATUS dcerpc_parse_binding(TALLOC_CTX *mem_ctx, const char *s, struct dcerpc_binding **b_out);
107 _PUBLIC_ NTSTATUS dcerpc_floor_get_lhs_data(const struct epm_floor *epm_floor,
108                                             struct ndr_syntax_id *syntax);
109 const char *dcerpc_floor_get_rhs_data(TALLOC_CTX *mem_ctx, struct epm_floor *epm_floor);
110 enum dcerpc_transport_t dcerpc_transport_by_endpoint_protocol(int prot);
111 _PUBLIC_ enum dcerpc_transport_t dcerpc_transport_by_tower(const struct epm_tower *tower);
112 _PUBLIC_ const char *derpc_transport_string_by_transport(enum dcerpc_transport_t t);
113 _PUBLIC_ NTSTATUS dcerpc_binding_from_tower(TALLOC_CTX *mem_ctx,
114                                    struct epm_tower *tower,
115                                    struct dcerpc_binding **b_out);
116 _PUBLIC_ NTSTATUS dcerpc_binding_build_tower(TALLOC_CTX *mem_ctx,
117                                              const struct dcerpc_binding *binding,
118                                              struct epm_tower *tower);
119
120 struct NL_AUTH_MESSAGE;
121 struct pipe_auth_data;
122
123 /* The following definitions come from librpc/rpc/dcerpc_helpers.c  */
124 NTSTATUS dcerpc_push_ncacn_packet(TALLOC_CTX *mem_ctx,
125                                   enum dcerpc_pkt_type ptype,
126                                   uint8_t pfc_flags,
127                                   uint16_t auth_length,
128                                   uint32_t call_id,
129                                   union dcerpc_payload *u,
130                                   DATA_BLOB *blob);
131 NTSTATUS dcerpc_pull_ncacn_packet(TALLOC_CTX *mem_ctx,
132                                   const DATA_BLOB *blob,
133                                   struct ncacn_packet *r,
134                                   bool bigendian);
135 NTSTATUS dcerpc_push_schannel_bind(TALLOC_CTX *mem_ctx,
136                                    struct NL_AUTH_MESSAGE *r,
137                                    DATA_BLOB *blob);
138 NTSTATUS dcerpc_push_dcerpc_auth(TALLOC_CTX *mem_ctx,
139                                  enum dcerpc_AuthType auth_type,
140                                  enum dcerpc_AuthLevel auth_level,
141                                  uint8_t auth_pad_length,
142                                  uint32_t auth_context_id,
143                                  const DATA_BLOB *credentials,
144                                  DATA_BLOB *blob);
145 NTSTATUS dcerpc_pull_dcerpc_auth(TALLOC_CTX *mem_ctx,
146                                  const DATA_BLOB *blob,
147                                  struct dcerpc_auth *r,
148                                  bool bigendian);
149 NTSTATUS dcerpc_guess_sizes(struct pipe_auth_data *auth,
150                             size_t header_len, size_t data_left,
151                             size_t max_xmit_frag, size_t pad_alignment,
152                             size_t *data_to_send, size_t *frag_len,
153                             size_t *auth_len, size_t *pad_len);
154 NTSTATUS dcerpc_add_auth_footer(struct pipe_auth_data *auth,
155                                 size_t pad_len, DATA_BLOB *rpc_out);
156 NTSTATUS dcerpc_check_auth(struct pipe_auth_data *auth,
157                            struct ncacn_packet *pkt,
158                            DATA_BLOB *pkt_trailer,
159                            size_t header_size,
160                            DATA_BLOB *raw_pkt,
161                            size_t *pad_len);
162
163 #endif /* __S3_DCERPC_H__ */