ssh_extensions.h File Reference

SSH extension negotiation. More...

#include "ssh/ssh.h"

Go to the source code of this file.

Macros
#define	SSH_MSG_EXT_INFO_MIN_SIZE   5

Functions
error_t	sshSendExtInfo (SshConnection *connection)
	Send SSH_MSG_EXT_INFO message. More...
error_t	sshFormatExtInfo (SshConnection *connection, uint8_t *message, size_t *length)
	Format SSH_MSG_EXT_INFO message. More...
error_t	sshFormatServerSigAlgsExt (SshConnection *connection, uint8_t *p, size_t *written)
	Format "server-sig-algs" extension. More...
error_t	sshFormatGlobalRequestsOkExt (SshConnection *connection, uint8_t *p, size_t *written)
	Format "global-requests-ok" extension. More...
error_t	sshParseExtInfo (SshConnection *connection, const uint8_t *message, size_t length)
	Parse SSH_MSG_EXT_INFO message. More...
error_t	sshParseServerSigAlgsExt (SshConnection *connection, const char_t *p, size_t length)
	Parse "server-sig-algs" extension. More...
error_t	sshParseGlobalRequestsOkExt (SshConnection *connection, const char_t *p, size_t length)
	Parse "global-requests-ok" extension. More...

Detailed Description

SSH extension negotiation.

License

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

Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.

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_extensions.h.

Macro Definition Documentation

SSH_MSG_EXT_INFO_MIN_SIZE

#define SSH_MSG_EXT_INFO_MIN_SIZE   5

Definition at line 38 of file ssh_extensions.h.

Function Documentation

sshFormatExtInfo()

error_t sshFormatExtInfo	(	SshConnection *	connection,
		uint8_t *	message,
		size_t *	length
	)

Format SSH_MSG_EXT_INFO message.

Parameters

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

Returns

Error code

Definition at line 127 of file ssh_extensions.c.

sshFormatGlobalRequestsOkExt()

error_t sshFormatGlobalRequestsOkExt	(	SshConnection *	connection,
		uint8_t *	p,
		size_t *	written
	)

Format "global-requests-ok" extension.

Parameters

[in]	connection	Pointer to the SSH connection
[out]	p	Output stream where to write the extension
[out]	written	Total number of bytes that have been written

Returns

Error code

Definition at line 255 of file ssh_extensions.c.

sshFormatServerSigAlgsExt()

error_t sshFormatServerSigAlgsExt	(	SshConnection *	connection,
		uint8_t *	p,
		size_t *	written
	)

Format "server-sig-algs" extension.

Parameters

[in]	connection	Pointer to the SSH connection
[out]	p	Output stream where to write the extension
[out]	written	Total number of bytes that have been written

Returns

Error code

Definition at line 208 of file ssh_extensions.c.

sshParseExtInfo()

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

Parse SSH_MSG_EXT_INFO 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 296 of file ssh_extensions.c.

sshParseGlobalRequestsOkExt()

error_t sshParseGlobalRequestsOkExt	(	SshConnection *	connection,
		const char_t *	p,
		size_t	length
	)

Parse "global-requests-ok" extension.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	p	Pointer to extension value
[in]	length	Length of the extension value, in bytes

Returns

Error code

Definition at line 514 of file ssh_extensions.c.

sshParseServerSigAlgsExt()

error_t sshParseServerSigAlgsExt	(	SshConnection *	connection,
		const char_t *	p,
		size_t	length
	)

Parse "server-sig-algs" extension.

Parameters

[in]	connection	Pointer to the SSH connection
[in]	p	Pointer to extension value
[in]	length	Length of the extension value, in bytes

Returns

Error code

Definition at line 450 of file ssh_extensions.c.

sshSendExtInfo()

error_t sshSendExtInfo

(

SshConnection *

connection

)

Send SSH_MSG_EXT_INFO message.

Parameters

[in]

connection

Pointer to the SSH connection

Returns

Error code

Definition at line 53 of file ssh_extensions.c.