SSH transport layer protocol. More...

#include "ssh/ssh.h"

Functions
error_t	sshSendIdString (SshConnection *connection)
	Send identification string. More...

error_t	sshSendServiceRequest (SshConnection *connection)
	Send SSH_MSG_SERVICE_REQUEST message. More...

error_t	sshSendServiceAccept (SshConnection connection, const char_t serviceName)
	Send SSH_MSG_SERVICE_ACCEPT message. More...

error_t	sshSendDisconnect (SshConnection connection, uint32_t reasonCode, const char_t description)
	Send SSH_MSG_DISCONNECT message. More...

error_t	sshSendUnimplemented (SshConnection connection, const uint8_t packetSeqNum)
	Send SSH_MSG_UNIMPLEMENTED message. More...

error_t	sshFormatServiceRequest (SshConnection connection, uint8_t p, size_t *length)
	Format SSH_MSG_SERVICE_REQUEST message. More...

error_t	sshFormatServiceAccept (SshConnection connection, const char_t serviceName, uint8_t p, size_t length)
	Format SSH_MSG_SERVICE_ACCEPT message. More...

error_t	sshFormatDisconnect (SshConnection connection, uint32_t reasonCode, const char_t description, uint8_t p, size_t length)
	Format SSH_MSG_DISCONNECT message. More...

error_t	sshFormatUnimplemented (SshConnection connection, const uint8_t packetSeqNum, uint8_t p, size_t length)
	Format SSH_MSG_UNIMPLEMENTED message. More...

error_t	sshParseIdString (SshConnection connection, const uint8_t id, size_t length)
	Parse identification string. More...

error_t	sshParseServiceRequest (SshConnection connection, const uint8_t message, size_t length)
	Parse SSH_MSG_SERVICE_REQUEST message. More...

error_t	sshParseServiceAccept (SshConnection connection, const uint8_t message, size_t length)
	Parse SSH_MSG_SERVICE_ACCEPT message. More...

error_t	sshParseIgnore (SshConnection connection, const uint8_t message, size_t length)
	Parse SSH_MSG_IGNORE message. More...

error_t	sshParseDebug (SshConnection connection, const uint8_t message, size_t length)
	Parse SSH_MSG_DEBUG message. More...

error_t	sshParseDisconnect (SshConnection connection, const uint8_t message, size_t length)
	Parse SSH_MSG_DISCONNECT message. More...

error_t	sshParseUnimplemented (SshConnection connection, const uint8_t message, size_t length)
	Parse SSH_MSG_UNIMPLEMENTED message. More...

error_t	sshParseUnrecognized (SshConnection connection, const uint8_t message, size_t length)
	Parse unrecognized message. More...

Detailed Description

SSH transport layer protocol.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneSSH Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file ssh_transport.h.

Function Documentation

◆ sshFormatDisconnect()

error_t sshFormatDisconnect	(	SshConnection *	connection,
		uint32_t	reasonCode,
		const char_t *	description,
		uint8_t *	p,
		size_t *	length
	)

Format SSH_MSG_DISCONNECT message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	reasonCode	Reason in a machine-readable format
[in]	description	Specific explanation in a human-readable form
[out]	p	Buffer where to format the message
[out]	length	Length of the resulting message, in bytes

Returns: Error code

Definition at line 372 of file ssh_transport.c.

◆ sshFormatServiceAccept()

error_t sshFormatServiceAccept	(	SshConnection *	connection,
		const char_t *	serviceName,
		uint8_t *	p,
		size_t *	length
	)

Format SSH_MSG_SERVICE_ACCEPT message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	serviceName	NULL-terminating string that contains the service name
[out]	p	Buffer where to format the message
[out]	length	Length of the resulting message, in bytes

Returns: Error code

Definition at line 332 of file ssh_transport.c.

◆ sshFormatServiceRequest()

error_t sshFormatServiceRequest	(	SshConnection *	connection,
		uint8_t *	p,
		size_t *	length
	)

Format SSH_MSG_SERVICE_REQUEST message.

Parameters

[in]	connection	Pointer to the SSH connection
[out]	p	Buffer where to format the message
[out]	length	Length of the resulting message, in bytes

Returns: Error code

Definition at line 293 of file ssh_transport.c.

◆ sshFormatUnimplemented()

