_SshContext Struct Reference

SSH context. More...

#include <ssh.h>

Data Fields

SshOperationMode mode
 Mode of operation (client or server) More...
 
uint_t numConnections
 Maximum number of SSH connections. More...
 
SshConnectionconnections
 SSH connections. More...
 
uint_t numChannels
 Maximum number of SSH channels. More...
 
SshChannelchannels
 SSH channels. More...
 
const PrngAlgoprngAlgo
 Pseudo-random number generator to be used. More...
 
void * prngContext
 Pseudo-random number generator context. More...
 
SshHostKey hostKeys [SSH_MAX_HOST_KEYS]
 List of host keys. More...
 
char_t username [SSH_MAX_USERNAME_LEN+1]
 User name. More...
 
char_t password [SSH_MAX_PASSWORD_LEN+1]
 Password. More...
 
SshRsaKey rsaKeys [SSH_MAX_RSA_KEYS]
 Transient RSA keys (for RSA key exchange) More...
 
SshDhGexGroup dhGexGroups [SSH_MAX_DH_GEX_GROUPS]
 Diffie-Hellman groups. More...
 
SshHostKeyVerifyCallback hostKeyVerifyCallback
 Host key verification callback. More...
 
SshCertVerifyCallback certVerifyCallback
 Certificate verification callback. More...
 
SshCaPublicKeyVerifyCallback caPublicKeyVerifyCallback
 CA public key verification callback. More...
 
SshPublicKeyAuthCallback publicKeyAuthCallback
 Public key authentication callback. More...
 
SshCertAuthCallback certAuthCallback
 Certificate authentication callback. More...
 
SshPasswordAuthCallback passwordAuthCallback
 Password authentication callback. More...
 
SshPasswordChangeCallback passwordChangeCallback
 Password change callback. More...
 
SshSignGenCallback signGenCallback
 Signature generation callback. More...
 
SshSignVerifyCallback signVerifyCallback
 Signature verification callback. More...
 
SshEcdhKeyPairGenCallback ecdhKeyPairGenCallback
 ECDH key pair generation callback. More...
 
SshEcdhSharedSecretCalcCallback ecdhSharedSecretCalcCallback
 ECDH shared secret calculation callback. More...
 
SshGlobalReqCallback globalReqCallback [SSH_MAX_GLOBAL_REQ_CALLBACKS]
 Global request callbacks. More...
 
void * globalReqParam [SSH_MAX_GLOBAL_REQ_CALLBACKS]
 Opaque pointer passed to the global request callback. More...
 
SshChannelReqCallback channelReqCallback [SSH_MAX_CHANNEL_REQ_CALLBACKS]
 Channel request callbacks. More...
 
void * channelReqParam [SSH_MAX_CHANNEL_REQ_CALLBACKS]
 Opaque pointer passed to the channel request callback. More...
 
SshChannelOpenCallback channelOpenCallback [SSH_MAX_CHANNEL_OPEN_CALLBACKS]
 Channel open callbacks. More...
 
void * channelOpenParam [SSH_MAX_CHANNEL_OPEN_CALLBACKS]
 Opaque pointer passed to the channel open callback. More...
 
SshConnectionOpenCallback connectionOpenCallback [SSH_MAX_CONN_OPEN_CALLBACKS]
 Connection open callback function. More...
 
void * connectionOpenParam [SSH_MAX_CONN_OPEN_CALLBACKS]
 Opaque pointer passed to the connection open callback. More...
 
SshConnectionCloseCallback connectionCloseCallback [SSH_MAX_CONN_CLOSE_CALLBACKS]
 Connection close callback function. More...
 
void * connectionCloseParam [SSH_MAX_CONN_CLOSE_CALLBACKS]
 Opaque pointer passed to the connection close callback. More...
 
OsMutex mutex
 Mutex preventing simultaneous access to the context. More...
 
OsEvent event
 Event object used to poll the sockets. More...
 
SocketEventDesc eventDesc [SSH_MAX_CONNECTIONS+1]
 The events the application is interested in. More...
 

Detailed Description

SSH context.

Definition at line 1425 of file ssh.h.

Field Documentation

◆ caPublicKeyVerifyCallback

SshCaPublicKeyVerifyCallback caPublicKeyVerifyCallback

CA public key verification callback.

Definition at line 1451 of file ssh.h.

◆ certAuthCallback

SshCertAuthCallback certAuthCallback

Certificate authentication callback.

Definition at line 1457 of file ssh.h.

◆ certVerifyCallback

SshCertVerifyCallback certVerifyCallback

Certificate verification callback.

Definition at line 1450 of file ssh.h.

◆ channelOpenCallback

Channel open callbacks.

Definition at line 1475 of file ssh.h.

◆ channelOpenParam

void* channelOpenParam[SSH_MAX_CHANNEL_OPEN_CALLBACKS]

Opaque pointer passed to the channel open callback.

Definition at line 1476 of file ssh.h.

◆ channelReqCallback

Channel request callbacks.

Definition at line 1473 of file ssh.h.

◆ channelReqParam

void* channelReqParam[SSH_MAX_CHANNEL_REQ_CALLBACKS]

Opaque pointer passed to the channel request callback.

Definition at line 1474 of file ssh.h.

◆ channels

SshChannel* channels

SSH channels.

Definition at line 1431 of file ssh.h.

◆ connectionCloseCallback

Connection close callback function.

Definition at line 1479 of file ssh.h.

◆ connectionCloseParam

void* connectionCloseParam[SSH_MAX_CONN_CLOSE_CALLBACKS]

Opaque pointer passed to the connection close callback.

Definition at line 1480 of file ssh.h.

◆ connectionOpenCallback

Connection open callback function.

Definition at line 1477 of file ssh.h.

◆ connectionOpenParam

void* connectionOpenParam[SSH_MAX_CONN_OPEN_CALLBACKS]

Opaque pointer passed to the connection open callback.

Definition at line 1478 of file ssh.h.

◆ connections

SshConnection* connections

SSH connections.

Definition at line 1429 of file ssh.h.

◆ dhGexGroups

Diffie-Hellman groups.

Definition at line 1445 of file ssh.h.

◆ ecdhKeyPairGenCallback

SshEcdhKeyPairGenCallback ecdhKeyPairGenCallback

ECDH key pair generation callback.

Definition at line 1468 of file ssh.h.

◆ ecdhSharedSecretCalcCallback

SshEcdhSharedSecretCalcCallback ecdhSharedSecretCalcCallback

ECDH shared secret calculation callback.

Definition at line 1469 of file ssh.h.

◆ event

OsEvent event

Event object used to poll the sockets.

Definition at line 1483 of file ssh.h.

◆ eventDesc

The events the application is interested in.

Definition at line 1484 of file ssh.h.

◆ globalReqCallback

Global request callbacks.

Definition at line 1471 of file ssh.h.

◆ globalReqParam

void* globalReqParam[SSH_MAX_GLOBAL_REQ_CALLBACKS]

Opaque pointer passed to the global request callback.

Definition at line 1472 of file ssh.h.

◆ hostKeys

List of host keys.

Definition at line 1434 of file ssh.h.

◆ hostKeyVerifyCallback

SshHostKeyVerifyCallback hostKeyVerifyCallback

Host key verification callback.

Definition at line 1448 of file ssh.h.

◆ mode

Mode of operation (client or server)

Definition at line 1427 of file ssh.h.

◆ mutex

OsMutex mutex

Mutex preventing simultaneous access to the context.

Definition at line 1482 of file ssh.h.

◆ numChannels

uint_t numChannels

Maximum number of SSH channels.

Definition at line 1430 of file ssh.h.

◆ numConnections

uint_t numConnections

Maximum number of SSH connections.

Definition at line 1428 of file ssh.h.

◆ password

Password.

Definition at line 1438 of file ssh.h.

◆ passwordAuthCallback

SshPasswordAuthCallback passwordAuthCallback

Password authentication callback.

Definition at line 1460 of file ssh.h.

◆ passwordChangeCallback

SshPasswordChangeCallback passwordChangeCallback

Password change callback.

Definition at line 1461 of file ssh.h.

◆ prngAlgo

const PrngAlgo* prngAlgo

Pseudo-random number generator to be used.

Definition at line 1432 of file ssh.h.

◆ prngContext

void* prngContext

Pseudo-random number generator context.

Definition at line 1433 of file ssh.h.

◆ publicKeyAuthCallback

SshPublicKeyAuthCallback publicKeyAuthCallback

Public key authentication callback.

Definition at line 1454 of file ssh.h.

◆ rsaKeys

Transient RSA keys (for RSA key exchange)

Definition at line 1442 of file ssh.h.

◆ signGenCallback

SshSignGenCallback signGenCallback

Signature generation callback.

Definition at line 1464 of file ssh.h.

◆ signVerifyCallback

SshSignVerifyCallback signVerifyCallback

Signature verification callback.

Definition at line 1465 of file ssh.h.

◆ username

User name.

Definition at line 1437 of file ssh.h.


The documentation for this struct was generated from the following file: