path: root/include/freerdp/settings.h

/**
 * FreeRDP: A Remote Desktop Protocol Client
 * RDP Settings
 *
 * Copyright 2009-2013 Jay Sorg <jay.sorg@gmail.com>
 *
 * 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 __RDP_SETTINGS_H
#define __RDP_SETTINGS_H

#include <freerdp/types.h>
#include <freerdp/utils/blob.h>
#include <freerdp/utils/unicode.h>

/* Performance Flags */
#define PERF_FLAG_NONE                      0x00000000
#define PERF_DISABLE_WALLPAPER              0x00000001
#define PERF_DISABLE_FULLWINDOWDRAG         0x00000002
#define PERF_DISABLE_MENUANIMATIONS         0x00000004
#define PERF_DISABLE_THEMING                0x00000008
#define PERF_DISABLE_CURSOR_SHADOW          0x00000020
#define PERF_DISABLE_CURSORSETTINGS         0x00000040
#define PERF_ENABLE_FONT_SMOOTHING          0x00000080
#define PERF_ENABLE_DESKTOP_COMPOSITION     0x00000100

/* Connection Types */
#define CONNECTION_TYPE_MODEM               0x01
#define CONNECTION_TYPE_BROADBAND_LOW       0x02
#define CONNECTION_TYPE_SATELLITE           0x03
#define CONNECTION_TYPE_BROADBAND_HIGH      0x04
#define CONNECTION_TYPE_WAN                 0x05
#define CONNECTION_TYPE_LAN                 0x06

/* Encryption Methods */
#define ENCRYPTION_METHOD_NONE              0x00000000
#define ENCRYPTION_METHOD_40BIT             0x00000001
#define ENCRYPTION_METHOD_128BIT            0x00000002
#define ENCRYPTION_METHOD_56BIT             0x00000008
#define ENCRYPTION_METHOD_FIPS              0x00000010

/* Encryption Levels */
#define ENCRYPTION_LEVEL_NONE               0x00000000
#define ENCRYPTION_LEVEL_LOW                0x00000001
#define ENCRYPTION_LEVEL_CLIENT_COMPATIBLE  0x00000002
#define ENCRYPTION_LEVEL_HIGH               0x00000003
#define ENCRYPTION_LEVEL_FIPS               0x00000004

/* Auto Reconnect Version */
#define AUTO_RECONNECT_VERSION_1            0x00000001

/* Order Support */
#define NEG_DSTBLT_INDEX                    0x00
#define NEG_PATBLT_INDEX                    0x01
#define NEG_SCRBLT_INDEX                    0x02
#define NEG_MEMBLT_INDEX                    0x03
#define NEG_MEM3BLT_INDEX                   0x04
#define NEG_ATEXTOUT_INDEX                  0x05
#define NEG_AEXTTEXTOUT_INDEX               0x06
#define NEG_DRAWNINEGRID_INDEX              0x07
#define NEG_LINETO_INDEX                    0x08
#define NEG_MULTI_DRAWNINEGRID_INDEX        0x09
#define NEG_OPAQUE_RECT_INDEX               0x0A
#define NEG_SAVEBITMAP_INDEX                0x0B
#define NEG_WTEXTOUT_INDEX                  0x0C
#define NEG_MEMBLT_V2_INDEX                 0x0D
#define NEG_MEM3BLT_V2_INDEX                0x0E
#define NEG_MULTIDSTBLT_INDEX               0x0F
#define NEG_MULTIPATBLT_INDEX               0x10
#define NEG_MULTISCRBLT_INDEX               0x11
#define NEG_MULTIOPAQUERECT_INDEX           0x12
#define NEG_FAST_INDEX_INDEX                0x13
#define NEG_POLYGON_SC_INDEX                0x14
#define NEG_POLYGON_CB_INDEX                0x15
#define NEG_POLYLINE_INDEX                  0x16
#define NEG_FAST_GLYPH_INDEX                0x18
#define NEG_ELLIPSE_SC_INDEX                0x19
#define NEG_ELLIPSE_CB_INDEX                0x1A
#define NEG_GLYPH_INDEX_INDEX               0x1B
#define NEG_GLYPH_WEXTTEXTOUT_INDEX         0x1C
#define NEG_GLYPH_WLONGTEXTOUT_INDEX        0x1D
#define NEG_GLYPH_WLONGEXTTEXTOUT_INDEX     0x1E

