#include <api_frame_helper_noise.h>

Inheritance diagram for esphome::api::APINoiseFrameHelper:

Public Member Functions
	APINoiseFrameHelper (std::unique_ptr< socket::Socket > socket, APINoiseContext &ctx)

	~APINoiseFrameHelper () override

APIError	init () override
	Initialize the frame helper, returns OK if successful.

APIError	loop () override
	Run through handshake messages (if in that phase)

APIError	read_packet (ReadPacketBuffer *buffer) override

APIError	write_protobuf_packet (uint8_t type, ProtoWriteBuffer buffer) override

APIError	write_protobuf_messages (ProtoWriteBuffer buffer, std::span< const MessageInfo > messages) override

Public Member Functions inherited from esphome::api::APIFrameHelper
	APIFrameHelper ()=default

	APIFrameHelper (std::unique_ptr< socket::Socket > socket)

const char *	get_client_name () const

const char *	get_peername_to (std::span< char, socket::SOCKADDR_STR_LEN > buf) const

void	set_client_name (const char *name, size_t len)

virtual	~APIFrameHelper ()=default

bool	can_write_without_blocking ()

int	getpeername (struct sockaddr addr, socklen_t addrlen)

APIError	close ()

APIError	shutdown (int how)

void	set_nodelay_for_message (bool is_log_message)

uint8_t	frame_header_padding () const

uint8_t	frame_header_size (uint16_t payload_size, uint8_t message_type) const

uint8_t	frame_footer_size () const

bool	is_socket_ready () const

void	release_buffers ()

Static Public Attributes
static constexpr uint8_t	HEADER_PADDING = 1 + 2 + 2 + 2

Protected Member Functions
APIError	state_action_ ()
	To be called from read/write methods.

APIError	state_action_client_hello_ ()

APIError	state_action_server_hello_ ()

APIError	state_action_handshake_ ()

APIError	state_action_handshake_read_ ()

APIError	state_action_handshake_write_ ()

APIError	try_read_frame_ ()
	Read a packet into the rx_buf_.

APIError	write_frame_ (const uint8_t *data, uint16_t len)

APIError	encrypt_noise_message_ (uint8_t *buf_start, uint16_t payload_size, uint8_t message_type, uint16_t &encrypted_len_out)

APIError	init_handshake_ ()
	Initiate the data structures for the handshake.

APIError	check_handshake_finished_ ()

void	send_explicit_handshake_reject_ (const LogString *reason)

APIError	handle_handshake_frame_error_ (APIError aerr)

APIError	handle_noise_error_ (int err, const LogString *func_name, APIError api_err)

Protected Member Functions inherited from esphome::api::APIFrameHelper
APIError	drain_overflow_and_handle_errors_ ()

ssize_t ESPHOME_ALWAYS_INLINE	write_iov_to_socket_ (const struct iovec *iov, int iovcnt)

APIError ESPHOME_ALWAYS_INLINE	write_raw_fast_buf_ (const void *data, uint16_t len)

APIError	write_raw_buf_ (const void *data, uint16_t len, ssize_t sent=WRITE_NOT_ATTEMPTED)

APIError	write_raw_iov_ (const struct iovec *iov, int iovcnt, uint16_t total_write_len, ssize_t sent=WRITE_NOT_ATTEMPTED)

void	log_packet_sending_ (const void *data, uint16_t len)

APIError ESPHOME_ALWAYS_INLINE	check_data_state_ () const

void	set_nodelay_raw_ (bool enable)

APIError	init_common_ ()

APIError	handle_socket_read_result_ (ssize_t received)

Protected Attributes
NoiseHandshakeState *	handshake_ {nullptr}

NoiseCipherState *	send_cipher_ {nullptr}

NoiseCipherState *	recv_cipher_ {nullptr}

APINoiseContext &	ctx_

APIBuffer	prologue_

NoiseProtocolId	nid_

uint8_t	rx_header_buf_ [3]

uint8_t	rx_header_buf_len_ = 0

Protected Attributes inherited from esphome::api::APIFrameHelper
std::unique_ptr< socket::Socket >	socket_

APIOverflowBuffer	overflow_buf_

APIBuffer	rx_buf_

char	client_name_ [CLIENT_INFO_NAME_MAX_LEN] {}

uint16_t	rx_buf_len_ = 0

State	state_ {State::INITIALIZE}

uint8_t	frame_header_padding_ {0}

uint8_t	frame_footer_size_ {0}

uint8_t	nodelay_counter_ {0}

