ssh_exchange_hash.h
Go to the documentation of this file.
1 /**
2  * @file ssh_exchange_hash.h
3  * @brief Exchange hash calculation
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneSSH Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _SSH_EXCHANGE_HASH_H
32 #define _SSH_EXCHANGE_HASH_H
33 
34 //Dependencies
35 #include "ssh/ssh.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //SSH related functions
44 
45 error_t sshUpdateExchangeHash(SshConnection *connection, const void *data,
46  size_t length);
47 
48 error_t sshFinalizeExchangeHash(SshConnection *connection, uint8_t *digest,
49  size_t *digestLen);
50 
51 error_t sshUpdateExchangeHashRaw(SshConnection *connection, const void *data,
52  size_t length);
53 
55  uint8_t *p, size_t *written);
56 
58  const SshBinaryString *serverHostKey, const SshBinaryString *signature);
59 
60 //C++ guard
61 #ifdef __cplusplus
62 }
63 #endif
64 
65 #endif
error_t
Error codes.
Definition: error.h:43
uint8_t data[]
Definition: ethernet.h:222
uint8_t p
Definition: ndp.h:300
Secure Shell (SSH)
#define SshConnection
Definition: ssh.h:883
error_t sshInitExchangeHash(SshConnection *connection)
Initialize exchange hash.
error_t sshUpdateExchangeHash(SshConnection *connection, const void *data, size_t length)
Update exchange hash calculation.
error_t sshFinalizeExchangeHash(SshConnection *connection, uint8_t *digest, size_t *digestLen)
Finalize exchange hash calculation.
error_t sshUpdateExchangeHashRaw(SshConnection *connection, const void *data, size_t length)
Update exchange hash calculation (raw data)
error_t sshGenerateExchangeHashSignature(SshConnection *connection, uint8_t *p, size_t *written)
Compute the signature on the exchange hash.
error_t sshVerifyExchangeHashSignature(SshConnection *connection, const SshBinaryString *serverHostKey, const SshBinaryString *signature)
Verify the signature on the exchange hash.
Binary string.
Definition: ssh_types.h:67
uint8_t length
Definition: tcp.h:368