error_t sshFormatUnimplemented	(	SshConnection *	connection,
		const uint8_t *	packetSeqNum,
		uint8_t *	p,
		size_t *	length
	)

Format SSH_MSG_UNIMPLEMENTED message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	packetSeqNum	Packet sequence number of rejected message
[out]	p	Buffer where to format the message
[out]	length	Length of the resulting message, in bytes

Returns: Error code

Definition at line 428 of file ssh_transport.c.

◆ sshParseDebug()

error_t sshParseDebug	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse SSH_MSG_DEBUG message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 754 of file ssh_transport.c.

◆ sshParseDisconnect()

error_t sshParseDisconnect	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse SSH_MSG_DISCONNECT message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 838 of file ssh_transport.c.

◆ sshParseIdString()

error_t sshParseIdString	(	SshConnection *	connection,
		const uint8_t *	id,
		size_t	length
	)

Parse identification string.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	id	Pointer to the identification string
[in]	length	Length of the identification string

Returns: Error code

Definition at line 460 of file ssh_transport.c.

◆ sshParseIgnore()

error_t sshParseIgnore	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse SSH_MSG_IGNORE message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 695 of file ssh_transport.c.

◆ sshParseServiceAccept()

error_t sshParseServiceAccept	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse SSH_MSG_SERVICE_ACCEPT message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 624 of file ssh_transport.c.

◆ sshParseServiceRequest()

error_t sshParseServiceRequest	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse SSH_MSG_SERVICE_REQUEST message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 546 of file ssh_transport.c.

◆ sshParseUnimplemented()

error_t sshParseUnimplemented	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse SSH_MSG_UNIMPLEMENTED message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 916 of file ssh_transport.c.

◆ sshParseUnrecognized()

error_t sshParseUnrecognized	(	SshConnection *	connection,
		const uint8_t *	message,
		size_t	length
	)

Parse unrecognized message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	message	Pointer to message
[in]	length	Length of the message, in bytes

Returns: Error code

Definition at line 957 of file ssh_transport.c.

◆ sshSendDisconnect()

error_t sshSendDisconnect	(	SshConnection *	connection,
		uint32_t	reasonCode,
		const char_t *	description
	)

Send SSH_MSG_DISCONNECT message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	reasonCode	Reason in a machine-readable format
[in]	description	Specific explanation in a human-readable form

Returns: Error code

Definition at line 209 of file ssh_transport.c.

◆ sshSendIdString()

error_t sshSendIdString ( SshConnection * connection )

Send identification string.

Parameters

[in] connection Pointer to the SSH connection

Returns: Error code

Definition at line 51 of file ssh_transport.c.

◆ sshSendServiceAccept()

error_t sshSendServiceAccept	(	SshConnection *	connection,
		const char_t *	serviceName
	)

Send SSH_MSG_SERVICE_ACCEPT message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	serviceName	NULL-terminating string that contains the service name

Returns: Error code

Definition at line 164 of file ssh_transport.c.

◆ sshSendServiceRequest()

error_t sshSendServiceRequest ( SshConnection * connection )

Send SSH_MSG_SERVICE_REQUEST message.

Parameters

[in] connection Pointer to the SSH connection

Returns: Error code

Definition at line 115 of file ssh_transport.c.

◆ sshSendUnimplemented()

error_t sshSendUnimplemented	(	SshConnection *	connection,
		const uint8_t *	packetSeqNum
	)

Send SSH_MSG_UNIMPLEMENTED message.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	packetSeqNum	Packet sequence number of rejected message

Returns: Error code

Definition at line 256 of file ssh_transport.c.

Functions

Detailed Description

License

Function Documentation

◆ sshFormatDisconnect()

◆ sshFormatServiceAccept()

◆ sshFormatServiceRequest()

◆ sshFormatUnimplemented()

◆ sshParseDebug()

◆ sshParseDisconnect()

◆ sshParseIdString()

◆ sshParseIgnore()

◆ sshParseServiceAccept()

◆ sshParseServiceRequest()

◆ sshParseUnimplemented()

◆ sshParseUnrecognized()

◆ sshSendDisconnect()

◆ sshSendIdString()

◆ sshSendServiceAccept()

◆ sshSendServiceRequest()

◆ sshSendUnimplemented()