trunk/rdesktop/constants.h

/*
   rdesktop: A Remote Desktop Protocol client.
   Miscellaneous protocol constants
   Copyright (C) Matthew Chapman 1999-2002
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/* TCP port for Remote Desktop Protocol */
#define TCP_PORT_RDP 3389

/* ISO PDU codes */
enum ISO_PDU_CODE
{
        ISO_PDU_CR = 0xE0,      /* Connection Request */
        ISO_PDU_CC = 0xD0,      /* Connection Confirm */
        ISO_PDU_DR = 0x80,      /* Disconnect Request */
        ISO_PDU_DT = 0xF0,      /* Data */
        ISO_PDU_ER = 0x70       /* Error */
};

/* MCS PDU codes */
enum MCS_PDU_TYPE
{
        MCS_EDRQ = 1,           /* Erect Domain Request */
        MCS_DPUM = 8,           /* Disconnect Provider Ultimatum */
        MCS_AURQ = 10,          /* Attach User Request */
        MCS_AUCF = 11,          /* Attach User Confirm */
        MCS_CJRQ = 14,          /* Channel Join Request */
        MCS_CJCF = 15,          /* Channel Join Confirm */
        MCS_SDRQ = 25,          /* Send Data Request */
        MCS_SDIN = 26           /* Send Data Indication */
};

#define MCS_CONNECT_INITIAL     0x7f65
#define MCS_CONNECT_RESPONSE    0x7f66

#define BER_TAG_BOOLEAN         1
#define BER_TAG_INTEGER         2
#define BER_TAG_OCTET_STRING    4
#define BER_TAG_RESULT          10
#define MCS_TAG_DOMAIN_PARAMS   0x30

#define MCS_GLOBAL_CHANNEL      1003

/* RDP secure transport constants */
#define SEC_RANDOM_SIZE         32
#define SEC_MODULUS_SIZE        64
#define SEC_PADDING_SIZE        8
#define SEC_EXPONENT_SIZE       4

#define SEC_CLIENT_RANDOM       0x0001
#define SEC_ENCRYPT             0x0008
#define SEC_LOGON_INFO          0x0040
#define SEC_LICENCE_NEG         0x0080

#define SEC_TAG_SRV_INFO        0x0c01
#define SEC_TAG_SRV_CRYPT       0x0c02
#define SEC_TAG_SRV_3           0x0c03

#define SEC_TAG_CLI_INFO        0xc001
#define SEC_TAG_CLI_CRYPT       0xc002
#define SEC_TAG_CLI_4           0xc004
#define SEC_TAG_CLI_CHANNELS    0xc003

#define SEC_TAG_PUBKEY          0x0006
#define SEC_TAG_KEYSIG          0x0008

#define SEC_RSA_MAGIC           0x31415352      /* RSA1 */

/* RDP licensing constants */
#define LICENCE_TOKEN_SIZE      10
#define LICENCE_HWID_SIZE       20
#define LICENCE_SIGNATURE_SIZE  16

#define LICENCE_TAG_DEMAND      0x0201
#define LICENCE_TAG_AUTHREQ     0x0202
#define LICENCE_TAG_ISSUE       0x0203
#define LICENCE_TAG_REISSUE     0x0204
#define LICENCE_TAG_PRESENT     0x0212
#define LICENCE_TAG_REQUEST     0x0213
#define LICENCE_TAG_AUTHRESP    0x0215
#define LICENCE_TAG_RESULT      0x02ff

/* RDP5 licensing constants - thanks goes to Steve Fosdick for finding them! */
#define LICENCE_TAG_DEMAND_5    0x0301
#define LICENCE_TAG_AUTHREQ_5   0x0302
#define LICENCE_TAG_ISSUE_5     0x0303
#define LICENCE_TAG_REISSUE_5   0x0304
#define LICENCE_TAG_PRESENT_5   0x0312
#define LICENCE_TAG_REQUEST_5   0x0313
#define LICENCE_TAG_AUTHRESP_5  0x0315
#define LICENCE_TAG_RESULT_5    0x03ff


#define LICENCE_TAG_USER        0x000f
#define LICENCE_TAG_HOST        0x0010

/* RDP PDU codes */
enum RDP_PDU_TYPE
{
        RDP_PDU_DEMAND_ACTIVE = 1,
        RDP_PDU_CONFIRM_ACTIVE = 3,
        RDP_PDU_DEACTIVATE = 6,
        RDP_PDU_DATA = 7
};

