ssh_key_verify.h
Go to the documentation of this file.
1 /**
2  * @file ssh_key_verify.h
3  * @brief SSH host key verification
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_KEY_VERIFY_H
32 #define _SSH_KEY_VERIFY_H
33 
34 //Dependencies
35 #include "ssh.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //SSH host key verification related functions
43 error_t sshVerifyHostKey(const uint8_t *hostKey, size_t hostKeyLen,
44  const char_t *trustedKey, size_t trustedKeyLen);
45 
47  const SshString *publicKeyAlgo, const SshBinaryString *hostKey);
48 
50  const SshString *publicKeyAlgo, const SshBinaryString *hostKey);
51 
52 //C++ guard
53 #ifdef __cplusplus
54 }
55 #endif
56 
57 #endif
char char_t
Definition: compiler_port.h:48
error_t
Error codes.
Definition: error.h:43
Secure Shell (SSH)
#define SshConnection
Definition: ssh.h:883
error_t sshVerifyHostKey(const uint8_t *hostKey, size_t hostKeyLen, const char_t *trustedKey, size_t trustedKeyLen)
Check if a host key is trusted.
error_t sshVerifyClientHostKey(SshConnection *connection, const SshString *publicKeyAlgo, const SshBinaryString *hostKey)
Verify client's host key.
error_t sshVerifyServerHostKey(SshConnection *connection, const SshString *publicKeyAlgo, const SshBinaryString *hostKey)
Verify server's host key.
Binary string.
Definition: ssh_types.h:67
String.
Definition: ssh_types.h:56