#include "syshead.h"
#include <stddef.h>
#include "packet_id.h"
#include "misc.h"
#include "integer.h"
#include "memdbg.h"

Include dependency graph for packet_id.c:

Macros
#define	SEQ_UNSEEN ((time_t)0)

#define	SEQ_EXPIRED ((time_t)1)

Functions
static void	packet_id_debug (int msglevel, const struct packet_id_rec p, const struct packet_id_net pin, const char *message, uint64_t value)

static void	packet_id_init_recv (struct packet_id_rec rec, int seq_backtrack, int time_backtrack, const char name, int unit)

void	packet_id_init (struct packet_id p, int seq_backtrack, int time_backtrack, const char name, int unit)

void	packet_id_move_recv (struct packet_id_rec dest, struct packet_id_rec src)
	Move the packet id recv structure from `src` to `dest`.

void	packet_id_free (struct packet_id *p)

void	packet_id_add (struct packet_id_rec p, const struct packet_id_net pin)

void	packet_id_reap (struct packet_id_rec *p)

bool	packet_id_test (struct packet_id_rec p, const struct packet_id_net pin)

bool	packet_id_read (struct packet_id_net pin, struct buffer buf, bool long_form)

static bool	packet_id_send_update (struct packet_id_send *p, bool long_form)

static bool	packet_id_send_update_epoch (struct packet_id_send *p)

bool	packet_id_write (struct packet_id_send p, struct buffer buf, bool long_form, bool prepend)
	Write a packet ID to buf, and update the packet ID state.

const char *	packet_id_net_print (const struct packet_id_net pin, bool print_timestamp, struct gc_arena gc)

void	packet_id_persist_init (struct packet_id_persist *p)

void	packet_id_persist_close (struct packet_id_persist *p)

void	packet_id_persist_load (struct packet_id_persist p, const char filename)

void	packet_id_persist_save (struct packet_id_persist *p)

void	packet_id_persist_load_obj (const struct packet_id_persist p, struct packet_id pid)

const char *	packet_id_persist_print (const struct packet_id_persist p, struct gc_arena gc)

uint16_t	packet_id_read_epoch (struct packet_id_net pin, struct buffer buf)
	Reads the packet ID containing both the epoch and the per-epoch counter from the buf.

bool	packet_id_write_epoch (struct packet_id_send p, uint16_t epoch, struct buffer buf)
	Writes the packet ID containing both the epoch and the packet id to the buffer specified by buf.

Macro Definition Documentation

◆ SEQ_EXPIRED

#define SEQ_EXPIRED ((time_t)1)

Definition at line 54 of file packet_id.c.

◆ SEQ_UNSEEN

#define SEQ_UNSEEN ((time_t)0)

Definition at line 53 of file packet_id.c.

Function Documentation

◆ packet_id_add()

void packet_id_add	(	struct packet_id_rec *	p,
		const struct packet_id_net *	pin
	)

Definition at line 138 of file packet_id.c.

References CIRC_LIST_ITEM, CIRC_LIST_PUSH, CIRC_LIST_RESET, CIRC_LIST_SIZE, get_random(), packet_id_rec::id, packet_id_net::id, now, packet_id_rec::seq_backtrack, SEQ_EXPIRED, packet_id_rec::seq_list, SEQ_UNSEEN, packet_id_rec::time, and packet_id_net::time.

Referenced by crypto_check_replay().

◆ packet_id_debug()

static void packet_id_debug	(	int	msglevel,
		const struct packet_id_rec *	p,
		const struct packet_id_net *	pin,
		const char *	message,
		uint64_t	value
	)

inlinestatic

Definition at line 66 of file packet_id.c.

References check_debug_level(), and unlikely.

Referenced by packet_id_test().

◆ packet_id_free()

void packet_id_free ( struct packet_id * p )

Definition at line 127 of file packet_id.c.

References CLEAR, D_PID_DEBUG, dmsg, packet_id::rec, and packet_id_rec::seq_list.

Referenced by do_close_packet_id(), key_state_free(), test_crypto_thread(), test_generate_reset_packet_tls_auth(), tls_auth_standalone_free(), tls_wrap_free(), and uninit_crypto_options().

◆ packet_id_init()

void packet_id_init	(	struct packet_id *	p,
		int	seq_backtrack,
		int	time_backtrack,
		const char *	name,
		int	unit
	)

Definition at line 96 of file packet_id.c.

References ASSERT, CLEAR, D_PID_DEBUG, dmsg, packet_id_init_recv(), and packet_id::rec.

Referenced by do_init_crypto_static(), init_crypto_options(), key_state_init(), test_generate_reset_packet_tls_auth(), test_tls_crypt_setup(), tls_auth_standalone_init(), tls_session_generate_dynamic_tls_crypt_key(), and tls_session_init().

◆ packet_id_init_recv()

static void packet_id_init_recv	(	struct packet_id_rec *	rec,
		int	seq_backtrack,
		int	time_backtrack,
		const char *	name,
		int	unit
	)

static

Definition at line 81 of file packet_id.c.

References ASSERT, CIRC_LIST_ALLOC, packet_id_rec::initialized, MAX_SEQ_BACKTRACK, MAX_TIME_BACKTRACK, MIN_SEQ_BACKTRACK, MIN_TIME_BACKTRACK, packet_id_rec::name, packet_id_rec::seq_backtrack, packet_id_rec::seq_list, packet_id_rec::time_backtrack, and packet_id_rec::unit.

Referenced by packet_id_init(), and packet_id_move_recv().

◆ packet_id_move_recv()

void packet_id_move_recv	(	struct packet_id_rec *	dest,
		struct packet_id_rec *	src
	)

Move the packet id recv structure from src to dest.

src will be reinitialised. dest will be freed before the move.

Definition at line 109 of file packet_id.c.

References ASSERT, CLEAR, packet_id_rec::name, packet_id_init_recv(), packet_id_rec::seq_backtrack, packet_id_rec::seq_list, packet_id_rec::time_backtrack, and packet_id_rec::unit.

Referenced by epoch_replace_update_recv_key().

◆ packet_id_net_print()

const char * packet_id_net_print	(	const struct packet_id_net *	pin,
		bool	print_timestamp,
		struct gc_arena *	gc
	)

Definition at line 428 of file packet_id.c.

References alloc_buf_gc(), BSTR, buf_printf(), gc, buffer::len, packet_id_format, and time_string().

Referenced by crypto_check_replay(), and protocol_dump().

◆ packet_id_persist_close()

void packet_id_persist_close ( struct packet_id_persist * p )

Definition at line 456 of file packet_id.c.

References D_PID_PERSIST, buffer::len, M_ERRNO, msg, packet_id_persist_enabled(), and packet_id_persist_init().

Referenced by do_close_packet_id().

◆ packet_id_persist_init()

void packet_id_persist_init ( struct packet_id_persist * p )

Definition at line 446 of file packet_id.c.

References buffer::len.

Referenced by packet_id_persist_close().

◆ packet_id_persist_load()

void packet_id_persist_load	(	struct packet_id_persist *	p,
		const char *	filename
	)

Definition at line 470 of file packet_id.c.

References D_PID_PERSIST, D_PID_PERSIST_DEBUG, dmsg, packet_id_persist::fd, packet_id_persist::filename, gc, gc_free(), gc_new(), packet_id_persist::id, packet_id_persist_file_image::id, packet_id_persist::id_last_written, M_ERR, M_ERRNO, msg, O_BINARY, packet_id_persist_enabled(), packet_id_persist_print(), platform_open(), read, packet_id_persist::time, packet_id_persist_file_image::time, and packet_id_persist::time_last_written.

Referenced by init_crypto_pre().

◆ packet_id_persist_load_obj()

void packet_id_persist_load_obj	(	const struct packet_id_persist *	p,
		struct packet_id *	pid
	)

Definition at line 561 of file packet_id.c.

References packet_id_rec::id, packet_id_persist::id, packet_id_persist_enabled(), packet_id::rec, packet_id_rec::time, and packet_id_persist::time.

Referenced by do_init_crypto_static(), and tls_session_init().

◆ packet_id_persist_print()

const char * packet_id_persist_print	(	const struct packet_id_persist *	p,
		struct gc_arena *	gc
	)

Definition at line 571 of file packet_id.c.

References alloc_buf_gc(), buf_printf(), buffer::data, gc, buffer::len, packet_id_format, packet_id_persist_enabled(), and time_string().

Referenced by packet_id_persist_load(), and packet_id_persist_save().

◆ packet_id_persist_save()

void packet_id_persist_save ( struct packet_id_persist * p )

Definition at line 519 of file packet_id.c.

References D_PID_PERSIST, D_PID_PERSIST_DEBUG, dmsg, packet_id_persist::fd, packet_id_persist::filename, gc, gc_free(), gc_new(), packet_id_persist::id, packet_id_persist_file_image::id, packet_id_persist::id_last_written, M_ERRNO, msg, packet_id_persist_enabled(), packet_id_persist_print(), packet_id_persist::time, packet_id_persist_file_image::time, packet_id_persist::time_last_written, and write.

Referenced by do_close_packet_id(), and process_coarse_timers().

◆ packet_id_read()

bool packet_id_read	(	struct packet_id_net *	pin,
		struct buffer *	buf,
		bool	long_form
	)

Definition at line 323 of file packet_id.c.

References buf_read(), packet_id_net::id, ntohpid, ntohtime, and packet_id_net::time.

Referenced by do_pre_decrypt_check(), openvpn_decrypt_aead(), openvpn_decrypt_v1(), protocol_dump(), and tls_crypt_unwrap().