enum RDP_DATA_PDU_TYPE
{
        RDP_DATA_PDU_UPDATE = 2,
        RDP_DATA_PDU_CONTROL = 20,
        RDP_DATA_PDU_POINTER = 27,
        RDP_DATA_PDU_INPUT = 28,
        RDP_DATA_PDU_SYNCHRONISE = 31,
        RDP_DATA_PDU_BELL = 34,
        RDP_DATA_PDU_LOGON = 38,
        RDP_DATA_PDU_FONT2 = 39
};

enum RDP_CONTROL_PDU_TYPE
{
        RDP_CTL_REQUEST_CONTROL = 1,
        RDP_CTL_GRANT_CONTROL = 2,
        RDP_CTL_DETACH = 3,
        RDP_CTL_COOPERATE = 4
};

enum RDP_UPDATE_PDU_TYPE
{
        RDP_UPDATE_ORDERS = 0,
        RDP_UPDATE_BITMAP = 1,
        RDP_UPDATE_PALETTE = 2,
        RDP_UPDATE_SYNCHRONIZE = 3
};

enum RDP_POINTER_PDU_TYPE
{
        RDP_POINTER_MOVE = 3,
        RDP_POINTER_COLOR = 6,
        RDP_POINTER_CACHED = 7
};

enum RDP_INPUT_DEVICE
{
        RDP_INPUT_SYNCHRONIZE = 0,
        RDP_INPUT_CODEPOINT = 1,
        RDP_INPUT_VIRTKEY = 2,
        RDP_INPUT_SCANCODE = 4,
        RDP_INPUT_MOUSE = 0x8001
};

/* Device flags */
#define KBD_FLAG_RIGHT          0x0001
#define KBD_FLAG_EXT            0x0100
#define KBD_FLAG_QUIET          0x1000
#define KBD_FLAG_DOWN           0x4000
#define KBD_FLAG_UP             0x8000

/* These are for synchronization; not for keystrokes */
#define KBD_FLAG_SCROLL   0x0001
#define KBD_FLAG_NUMLOCK  0x0002
#define KBD_FLAG_CAPITAL  0x0004

/* See T.128 */
#define RDP_KEYPRESS 0
#define RDP_KEYRELEASE (KBD_FLAG_DOWN | KBD_FLAG_UP)

#define MOUSE_FLAG_MOVE         0x0800
#define MOUSE_FLAG_BUTTON1      0x1000
#define MOUSE_FLAG_BUTTON2      0x2000
#define MOUSE_FLAG_BUTTON3      0x4000
#define MOUSE_FLAG_BUTTON4      0x0280
#define MOUSE_FLAG_BUTTON5      0x0380
#define MOUSE_FLAG_DOWN         0x8000

/* Raster operation masks */
#define ROP2_S(rop3) (rop3 & 0xf)
#define ROP2_P(rop3) ((rop3 & 0x3) | ((rop3 & 0x30) >> 2))

#define ROP2_COPY       0xc
#define ROP2_XOR        0x6
#define ROP2_AND        0x8
#define ROP2_NXOR       0x9
#define ROP2_OR         0xe

#define MIX_TRANSPARENT 0
#define MIX_OPAQUE      1

#define TEXT2_VERTICAL          0x04
#define TEXT2_IMPLICIT_X        0x20

/* RDP capabilities */
#define RDP_CAPSET_GENERAL      1       /* Maps to generalCapabilitySet in T.128 page 138 */
#define RDP_CAPLEN_GENERAL      0x18
#define OS_MAJOR_TYPE_UNIX      4
#define OS_MINOR_TYPE_XSERVER   7

#define RDP_CAPSET_BITMAP       2
#define RDP_CAPLEN_BITMAP       0x1C

#define RDP_CAPSET_ORDER        3
#define RDP_CAPLEN_ORDER        0x58
#define ORDER_CAP_NEGOTIATE     2
#define ORDER_CAP_NOSUPPORT     4

#define RDP_CAPSET_BMPCACHE     4
#define RDP_CAPLEN_BMPCACHE     0x28

#define RDP_CAPSET_CONTROL      5
#define RDP_CAPLEN_CONTROL      0x0C

#define RDP_CAPSET_ACTIVATE     7
#define RDP_CAPLEN_ACTIVATE     0x0C

#define RDP_CAPSET_POINTER      8
#define RDP_CAPLEN_POINTER      0x08

#define RDP_CAPSET_SHARE        9
#define RDP_CAPLEN_SHARE        0x08

#define RDP_CAPSET_COLCACHE     10
#define RDP_CAPLEN_COLCACHE     0x08

#define RDP_CAPSET_UNKNOWN      13
#define RDP_CAPLEN_UNKNOWN      0x9C

#define RDP_SOURCE              "MSTSC"