Additional Inherited Members
Protected Types inherited from esphome::api::APIFrameHelper
enum class	State : uint8_t { INITIALIZE = 1 , CLIENT_HELLO = 2 , SERVER_HELLO = 3 , HANDSHAKE = 4 , DATA = 5 , CLOSED = 6 , FAILED = 7 , EXPLICIT_REJECT = 8 }

Static Protected Attributes inherited from esphome::api::APIFrameHelper
static constexpr ssize_t	WRITE_FAILED = -1

static constexpr ssize_t	WRITE_NOT_ATTEMPTED = -2

static constexpr uint8_t	LOG_NAGLE_COUNT = 2

Detailed Description

Definition at line 10 of file api_frame_helper_noise.h.

Constructor & Destructor Documentation

◆ APINoiseFrameHelper()

esphome::api::APINoiseFrameHelper::APINoiseFrameHelper	(	std::unique_ptr< socket::Socket >	socket,
		APINoiseContext &	ctx )

inline

Definition at line 19 of file api_frame_helper_noise.h.

◆ ~APINoiseFrameHelper()

esphome::api::APINoiseFrameHelper::~APINoiseFrameHelper ( )

override

Definition at line 629 of file api_frame_helper_noise.cpp.

Member Function Documentation

◆ check_handshake_finished_()

APIError esphome::api::APINoiseFrameHelper::check_handshake_finished_ ( )

protected

Definition at line 601 of file api_frame_helper_noise.cpp.

◆ encrypt_noise_message_()

APIError esphome::api::APINoiseFrameHelper::encrypt_noise_message_	(	uint8_t *	buf_start,
		uint16_t	payload_size,
		uint8_t	message_type,
		uint16_t &	encrypted_len_out )

protected

Definition at line 462 of file api_frame_helper_noise.cpp.

◆ handle_handshake_frame_error_()

APIError esphome::api::APINoiseFrameHelper::handle_handshake_frame_error_ ( APIError aerr )

protected

Definition at line 113 of file api_frame_helper_noise.cpp.

◆ handle_noise_error_()

APIError esphome::api::APINoiseFrameHelper::handle_noise_error_	(	int	err,
		const LogString *	func_name,
		APIError	api_err )

protected

Definition at line 123 of file api_frame_helper_noise.cpp.

◆ init()

APIError esphome::api::APINoiseFrameHelper::init ( )

overridevirtual

Initialize the frame helper, returns OK if successful.

Implements esphome::api::APIFrameHelper.

Definition at line 94 of file api_frame_helper_noise.cpp.

◆ init_handshake_()

APIError esphome::api::APINoiseFrameHelper::init_handshake_ ( )

protected

Initiate the data structures for the handshake.

Returns: 0 on success, -1 on error (check errno)

Definition at line 561 of file api_frame_helper_noise.cpp.

◆ loop()

APIError esphome::api::APINoiseFrameHelper::loop ( )

overridevirtual

Run through handshake messages (if in that phase)

Implements esphome::api::APIFrameHelper.

Definition at line 133 of file api_frame_helper_noise.cpp.

◆ read_packet()

APIError esphome::api::APINoiseFrameHelper::read_packet ( ReadPacketBuffer * buffer )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 409 of file api_frame_helper_noise.cpp.

◆ send_explicit_handshake_reject_()

void esphome::api::APINoiseFrameHelper::send_explicit_handshake_reject_ ( const LogString * reason )

protected

Definition at line 378 of file api_frame_helper_noise.cpp.

◆ state_action_()

APIError esphome::api::APINoiseFrameHelper::state_action_ ( )

protected

To be called from read/write methods.

This method runs through the internal handshake methods, if in that state.

If the handshake is still active when this method returns and a read/write can't take place at the moment, returns WOULD_BLOCK. If an error occurred, returns that error. Only returns OK if the transport is ready for data traffic.

Definition at line 244 of file api_frame_helper_noise.cpp.

◆ state_action_client_hello_()

APIError esphome::api::APINoiseFrameHelper::state_action_client_hello_ ( )

protected

Definition at line 262 of file api_frame_helper_noise.cpp.

◆ state_action_handshake_()

APIError esphome::api::APINoiseFrameHelper::state_action_handshake_ ( )

protected

Definition at line 319 of file api_frame_helper_noise.cpp.

◆ state_action_handshake_read_()

APIError esphome::api::APINoiseFrameHelper::state_action_handshake_read_ ( )

protected

Definition at line 331 of file api_frame_helper_noise.cpp.

◆ state_action_handshake_write_()

