NbWolfSsh.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_SSH_H_
#define _NB_SSH_H_
#include <nettypes.h>
#include <stdio.h>
#include <basictypes.h>
 
#ifdef NB_SSH_SUPPORTED
 
#ifndef WOLFSSL_USER_SETTINGS
#define WOLFSSL_USER_SETTINGS // This wasn't getting defined in the project source files in NBEclipse
#endif
 
#include <ssh/wolfssh/ssh.h>
#include <ssh/NetBurner/UserAuthManager.h>
#include <ssh/NetBurner/SshSocket.h>
 
/*
 ******************************************************************************
 *
 * Definitions
 *
 ******************************************************************************
 */
/* Default SSH Server Port*/
#define SSH_SECURE_SHELL_IANA_ASSIGNED_PORT (22)
 
/* Connection timeout */
#ifdef _DEBUG
#define SSH_CONNECTION_TIMEOUT_IN_SECS (360)
#else /* #ifdef _DEBUG */
#define SSH_CONNECTION_TIMEOUT_IN_SECS (180)
#endif /* #ifdef _DEBUG */
 
/* Default static key size, no choice is 1024 */
/* #define SSH_RSA_KEY_DEFAULT_512 ( 512 ) */
#define SSH_RSA_KEY_DEFAULT_1024 (1024)
/* #define SSH_RSA_KEY_DEFAULT_2048 ( 2048 ) */
 
#define SSH_DSS_KEY_DEFAULT_512 (512)
/* #define SSH_DSS_KEY_DEFAULT_1024 ( 1024 ) */
/* #define SSH_DSS_KEY_DEFAULT_2048 ( 2048 ) */
 
#define SSH_SUCCESS (0) 
#define SSH_ERROR_FAILED_SESSION_FAILED (-300) 
#define SSH_ERROR_FAILED_NEGOTIATION (-301) 
#define SSH_ERROR_FAILED_INITIALIZATION (-302) 
#define SSH_ERROR_FAILED_CONTEXT_INIT (-303) 
#define SSH_ERROR_BAD_KEY (-304) 
#define SSH_ERROR_BAD_ARGUMENT (-305) 
#define SSH_FAILED_KEY_CHECK (-306) 
the onboard generated key is not valid, and auto-cert generation is not enabled or the cert generation function failed.
 
/* SSH Key */
#define SSH_KEY_RSA (1)
#define SSH_KEY_DSS (2)
#define SSH_KEY_ECC (3)
 
/*
 ******************************************************************************
 *
 * SSH "C" Library Interface
 *
 ******************************************************************************
 */
#ifdef __cplusplus
extern "C"
{
#endif
 
 /*Functions:*/
 /*Group:SSH functions*/
 
 // Server
 // Deprecated, only left for backwards compatibility. Should use sshUserAuthenticateWithTypeFn instead.
 typedef int (*sshUserAuthenticateFn)(const char *usernamePtr, const char *passwordPtr);
 
 typedef int (*sshUserAuthenticateWithTypeFn)(const char *usernamePtr, const char *authValPtr, AuthType authType);
 
 // Client
 typedef int (*sshGetUserPwFn)(const NBString &usernamePtr, NBString &passwordPtr);
 
 typedef int (*sshGetUserKeyFn)(const NBString &usernamePtr, NBString &publicKey, NBString &privateKey, NBString &keyType);
 
 // Server Callbacks
 void SshSetUserAuthenticate(sshUserAuthenticateFn sshUserAuthenticateFnPtr);
 
 sshUserAuthenticateFn SshGetUserAuthenticate(void);
 
 void SshSetUserAuthenticateWithType(sshUserAuthenticateWithTypeFn sshUserAuthenticateFnPtr);
 
 sshUserAuthenticateWithTypeFn SshGetUserAuthenticateWithType(void);
 
 // Client Callbacks
 void SshClientSetGetUserPaswordFn(sshGetUserPwFn sshGetUserPwFnPtr);
 
 sshGetUserPwFn SshClientGetUserPaswordFn(void);
 
 void SshClientSetGetUserKeyFn(sshGetUserKeyFn sshGetUserKeyFnPtr);
 
 sshGetUserKeyFn SshClientGetUserKeyFn(void);
 
 typedef int (*sshUserGetKeyFn)(int keyRequested, const unsigned char **keyBufferPtr, int *keyLengthPtr);
 
 void SshSetUserGetKey(sshUserGetKeyFn sshUserGetKeyFnPtr);
 
 sshUserGetKeyFn SshGetUserGetKey(void);
 
 bool SshValidateKey(const char *candidateKey, int candidateKeySize, int *keyTypePtr, int keyFormat = WOLFSSH_FORMAT_ASN1);
 
 bool SshWritePublicKey(int publicKeyFd, unsigned char *candidateKey, int candidateKeySize);
 
 int NbSshInit();
 
 int SshAccept(int listenFd, IPADDR *clientAddress, uint16_t *securePort, uint16_t timeout);
 
 int SshConnect(IPADDR clientAddress, uint16_t securePort, uint16_t localPort, uint16_t timeout, const char *username);
 
 SshSocket *SshNegotiateSession(int fd);
 
 SshSocket *SshNegotiateSessionClient(int secureFd, const char *username);
 
 void SshPrintStatistics(int secureFd);
 
 int SshGetKeySize();
 
 int SshSetBannerText(const char *banner);
 
 int SshSetSockOption(int fd, int option);
 
 int SshClrSockOption(int fd, int option);
 
 int SshGetSockOption(int fd);
 
 
#ifdef __cplusplus
};
#endif
 
#endif /* NB_SSH_SUPPORTED */
#endif /* _NB_SSH_H_ */