/* Logon flags */
#define RDP_LOGON_NORMAL        0x33
#define RDP_LOGON_AUTO          0x8

/* Keymap flags */
#define MapRightShiftMask   (1<<0)
#define MapLeftShiftMask    (1<<1)
#define MapShiftMask (MapRightShiftMask | MapLeftShiftMask)

#define MapRightAltMask     (1<<2)
#define MapLeftAltMask      (1<<3)
#define MapAltGrMask MapRightAltMask

#define MapRightCtrlMask    (1<<4)
#define MapLeftCtrlMask     (1<<5)
#define MapCtrlMask (MapRightCtrlMask | MapLeftCtrlMask)

#define MapRightWinMask     (1<<6)
#define MapLeftWinMask      (1<<7)
#define MapWinMask (MapRightWinMask | MapLeftWinMask)

#define MapNumLockMask      (1<<8)
#define MapCapsLockMask     (1<<9)

#define MapLocalStateMask   (1<<10)

#define MapInhibitMask      (1<<11)

#define MASK_ADD_BITS(var, mask) (var |= mask)
#define MASK_REMOVE_BITS(var, mask) (var &= ~mask)
#define MASK_HAS_BITS(var, mask) ((var & mask)>0)
#define MASK_CHANGE_BIT(var, mask, active) (var = ((var & ~mask) | (active ? mask : 0)))
1	matty	10	/*
2			rdesktop: A Remote Desktop Protocol client.
3			Miscellaneous protocol constants
4	matthewc	207	Copyright (C) Matthew Chapman 1999-2002
5	matty	10
6			This program is free software; you can redistribute it and/or modify
7			it under the terms of the GNU General Public License as published by
8			the Free Software Foundation; either version 2 of the License, or
9			(at your option) any later version.
10
11			This program 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
14			GNU General Public License for more details.
15
16			You should have received a copy of the GNU General Public License
17			along with this program; if not, write to the Free Software
18			Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19			*/
20
21			/* TCP port for Remote Desktop Protocol */
22			#define TCP_PORT_RDP 3389
23
24			/* ISO PDU codes */
25			enum ISO_PDU_CODE
26			{
27	astrand	64	ISO_PDU_CR = 0xE0, /* Connection Request */
28			ISO_PDU_CC = 0xD0, /* Connection Confirm */
29			ISO_PDU_DR = 0x80, /* Disconnect Request */
30			ISO_PDU_DT = 0xF0, /* Data */
31			ISO_PDU_ER = 0x70 /* Error */
32	matty	10	};
33
34			/* MCS PDU codes */
35			enum MCS_PDU_TYPE
36			{
37	matty	28	MCS_EDRQ = 1, /* Erect Domain Request */
38			MCS_DPUM = 8, /* Disconnect Provider Ultimatum */
39			MCS_AURQ = 10, /* Attach User Request */
40			MCS_AUCF = 11, /* Attach User Confirm */
41			MCS_CJRQ = 14, /* Channel Join Request */
42			MCS_CJCF = 15, /* Channel Join Confirm */
43			MCS_SDRQ = 25, /* Send Data Request */
44			MCS_SDIN = 26 /* Send Data Indication */
45	matty	10	};
46
47			#define MCS_CONNECT_INITIAL 0x7f65
48			#define MCS_CONNECT_RESPONSE 0x7f66
49
50			#define BER_TAG_BOOLEAN 1
51			#define BER_TAG_INTEGER 2
52			#define BER_TAG_OCTET_STRING 4
53			#define BER_TAG_RESULT 10
54			#define MCS_TAG_DOMAIN_PARAMS 0x30
55
56			#define MCS_GLOBAL_CHANNEL 1003
57
58			/* RDP secure transport constants */
59			#define SEC_RANDOM_SIZE 32
60			#define SEC_MODULUS_SIZE 64
61			#define SEC_PADDING_SIZE 8
62			#define SEC_EXPONENT_SIZE 4
63
64			#define SEC_CLIENT_RANDOM 0x0001
65			#define SEC_ENCRYPT 0x0008
66			#define SEC_LOGON_INFO 0x0040
67			#define SEC_LICENCE_NEG 0x0080
68
69			#define SEC_TAG_SRV_INFO 0x0c01
70			#define SEC_TAG_SRV_CRYPT 0x0c02
71			#define SEC_TAG_SRV_3 0x0c03
72
73			#define SEC_TAG_CLI_INFO 0xc001
74			#define SEC_TAG_CLI_CRYPT 0xc002
75	forsberg	346	#define SEC_TAG_CLI_4 0xc004
76			#define SEC_TAG_CLI_CHANNELS 0xc003
77	matty	10
78			#define SEC_TAG_PUBKEY 0x0006
79			#define SEC_TAG_KEYSIG 0x0008
80
81	astrand	64	#define SEC_RSA_MAGIC 0x31415352 /* RSA1 */
82	matty	10
83			/* RDP licensing constants */
84			#define LICENCE_TOKEN_SIZE 10
85			#define LICENCE_HWID_SIZE 20
86			#define LICENCE_SIGNATURE_SIZE 16
87
88			#define LICENCE_TAG_DEMAND 0x0201
89			#define LICENCE_TAG_AUTHREQ 0x0202
90			#define LICENCE_TAG_ISSUE 0x0203
91	matthewc	39	#define LICENCE_TAG_REISSUE 0x0204
92			#define LICENCE_TAG_PRESENT 0x0212
93	matty	10	#define LICENCE_TAG_REQUEST 0x0213
94			#define LICENCE_TAG_AUTHRESP 0x0215
95			#define LICENCE_TAG_RESULT 0x02ff
96
97	forsberg	360	/* RDP5 licensing constants - thanks goes to Steve Fosdick for finding them! */
98	forsberg	359	#define LICENCE_TAG_DEMAND_5 0x0301
99			#define LICENCE_TAG_AUTHREQ_5 0x0302
100			#define LICENCE_TAG_ISSUE_5 0x0303
101			#define LICENCE_TAG_REISSUE_5 0x0304
102			#define LICENCE_TAG_PRESENT_5 0x0312
103			#define LICENCE_TAG_REQUEST_5 0x0313
104			#define LICENCE_TAG_AUTHRESP_5 0x0315
105			#define LICENCE_TAG_RESULT_5 0x03ff
106
107
108
109	matty	10	#define LICENCE_TAG_USER 0x000f
110			#define LICENCE_TAG_HOST 0x0010
111
112			/* RDP PDU codes */
113			enum RDP_PDU_TYPE
114			{
115			RDP_PDU_DEMAND_ACTIVE = 1,
116			RDP_PDU_CONFIRM_ACTIVE = 3,
117			RDP_PDU_DEACTIVATE = 6,
118			RDP_PDU_DATA = 7
119			};
120
121			enum RDP_DATA_PDU_TYPE
122			{
123			RDP_DATA_PDU_UPDATE = 2,
124			RDP_DATA_PDU_CONTROL = 20,
125			RDP_DATA_PDU_POINTER = 27,
126			RDP_DATA_PDU_INPUT = 28,
127			RDP_DATA_PDU_SYNCHRONISE = 31,
128			RDP_DATA_PDU_BELL = 34,
129			RDP_DATA_PDU_LOGON = 38,
130			RDP_DATA_PDU_FONT2 = 39
131			};
132
133			enum RDP_CONTROL_PDU_TYPE
134			{
135			RDP_CTL_REQUEST_CONTROL = 1,
136			RDP_CTL_GRANT_CONTROL = 2,
137			RDP_CTL_DETACH = 3,
138			RDP_CTL_COOPERATE = 4
139			};
140
141			enum RDP_UPDATE_PDU_TYPE
142			{
143			RDP_UPDATE_ORDERS = 0,
144			RDP_UPDATE_BITMAP = 1,
145			RDP_UPDATE_PALETTE = 2,
146			RDP_UPDATE_SYNCHRONIZE = 3
147			};
148
149			enum RDP_POINTER_PDU_TYPE
150			{
151	matty	28	RDP_POINTER_MOVE = 3,
152			RDP_POINTER_COLOR = 6,
153			RDP_POINTER_CACHED = 7
154	matty	10	};
155
156			enum RDP_INPUT_DEVICE
157			{
158			RDP_INPUT_SYNCHRONIZE = 0,
159			RDP_INPUT_CODEPOINT = 1,
160			RDP_INPUT_VIRTKEY = 2,
161			RDP_INPUT_SCANCODE = 4,
162			RDP_INPUT_MOUSE = 0x8001
163			};
164
165			/* Device flags */
166			#define KBD_FLAG_RIGHT 0x0001
167	matty	28	#define KBD_FLAG_EXT 0x0100
168	matty	10	#define KBD_FLAG_QUIET 0x1000
169			#define KBD_FLAG_DOWN 0x4000
170			#define KBD_FLAG_UP 0x8000
171
172	astrand	63	/* These are for synchronization; not for keystrokes */
173			#define KBD_FLAG_SCROLL 0x0001
174			#define KBD_FLAG_NUMLOCK 0x0002
175			#define KBD_FLAG_CAPITAL 0x0004
176
177			/* See T.128 */
178			#define RDP_KEYPRESS 0
179			#define RDP_KEYRELEASE (KBD_FLAG_DOWN \| KBD_FLAG_UP)
180
181	matty	10	#define MOUSE_FLAG_MOVE 0x0800
182			#define MOUSE_FLAG_BUTTON1 0x1000
183			#define MOUSE_FLAG_BUTTON2 0x2000
184			#define MOUSE_FLAG_BUTTON3 0x4000
185	jsorg71	56	#define MOUSE_FLAG_BUTTON4 0x0280
186			#define MOUSE_FLAG_BUTTON5 0x0380
187	matty	10	#define MOUSE_FLAG_DOWN 0x8000
188
189			/* Raster operation masks */
190			#define ROP2_S(rop3) (rop3 & 0xf)
191			#define ROP2_P(rop3) ((rop3 & 0x3) \| ((rop3 & 0x30) >> 2))
192
193			#define ROP2_COPY 0xc
194			#define ROP2_XOR 0x6
195			#define ROP2_AND 0x8
196	matty	16	#define ROP2_NXOR 0x9
197	matty	10	#define ROP2_OR 0xe
198
199			#define MIX_TRANSPARENT 0
200			#define MIX_OPAQUE 1
201
202	matty	29	#define TEXT2_VERTICAL 0x04
203			#define TEXT2_IMPLICIT_X 0x20
204	matty	10
205			/* RDP capabilities */
206	forsberg	346	#define RDP_CAPSET_GENERAL 1 /* Maps to generalCapabilitySet in T.128 page 138 */
207	matty	10	#define RDP_CAPLEN_GENERAL 0x18
208			#define OS_MAJOR_TYPE_UNIX 4
209			#define OS_MINOR_TYPE_XSERVER 7
210
211			#define RDP_CAPSET_BITMAP 2
212			#define RDP_CAPLEN_BITMAP 0x1C
213
214			#define RDP_CAPSET_ORDER 3
215			#define RDP_CAPLEN_ORDER 0x58
216			#define ORDER_CAP_NEGOTIATE 2
217			#define ORDER_CAP_NOSUPPORT 4
218
219			#define RDP_CAPSET_BMPCACHE 4
220			#define RDP_CAPLEN_BMPCACHE 0x28
221
222			#define RDP_CAPSET_CONTROL 5
223			#define RDP_CAPLEN_CONTROL 0x0C
224
225			#define RDP_CAPSET_ACTIVATE 7
226			#define RDP_CAPLEN_ACTIVATE 0x0C
227
228			#define RDP_CAPSET_POINTER 8
229			#define RDP_CAPLEN_POINTER 0x08
230
231			#define RDP_CAPSET_SHARE 9
232			#define RDP_CAPLEN_SHARE 0x08
233
234			#define RDP_CAPSET_COLCACHE 10
235			#define RDP_CAPLEN_COLCACHE 0x08
236
237			#define RDP_CAPSET_UNKNOWN 13
238			#define RDP_CAPLEN_UNKNOWN 0x9C
239
240			#define RDP_SOURCE "MSTSC"
241	matty	21
242			/* Logon flags */
243			#define RDP_LOGON_NORMAL 0x33
244			#define RDP_LOGON_AUTO 0x8
245	astrand	63
246			/* Keymap flags */
247			#define MapRightShiftMask (1<<0)
248			#define MapLeftShiftMask (1<<1)
249			#define MapShiftMask (MapRightShiftMask \| MapLeftShiftMask)
250
251			#define MapRightAltMask (1<<2)
252			#define MapLeftAltMask (1<<3)
253			#define MapAltGrMask MapRightAltMask
254
255			#define MapRightCtrlMask (1<<4)
256			#define MapLeftCtrlMask (1<<5)
257			#define MapCtrlMask (MapRightCtrlMask \| MapLeftCtrlMask)
258
259			#define MapRightWinMask (1<<6)
260			#define MapLeftWinMask (1<<7)
261			#define MapWinMask (MapRightWinMask \| MapLeftWinMask)
262
263			#define MapNumLockMask (1<<8)
264			#define MapCapsLockMask (1<<9)
265
266	astrand	69	#define MapLocalStateMask (1<<10)
267
268	astrand	116	#define MapInhibitMask (1<<11)
269
270	astrand	63	#define MASK_ADD_BITS(var, mask) (var \|= mask)
271			#define MASK_REMOVE_BITS(var, mask) (var &= ~mask)
272			#define MASK_HAS_BITS(var, mask) ((var & mask)>0)
273			#define MASK_CHANGE_BIT(var, mask, active) (var = ((var & ~mask) \| (active ? mask : 0)))