/* Glyph Support Level */
#define GLYPH_SUPPORT_NONE                  0x0000
#define GLYPH_SUPPORT_PARTIAL               0x0001
#define GLYPH_SUPPORT_FULL                  0x0002
#define GLYPH_SUPPORT_ENCODE                0x0003

/* SYSTEM_TIME */
typedef struct
{
	uint16 wYear;
	uint16 wMonth;
	uint16 wDayOfWeek;
	uint16 wDay;
	uint16 wHour;
	uint16 wMinute;
	uint16 wSecond;
	uint16 wMilliseconds;
} SYSTEM_TIME;

/* TIME_ZONE_INFORMATION */
struct _TIME_ZONE_INFO
{
	uint32 bias;
	char standardName[32];
	SYSTEM_TIME standardDate;
	uint32 standardBias;
	char daylightName[32];
	SYSTEM_TIME daylightDate;
	uint32 daylightBias;
};
typedef struct _TIME_ZONE_INFO TIME_ZONE_INFO;

/* ARC_CS_PRIVATE_PACKET */
typedef struct
{
	uint32 cbLen;
	uint32 version;
	uint32 logonId;
	uint8 securityVerifier[16];
} ARC_CS_PRIVATE_PACKET;

/* ARC_SC_PRIVATE_PACKET */
typedef struct
{
	uint32 cbLen;
	uint32 version;
	uint32 logonId;
	uint8 arcRandomBits[16];
} ARC_SC_PRIVATE_PACKET;

/* Certificates */

typedef struct rdp_certificate rdpCertificate;
typedef struct rdp_key rdpKey;

struct rdp_CertBlob
{
	uint32 length;
	uint8* data;
};
typedef struct rdp_CertBlob rdpCertBlob;

struct rdp_X509CertChain
{
	uint32 count;
	rdpCertBlob* array;
};
typedef struct rdp_X509CertChain rdpX509CertChain;

struct rdp_CertInfo
{
	rdpBlob modulus;
	uint8 exponent[4];
};
typedef struct rdp_CertInfo rdpCertInfo;

struct rdp_certificate
{
	rdpCertInfo cert_info;
	rdpX509CertChain* x509_cert_chain;
};

/* Channels */

struct rdp_channel
{
	char name[8]; /* ui sets */
	int options; /* ui sets */
	int channel_id; /* core sets */
	boolean joined; /* client has joined the channel */
	void* handle; /* just for ui */
};
typedef struct rdp_channel rdpChannel;

/* Extensions */

struct rdp_ext_set
{
	char name[256]; /* plugin name or path */
	void* data; /* plugin data */
};

/* Bitmap Cache */

struct _BITMAP_CACHE_CELL_INFO
{
	uint16 numEntries;
	uint16 maxSize;
};
typedef struct _BITMAP_CACHE_CELL_INFO BITMAP_CACHE_CELL_INFO;

struct _BITMAP_CACHE_V2_CELL_INFO
{
	uint32 numEntries;
	boolean persistent;
};
typedef struct _BITMAP_CACHE_V2_CELL_INFO BITMAP_CACHE_V2_CELL_INFO;

/* Glyph Cache */

struct _GLYPH_CACHE_DEFINITION
{
	uint16 cacheEntries;
	uint16 cacheMaximumCellSize;
};
typedef struct _GLYPH_CACHE_DEFINITION GLYPH_CACHE_DEFINITION;

/* Monitors */

struct rdp_monitor
{
	int x;
	int y;
	int width;
	int height;
	int is_primary;
};

/* Settings */

struct rdp_settings
{
	void* instance; /* 0 */
	uint32 paddingA[16 - 1]; /* 1 */

	/* Core Protocol Parameters */
	uint32 width; /* 16 */
	uint32 height; /* 17 */
	uint32 rdp_version; /* 18 */
	uint32 color_depth; /* 19 */
	uint32 kbd_layout; /* 20 */
	uint32 kbd_type; /* 21 */
	uint32 kbd_subtype; /* 22 */
	uint32 kbd_fn_keys; /* 23 */
	uint32 client_build; /* 24 */
	uint32 requested_protocols; /* 25 */
	uint32 selected_protocol; /* 26 */
	uint32 encryption_method; /* 27 */
	uint32 encryption_level; /* 28 */
	boolean authentication; /* 29 */
	uint32 negotiationFlags; /* 30 */
	uint32 paddingB[48 - 31]; /* 31 */

