#include "syshead.h"
#include "common.h"
#include "buffer.h"
#include "error.h"
#include "mtu.h"
#include "misc.h"
#include "memdbg.h"
#include <wchar.h>

Include dependency graph for buffer.c:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	buf_debug_line(buf) 0

#define	buf_debug_file(buf) "[UNDEF]"

Functions
size_t	array_mult_safe (const size_t m1, const size_t m2, const size_t extra)

void	buf_size_error (const size_t size)

struct buffer	alloc_buf (size_t size)

struct buffer	alloc_buf_gc (size_t size, struct gc_arena *gc)

struct buffer	clone_buf (const struct buffer *buf)

void	buf_clear (struct buffer *buf)

bool	buf_assign (struct buffer dest, const struct buffer src)

void	free_buf (struct buffer *buf)

static void	free_buf_gc (struct buffer buf, struct gc_arena gc)

struct buffer	buf_sub (struct buffer *buf, int size, bool prepend)

bool	buf_printf (struct buffer buf, const char format,...)

bool	buf_puts (struct buffer buf, const char str)

void	buf_catrunc (struct buffer buf, const char str)

void	convert_to_one_line (struct buffer *buf)

bool	buffer_write_file (const char filename, const struct buffer buf)
	Write buffer contents to file. More...

void *	gc_malloc (size_t size, bool clear, struct gc_arena *a)

void *	gc_realloc (void ptr, size_t size, struct gc_arena a)
	allows to realloc a pointer previously allocated by gc_malloc or gc_realloc More...

void	x_gc_free (struct gc_arena *a)

void	x_gc_freespecial (struct gc_arena *a)

void	gc_addspecial (void addr, void(free_function)(void ), struct gc_arena a)

void	gc_transfer (struct gc_arena dest, struct gc_arena src)

char *	format_hex_ex (const uint8_t data, int size, int maxoutput, unsigned int space_break_flags, const char separator, struct gc_arena *gc)

void	buf_rmtail (struct buffer *buf, uint8_t remove)

void	buf_null_terminate (struct buffer *buf)

void	buf_chomp (struct buffer *buf)

const char *	skip_leading_whitespace (const char *str)

void	string_null_terminate (char *str, int len, int capacity)

void	chomp (char *str)

void	rm_trailing_chars (char str, const char what_to_delete)

char *	string_alloc (const char str, struct gc_arena gc)

void	string_clear (char *str)

int	string_array_len (const char **array)

char *	print_argv (const char *p, struct gc_arena gc, const unsigned int flags)

struct buffer	string_alloc_buf (const char str, struct gc_arena gc)

bool	buf_string_match_head_str (const struct buffer src, const char match)

bool	buf_string_compare_advance (struct buffer src, const char match)

int	buf_substring_len (const struct buffer *buf, int delim)

bool	buf_parse (struct buffer buf, const int delim, char line, const int size)

const char *	np (const char *str)

bool	char_class (const unsigned char c, const unsigned int flags)

static bool	char_inc_exc (const char c, const unsigned int inclusive, const unsigned int exclusive)

bool	string_class (const char *str, const unsigned int inclusive, const unsigned int exclusive)

bool	string_mod (char *str, const unsigned int inclusive, const unsigned int exclusive, const char replace)
	Modifies a string in place by replacing certain classes of characters of it with a specified character. More...

bool	string_check_buf (struct buffer *buf, const unsigned int inclusive, const unsigned int exclusive)
	Check a buffer if it only consists of allowed characters. More...

const char *	string_mod_const (const char str, const unsigned int inclusive, const unsigned int exclusive, const char replace, struct gc_arena gc)
	Returns a copy of a string with certain classes of characters of it replaced with a specified character. More...

void	string_replace_leading (char *str, const char match, const char replace)

struct buffer_list *	buffer_list_new (void)
	Allocate an empty buffer list of capacity `max_size`. More...

void	buffer_list_free (struct buffer_list *ol)
	Frees a buffer list and all the buffers in it. More...

bool	buffer_list_defined (const struct buffer_list *ol)
	Checks if the list is valid and non-empty. More...

void	buffer_list_reset (struct buffer_list *ol)
	Empty the list `ol` and frees all the contained buffers. More...

void	buffer_list_push (struct buffer_list ol, const char str)
	Allocates and appends a new buffer containing `str` as data to `ol`. More...

struct buffer_entry *	buffer_list_push_data (struct buffer_list ol, const void data, size_t size)
	Allocates and appends a new buffer containing `data` of length `size`. More...

struct buffer *	buffer_list_peek (struct buffer_list *ol)
	Retrieve the head buffer. More...

void	buffer_list_aggregate_separator (struct buffer_list bl, const size_t max_len, const char sep)
	Aggregates as many buffers as possible from `bl` in a new buffer of maximum length `max_len` . More...

void	buffer_list_aggregate (struct buffer_list *bl, const size_t max)
	Aggregates as many buffers as possible from `bl` in a new buffer of maximum length `max_len` . More...

void	buffer_list_pop (struct buffer_list *ol)

void	buffer_list_advance (struct buffer_list *ol, int n)

struct buffer_list *	buffer_list_file (const char *fn, int max_line_len)

struct buffer	buffer_read_from_file (const char filename, struct gc_arena gc)
	buffer_read_from_file - copy the content of a file into a buffer More...

Macro Definition Documentation

◆ buf_debug_file

#define buf_debug_file ( buf ) "[UNDEF]"

Definition at line 157 of file buffer.c.

◆ buf_debug_line

#define buf_debug_line ( buf ) 0

Definition at line 156 of file buffer.c.

Function Documentation

◆ alloc_buf()

struct buffer alloc_buf ( size_t size )

Definition at line 62 of file buffer.c.

References buf_size_error(), buf_size_valid(), buffer::capacity, check_malloc_return(), buffer::data, buffer::len, and buffer::offset.

Referenced by alloc_buf_sock_tun(), auth_token_init_secret(), buffer_list_aggregate_separator(), buffer_list_push_data(), check_inline_file(), command_line_new(), fragment_frame_init(), fragment_list_buf_init(), init_context_buffers(), init_tas_auth(), init_tas_crypt(), key_state_init(), management_query_cert(), management_query_pk_sig(), mutate_ncp_cipher_list(), openvpn_PRF(), options_string(), read_inline_file(), reliable_init(), send_line_crlf(), status_open(), stream_buf_init(), test_generate_reset_packet_plain(), test_parse_ack(), test_tls_crypt_setup(), test_tls_decrypt_lite_auth(), test_tls_decrypt_lite_crypt(), test_tls_decrypt_lite_none(), test_verify_hmac_none(), test_verify_hmac_tls_auth(), tls_crypt_v2_extract_client_key(), tls_crypt_v2_init_client_key(), tls_session_generate_dynamic_tls_crypt_key(), tls_session_init(), tun_show_debug(), and tuntap_dhcp_mask().

◆ alloc_buf_gc()

struct buffer alloc_buf_gc	(	size_t	size,
		struct gc_arena *	gc
	)

Definition at line 88 of file buffer.c.

References buf_size_error(), buf_size_valid(), buffer::capacity, buffer::data, gc_malloc(), buffer::len, and buffer::offset.

Referenced by __wrap_buffer_read_from_file(), add_option(), buffer_read_from_file(), ce_management_query_proxy(), ce_management_query_remote(), check_incoming_control_channel(), construct_name_value(), crypto_pem_encode(), dco_version_string(), do_data_channel_round_trip(), do_init_frame_tls(), fork_dhcp_action(), fork_register_dns_action(), format_common_name(), format_hex_ex(), format_ip_addr_string(), format_route_entry(), frame_print(), generate_auth_token(), get_device_guid(), get_unspecified_device_guid(), get_user_pass_cr(), hostname_randomize(), ifconfig_options_string(), ifconfig_pool_read(), ipset2ascii_all(), link_socket_connection_initiated(), log_entry_print(), management_callback_send_cc_message(), management_hold(), management_query_multiline(), management_query_user_pass(), mroute_addr_print_ex(), mroute_helper_regenerate(), msg_flags_string(), multi_instance_string(), netsh_get_id(), ntlm_phase_1(), options_string_compat_lzo(), options_string_version(), options_warning_safe_ml(), p2p_mode_ncp(), packet_id_net_print(), packet_id_persist_print(), platform_gen_path(), plugin_mask_string(), prepare_push_reply(), prepend_dir(), print_argv(), print_default_gateway(), print_in_port_t(), print_key_id(), print_link_socket_actual_ex(), print_netmask(), print_opt_route(), print_opt_route_gateway(), print_opt_route_gateway_dhcp(), print_opt_topology(), print_sockaddr_ex(), print_str(), print_str_int(), proto2ascii_all(), protocol_dump(), push_peer_info(), read_control_auth(), reliable_ack_print(), route_string(), send_auth_failed(), send_auth_pending_messages(), send_push_reply(), send_push_reply_auth_token(), server_pushed_info(), setenv_format_indexed_name(), setenv_route(), setenv_route_addr(), setenv_route_ipv6(), socket_stat(), strerror_win32(), system_error_message(), tap_win_getinfo(), test_buffer_free_gc_one(), test_buffer_free_gc_two(), test_buffer_printf_catrunc(), test_character_string_mod_buf(), test_crypto(), test_tls_crypt_v2_setup(), time_string(), tls_crypt_v2_wrap_client_key(), tls_crypt_v2_wrap_unwrap_dst_too_small(), tls_crypt_v2_wrap_unwrap_max_metadata(), tls_crypt_v2_wrap_unwrap_no_metadata(), tls_crypt_v2_write_client_key_file(), tun_stat(), tv_string(), username_password_as_base64(), verify_cert(), wide_cmd_line(), win32_version_string(), window_title_generate(), write_key_file(), write_outgoing_tls_ciphertext(), x509_get_sha1_fingerprint(), and x509_get_sha256_fingerprint().

◆ array_mult_safe()