◆ packet_id_read_epoch()

uint16_t packet_id_read_epoch	(	struct packet_id_net *	p,
		struct buffer *	buf
	)

Reads the packet ID containing both the epoch and the per-epoch counter from the buf.

Will return 0 as epoch id if there is any error.

Parameters

p	packet_id struct to populate with the on-wire counter
buf	buffer to read the packet id from.

Returns: 0 for an error/invalid id, epoch otherwise

Definition at line 679 of file packet_id.c.

References buf_read(), packet_id_net::id, ntohll, and PACKET_ID_MASK.

Referenced by openvpn_decrypt_aead(), and test_packet_id_write_epoch().

◆ packet_id_reap()

void packet_id_reap ( struct packet_id_rec * p )

Definition at line 193 of file packet_id.c.

References CIRC_LIST_ITEM, CIRC_LIST_SIZE, packet_id_rec::last_reap, now, SEQ_EXPIRED, packet_id_rec::seq_list, and packet_id_rec::time_backtrack.

Referenced by packet_id_reap_test().

◆ packet_id_send_update()

static bool packet_id_send_update	(	struct packet_id_send *	p,
		bool	long_form
	)

static

Definition at line 348 of file packet_id.c.

References packet_id_send::id, now, PACKET_ID_MAX, and packet_id_send::time.

Referenced by packet_id_write().

◆ packet_id_send_update_epoch()

static bool packet_id_send_update_epoch ( struct packet_id_send * p )

static

Definition at line 371 of file packet_id.c.

References packet_id_send::id, now, PACKET_ID_EPOCH_MAX, and packet_id_send::time.

Referenced by packet_id_write_epoch().

◆ packet_id_test()

bool packet_id_test	(	struct packet_id_rec *	p,
		const struct packet_id_net *	pin
	)

Definition at line 224 of file packet_id.c.

References ASSERT, CIRC_LIST_ITEM, CIRC_LIST_SIZE, D_PID_DEBUG, D_PID_DEBUG_LOW, D_PID_DEBUG_MEDIUM, packet_id_rec::id, packet_id_net::id, packet_id_rec::initialized, packet_id_rec::max_backtrack_stat, packet_id_debug(), packet_id_rec::seq_backtrack, packet_id_rec::seq_list, packet_id_rec::time, and packet_id_net::time.

Referenced by crypto_check_replay().

◆ packet_id_write()

bool packet_id_write	(	struct packet_id_send *	p,
		struct buffer *	buf,
		bool	long_form,
		bool	prepend
	)

Write a packet ID to buf, and update the packet ID state.

Parameters

p	Packet ID state.
buf	Buffer to write the packet ID too
long_form	If true, also update and write time_t to buf
prepend	If true, prepend to buffer, otherwise append.

Returns: true if successful, false otherwise.

Definition at line 386 of file packet_id.c.

References buf_write(), buf_write_prepend(), htonpid, htontime, packet_id_send::id, packet_id_send_update(), and packet_id_send::time.

Referenced by openvpn_encrypt_aead(), openvpn_encrypt_v1(), test_packet_id_write_long(), test_packet_id_write_long_prepend(), test_packet_id_write_long_wrap(), test_packet_id_write_short(), test_packet_id_write_short_prepend(), test_packet_id_write_short_wrap(), and tls_crypt_wrap().

◆ packet_id_write_epoch()

bool packet_id_write_epoch	(	struct packet_id_send *	p,
		uint16_t	epoch,
		struct buffer *	buf
	)

Writes the packet ID containing both the epoch and the packet id to the buffer specified by buf.

Parameters

p	packet id send structure to use for the packet id
epoch	epoch to write to the packet
buf	buffer to write the packet id/epoch to

Returns: false if the packet id space is exhausted and cannot be written

Definition at line 698 of file packet_id.c.

References buf_write(), htonll, packet_id_send::id, and packet_id_send_update_epoch().

Referenced by openvpn_encrypt_aead(), and test_packet_id_write_epoch().

Macros

Functions

Macro Definition Documentation

◆ SEQ_EXPIRED

◆ SEQ_UNSEEN

Function Documentation

◆ packet_id_add()

◆ packet_id_debug()

◆ packet_id_free()

◆ packet_id_init()

◆ packet_id_init_recv()

◆ packet_id_move_recv()

◆ packet_id_net_print()

◆ packet_id_persist_close()

◆ packet_id_persist_init()

◆ packet_id_persist_load()

◆ packet_id_persist_load_obj()

◆ packet_id_persist_print()

◆ packet_id_persist_save()

◆ packet_id_read()

◆ packet_id_read_epoch()

◆ packet_id_reap()

◆ packet_id_send_update()

◆ packet_id_send_update_epoch()

◆ packet_id_test()

◆ packet_id_write()

◆ packet_id_write_epoch()