Windows: Add missing msrpc.h dependency
[openafs.git] / src / WINNT / afsd / msrpc.h
1 /*
2  * Copyright (c) 2009 Secure Endpoints Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person
5  * obtaining a copy of this software and associated documentation
6  * files (the "Software"), to deal in the Software without
7  * restriction, including without limitation the rights to use, copy,
8  * modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is
10  * furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24
25 #pragma once
26
27 #include <Rpc.h>
28 #include <RpcdceP.h>
29 #include <RpcNdr.h>
30 #include "cm_nls.h"
31
32 #define I_RpcGetBuffer MSRPC_I_GetBuffer
33
34 #define I_RpcFreeBuffer MSRPC_I_FreeBuffer
35
36 #define NdrServerInitializeNew MSRPC_NdrServerInitializeNew
37
38 /*! \brief Maximum size of an accepted message
39
40    This value is arbitrary.  The chosen value is larger than the
41    maximum fragment size used by the SMB RPC transport and is only
42    meant to mitigate the damage that could be done from a malformed
43    packet.
44  */
45 #define MAX_RPC_MSG_SIZE 102400
46
47 /*! \brief Default message size */
48 #define DEF_RPC_MSG_SIZE 2048
49
50 /*! \brief Status of a msrpc_call object */
51 typedef enum msrpc_call_status {
52     MSRPC_CALL_NONE = 0,
53     MSRPC_CALL_MSGRECEIVED,
54     MSRPC_CALL_DISPATCHED,
55     MSRPC_CALL_MSGSENDING,
56     MSRPC_CALL_MSGSENT,
57     MSRPC_CALL_SKIP,
58 } MSRPC_CALL_STATUS;
59
60 typedef enum PDU_type {
61     PDU_TYPE_REQUEST = 0,
62     PDU_TYPE_PING = 1,
63     PDU_TYPE_RESPONSE = 2,
64     PDU_TYPE_FAULT = 3,
65     PDU_TYPE_WORKING = 4,
66     PDU_TYPE_NOCALL = 5,
67     PDU_TYPE_REJECT = 6,
68     PDU_TYPE_ACK = 7,
69     PDU_TYPE_CL_CANCEL = 8,
70     PDU_TYPE_FACK = 9,
71     PDU_TYPE_CANCEL_ACK = 10,
72     PDU_TYPE_BIND = 11,
73     PDU_TYPE_BIND_ACK = 12,
74     PDU_TYPE_BIND_NAK = 13,
75     PDU_TYPE_ALTER_CONTEXT = 14,
76     PDU_TYPE_ALTER_CONTEXT_RESP = 15,
77     PDU_TYPE_SHUTDOWN = 16,
78     PDU_TYPE_CO_CANCEL = 18,
79     PDU_TYPE_ORPHANED = 19
80 } PDU_TYPE;
81
82 typedef enum msrpc_bind_reject_reason {
83     BIND_REJ_REASON_NOT_SPECIFIED = 0,
84     BIND_REJ_TEMPORARY_CONGESTION = 1,
85     BIND_REJ_LOCAL_LIMIT_EXCEEDED = 2,
86     BIND_REJ_CALLED_PADDR_UNKNOWN = 3, /* not used */
87     BIND_REJ_PROTOCOL_VERSION_NOT_SUPPORTED = 4,
88     BIND_REJ_DEFAULT_CONTEXT_NOT_SUPPORTED = 5, /* not used */
89     BIND_REJ_USER_DATA_NOT_READABLE = 6, /* not used */
90     BIND_REJ_NO_PSAP_AVAILABLE = 7 /* not used */
91 } BIND_REJECT_REASON;
92
93 typedef unsigned __int8     byte;
94 typedef unsigned __int8     u_int8;
95 typedef unsigned __int16    u_int16;
96 typedef unsigned __int32    u_int32;
97 typedef unsigned __int64    u_int64;
98
99 /*! \brief Common RPC envelope header */
100 typedef
101 struct E_CommonHeader {
102     u_int8  rpc_vers;           /*!< 00:01 RPC version == 5 */
103     u_int8  rpc_vers_minor;     /*!< 01:01 minor version */
104     u_int8  PTYPE;              /*!< 02:01 packet type */
105     u_int8  pfc_flags;          /*!< 03:01 flags (see PFC_... ) */
106
107 #define PFC_FIRST_FRAG           0x01 /* First fragment */
108 #define PFC_LAST_FRAG            0x02 /* Last fragment */
109 #define PFC_PENDING_CANCEL       0x04 /* Cancel was pending at sender */
110 #define PFC_RESERVED_1           0x08
111 #define PFC_CONC_MPX             0x10 /* supports concurrent multiplexing
112                                        * of a single connection. */
113 #define PFC_DID_NOT_EXECUTE      0x20 /* only meaningful on `fault' packet;
114                                        * if true, guaranteed call did not
115                                        * execute. */
116 #define PFC_MAYBE                0x40 /* `maybe' call semantics requested */
117 #define PFC_OBJECT_UUID          0x80 /* if true, a non-nil object UUID
118                                        * was specified in the handle, and
119                                        * is present in the optional object
120                                        * field. If false, the object field
121                                        * is omitted. */
122
123     byte    packed_drep[4]; /*!< 04:04 NDR data representation format label */
124     u_int16 frag_length;    /*!< 08:02 total length of fragment */
125     u_int16 auth_length;    /*!< 10:02 length of auth_value */
126     u_int32 call_id;        /*!< 12:04 call identifier */
127 } E_CommonHeader;
128
129 typedef   u_int16   p_context_id_t; /* local context identifier */
130
131 /*! \brief RPC message buffer
132  */
133 typedef struct msrpc_buffer {
134     BYTE * buf_data;
135     unsigned int buf_length;
136     unsigned int buf_alloc;
137     unsigned int buf_pos;
138
139     PDU_TYPE pdu_type;
140 } msrpc_buffer;
141
142 typedef struct cm_user cm_user_t;
143
144 /*! \brief RPC call
145
146    A single RPC call.  This might even be a single fragment of a
147    message.
148  */
149 typedef struct msrpc_call {
150     struct msrpc_call * next;
151     struct msrpc_call * prev;
152
153     MSRPC_CALL_STATUS status;
154
155     u_int32 call_id;           /*!< Call ID */
156     p_context_id_t context_id;  /*!< presentation context ID (last seen) */
157
158     E_CommonHeader * in_header; /*!< Pointer to the header of the
159                                   input packet.  Only valid during a
160                                   request dispatch. */
161
162     msrpc_buffer in;            /*!< Input buffer */
163
164     msrpc_buffer out;           /*!< Output buffer */
165
166     RPC_MESSAGE msg;
167
168     cm_user_t *cm_userp;        /*!< Held reference to the cm_user_t
169                                    associated with this call. */
170 } msrpc_call;
171
172 /*! \brief RPC connection structure
173
174    Represents a single RPC connection.  Can support multiple queued
175    RPCs.
176 */
177 typedef struct _msrpc_conn {
178     unsigned int max_xmit_frag; /*!< Maximum size of fragment
179                                    client->server */
180     unsigned int max_recv_frag; /*!< Maximum size of fragment
181                                    server->client */
182     u_int32 assoc_group_id;     /*!< Association group ID for the
183                                    connection. */
184
185     unsigned int rpc_vers;      /*!< RPC Protocol version. Always 5 */
186     unsigned int rpc_vers_minor; /*!< Minor version number.  0 or 1 */
187
188     char * secondary_address;   /*!< Secondary address for the
189                                    connection. */
190
191     RPC_SERVER_INTERFACE * interface;
192                                 /*!< Selected server interface.  Only
193                                    valid after a successful bind. */
194
195     msrpc_call * head;          /*!< Queue of msrpc_call objects for
196                                    the connection. */
197     msrpc_call * tail;
198 } msrpc_conn;
199
200
201 void
202 MSRPC_Init(void);
203
204 void
205 MSRPC_Shutdown(void);
206
207 int
208 MSRPC_InitConn(msrpc_conn * conn, const char * secondary_address);
209
210 int
211 MSRPC_FreeConn(msrpc_conn * conn);
212
213 int
214 MSRPC_WriteMessage(msrpc_conn * conn, BYTE * buffer, unsigned int len,
215                    cm_user_t * userp);
216
217 int
218 MSRPC_PrepareRead(msrpc_conn * conn);
219
220 int
221 MSRPC_ReadMessageLength(msrpc_conn * conn, unsigned int max_len);
222
223 int
224 MSRPC_ReadMessage(msrpc_conn * conn, BYTE *buffer, unsigned int len);
225
226 RPC_STATUS
227 RPC_ENTRY
228 I_RpcGetBuffer (IN OUT RPC_MESSAGE __RPC_FAR * Message);
229
230 RPC_STATUS
231 RPC_ENTRY
232 I_RpcFreeBuffer (IN OUT RPC_MESSAGE __RPC_FAR * Message);
233
234 unsigned char  *
235 RPC_ENTRY
236 NdrServerInitializeNew(
237     PRPC_MESSAGE            pRpcMsg,
238     PMIDL_STUB_MESSAGE      pStubMsg,
239     PMIDL_STUB_DESC         pStubDescriptor
240     );
241
242 extern cm_user_t *
243 MSRPC_GetCmUser(void);
244
245 extern void RPC_SRVSVC_Init(void);
246
247 extern void RPC_SRVSVC_Shutdown(void);
248
249 extern int
250 MSRPC_IsWellKnownService(const clientchar_t * lastNamep);