APIError esphome::api::APINoiseFrameHelper::state_action_handshake_write_ ( )

protected

Definition at line 360 of file api_frame_helper_noise.cpp.

◆ state_action_server_hello_()

APIError esphome::api::APINoiseFrameHelper::state_action_server_hello_ ( )

protected

Definition at line 282 of file api_frame_helper_noise.cpp.

◆ try_read_frame_()

APIError esphome::api::APINoiseFrameHelper::try_read_frame_ ( )

protected

Read a packet into the rx_buf_.

Returns: APIError::OK if a full packet is in rx_buf_

errno EWOULDBLOCK: Packet could not be read without blocking. Try again later. errno ENOMEM: Not enough memory for reading packet. errno API_ERROR_BAD_INDICATOR: Bad indicator byte at start of frame. errno API_ERROR_HANDSHAKE_PACKET_LEN: Packet too big for this phase.

Definition at line 164 of file api_frame_helper_noise.cpp.

◆ write_frame_()

APIError esphome::api::APINoiseFrameHelper::write_frame_	(	const uint8_t *	data,
		uint16_t	len )

protected

Definition at line 539 of file api_frame_helper_noise.cpp.

◆ write_protobuf_messages()

APIError esphome::api::APINoiseFrameHelper::write_protobuf_messages	(	ProtoWriteBuffer	buffer,
		std::span< const MessageInfo >	messages )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 514 of file api_frame_helper_noise.cpp.

◆ write_protobuf_packet()

APIError esphome::api::APINoiseFrameHelper::write_protobuf_packet	(	uint8_t	type,
		ProtoWriteBuffer	buffer )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 495 of file api_frame_helper_noise.cpp.

Field Documentation

◆ ctx_

APINoiseContext& esphome::api::APINoiseFrameHelper::ctx_

protected

Definition at line 53 of file api_frame_helper_noise.h.

◆ handshake_

NoiseHandshakeState* esphome::api::APINoiseFrameHelper::handshake_ {nullptr}

protected

Definition at line 48 of file api_frame_helper_noise.h.

◆ HEADER_PADDING

uint8_t esphome::api::APINoiseFrameHelper::HEADER_PADDING = 1 + 2 + 2 + 2

staticconstexpr

Definition at line 17 of file api_frame_helper_noise.h.

◆ nid_

NoiseProtocolId esphome::api::APINoiseFrameHelper::nid_

protected

Definition at line 59 of file api_frame_helper_noise.h.

◆ prologue_

APIBuffer esphome::api::APINoiseFrameHelper::prologue_

protected

Definition at line 56 of file api_frame_helper_noise.h.

◆ recv_cipher_

NoiseCipherState* esphome::api::APINoiseFrameHelper::recv_cipher_ {nullptr}

protected

Definition at line 50 of file api_frame_helper_noise.h.

◆ rx_header_buf_

uint8_t esphome::api::APINoiseFrameHelper::rx_header_buf_[3]

protected

Definition at line 65 of file api_frame_helper_noise.h.

◆ rx_header_buf_len_

uint8_t esphome::api::APINoiseFrameHelper::rx_header_buf_len_ = 0

protected

Definition at line 66 of file api_frame_helper_noise.h.

◆ send_cipher_

NoiseCipherState* esphome::api::APINoiseFrameHelper::send_cipher_ {nullptr}

protected

Definition at line 49 of file api_frame_helper_noise.h.

The documentation for this class was generated from the following files:

esphome/components/api/api_frame_helper_noise.h
esphome/components/api/api_frame_helper_noise.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ APINoiseFrameHelper()

◆ ~APINoiseFrameHelper()

Member Function Documentation

◆ check_handshake_finished_()

◆ encrypt_noise_message_()

◆ handle_handshake_frame_error_()

◆ handle_noise_error_()

◆ init()

◆ init_handshake_()

◆ loop()

◆ read_packet()

◆ send_explicit_handshake_reject_()

◆ state_action_()

◆ state_action_client_hello_()

◆ state_action_handshake_()

◆ state_action_handshake_read_()

◆ state_action_handshake_write_()

◆ state_action_server_hello_()

◆ try_read_frame_()

◆ write_frame_()

◆ write_protobuf_messages()

◆ write_protobuf_packet()

Field Documentation

◆ ctx_

◆ handshake_

◆ HEADER_PADDING

◆ nid_

◆ prologue_

◆ recv_cipher_

◆ rx_header_buf_

◆ rx_header_buf_len_

◆ send_cipher_