/** * FreeRDP: A Remote Desktop Protocol Implementation * Request To Send (RTS) PDUs * * Copyright 2012 Marc-Andre Moreau * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef FREERDP_CORE_RTS_H #define FREERDP_CORE_RTS_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "rpc.h" #include #include #include #define RTS_FLAG_NONE 0x0000 #define RTS_FLAG_PING 0x0001 #define RTS_FLAG_OTHER_CMD 0x0002 #define RTS_FLAG_RECYCLE_CHANNEL 0x0004 #define RTS_FLAG_IN_CHANNEL 0x0008 #define RTS_FLAG_OUT_CHANNEL 0x0010 #define RTS_FLAG_EOF 0x0020 #define RTS_FLAG_ECHO 0x0040 #define RTS_CMD_RECEIVE_WINDOW_SIZE 0x00000000 #define RTS_CMD_FLOW_CONTROL_ACK 0x00000001 #define RTS_CMD_CONNECTION_TIMEOUT 0x00000002 #define RTS_CMD_COOKIE 0x00000003 #define RTS_CMD_CHANNEL_LIFETIME 0x00000004 #define RTS_CMD_CLIENT_KEEPALIVE 0x00000005 #define RTS_CMD_VERSION 0x00000006 #define RTS_CMD_EMPTY 0x00000007 #define RTS_CMD_PADDING 0x00000008 #define RTS_CMD_NEGATIVE_ANCE 0x00000009 #define RTS_CMD_ANCE 0x0000000A #define RTS_CMD_CLIENT_ADDRESS 0x0000000B #define RTS_CMD_ASSOCIATION_GROUP_ID 0x0000000C #define RTS_CMD_DESTINATION 0x0000000D #define RTS_CMD_PING_TRAFFIC_SENT_NOTIFY 0x0000000E #define RTS_CMD_LAST_ID 0x0000000F #define RTS_CMD_RECEIVE_WINDOW_SIZE_LENGTH 0x00000004 #define RTS_CMD_FLOW_CONTROL_ACK_LENGTH 0x00000018 #define RTS_CMD_CONNECTION_TIMEOUT_LENGTH 0x00000004 #define RTS_CMD_COOKIE_LENGTH 0x00000010 #define RTS_CMD_CHANNEL_LIFETIME_LENGTH 0x00000004 #define RTS_CMD_CLIENT_KEEPALIVE_LENGTH 0x00000004 #define RTS_CMD_VERSION_LENGTH 0x00000004 #define RTS_CMD_EMPTY_LENGTH 0x00000000 #define RTS_CMD_PADDING_LENGTH 0x00000000 /* variable-size */ #define RTS_CMD_NEGATIVE_ANCE_LENGTH 0x00000000 #define RTS_CMD_ANCE_LENGTH 0x00000000 #define RTS_CMD_CLIENT_ADDRESS_LENGTH 0x00000000 /* variable-size */ #define RTS_CMD_ASSOCIATION_GROUP_ID_LENGTH 0x00000010 #define RTS_CMD_DESTINATION_LENGTH 0x00000004 #define RTS_CMD_PING_TRAFFIC_SENT_NOTIFY_LENGTH 0x00000004 #define FDClient 0x00000000 #define FDInProxy 0x00000001 #define FDServer 0x00000002 #define FDOutProxy 0x00000003 struct rts_pdu_signature { UINT16 Flags; UINT16 NumberOfCommands; UINT32 CommandTypes[8]; }; typedef struct rts_pdu_signature RtsPduSignature; /* RTS PDU Signature IDs */ #define RTS_PDU_CONN_A 0x10000000 #define RTS_PDU_CONN_A1 (RTS_PDU_CONN_A | 0x00000001) #define RTS_PDU_CONN_A2 (RTS_PDU_CONN_A | 0x00000002) #define RTS_PDU_CONN_A3 (RTS_PDU_CONN_A | 0x00000003) #define RTS_PDU_CONN_B 0x20000000 #define RTS_PDU_CONN_B1 (RTS_PDU_CONN_B | 0x00000001) #define RTS_PDU_CONN_B2 (RTS_PDU_CONN_B | 0x00000002) #define RTS_PDU_CONN_B3 (RTS_PDU_CONN_B | 0x00000003) #define RTS_PDU_CONN_C 0x40000000 #define RTS_PDU_CONN_C1 (RTS_PDU_CONN_C | 0x00000001) #define RTS_PDU_CONN_C2 (RTS_PDU_CONN_C | 0x00000002) #define RTS_PDU_IN_R1_A 0x01000000 #define RTS_PDU_IN_R1_A1 (RTS_PDU_IN_R1_A | 0x00000001) #define RTS_PDU_IN_R1_A2 (RTS_PDU_IN_R1_A | 0x00000002) #define RTS_PDU_IN_R1_A3 (RTS_PDU_IN_R1_A | 0x00000003) #define RTS_PDU_IN_R1_A4 (RTS_PDU_IN_R1_A | 0x00000004) #define RTS_PDU_IN_R1_A5 (RTS_PDU_IN_R1_A | 0x00000005) #define RTS_PDU_IN_R1_A6 (RTS_PDU_IN_R1_A | 0x00000006) #define RTS_PDU_IN_R1_B 0x02000000 #define RTS_PDU_IN_R1_B1 (RTS_PDU_IN_R1_B | 0x00000001) #define RTS_PDU_IN_R1_B2 (RTS_PDU_IN_R1_B | 0x00000002) #define RTS_PDU_IN_R2_A 0x04000000 #define RTS_PDU_IN_R2_A1 (RTS_PDU_IN_R2_A | 0x00000001) #define RTS_PDU_IN_R2_A2 (RTS_PDU_IN_R2_A | 0x00000002) #define RTS_PDU_IN_R2_A3 (RTS_PDU_IN_R2_A | 0x00000003) #define RTS_PDU_IN_R2_A4 (RTS_PDU_IN_R2_A | 0x00000004) #define RTS_PDU_IN_R2_A5 (RTS_PDU_IN_R2_A | 0x00000005) #define RTS_PDU_OUT_R1_A 0x00100000 #define RTS_PDU_OUT_R1_A1 (RTS_PDU_OUT_R1_A | 0x00000001) #define RTS_PDU_OUT_R1_A2 (RTS_PDU_OUT_R1_A | 0x00000002) #define RTS_PDU_OUT_R1_A3 (RTS_PDU_OUT_R1_A | 0x00000003) #define RTS_PDU_OUT_R1_A4 (RTS_PDU_OUT_R1_A | 0x00000004) #define RTS_PDU_OUT_R1_A5 (RTS_PDU_OUT_R1_A | 0x00000005) #define RTS_PDU_OUT_R1_A6 (RTS_PDU_OUT_R1_A | 0x00000006) #define RTS_PDU_OUT_R1_A7 (RTS_PDU_OUT_R1_A | 0x00000007) #define RTS_PDU_OUT_R1_A8 (RTS_PDU_OUT_R1_A | 0x00000008) #define RTS_PDU_OUT_R1_A9 (RTS_PDU_OUT_R1_A | 0x00000009) #define RTS_PDU_OUT_R1_A10 (RTS_PDU_OUT_R1_A | 0x0000000A) #define RTS_PDU_OUT_R1_A11 (RTS_PDU_OUT_R1_A | 0x0000000B) #define RTS_PDU_OUT_R2_A 0x00200000 #define RTS_PDU_OUT_R2_A1 (RTS_PDU_OUT_R2_A | 0x00000001) #define RTS_PDU_OUT_R2_A2 (RTS_PDU_OUT_R2_A | 0x00000002) #define RTS_PDU_OUT_R2_A3 (RTS_PDU_OUT_R2_A | 0x00000003) #define RTS_PDU_OUT_R2_A4 (RTS_PDU_OUT_R2_A | 0x00000004) #define RTS_PDU_OUT_R2_A5 (RTS_PDU_OUT_R2_A | 0x00000005) #define RTS_PDU_OUT_R2_A6 (RTS_PDU_OUT_R2_A | 0x00000006) #define RTS_PDU_OUT_R2_A7 (RTS_PDU_OUT_R2_A | 0x00000007) #define RTS_PDU_OUT_R2_A8 (RTS_PDU_OUT_R2_A | 0x00000008) #define RTS_PDU_OUT_R2_B 0x00400000 #define RTS_PDU_OUT_R2_B1 (RTS_PDU_OUT_R2_B | 0x00000001) #define RTS_PDU_OUT_R2_B2 (RTS_PDU_OUT_R2_B | 0x00000002) #define RTS_PDU_OUT_R2_B3 (RTS_PDU_OUT_R2_B | 0x00000003) #define RTS_PDU_OUT_R2_C 0x00800000 #define RTS_PDU_OUT_R2_C1 (RTS_PDU_OUT_R2_C | 0x00000001) #define RTS_PDU_OUT_OF_SEQUENCE 0x00010000 #define RTS_PDU_KEEP_ALIVE (RTS_PDU_OUT_OF_SEQUENCE | 0x00000001) #define RTS_PDU_PING_TRAFFIC_SENT_NOTIFY (RTS_PDU_OUT_OF_SEQUENCE | 0x00000002) #define RTS_PDU_ECHO (RTS_PDU_OUT_OF_SEQUENCE | 0x00000003) #define RTS_PDU_PING (RTS_PDU_OUT_OF_SEQUENCE | 0x00000004) #define RTS_PDU_FLOW_CONTROL_ACK (RTS_PDU_OUT_OF_SEQUENCE | 0x00000005) #define RTS_PDU_FLOW_CONTROL_ACK_WITH_DESTINATION (RTS_PDU_OUT_OF_SEQUENCE | 0x00000006) int rts_command_length(rdpRpc* rpc, UINT32 CommandType, BYTE* buffer, UINT32 length); BOOL rts_match_pdu_signature(rdpRpc* rpc, RtsPduSignature* signature, rpcconn_rts_hdr_t* rts); int rts_recv_pdu_commands(rdpRpc* rpc, rpcconn_rts_hdr_t* rts); BOOL rts_connect(rdpRpc* rpc); int rts_receive_window_size_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length, UINT32* ReceiveWindowSize); int rts_receive_window_size_command_write(BYTE* buffer, UINT32 ReceiveWindowSize); int rts_flow_control_ack_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length, UINT32* BytesReceived, UINT32* AvailableWindow, BYTE* ChannelCookie); int rts_flow_control_ack_command_write(BYTE* buffer, UINT32 BytesReceived, UINT32 AvailableWindow, BYTE* ChannelCookie); int rts_connection_timeout_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length, UINT32* ConnectionTimeout); int rts_connection_timeout_command_write(BYTE* buffer, UINT32 ConnectionTimeout); int rts_cookie_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_cookie_command_write(BYTE* buffer, BYTE* Cookie); int rts_channel_lifetime_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_channel_lifetime_command_write(BYTE* buffer, UINT32 ChannelLifetime); int rts_client_keepalive_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_client_keepalive_command_write(BYTE* buffer, UINT32 ClientKeepalive); int rts_version_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_version_command_write(BYTE* buffer); int rts_empty_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_empty_command_write(BYTE* buffer); int rts_padding_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_padding_command_write(BYTE* buffer, UINT32 ConformanceCount); int rts_negative_ance_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_negative_ance_command_write(BYTE* buffer); int rts_ance_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_ance_command_write(BYTE* buffer); int rts_client_address_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_client_address_command_write(BYTE* buffer, UINT32 AddressType, BYTE* ClientAddress); int rts_association_group_id_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_association_group_id_command_write(BYTE* buffer, BYTE* AssociationGroupId); int rts_destination_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length, UINT32* Destination); int rts_destination_command_write(BYTE* buffer, UINT32 Destination); int rts_ping_traffic_sent_notify_command_read(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_ping_traffic_sent_notify_command_write(BYTE* buffer, UINT32 PingTrafficSent); int rts_send_CONN_A1_pdu(rdpRpc* rpc); int rts_recv_CONN_A3_pdu(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_send_CONN_B1_pdu(rdpRpc* rpc); int rts_recv_CONN_C2_pdu(rdpRpc* rpc, BYTE* buffer, UINT32 length); int rts_send_keep_alive_pdu(rdpRpc* rpc); int rts_send_flow_control_ack_pdu(rdpRpc* rpc); int rts_send_ping_pdu(rdpRpc* rpc); int rts_recv_pdu(rdpRpc* rpc); int rts_recv_out_of_sequence_pdu(rdpRpc* rpc); #ifdef WITH_DEBUG_TSG #define WITH_DEBUG_RTS #endif #ifdef WITH_DEBUG_RTS #define DEBUG_RTS(fmt, ...) DEBUG_CLASS(RTS, fmt, ## __VA_ARGS__) #else #define DEBUG_RTS(fmt, ...) DEBUG_NULL(fmt, ## __VA_ARGS__) #endif #endif /* FREERDP_CORE_RTS_H */