size_t array_mult_safe	(	const size_t	m1,
		const size_t	m2,
		const size_t	extra
	)

Definition at line 41 of file buffer.c.

References M_FATAL, msg, and unlikely.

◆ buf_assign()

bool buf_assign	(	struct buffer *	dest,
		const struct buffer *	src
	)

Definition at line 173 of file buffer.c.

References BLEN, BPTR, buf_init, buf_write(), and buffer::offset.

Referenced by buffer_turnover().

◆ buf_catrunc()

void buf_catrunc	(	struct buffer *	buf,
		const char *	str
	)

Definition at line 287 of file buffer.c.

References buf_forward_capacity(), buf_forward_capacity_total(), buffer::capacity, buffer::data, and buffer::len.

Referenced by format_hex_ex(), and test_buffer_printf_catrunc().

◆ buf_chomp()

void buf_chomp ( struct buffer * buf )

Definition at line 572 of file buffer.c.

References BLAST, buf_inc_len(), buf_null_terminate(), CC_CRLF, CC_NULL, and char_class().

Referenced by command_line_get(), and key_state_check_auth_pending_file().

◆ buf_clear()

void buf_clear ( struct buffer * buf )

◆ buf_null_terminate()

void buf_null_terminate ( struct buffer * buf )

Definition at line 551 of file buffer.c.

References BLAST, buf_inc_len(), buf_safe(), and buf_write_u8().

Referenced by buf_chomp(), buffer_read_from_file(), mutate_ncp_cipher_list(), and status_read().

◆ buf_parse()

bool buf_parse	(	struct buffer *	buf,
		const int	delim,
		char *	line,
		const int	size
	)

Definition at line 843 of file buffer.c.

References ASSERT, and buf_read_u8().

Referenced by apply_push_options(), get_user_pass_cr(), ifconfig_pool_read(), in_src_get(), make_inline_array(), man_kill(), man_output_peer_info_env(), options_warning_extract_parm1(), options_warning_safe_scan1(), options_warning_safe_scan2(), output_peer_info_env(), parse_auth_challenge(), parse_auth_pending_keywords(), push_update_digest(), and read_config_string().

◆ buf_printf()

bool buf_printf	(	struct buffer *	buf,
		const char *	format,
			...
	)

Definition at line 240 of file buffer.c.

References BEND, buf_defined(), buf_forward_capacity(), buffer::capacity, buffer::data, and buffer::len.

Referenced by add_delim_if_non_empty(), add_option(), ce_management_query_proxy(), ce_management_query_remote(), check_inline_file(), construct_name_value(), dco_version_string(), fork_dhcp_action(), fork_register_dns_action(), format_common_name(), format_hex_ex(), format_ip_addr_string(), format_route_entry(), frame_print(), get_device_guid(), get_unspecified_device_guid(), get_user_pass_cr(), hostname_randomize(), ifconfig_options_string(), ipset2ascii_all(), link_socket_connection_initiated(), log_entry_print(), management_callback_send_cc_message(), management_hold(), management_query_multiline(), management_query_user_pass(), mroute_addr_print_ex(), mroute_helper_regenerate(), msg_flags_string(), multi_instance_string(), ntlm_phase_1(), options_string(), options_string_compat_lzo(), options_warning_safe_ml(), p2p_mode_ncp(), packet_id_net_print(), packet_id_persist_print(), platform_gen_path(), plugin_mask_string(), prepare_push_reply(), prepend_dir(), print_argv(), print_default_gateway(), print_in_port_t(), print_key_id(), print_link_socket_actual_ex(), print_netmask(), print_opt_route(), print_opt_route_gateway(), print_opt_route_gateway_dhcp(), print_opt_topology(), print_sockaddr_ex(), print_str(), print_str_int(), proto2ascii_all(), protocol_dump(), push_peer_info(), read_inline_file(), reliable_ack_print(), route_string(), send_auth_failed(), send_auth_pending_messages(), send_push_options(), send_push_reply(), send_push_reply_auth_token(), server_pushed_info(), setenv_format_indexed_name(), setenv_route(), setenv_route_addr(), setenv_route_ipv6(), setenv_str_safe(), socket_stat(), strerror_win32(), system_error_message(), test_buffer_printf_catrunc(), time_string(), tls_print_deferred_options_results(), tun_stat(), tv_string(), username_password_as_base64(), verify_cert(), wide_cmd_line(), win32_print_arch(), win32_version_string(), window_title_generate(), and write_key_file().

◆ buf_puts()

bool buf_puts	(	struct buffer *	buf,
		const char *	str
	)

Definition at line 267 of file buffer.c.

References BEND, buf_forward_capacity(), buffer::capacity, buffer::data, buffer::len, and strncpynt().

Referenced by mutate_ncp_cipher_list(), and print_sockaddr_ex().

◆ buf_rmtail()

void buf_rmtail	(	struct buffer *	buf,
		uint8_t	remove
	)

Definition at line 536 of file buffer.c.

References BLAST, and buffer::len.

◆ buf_size_error()

void buf_size_error ( const size_t size )

Definition at line 53 of file buffer.c.

References M_FATAL, and msg.

Referenced by alloc_buf(), alloc_buf_gc(), buf_set_read(), and buf_set_write().

◆ buf_string_compare_advance()

bool buf_string_compare_advance	(	struct buffer *	src,
		const char *	match
	)

Definition at line 807 of file buffer.c.

References buf_advance(), and buf_string_match_head_str().

Referenced by process_incoming_push_msg(), and receive_auth_failed().

◆ buf_string_match_head_str()

bool buf_string_match_head_str	(	const struct buffer *	src,
		const char *	match
	)

Definition at line 796 of file buffer.c.

References BPTR, and buffer::len.

Referenced by buf_string_compare_advance(), parse_incoming_control_channel_command(), and receive_auth_failed().

◆ buf_sub()

struct buffer buf_sub	(	struct buffer *	buf,
		int	size,
		bool	prepend
	)

Definition at line 221 of file buffer.c.

References buf_prepend(), buf_write_alloc(), buffer::capacity, CLEAR, and buffer::data.

Referenced by reliable_ack_write(), and socks_process_outgoing_udp().

◆ buf_substring_len()

int buf_substring_len	(	const struct buffer *	buf,
		int	delim
	)

Definition at line 821 of file buffer.c.

References buf_read_u8().

Referenced by command_line_get().

◆ buffer_list_advance()

void buffer_list_advance	(	struct buffer_list *	ol,
		int	n
	)

Definition at line 1339 of file buffer.c.

References ASSERT, BLEN, buffer_entry::buf, buf_advance(), buffer_list_pop(), and buffer_list::head.

Referenced by man_write().

◆ buffer_list_aggregate()

void buffer_list_aggregate	(	struct buffer_list *	bl,
		const size_t	max
	)

Aggregates as many buffers as possible from bl in a new buffer of maximum length max_len .

All the aggregated buffers are removed from the list and replaced by the new one, followed by any additional (non-aggregated) data.

Parameters

bl	the list of buffer to aggregate
max	the maximum length of the aggregated buffer

Definition at line 1316 of file buffer.c.

References buffer_list_aggregate_separator().

Referenced by man_write(), and management_query_multiline_flatten().

◆ buffer_list_aggregate_separator()

void buffer_list_aggregate_separator	(	struct buffer_list *	bl,
		const size_t	max_len,
		const char *	sep
	)

Aggregates as many buffers as possible from bl in a new buffer of maximum length max_len .

sep is written after each copied buffer (also after the last one). All the aggregated buffers are removed from the list and replaced by the new one, followed by any additional (non-aggregated) data. Nothing happens if max_len is not enough to aggregate at least 2 buffers.

Parameters

bl	the list of buffer to aggregate
max_len	the maximum length of the aggregated buffer
sep	the separator to put between buffers during aggregation

Definition at line 1270 of file buffer.c.

References alloc_buf(), ALLOC_OBJ_CLEAR, BLEN, buffer_entry::buf, buf_copy(), buf_write(), http-client::f, free_buf(), buffer_list::head, buffer_entry::next, buffer_list::size, and buffer_list::tail.

Referenced by buffer_list_aggregate(), management_query_multiline_flatten_newline(), test_buffer_list_aggregate_separator_all(), test_buffer_list_aggregate_separator_empty(), test_buffer_list_aggregate_separator_emptybuffers(), test_buffer_list_aggregate_separator_noop(), test_buffer_list_aggregate_separator_nosep(), test_buffer_list_aggregate_separator_two(), and test_buffer_list_aggregate_separator_zerolen().

◆ buffer_list_defined()

bool buffer_list_defined ( const struct buffer_list * ol )

Checks if the list is valid and non-empty.

Parameters

ol	the list to check

Returns: true iff ol is not NULL and contains at least one buffer

Definition at line 1195 of file buffer.c.

References buffer_list::head.

Referenced by man_update_io_state(), management_query_multiline_flatten(), and management_query_multiline_flatten_newline().

◆ buffer_list_file()

struct buffer_list* buffer_list_file	(	const char *	fn,
		int	max_line_len
	)

Definition at line 1353 of file buffer.c.

References buffer_list_new(), buffer_list_push(), and platform_fopen().

Referenced by key_state_check_auth_pending_file().

◆ buffer_list_free()

void buffer_list_free ( struct buffer_list * ol )

Frees a buffer list and all the buffers in it.

Parameters

ol	the list to free

Definition at line 1185 of file buffer.c.

References buffer_list_reset().

Referenced by in_extra_dispatch(), in_extra_reset(), key_state_check_auth_pending_file(), key_state_free(), man_connection_close(), management_client_auth(), management_query_multiline_flatten(), management_query_multiline_flatten_newline(), set_cc_config(), and test_buffer_list_teardown().

◆ buffer_list_new()

struct buffer_list* buffer_list_new ( void )

Allocate an empty buffer list of capacity max_size.

Returns: the new list

Definition at line 1176 of file buffer.c.

References ALLOC_OBJ_CLEAR, and buffer_list::size.

Referenced by buffer_list_file(), in_extra_reset(), man_connection_init(), test_buffer_list_setup(), and tls_send_payload().

◆ buffer_list_peek()

struct buffer* buffer_list_peek ( struct buffer_list * ol )

Retrieve the head buffer.

Parameters

ol	the list to retrieve the buffer from

Returns: a pointer to the head buffer or NULL if the list is empty

Definition at line 1257 of file buffer.c.

References buffer_entry::buf, and buffer_list::head.

Referenced by flush_payload_buffer(), man_write(), management_query_multiline_flatten(), management_query_multiline_flatten_newline(), test_buffer_list_aggregate_separator_all(), test_buffer_list_aggregate_separator_emptybuffers(), test_buffer_list_aggregate_separator_noop(), test_buffer_list_aggregate_separator_nosep(), test_buffer_list_aggregate_separator_two(), and test_buffer_list_aggregate_separator_zerolen().

◆ buffer_list_pop()

void buffer_list_pop ( struct buffer_list * ol )

Definition at line 1322 of file buffer.c.

References buffer_entry::buf, free_buf(), buffer_list::head, buffer_entry::next, buffer_list::size, and buffer_list::tail.

Referenced by buffer_list_advance(), and flush_payload_buffer().

◆ buffer_list_push()

void buffer_list_push	(	struct buffer_list *	ol,
		const char *	str
	)

Allocates and appends a new buffer containing str as data to ol.

Parameters

ol	the list to append the new buffer to
str	the string to copy into the new buffer

Definition at line 1216 of file buffer.c.

References buffer_entry::buf, buffer_list_push_data(), and buffer::len.

Referenced by buffer_list_file(), man_output_list_push_str(), man_read(), and test_buffer_list_setup().

◆ buffer_list_push_data()

struct buffer_entry* buffer_list_push_data	(	struct buffer_list *	ol,
		const void *	data,
		size_t	size
	)

Allocates and appends a new buffer containing data of length size.

Parameters

ol	the list to append the new buffer to
data	the data to copy into the new buffer
size	the length of `data` to copy into the buffer

Returns: the new buffer

Definition at line 1230 of file buffer.c.

References alloc_buf(), ALLOC_OBJ_CLEAR, ASSERT, buffer_entry::buf, buffer::data, buffer_list::head, buffer::len, buffer_entry::next, buffer_list::size, and buffer_list::tail.

Referenced by buffer_list_push(), test_buffer_list_setup(), and tls_send_payload().

◆ buffer_list_reset()

void buffer_list_reset ( struct buffer_list * ol )

Empty the list ol and frees all the contained buffers.

Parameters

ol	the list to reset

Definition at line 1201 of file buffer.c.

References buffer_entry::buf, free_buf(), buffer_list::head, buffer_entry::next, buffer_list::size, and buffer_list::tail.

Referenced by buffer_list_free(), man_new_connection_post(), man_read(), and man_reset_client_socket().

◆ buffer_read_from_file()

struct buffer buffer_read_from_file	(	const char *	filename,
		struct gc_arena *	gc
	)

buffer_read_from_file - copy the content of a file into a buffer

Parameters

file	path to the file to read
gc	the garbage collector to use when allocating the buffer. It is passed to alloc_buf_gc() and therefore can be NULL.

Returns: the buffer storing the file content or an invalid buffer in case of error

Definition at line 1376 of file buffer.c.

References alloc_buf_gc(), ASSERT, BPTR, buf_inc_len(), buf_null_terminate(), cleanup(), free_buf_gc(), platform_fopen(), and platform_stat().

Referenced by connection_entry_preload_key(), crypto_pem_encode_certificate(), key_state_check_auth_failed_message_file(), read_key_file(), and read_pem_key_file().

◆ buffer_write_file()

bool buffer_write_file	(	const char *	filename,
		const struct buffer *	buf
	)

Write buffer contents to file.

Parameters

filename	The filename to write the buffer to.
buf	The buffer to write to the file.

Returns: true on success, false otherwise.

Definition at line 318 of file buffer.c.

References BLEN, BPTR, cleanup(), M_ERRNO, msg, platform_open(), and write.

Referenced by tls_crypt_v2_verify_metadata(), tls_crypt_v2_write_client_key_file(), write_key_file(), and write_pem_key_file().

◆ char_class()

bool char_class	(	const unsigned char	c,
		const unsigned int	flags
	)

Definition at line 895 of file buffer.c.

References CC_ALNUM, CC_ALPHA, CC_ANY, CC_ASCII, CC_ASTERISK, CC_AT, CC_BACKSLASH, CC_BLANK, CC_CNTRL, CC_COLON, CC_COMMA, CC_CR, CC_DASH, CC_DIGIT, CC_DOT, CC_DOUBLE_QUOTE, CC_EQUAL, CC_GREATER_THAN, CC_LESS_THAN, CC_NEWLINE, CC_NULL, CC_PIPE, CC_PRINT, CC_PUNCT, CC_QUESTION_MARK, CC_REVERSE_QUOTE, CC_SINGLE_QUOTE, CC_SLASH, CC_SPACE, CC_UNDERBAR, and CC_XDIGIT.

Referenced by buf_chomp(), char_inc_exc(), and command_line_add().

◆ char_inc_exc()

static bool char_inc_exc	(	const char	c,
		const unsigned int	inclusive,
		const unsigned int	exclusive
	)

inlinestatic

Definition at line 1034 of file buffer.c.

References char_class().

Referenced by string_check_buf(), string_class(), and string_mod().

◆ chomp()

void chomp ( char * str )

Definition at line 632 of file buffer.c.

References rm_trailing_chars().

Referenced by establish_http_proxy_passthru(), get_console_input(), get_console_input_win32(), get_proxy_authenticate(), get_user_pass_cr(), make_inline_array(), man_output_peer_info_env(), output_peer_info_env(), and status_printf().

◆ clone_buf()

struct buffer clone_buf ( const struct buffer * buf )

Definition at line 115 of file buffer.c.

References BLEN, BPTR, buffer::capacity, check_malloc_return(), buffer::data, buffer::len, and buffer::offset.

Referenced by mbuf_alloc_buf(), and tls_pre_decrypt_lite().

◆ convert_to_one_line()

void convert_to_one_line ( struct buffer * buf )

Definition at line 303 of file buffer.c.

References BLEN, BPTR, and buffer::len.

◆ format_hex_ex()

char* format_hex_ex	(	const uint8_t *	data,
		int	size,
		int	maxoutput,
		unsigned int	space_break_flags,
		const char *	separator,
		struct gc_arena *	gc
	)

Definition at line 501 of file buffer.c.

References alloc_buf_gc(), buf_catrunc(), buf_printf(), buffer::data, FHE_CAPS, FHE_SPACE_BREAK_MASK, and static_assert.

Referenced by backend_x509_get_serial_hex(), backend_x509_get_username(), export_user_keying_material(), format_hex(), hostname_randomize(), mroute_addr_print_ex(), print_default_gateway(), push_peer_info(), read_key_file(), show_adapter(), show_settings(), test_buffer_format_hex_ex(), verify_cert(), verify_cert_set_env(), write_key_file(), and x509_setenv_track().

◆ free_buf()

void free_buf ( struct buffer * buf )

Definition at line 183 of file buffer.c.

References CLEAR, and buffer::data.

Referenced by auth_token_init_secret(), buffer_list_aggregate_separator(), buffer_list_pop(), buffer_list_reset(), check_inline_file(), command_line_free(), do_close_free_key_schedule(), fragment_free(), fragment_list_buf_free(), free_context_buffers(), free_tas(), free_tls_pre_decrypt_state(), key_state_free(), link_socket_close(), management_query_cert(), management_query_pk_sig(), mbuf_free_buf(), mutate_ncp_cipher_list(), openvpn_PRF(), overlapped_io_close(), read_inline_file(), reliable_free(), send_line_crlf(), status_close(), stream_buf_close(), test_generate_reset_packet_plain(), test_parse_ack(), test_tls_crypt_teardown(), test_tls_decrypt_lite_auth(), test_tls_decrypt_lite_crypt(), test_tls_decrypt_lite_none(), test_verify_hmac_none(), test_verify_hmac_tls_auth(), tls_crypt_v2_write_client_key_file(), tls_wrap_free(), tun_show_debug(), and tuntap_dhcp_mask().

◆ free_buf_gc()

static void free_buf_gc	(	struct buffer *	buf,
		struct gc_arena *	gc
	)

static

Definition at line 190 of file buffer.c.

References CLEAR, buffer::data, gc_arena::list, and gc_entry::next.

Referenced by buffer_read_from_file(), test_buffer_free_gc_one(), and test_buffer_free_gc_two().

◆ gc_addspecial()

void gc_addspecial	(	void *	addr,
		void()(void )	free_function,
		struct gc_arena *	a
	)

Definition at line 456 of file buffer.c.

References gc_entry_special::addr, ASSERT, check_malloc_return(), gc_entry_special::free_fnc, gc_arena::list_special, and gc_entry_special::next.

Referenced by do_preresolve_host(), gc_realloc(), and init_route_list().

◆ gc_malloc()

void* gc_malloc	(	size_t	size,
		bool	clear,
		struct gc_arena *	a
	)

Definition at line 354 of file buffer.c.

References check_malloc_return(), gc_arena::list, and gc_entry::next.

Referenced by add_route_ipv6(), alloc_buf_gc(), append_cipher_to_ncp_list(), argv_prep_format(), argv_printf_arglist(), delete_route_ipv6(), ecdsa_sign_sig(), establish_http_proxy_passthru(), export_user_keying_material(), get_adapter_info_list(), get_device_instance_id_interface(), get_interface_info_list(), get_ipv6_addr_no_netbits(), get_panel_reg(), get_per_adapter_info(), get_user_pass_cr(), get_windows_routing_table(), options_string_extract_option(), options_warning_extract_parm1(), options_warning_safe_scan1(), options_warning_safe_scan2(), parse_auth_challenge(), parse_line(), plugin_vlog(), print_in6_addr(), print_in_addr_t(), route_ipv6_ipapi(), sanitize_control_message(), setenv_str_incr(), string_alloc(), string_substitute(), utf16to8(), wide_cmd_line(), wide_string(), x509_get_subject(), and x_msg_va().

◆ gc_realloc()

void* gc_realloc	(	void *	ptr,
		size_t	size,
		struct gc_arena *	a
	)

allows to realloc a pointer previously allocated by gc_malloc or gc_realloc

Note: only use this function on pointers returned by gc_malloc or re_alloc with the same gc_arena

Parameters

ptr	Pointer of the previously allocated memory
size	New size
a	gc_arena to use

Returns: new pointer

Definition at line 388 of file buffer.c.

References gc_entry_special::addr, ASSERT, check_malloc_return(), gc_addspecial(), gc_arena::list_special, and gc_entry_special::next.

Referenced by alloc_connection_entry(), alloc_remote_entry(), and test_buffer_gc_realloc().

◆ gc_transfer()

void gc_transfer	(	struct gc_arena *	dest,
		struct gc_arena *	src
	)

Definition at line 478 of file buffer.c.

References gc_arena::list, and gc_entry::next.

Referenced by add_option().

◆ np()

const char* np ( const char * str )

Definition at line 878 of file buffer.c.

◆ print_argv()

char* print_argv	(	const char **	p,
		struct gc_arena *	gc,
		const unsigned int	flags
	)

Definition at line 735 of file buffer.c.

References alloc_buf_gc(), BSTR, buf_printf(), and PA_BRACKET.

Referenced by argv_str(), plugin_open_item(), plugin_option_list_print(), and push_options().

◆ rm_trailing_chars()

void rm_trailing_chars	(	char *	str,
		const char *	what_to_delete
	)

Definition at line 641 of file buffer.c.

References buffer::len.

Referenced by chomp().

◆ skip_leading_whitespace()

const char* skip_leading_whitespace ( const char * str )

Definition at line 597 of file buffer.c.

Referenced by make_inline_array().

◆ string_alloc()

char* string_alloc	(	const char *	str,
		struct gc_arena *	gc
	)

Definition at line 667 of file buffer.c.

References check_malloc_return(), and gc_malloc().

Referenced by add_env_item(), argv_clone(), argv_insert_head(), argv_parse_cmd(), auth_set_client_reason(), backend_x509_get_serial(), ccs_gen_config_file(), ccs_gen_deferred_ret_file(), check_file_access(), check_inline_file(), cipher_kt_block_size(), clone_push_list(), do_close_tun(), do_init_route_ipv6_list(), extract_var_peer_info(), fork_to_self(), generate_auth_token(), get_device_instance_id_interface(), get_ipv6_addr_no_netbits(), get_p2p_ncp_cipher(), get_pa_var(), get_panel_reg(), get_proxy_authenticate(), get_tap_reg(), ifconfig_pool_acquire(), ifconfig_pool_set(), init_options_dev(), key_method_2_read(), key_state_gen_auth_control_files(), log_history_add(), make_arg_array(), make_base64_string2(), make_inline_array(), management_callback_proxy_cmd(), mutate_ncp_cipher_list(), ncp_get_best_cipher(), open_null(), open_syslog(), options_warning_extract_parm1(), parse_auth_challenge(), parse_auth_failed_temp(), parse_hash_fingerprint_multiline(), parse_http_proxy_override(), push_option_fmt(), read_inline_file(), set_common_name(), set_win_sys_path(), ssl_put_auth_challenge(), status_open(), string_alloc_buf(), string_mod_const(), test_cipher_names(), test_list(), tls_ctx_set_tls_groups(), tls_item_in_cipher_list(), tls_lock_common_name(), tls_lock_username(), tls_poor_mans_ncp(), and tun_open_device().

◆ string_alloc_buf()

struct buffer string_alloc_buf	(	const char *	str,
		struct gc_arena *	gc
	)

Definition at line 770 of file buffer.c.

References ASSERT, buf_set_read(), buffer::len, and string_alloc().

Referenced by options_warning_extract_parm1().

◆ string_array_len()

int string_array_len ( const char ** array )

Definition at line 721 of file buffer.c.

Referenced by make_arg_copy(), make_extended_arg_array(), no_more_than_n_args(), and openvpn_plugin_open_v3().

◆ string_check_buf()

bool string_check_buf	(	struct buffer *	buf,
		const unsigned int	inclusive,
		const unsigned int	exclusive
	)

Check a buffer if it only consists of allowed characters.

Parameters

buf	The buffer to be checked.
inclusive	The character classes that are allowed.
exclusive	Character classes that are not allowed even if they are also in inclusive.

Returns: True if the string consists only of allowed characters, false otherwise.

Definition at line 1091 of file buffer.c.

References ASSERT, BLEN, BSTR, and char_inc_exc().

Referenced by check_incoming_control_channel(), and test_character_string_mod_buf().

◆ string_class()

bool string_class	(	const char *	str,
		const unsigned int	inclusive,
		const unsigned int	exclusive
	)

Definition at line 1040 of file buffer.c.

References ASSERT, and char_inc_exc().

Referenced by dns_addr_safe(), openvpn_inet_aton(), push_option_ex(), and wide_cmd_line().

◆ string_clear()

void string_clear ( char * str )

Definition at line 709 of file buffer.c.

References secure_memzero().

Referenced by do_init_crypto_tls_c1(), get_user_pass_cr(), and openvpn_plugin_string_list_item_free().

◆ string_mod()

bool string_mod	(	char *	str,
		const unsigned int	inclusive,
		const unsigned int	exclusive,
		const char	replace
	)

Modifies a string in place by replacing certain classes of characters of it with a specified character.

Guaranteed to not increase the length of the string. If replace is 0, characters are skipped instead of replaced.

Parameters

str	The string to be modified.
inclusive	The character classes not to be replaced.
exclusive	Character classes to be replaced even if they are also in inclusive.
replace	The character to replace the specified character classes with.

Returns: True if the string was not modified, false otherwise.

Definition at line 1059 of file buffer.c.

References ASSERT, and char_inc_exc().

Referenced by do_setenv_x509(), get_user_pass_cr(), string_mod_const(), string_mod_remap_name(), test_character_class(), verify_user_pass(), wide_cmd_line(), and x509_setenv().

◆ string_mod_const()

const char* string_mod_const	(	const char *	str,
		const unsigned int	inclusive,
		const unsigned int	exclusive,
		const char	replace,
		struct gc_arena *	gc
	)

Returns a copy of a string with certain classes of characters of it replaced with a specified character.

If replace is 0, characters are skipped instead of replaced.

Parameters

str	The input string to be modified.
inclusive	Character classes not to be replaced.
exclusive	Character classes to be replaced even if they are also in inclusive.
replace	The character to replace the specified character classes with.
gc	The garbage collector arena to allocate memory from.

Returns: The modified string with characters replaced within the specified range.

Definition at line 1108 of file buffer.c.

References string_alloc(), and string_mod().

Referenced by platform_gen_path(), safe_print(), and setenv_str_ex().

◆ string_null_terminate()

void string_null_terminate	(	char *	str,
		int	len,
		int	capacity
	)

Definition at line 615 of file buffer.c.

References ASSERT, buffer::capacity, and buffer::len.

Referenced by get_console_input_win32().

◆ string_replace_leading()

void string_replace_leading	(	char *	str,
		const char	match,
		const char	replace
	)

Definition at line 1127 of file buffer.c.

References ASSERT.

Referenced by verify_cert().

◆ x_gc_free()

void x_gc_free ( struct gc_arena * a )

Definition at line 421 of file buffer.c.

References gc_arena::list, and gc_entry::next.

Referenced by gc_free().

◆ x_gc_freespecial()

void x_gc_freespecial ( struct gc_arena * a )

Definition at line 440 of file buffer.c.

References gc_entry_special::addr, gc_entry_special::free_fnc, gc_arena::list_special, and gc_entry_special::next.

Referenced by gc_free().

Macros

Functions

Macro Definition Documentation

◆ buf_debug_file

◆ buf_debug_line

Function Documentation

◆ alloc_buf()

◆ alloc_buf_gc()

◆ array_mult_safe()

◆ buf_assign()

◆ buf_catrunc()

◆ buf_chomp()

◆ buf_clear()

◆ buf_null_terminate()

◆ buf_parse()

◆ buf_printf()

◆ buf_puts()

◆ buf_rmtail()

◆ buf_size_error()

◆ buf_string_compare_advance()

◆ buf_string_match_head_str()

◆ buf_sub()

◆ buf_substring_len()

◆ buffer_list_advance()

◆ buffer_list_aggregate()

◆ buffer_list_aggregate_separator()

◆ buffer_list_defined()

◆ buffer_list_file()

◆ buffer_list_free()

◆ buffer_list_new()

◆ buffer_list_peek()

◆ buffer_list_pop()

◆ buffer_list_push()

◆ buffer_list_push_data()

◆ buffer_list_reset()

◆ buffer_read_from_file()

◆ buffer_write_file()

◆ char_class()

◆ char_inc_exc()

◆ chomp()

◆ clone_buf()

◆ convert_to_one_line()

◆ format_hex_ex()

◆ free_buf()

◆ free_buf_gc()

◆ gc_addspecial()

◆ gc_malloc()

◆ gc_realloc()

◆ gc_transfer()

◆ np()

◆ print_argv()

◆ rm_trailing_chars()

◆ skip_leading_whitespace()

◆ string_alloc()

◆ string_alloc_buf()

◆ string_array_len()

◆ string_check_buf()

◆ string_class()

◆ string_clear()

◆ string_mod()

◆ string_mod_const()

◆ string_null_terminate()

◆ string_replace_leading()

◆ x_gc_free()

◆ x_gc_freespecial()