	/* Connection Settings */
	uint32 port; /* 48 */
	boolean ipv6; /* 49 */
	char* hostname; /* 50 */
	char* username; /* 51 */
	char* password; /* 52 */
	char* domain; /* 53 */
	char* shell; /* 54 */
	char* directory; /* 55 */
	char* ip_address; /* 56 */
	char* client_dir; /* 57 */
	boolean autologon; /* 58 */
	boolean compression; /* 59 */
	uint32 performance_flags; /* 60 */
	rdpBlob* password_cookie; /* 61 */
	uint32 paddingC[80 - 62]; /* 62 */

	/* User Interface Parameters */
	boolean sw_gdi; /* 80 */
	boolean workarea; /* 81 */
	boolean fullscreen; /* 82 */
	boolean grab_keyboard; /* 83 */
	boolean decorations; /* 84 */
	uint32 percent_screen; /* 85 */
	boolean mouse_motion; /* 86 */
	char* window_title; /* 87 */
	uint64 parent_window_xid; /* 88 */
	uint32 paddingD[112 - 89]; /* 89 */

	/* Internal Parameters */
	char* home_path; /* 112 */
	uint32 share_id; /* 113 */
	uint32 pdu_source; /* 114 */
	UNICONV* uniconv; /* 115 */
	boolean server_mode; /* 116 */
	char* config_path; /* 117 */
	char* current_path; /* 118 */
	char* development_path; /* 119 */
	boolean development_mode; /* 120 */
	uint32 paddingE[144 - 121]; /* 121 */

	/* Security */
	boolean encryption; /* 144 */
	boolean tls_security; /* 145 */
	boolean nla_security; /* 146 */
	boolean rdp_security; /* 147 */
	uint32 ntlm_version; /* 148 */
	boolean secure_checksum; /* 149 */
	uint32 paddingF[160 - 150]; /* 150 */

	/* Session */
	boolean console_audio; /* 160 */
	boolean console_session; /* 161 */
	uint32 redirected_session_id; /* 162 */
	uint32 paddingG[176 - 163]; /* 163 */

	/* Output Control */
	boolean refresh_rect; /* 176 */
	boolean suppress_output; /* 177 */
	boolean desktop_resize; /* 178 */
	uint32 paddingH[192 - 179]; /* 179 */

	/* Reconnection */
	boolean auto_reconnection; /* 192 */
	ARC_CS_PRIVATE_PACKET* client_auto_reconnect_cookie; /* 193 */
	ARC_SC_PRIVATE_PACKET* server_auto_reconnect_cookie; /* 194 */
	uint32 paddingI[208 - 195]; /* 195 */

	/* Time Zone */
	TIME_ZONE_INFO* client_time_zone; /* 208 */
	uint32 paddingJ[216 - 209]; /* 209 */

	/* Capabilities */
	uint32 os_major_type; /* 216 */
	uint32 os_minor_type; /* 217 */
	uint32 vc_chunk_size; /* 218 */
	boolean sound_beeps; /* 219 */
	boolean smooth_fonts; /* 220 */
	boolean frame_marker; /* 221 */
	boolean fastpath_input; /* 222 */
	boolean fastpath_output; /* 223 */
	uint8 received_caps[32]; /* 224 (8) */
	uint8 order_support[32]; /* 232 (8) */
	boolean surface_commands; /* 240 */
	boolean disable_wallpaper; /* 241 */
	boolean disable_full_window_drag; /* 242 */
	boolean disable_menu_animations; /* 243 */
	boolean disable_theming; /* 244 */
	uint32 connection_type; /* 245 */
	uint32 multifrag_max_request_size; /* 246 */
	uint32 paddingK[248 - 247]; /* 247 */

	/* Certificate */
	char* cert_file; /* 248 */
	char* privatekey_file; /* 249 */
	char client_hostname[32]; /* 250 (8) */
	char client_product_id[32]; /* 258 (8) */
	rdpBlob* server_random; /* 266 */
	rdpBlob* server_certificate; /* 267 */
	boolean ignore_certificate; /* 268 */
	rdpCertificate* server_cert; /* 269 */
	char* rdp_key_file; /* 270 */
	rdpKey* server_key; /* 271 */
	char* certificate_name; /* 272 */
	uint32 paddingL[280 - 273]; /* 273 */

	/* Codecs */
	boolean rfx_codec; /* 280 */
	boolean ns_codec; /* 281 */
	uint32 rfx_codec_id; /* 282 */
	uint32 ns_codec_id; /* 283 */
	uint32 rfx_codec_mode; /* 284 */
	boolean frame_acknowledge; /* 285 */
	boolean jpeg_codec; /* 286 */
	uint32 jpeg_codec_id; /* 287 */
	uint32 jpeg_quality; /* 288 */
	uint32 v3_codec_id; /* 289 */
	boolean h264_codec; /* 290 */
	uint32 paddingM[296 - 291]; /* 291 */

	/* Recording */
	boolean dump_rfx; /* 296 */
	boolean play_rfx; /* 297 */
	char* dump_rfx_file; /* 298 */
	char* play_rfx_file; /* 299 */
	uint32 paddingN[312 - 300]; /* 300 */

	/* RemoteApp */
	boolean remote_app; /* 312 */
	uint32 num_icon_caches; /* 313 */
	uint32 num_icon_cache_entries; /* 314 */
	boolean rail_langbar_supported; /* 315 */
	uint32 paddingO[320 - 316]; /* 316 */

	/* Pointer */
	boolean large_pointer; /* 320 */
	boolean color_pointer; /* 321 */
	uint32 pointer_cache_size; /* 322 */
	uint32 paddingP[328 - 323]; /* 323 */

	/* Bitmap Cache */
	boolean bitmap_cache; /* 328 */
	boolean bitmap_cache_v3; /* 329 */
	boolean persistent_bitmap_cache; /* 330 */
	uint32 bitmapCacheV2NumCells; /* 331 */
	BITMAP_CACHE_V2_CELL_INFO* bitmapCacheV2CellInfo; /* 332 */
	uint32 paddingQ[344 - 333]; /* 333 */

	/* Offscreen Bitmap Cache */
	boolean offscreen_bitmap_cache; /* 344 */
	uint32 offscreen_bitmap_cache_size; /* 345 */
	uint32 offscreen_bitmap_cache_entries; /* 346 */
	uint32 paddingR[352 - 347]; /* 347 */

	/* Glyph Cache */
	boolean glyph_cache; /* 352 */
	uint32 glyphSupportLevel; /* 353 */
	GLYPH_CACHE_DEFINITION* glyphCache; /* 354 */
	GLYPH_CACHE_DEFINITION* fragCache; /* 355 */
	uint32 paddingS[360 - 356]; /* 356 */

	/* Draw Nine Grid */
	boolean draw_nine_grid; /* 360 */
	uint32 draw_nine_grid_cache_size; /* 361 */
	uint32 draw_nine_grid_cache_entries; /* 362 */
	uint32 paddingT[368 - 363]; /* 363 */

	/* Draw GDI+ */
	boolean draw_gdi_plus; /* 368 */
	boolean draw_gdi_plus_cache; /* 369 */
	uint32 paddingU[376 - 370]; /* 370 */

	/* Desktop Composition */
	boolean desktop_composition; /* 376 */
	uint32 paddingV[384 - 377]; /* 377 */

	/* Channels */
	int num_channels;
	rdpChannel channels[16];

	/* Monitors */
	int num_monitors;
	struct rdp_monitor monitors[16];

	/* Extensions */
	int num_extensions;
	struct rdp_ext_set extensions[16];

	int skip_bs;

	/* TSG */
	tbool tsg;
	char* tsg_username;
	char* tsg_password;
	char* tsg_domain;
	char* tsg_server;

	/* No Orders */
	tbool no_orders;

};
typedef struct rdp_settings rdpSettings;

rdpSettings* settings_new(void* instance);
void settings_free(rdpSettings* settings);

#endif /* __RDP_SETTINGS_H */