#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)

bool	openvpn_snprintf (char str, size_t size, const char format,...)

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)

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

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_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_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 313 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 598 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 577 of file buffer.c.

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

Referenced by buf_chomp(), buffer_read_from_file(), check_incoming_control_channel(), 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 869 of file buffer.c.

References ASSERT, and buf_read_u8().

Referenced by apply_push_options(), get_auth_challenge(), 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_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 562 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 833 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 822 of file buffer.c.

References BPTR, and buffer::len.

Referenced by buf_string_compare_advance(), check_incoming_control_channel(), 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 847 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 1368 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 1345 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