common/settings.c File Reference

#include <freerdp/config.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <winpr/crt.h>
#include <winpr/assert.h>
#include "../core/settings.h"
#include "../core/capabilities.h"
#include <freerdp/crypto/certificate.h>
#include <freerdp/settings.h>
#include <freerdp/freerdp.h>
#include <freerdp/log.h>

Macros
#define	TAG   FREERDP_TAG("common")

Functions
BOOL	freerdp_addin_argv_add_argument_ex (ADDIN_ARGV *args, const char *argument, size_t len)
BOOL	freerdp_addin_argv_add_argument (ADDIN_ARGV *args, const char *argument)
BOOL	freerdp_addin_argv_del_argument (ADDIN_ARGV *args, const char *argument)
int	freerdp_addin_set_argument (ADDIN_ARGV *args, const char *argument)
int	freerdp_addin_replace_argument (ADDIN_ARGV *args, const char *previous, const char *argument)
int	freerdp_addin_set_argument_value (ADDIN_ARGV *args, const char *option, const char *value)
int	freerdp_addin_replace_argument_value (ADDIN_ARGV *args, const char *previous, const char *option, const char *value)
BOOL	freerdp_device_collection_add (rdpSettings *settings, RDPDR_DEVICE *device)
RDPDR_DEVICE *	freerdp_device_collection_find (rdpSettings *settings, const char *name)
RDPDR_DEVICE *	freerdp_device_collection_find_type (rdpSettings *settings, UINT32 type)
RDPDR_DEVICE *	freerdp_device_new (UINT32 Type, size_t count, const char *args[])
void	freerdp_device_free (RDPDR_DEVICE *device)
RDPDR_DEVICE *	freerdp_device_clone (const RDPDR_DEVICE *device)
void	freerdp_device_collection_free (rdpSettings *settings)
BOOL	freerdp_static_channel_collection_del (rdpSettings *settings, const char *name)
BOOL	freerdp_static_channel_collection_add (rdpSettings *settings, ADDIN_ARGV *channel)
ADDIN_ARGV *	freerdp_static_channel_collection_find (rdpSettings *settings, const char *name)
void	freerdp_static_channel_collection_free (rdpSettings *settings)
BOOL	freerdp_dynamic_channel_collection_del (rdpSettings *settings, const char *name)
BOOL	freerdp_dynamic_channel_collection_add (rdpSettings *settings, ADDIN_ARGV *channel)
ADDIN_ARGV *	freerdp_dynamic_channel_collection_find (const rdpSettings *settings, const char *name)
void	freerdp_addin_argv_free (ADDIN_ARGV *args)
ADDIN_ARGV *	freerdp_addin_argv_new (size_t argc, const char *argv[])
ADDIN_ARGV *	freerdp_addin_argv_clone (const ADDIN_ARGV *args)
void	freerdp_dynamic_channel_collection_free (rdpSettings *settings)
void	freerdp_capability_buffer_free (rdpSettings *settings)
BOOL	freerdp_capability_buffer_copy (rdpSettings *settings, const rdpSettings *src)
void	freerdp_target_net_addresses_free (rdpSettings *settings)
void	freerdp_server_license_issuers_free (rdpSettings *settings)
BOOL	freerdp_server_license_issuers_copy (rdpSettings *settings, char **issuers, UINT32 count)
void	freerdp_performance_flags_make (rdpSettings *settings)
void	freerdp_performance_flags_split (rdpSettings *settings)
BOOL	freerdp_set_gateway_usage_method (rdpSettings *settings, UINT32 GatewayUsageMethod)
void	freerdp_update_gateway_usage_method (rdpSettings *settings, UINT32 GatewayEnabled, UINT32 GatewayBypassLocal)
static BOOL	value_to_uint (const char *value, ULONGLONG *result, ULONGLONG min, ULONGLONG max)
static BOOL	value_to_int (const char *value, LONGLONG *result, LONGLONG min, LONGLONG max)
static BOOL	parsing_fail (const char *key, const char *type, const char *value)
BOOL	freerdp_settings_set_value_for_name (rdpSettings *settings, const char *name, const char *value)
static BOOL	freerdp_settings_set_pointer_len_ (rdpSettings *settings, size_t id, SSIZE_T lenId, const void *data, size_t len, size_t size)
const void *	freerdp_settings_get_pointer (const rdpSettings *settings, size_t id)
	Returns a immutable pointer settings value. More...
BOOL	freerdp_settings_set_pointer_len (rdpSettings *settings, size_t id, const void *data, size_t len)
void *	freerdp_settings_get_pointer_array_writable (const rdpSettings *settings, size_t id, size_t offset)
BOOL	freerdp_settings_set_pointer_array (rdpSettings *settings, size_t id, size_t offset, const void *data)
const void *	freerdp_settings_get_pointer_array (const rdpSettings *settings, size_t id, size_t offset)
UINT32	freerdp_settings_get_codecs_flags (const rdpSettings *settings)
const char *	freerdp_settings_get_server_name (const rdpSettings *settings)
	A helper function to return the correct server name. More...
BOOL	freerdp_target_net_addresses_copy (rdpSettings *settings, char **addresses, UINT32 count)
BOOL	freerdp_device_equal (const RDPDR_DEVICE *what, const RDPDR_DEVICE *expect)
char *	freerdp_rail_support_flags_to_string (UINT32 flags, char *buffer, size_t length)
	Returns a stringified representation of RAIL support flags. More...
BOOL	freerdp_settings_update_from_caps (rdpSettings *settings, const BYTE *capsFlags, const BYTE **capsData, const UINT32 *capsSizes, UINT32 capsCount, BOOL serverReceivedCaps)
	Parse capability data and apply to settings. More...
const char *	freerdp_rdp_version_string (UINT32 version)
	Returns a stringified representation of the RDP protocol version. More...
BOOL	freerdp_settings_set_string_from_utf16 (rdpSettings *settings, size_t id, const WCHAR *param)
	Sets a string settings value. The param is converted to UTF-8 and the copy stored. More...
BOOL	freerdp_settings_set_string_from_utf16N (rdpSettings *settings, size_t id, const WCHAR *param, size_t length)
	Sets a string settings value. The param is converted to UTF-8 and the copy stored. More...
WCHAR *	freerdp_settings_get_string_as_utf16 (const rdpSettings *settings, size_t id, size_t *pCharLen)
	Return an allocated UTF16 string. More...
const char *	freerdp_rdpdr_dtyp_string (UINT32 type)
	Returns a string representation of RDPDR_DTYP_*. More...
const char *	freerdp_encryption_level_string (UINT32 EncryptionLevel)
const char *	freerdp_encryption_methods_string (UINT32 EncryptionMethods, char *buffer, size_t size)

Macro Definition Documentation

TAG

#define TAG   FREERDP_TAG("common")

FreeRDP: A Remote Desktop Protocol Implementation Settings Management

Copyright 2012 Marc-Andre Moreau marca.nosp@m.ndre.nosp@m..more.nosp@m.au@g.nosp@m.mail..nosp@m.com Copyright 2016 Armin Novak armin.nosp@m..nov.nosp@m.ak@gm.nosp@m.ail..nosp@m.com Copyright 2023 Armin Novak anova.nosp@m.k@th.nosp@m.incas.nosp@m.t.co.nosp@m.m Copyright 2023 Thincast Technologies GmbH

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.

Function Documentation

freerdp_addin_argv_add_argument()

BOOL freerdp_addin_argv_add_argument	(	ADDIN_ARGV *	args,
		const char *	argument
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_argv_add_argument_ex()

BOOL freerdp_addin_argv_add_argument_ex	(	ADDIN_ARGV *	args,
		const char *	argument,
		size_t	len
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_argv_clone()

ADDIN_ARGV* freerdp_addin_argv_clone

(

const ADDIN_ARGV *

args

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_argv_del_argument()

BOOL freerdp_addin_argv_del_argument	(	ADDIN_ARGV *	args,
		const char *	argument
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_argv_free()

void freerdp_addin_argv_free

(

ADDIN_ARGV *

args

)

Here is the caller graph for this function:

freerdp_addin_argv_new()

ADDIN_ARGV* freerdp_addin_argv_new	(	size_t	argc,
		const char *	argv[]
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_replace_argument()

int freerdp_addin_replace_argument	(	ADDIN_ARGV *	args,
		const char *	previous,
		const char *	argument
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_replace_argument_value()

int freerdp_addin_replace_argument_value	(	ADDIN_ARGV *	args,
		const char *	previous,
		const char *	option,
		const char *	value
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_set_argument()

int freerdp_addin_set_argument	(	ADDIN_ARGV *	args,
		const char *	argument
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_addin_set_argument_value()

int freerdp_addin_set_argument_value	(	ADDIN_ARGV *	args,
		const char *	option,
		const char *	value
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_capability_buffer_copy()

BOOL freerdp_capability_buffer_copy	(	rdpSettings *	settings,
		const rdpSettings *	src
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_capability_buffer_free()

void freerdp_capability_buffer_free

(

rdpSettings *

settings

)

Here is the caller graph for this function:

freerdp_device_clone()

RDPDR_DEVICE* freerdp_device_clone

(

const RDPDR_DEVICE *

device

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_device_collection_add()

BOOL freerdp_device_collection_add	(	rdpSettings *	settings,
		RDPDR_DEVICE *	device
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_device_collection_find()

RDPDR_DEVICE* freerdp_device_collection_find	(	rdpSettings *	settings,
		const char *	name
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_device_collection_find_type()

RDPDR_DEVICE* freerdp_device_collection_find_type	(	rdpSettings *	settings,
		UINT32	type
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_device_collection_free()

void freerdp_device_collection_free

(

rdpSettings *

settings

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_device_equal()

BOOL freerdp_device_equal	(	const RDPDR_DEVICE *	what,
		const RDPDR_DEVICE *	expect
	)

Here is the caller graph for this function:

freerdp_device_free()

void freerdp_device_free

(

RDPDR_DEVICE *

device

)

Here is the caller graph for this function:

freerdp_device_new()

RDPDR_DEVICE* freerdp_device_new	(	UINT32	Type,
		size_t	count,
		const char *	args[]
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_dynamic_channel_collection_add()

BOOL freerdp_dynamic_channel_collection_add	(	rdpSettings *	settings,
		ADDIN_ARGV *	channel
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_dynamic_channel_collection_del()

BOOL freerdp_dynamic_channel_collection_del	(	rdpSettings *	settings,
		const char *	name
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_dynamic_channel_collection_find()

ADDIN_ARGV* freerdp_dynamic_channel_collection_find	(	const rdpSettings *	settings,
		const char *	name
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_dynamic_channel_collection_free()

void freerdp_dynamic_channel_collection_free

(

rdpSettings *

settings

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_encryption_level_string()

const char* freerdp_encryption_level_string

(

UINT32

EncryptionLevel

)

freerdp_encryption_methods_string()

const char* freerdp_encryption_methods_string	(	UINT32	EncryptionMethods,
		char *	buffer,
		size_t	size
	)

Here is the call graph for this function:

freerdp_performance_flags_make()

void freerdp_performance_flags_make

(

rdpSettings *

settings

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_performance_flags_split()

void freerdp_performance_flags_split

(

rdpSettings *

settings

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_rail_support_flags_to_string()

char* freerdp_rail_support_flags_to_string	(	UINT32	flags,
		char *	buffer,
		size_t	length
	)

Returns a stringified representation of RAIL support flags.

Parameters

flags	The flags to stringify
buffer	A pointer to the string buffer to write to
length	The size of the string buffer

Returns

A pointer to buffer for success, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_rdp_version_string()

const char* freerdp_rdp_version_string

(

UINT32

version

)

Returns a stringified representation of the RDP protocol version.

Parameters

version

The RDP protocol version number.

Returns

A string representation of the protocol version as "RDP_VERSION_10_11" or "RDP_VERSION_UNKNOWN" for invalid/unknown versions

freerdp_rdpdr_dtyp_string()

const char* freerdp_rdpdr_dtyp_string

(

UINT32

type

)

Returns a string representation of RDPDR_DTYP_*.

Parameters

type	The integer of the RDPDR_DTYP_* to stringify

Returns

A string representation of the RDPDR_DTYP_* or "RDPDR_DTYP_UNKNOWN"

Here is the caller graph for this function:

freerdp_server_license_issuers_copy()

BOOL freerdp_server_license_issuers_copy	(	rdpSettings *	settings,
		char **	issuers,
		UINT32	count
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_server_license_issuers_free()

void freerdp_server_license_issuers_free

(

rdpSettings *

settings

)

Here is the caller graph for this function:

freerdp_set_gateway_usage_method()

BOOL freerdp_set_gateway_usage_method	(	rdpSettings *	settings,
		UINT32	GatewayUsageMethod
	)

This corresponds to "Automatically detect RD Gateway server settings", which means the client attempts to use gateway group policy settings http://technet.microsoft.com/en-us/library/cc770601.aspx

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_get_codecs_flags()

UINT32 freerdp_settings_get_codecs_flags

(

const rdpSettings *

settings

)

Here is the caller graph for this function:

freerdp_settings_get_pointer()

const void* freerdp_settings_get_pointer	(	const rdpSettings *	settings,
		size_t	id
	)

Returns a immutable pointer settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns

the immutable pointer value

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_get_pointer_array()

const void* freerdp_settings_get_pointer_array	(	const rdpSettings *	settings,
		size_t	id,
		size_t	offset
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_get_pointer_array_writable()

void* freerdp_settings_get_pointer_array_writable	(	const rdpSettings *	settings,
		size_t	id,
		size_t	offset
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_get_server_name()

const char* freerdp_settings_get_server_name

(

const rdpSettings *

settings

)

A helper function to return the correct server name.

The server name might be in key FreeRDP_ServerHostname or if used in FreeRDP_UserSpecifiedServerName. This function returns the correct name to use.

Parameters

settings

The settings to query, must not be NULL.

Returns

A string pointer or NULL in case of failure.

Here is the caller graph for this function:

freerdp_settings_get_string_as_utf16()

WCHAR* freerdp_settings_get_string_as_utf16	(	const rdpSettings *	settings,
		size_t	id,
		size_t *	pCharLen
	)

Return an allocated UTF16 string.

Parameters

settings	A pointer to the settings struct to use
id	The settings identifier

Returns

An allocated, '\0' terminated WCHAR string or NULL

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_set_pointer_array()

BOOL freerdp_settings_set_pointer_array	(	rdpSettings *	settings,
		size_t	id,
		size_t	offset,
		const void *	data
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_set_pointer_len()

BOOL freerdp_settings_set_pointer_len	(	rdpSettings *	settings,
		size_t	id,
		const void *	data,
		size_t	len
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_set_pointer_len_()

static BOOL freerdp_settings_set_pointer_len_ ( rdpSettings *  settings, size_t  id, SSIZE_T  lenId, const void *  data, size_t  len, size_t  size  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_set_string_from_utf16()

BOOL freerdp_settings_set_string_from_utf16	(	rdpSettings *	settings,
		size_t	id,
		const WCHAR *	param
	)

Sets a string settings value. The param is converted to UTF-8 and the copy stored.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set. If NULL removes the old entry, otherwise a copy is created.

Returns

TRUE for success, FALSE for failure

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_set_string_from_utf16N()

BOOL freerdp_settings_set_string_from_utf16N	(	rdpSettings *	settings,
		size_t	id,
		const WCHAR *	param,
		size_t	length
	)

Sets a string settings value. The param is converted to UTF-8 and the copy stored.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set. If NULL removes the old entry, otherwise a copy is created.
length	The length of the WCHAR string in number of WCHAR characters

Returns

TRUE for success, FALSE for failure

Here is the call graph for this function:

freerdp_settings_set_value_for_name()

BOOL freerdp_settings_set_value_for_name	(	rdpSettings *	settings,
		const char *	name,
		const char *	value
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_settings_update_from_caps()

BOOL freerdp_settings_update_from_caps	(	rdpSettings *	settings,
		const BYTE *	capsFlags,
		const BYTE **	capsData,
		const UINT32 *	capsSizes,
		UINT32	capsCount,
		BOOL	serverReceivedCaps
	)

Parse capability data and apply to settings.

The capability message is stored in raw form in the settings, the data parsed and applied to the settings.

Parameters

settings	A pointer to the settings to use
capsFlags	A pointer to the capablity flags, must have capsCount fields
capsData	A pointer array to the RAW capability data, must have capsCount fields
capsSizes	A pointer to an array of RAW capability sizes, must have capsCount fields
capsCount	The number of capabilities contained in the RAW data
serverReceivedCaps	Indicates if the parser should assume to be a server or client instance

Returns

TRUE for success, FALSE in case of an error

Here is the call graph for this function:

freerdp_static_channel_collection_add()

BOOL freerdp_static_channel_collection_add	(	rdpSettings *	settings,
		ADDIN_ARGV *	channel
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_static_channel_collection_del()

BOOL freerdp_static_channel_collection_del	(	rdpSettings *	settings,
		const char *	name
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_static_channel_collection_find()

ADDIN_ARGV* freerdp_static_channel_collection_find	(	rdpSettings *	settings,
		const char *	name
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_static_channel_collection_free()

void freerdp_static_channel_collection_free

(

rdpSettings *

settings

)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_target_net_addresses_copy()

BOOL freerdp_target_net_addresses_copy	(	rdpSettings *	settings,
		char **	addresses,
		UINT32	count
	)

Here is the call graph for this function:

Here is the caller graph for this function:

freerdp_target_net_addresses_free()

void freerdp_target_net_addresses_free

(

rdpSettings *

settings

)

Here is the caller graph for this function:

freerdp_update_gateway_usage_method()

void freerdp_update_gateway_usage_method	(	rdpSettings *	settings,
		UINT32	GatewayEnabled,
		UINT32	GatewayBypassLocal
	)

Here is the call graph for this function:

parsing_fail()

static BOOL parsing_fail ( const char *  key, const char *  type, const char *  value  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

value_to_int()

static BOOL value_to_int ( const char *  value, LONGLONG *  result, LONGLONG  min, LONGLONG  max  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

value_to_uint()

static BOOL value_to_uint ( const char *  value, ULONGLONG *  result, ULONGLONG  min, ULONGLONG  max  )

static

Here is the call graph for this function:

Here is the caller graph for this function: