Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
openapi_ssh.h File Reference
#include "openapi_common.h"
#include "openapi_logging.h"

Go to the source code of this file.

Enumerations

enum  OPEN_SSH_KEY_TYPE_t { OPEN_SSH_KEY_TYPE_RSA = 0, OPEN_SSH_KEY_TYPE_DSA = 1 }
 OpEN uses this enumeration to define SSH key types. More...
 
enum  OPEN_SSH_PROTO_VERSION_t { OPEN_SSH_PROTO_VERSION_1 = 0, OPEN_SSH_PROTO_VERSION_2 = 1, OPEN_SSH_PROTO_VERSION_BOTH = 2 }
 OpEN uses this enumeration to define SSH protocol versions. More...
 

Functions

open_error_t openapiScpRemoteTransferComplete (openapiClientHandle_t *client_handle)
 To update application about the completion of scp remote file transfer. More...
 
open_error_t openapiScpRemoteTransferStart (openapiClientHandle_t *client_handle, int32_t scpClientPID, open_buffdesc *fileParams)
 To get the download file complete path and initiate transfer process. More...
 
open_error_t openapiScpServerAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *scpServerAdminMode)
 Get the SCP server admin mode. More...
 
open_error_t openapiScpServerAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t scpServerAdminMode)
 Set the SCP server admin mode to initiate file transfer. More...
 
open_error_t openapiSSHActiveSessionsGet (openapiClientHandle_t *client_handle, uint32_t *sshActiveSessions)
 Get the active number of SSH sessions. More...
 
open_error_t openapiSSHAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *sshAdminMode)
 Get the admin mode of SSH. More...
 
open_error_t openapiSSHAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t sshAdminMode)
 Set the admin mode of SSH. More...
 
open_error_t openapiSSHKeyDelete (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
 Delete the generated SSH key pairs. More...
 
open_error_t openapiSSHKeyGenerate (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
 Generate SSH key pairs. More...
 
open_error_t openapiSSHKeyStatusGet (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
 Check the status of SSH key. More...
 
open_error_t openapiSSHLogMessage (openapiClientHandle_t *client_handle, OPEN_LOG_SEVERITY_t severity, open_buffdesc *fileName, uint32_t lineNum, open_buffdesc *msgBuf)
 Log an SSH message in the log server. More...
 
open_error_t openapiSSHMaxSessionsDefaultSet (openapiClientHandle_t *client_handle)
 Set the maximum number of allowed SSH sessions to the default. More...
 
open_error_t openapiSSHMaxSessionsGet (openapiClientHandle_t *client_handle, uint32_t *sshMaxSessions)
 Get the maximum number of SSH sessions allowed. More...
 
open_error_t openapiSSHMaxSessionsSet (openapiClientHandle_t *client_handle, uint32_t sshMaxSessions)
 Set the maximum number of allowed SSH sessions. More...
 
open_error_t openapiSSHProtocolVersionGet (openapiClientHandle_t *client_handle, OPEN_SSH_PROTO_VERSION_t *protoVersion)
 Get the SSH protocol version. More...
 
open_error_t openapiSSHProtocolVersionSet (openapiClientHandle_t *client_handle, OPEN_SSH_PROTO_VERSION_t protoVersion)
 Set the SSH protocol version. More...
 
open_error_t openapiSSHPubKeyAuthModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *sshdPubKeyAuthMode)
 Get the admin mode of SSH public key. More...
 
open_error_t openapiSSHPubKeyGet (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType, open_buffdesc *userName, open_buffdesc *pubKey)
 Get the SSH public key for specified user. More...
 
open_error_t openapiSSHPublicUserAuthenticate (openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *ipAddr, uint32_t sshClientID)
 Authenticate SSH User. More...
 
open_error_t openapiSSHRemotePasswordGet (openapiClientHandle_t *client_handle, uint32_t clientSockID, open_buffdesc *password)
 Get the remote password for the matching client Socket ID for outbound SSH . More...
 
open_error_t openapiSSHSessionTimeoutGet (openapiClientHandle_t *client_handle, uint32_t *sshSessionTimeout)
 Get the SSH session idle timeout value. More...
 
open_error_t openapiSSHSessionTimeoutSet (openapiClientHandle_t *client_handle, uint32_t sshSessionTimeout)
 Set the SSH session idle timeout. More...
 
open_error_t openapiSSHSocketInfoClear (openapiClientHandle_t *client_handle, uint32_t sshClientID)
 Clear socket info entry. More...
 
open_error_t openapiSSHTransferRemotePasswordFromUserGet (openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password)
 Get the remote password for the matching remote username used for transfer. More...
 
open_error_t openapiSSHUserAuthenticate (openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password, open_buffdesc *ipAddr, uint32_t sshClientID)
 Authenticate SSH User. More...