dlls/rpcrt4/rpc_binding.h

   1 /*
   2  * RPC binding API
   3  *
   4  * Copyright 2001 Ove Kåven, TransGaming Technologies
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_RPC_BINDING_H
  22 #define __WINE_RPC_BINDING_H
  23
  24 #include "rpcndr.h"
  25 #include "security.h"
  26 #include "wine/list.h"
  27 #include "rpc_defs.h"
  28
  29
  30 typedef struct _RpcAuthInfo
  31 {
  32   LONG refs;
  33
  34   ULONG AuthnLevel;
  35   ULONG AuthnSvc;
  36   CredHandle cred;
  37   TimeStamp exp;
  38   ULONG cbMaxToken;
  39   /* the auth identity pointer that the application passed us (freed by application) */
  40   RPC_AUTH_IDENTITY_HANDLE *identity;
  41   /* our copy of NT auth identity structure, if the authentication service
  42    * takes an NT auth identity */
  43   SEC_WINNT_AUTH_IDENTITY_W *nt_identity;
  44   LPWSTR server_principal_name;
  45 } RpcAuthInfo;
  46
  47 typedef struct _RpcQualityOfService
  48 {
  49     LONG refs;
  50
  51     RPC_SECURITY_QOS_V2_W *qos;
  52 } RpcQualityOfService;
  53
  54 struct connection_ops;
  55
  56 typedef struct _RpcConnection
  57 {
  58   BOOL server;
  59   LPSTR NetworkAddr;
  60   LPSTR Endpoint;
  61   LPWSTR NetworkOptions;
  62   const struct connection_ops *ops;
  63   USHORT MaxTransmissionSize;
  64
  65   /* authentication */
  66   CtxtHandle ctx;
  67   TimeStamp exp;
  68   ULONG attr;
  69   RpcAuthInfo *AuthInfo;
  70   ULONG auth_context_id;
  71   ULONG encryption_auth_len;
  72   ULONG signature_auth_len;
  73   RpcQualityOfService *QOS;
  74
  75   /* client-only */
  76   struct list conn_pool_entry;
  77   ULONG assoc_group_id; /* association group returned during binding */
  78   RPC_ASYNC_STATE *async_state;
  79   struct _RpcAssoc *assoc; /* association this connection is part of */
  80
  81   /* server-only */
  82   /* The active interface bound to server. */
  83   RPC_SYNTAX_IDENTIFIER ActiveInterface;
  84   USHORT NextCallId;
  85   struct _RpcConnection* Next;
  86   struct _RpcBinding *server_binding;
  87 } RpcConnection;
  88
  89 struct connection_ops {
  90   const char *name;
  91   unsigned char epm_protocols[2]; /* only floors 3 and 4. see http://www.opengroup.org/onlinepubs/9629399/apdxl.htm */
  92   RpcConnection *(*alloc)(void);
  93   RPC_STATUS (*open_connection_client)(RpcConnection *conn);
  94   RPC_STATUS (*handoff)(RpcConnection *old_conn, RpcConnection *new_conn);
  95   int (*read)(RpcConnection *conn, void *buffer, unsigned int len);
  96   int (*write)(RpcConnection *conn, const void *buffer, unsigned int len);
  97   int (*close)(RpcConnection *conn);
  98   void (*cancel_call)(RpcConnection *conn);
  99   int (*wait_for_incoming_data)(RpcConnection *conn);
 100   size_t (*get_top_of_tower)(unsigned char *tower_data, const char *networkaddr, const char *endpoint);
 101   RPC_STATUS (*parse_top_of_tower)(const unsigned char *tower_data, size_t tower_size, char **networkaddr, char **endpoint);
 102   RPC_STATUS (*receive_fragment)(RpcConnection *conn, RpcPktHdr **Header, void **Payload);
 103 };
 104
 105 /* don't know what MS's structure looks like */
 106 typedef struct _RpcBinding
 107 {
 108   LONG refs;
 109   struct _RpcBinding* Next;
 110   BOOL server;
 111   UUID ObjectUuid;
 112   LPSTR Protseq;
 113   LPSTR NetworkAddr;
 114   LPSTR Endpoint;
 115   LPWSTR NetworkOptions;
 116   RPC_BLOCKING_FN BlockingFn;
 117   ULONG ServerTid;
 118   RpcConnection* FromConn;
 119   struct _RpcAssoc *Assoc;
 120
 121   /* authentication */
 122   RpcAuthInfo *AuthInfo;
 123   RpcQualityOfService *QOS;
 124 } RpcBinding;
 125
 126 LPSTR RPCRT4_strndupA(LPCSTR src, INT len);
 127 LPWSTR RPCRT4_strndupW(LPCWSTR src, INT len);
 128 LPSTR RPCRT4_strdupWtoA(LPCWSTR src);
 129 LPWSTR RPCRT4_strdupAtoW(LPCSTR src);
 130 void RPCRT4_strfree(LPSTR src);
 131
 132 #define RPCRT4_strdupA(x) RPCRT4_strndupA((x),-1)
 133 #define RPCRT4_strdupW(x) RPCRT4_strndupW((x),-1)
 134
 135 ULONG RpcAuthInfo_AddRef(RpcAuthInfo *AuthInfo);
 136 ULONG RpcAuthInfo_Release(RpcAuthInfo *AuthInfo);
 137 BOOL RpcAuthInfo_IsEqual(const RpcAuthInfo *AuthInfo1, const RpcAuthInfo *AuthInfo2);
 138 ULONG RpcQualityOfService_AddRef(RpcQualityOfService *qos);
 139 ULONG RpcQualityOfService_Release(RpcQualityOfService *qos);
 140 BOOL RpcQualityOfService_IsEqual(const RpcQualityOfService *qos1, const RpcQualityOfService *qos2);
 141
 142 RPC_STATUS RPCRT4_CreateConnection(RpcConnection** Connection, BOOL server, LPCSTR Protseq, LPCSTR NetworkAddr, LPCSTR Endpoint, LPCWSTR NetworkOptions, RpcAuthInfo* AuthInfo, RpcQualityOfService *QOS);
 143 RPC_STATUS RPCRT4_DestroyConnection(RpcConnection* Connection);
 144 RPC_STATUS RPCRT4_OpenClientConnection(RpcConnection* Connection);
 145 RPC_STATUS RPCRT4_CloseConnection(RpcConnection* Connection);
 146
 147 RPC_STATUS RPCRT4_ResolveBinding(RpcBinding* Binding, LPCSTR Endpoint);
 148 RPC_STATUS RPCRT4_SetBindingObject(RpcBinding* Binding, const UUID* ObjectUuid);
 149 RPC_STATUS RPCRT4_MakeBinding(RpcBinding** Binding, RpcConnection* Connection);
 150 void       RPCRT4_AddRefBinding(RpcBinding* Binding);
 151 RPC_STATUS RPCRT4_ReleaseBinding(RpcBinding* Binding);
 152 RPC_STATUS RPCRT4_OpenBinding(RpcBinding* Binding, RpcConnection** Connection,
 153                               const RPC_SYNTAX_IDENTIFIER *TransferSyntax, const RPC_SYNTAX_IDENTIFIER *InterfaceId);
 154 RPC_STATUS RPCRT4_CloseBinding(RpcBinding* Binding, RpcConnection* Connection);
 155
 156 static inline const char *rpcrt4_conn_get_name(const RpcConnection *Connection)
 157 {
 158   return Connection->ops->name;
 159 }
 160
 161 static inline int rpcrt4_conn_read(RpcConnection *Connection,
 162                      void *buffer, unsigned int len)
 163 {
 164   return Connection->ops->read(Connection, buffer, len);
 165 }
 166
 167 static inline int rpcrt4_conn_write(RpcConnection *Connection,
 168                      const void *buffer, unsigned int len)
 169 {
 170   return Connection->ops->write(Connection, buffer, len);
 171 }
 172
 173 static inline int rpcrt4_conn_close(RpcConnection *Connection)
 174 {
 175   return Connection->ops->close(Connection);
 176 }
 177
 178 static inline void rpcrt4_conn_cancel_call(RpcConnection *Connection)
 179 {
 180   Connection->ops->cancel_call(Connection);
 181 }
 182
 183 static inline RPC_STATUS rpcrt4_conn_handoff(RpcConnection *old_conn, RpcConnection *new_conn)
 184 {
 185   return old_conn->ops->handoff(old_conn, new_conn);
 186 }
 187
 188 /* floors 3 and up */
 189 RPC_STATUS RpcTransport_GetTopOfTower(unsigned char *tower_data, size_t *tower_size, const char *protseq, const char *networkaddr, const char *endpoint);
 190 RPC_STATUS RpcTransport_ParseTopOfTower(const unsigned char *tower_data, size_t tower_size, char **protseq, char **networkaddr, char **endpoint);
 191
 192 void RPCRT4_SetThreadCurrentConnection(RpcConnection *Connection);
 193 void RPCRT4_SetThreadCurrentCallHandle(RpcBinding *Binding);
 194 RpcBinding *RPCRT4_GetThreadCurrentCallHandle(void);
 195 void RPCRT4_PushThreadContextHandle(NDR_SCONTEXT SContext);
 196 void RPCRT4_RemoveThreadContextHandle(NDR_SCONTEXT SContext);
 197 NDR_SCONTEXT RPCRT4_PopThreadContextHandle(void);
 198
 199 #endif