libnetconf2  1.1.48
NETCONF library for clients and servers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Client-side Call Home on SSH

SSH settings for the Call Home functionality. More...

Functions

void nc_client_ssh_ch_set_auth_hostkey_check_clb (int(*auth_hostkey_check)(const char *hostname, ssh_session session, void *priv), void *priv)
 Set SSH Call Home authentication hostkey check (knownhosts) callback. More...
 
void nc_client_ssh_ch_get_auth_hostkey_check_clb (int(**auth_hostkey_check)(const char *hostname, ssh_session session, void *priv), void **priv)
 Get currently set SSH Call Home authentication hostkey check (knownhosts) callback and its private data previously set by nc_client_ssh_ch_set_auth_hostkey_check_clb(). More...
 
void nc_client_ssh_ch_set_auth_password_clb (char *(*auth_password)(const char *username, const char *hostname, void *priv), void *priv)
 Set SSH Call Home password authentication callback. More...
 
void nc_client_ssh_ch_get_auth_password_clb (char *(**auth_password)(const char *username, const char *hostname, void *priv), void **priv)
 Get currently set SSH Call Home password authentication callback and its private data previously set by nc_client_ssh_ch_set_auth_password_clb(). More...
 
void nc_client_ssh_ch_set_auth_interactive_clb (char *(*auth_interactive)(const char *auth_name, const char *instruction, const char *prompt, int echo, void *priv), void *priv)
 Set SSH Call Home interactive authentication callback. More...
 
void nc_client_ssh_ch_get_auth_interactive_clb (char *(**auth_interactive)(const char *auth_name, const char *instruction, const char *prompt, int echo, void *priv), void **priv)
 Get currently set SSH Call Home interactive authentication callback and its private data previously set by nc_client_ssh_ch_set_auth_interactive_clb(). More...
 
void nc_client_ssh_ch_set_auth_privkey_passphrase_clb (char *(*auth_privkey_passphrase)(const char *privkey_path, void *priv), void *priv)
 Set SSH Call Home publickey authentication encrypted private key passphrase callback. More...
 
void nc_client_ssh_ch_get_auth_privkey_passphrase_clb (char *(**auth_privkey_passphrase)(const char *privkey_path, void *priv), void **priv)
 Get currently set SSH Call Home publickey authentication encrypted private key passphrase callback and its private data previously set by nc_client_ssh_ch_set_auth_privkey_passphrase_clb(). More...
 
int nc_client_ssh_ch_add_bind_listen (const char *address, uint16_t port)
 Add a new client bind and start listening on it for SSH Call Home connections. More...
 
int nc_client_ssh_ch_del_bind (const char *address, uint16_t port)
 Remove an SSH listening client bind. More...
 
int nc_client_ssh_ch_add_keypair (const char *pub_key, const char *priv_key)
 Add an SSH public and private key pair to be used for Call Home client authentication. More...
 
int nc_client_ssh_ch_del_keypair (int idx)
 Remove an SSH public and private key pair that was used for Call Home client authentication. More...
 
int nc_client_ssh_ch_get_keypair_count (void)
 Get the number of public an private key pairs set to be used for Call Home client authentication. More...
 
int nc_client_ssh_ch_get_keypair (int idx, const char **pub_key, const char **priv_key)
 Get a specific keypair set to be used for Call Home client authentication. More...
 
void nc_client_ssh_ch_set_auth_pref (NC_SSH_AUTH_TYPE auth_type, int16_t pref)
 Set SSH Call Home authentication method preference. More...
 
int16_t nc_client_ssh_ch_get_auth_pref (NC_SSH_AUTH_TYPE auth_type)
 Get SSH Call Home authentication method preference. More...
 
int nc_client_ssh_ch_set_username (const char *username)
 Set client Call Home SSH username used for authentication. More...
 
const char * nc_client_ssh_ch_get_username (void)
 Get client Call Home SSH username used for authentication. More...
 

Detailed Description

SSH settings for the Call Home functionality.

Function Documentation

void nc_client_ssh_ch_set_auth_hostkey_check_clb ( int(*)(const char *hostname, ssh_session session, void *priv)  auth_hostkey_check,
void *  priv 
)

Set SSH Call Home authentication hostkey check (knownhosts) callback.

Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for freeing the private data when necessary (the private data can be obtained by nc_client_ssh_ch_get_auth_hostkey_check_clb()).

Parameters
[in]auth_hostkey_checkFunction to call, returns 0 on success, non-zero in error. If NULL, the default callback is set.
[in]privOptional private data to be passed to the callback function.
void nc_client_ssh_ch_get_auth_hostkey_check_clb ( int(**)(const char *hostname, ssh_session session, void *priv)  auth_hostkey_check,
void **  priv 
)

Get currently set SSH Call Home authentication hostkey check (knownhosts) callback and its private data previously set by nc_client_ssh_ch_set_auth_hostkey_check_clb().

Parameters
[out]auth_hostkey_checkCurrently set callback, NULL in case of the default callback.
[out]privCurrently set (optional) private data to be passed to the callback function.
void nc_client_ssh_ch_set_auth_password_clb ( char *(*)(const char *username, const char *hostname, void *priv)  auth_password,
void *  priv 
)

Set SSH Call Home password authentication callback.

Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for freeing the private data when necessary (the private data can be obtained by nc_client_ssh_ch_get_auth_password_clb()).

Parameters
[in]auth_passwordFunction to call, returns the password for username@hostname. If NULL, the default callback is set.
[in]privOptional private data to be passed to the callback function.
void nc_client_ssh_ch_get_auth_password_clb ( char *(**)(const char *username, const char *hostname, void *priv)  auth_password,
void **  priv 
)

Get currently set SSH Call Home password authentication callback and its private data previously set by nc_client_ssh_ch_set_auth_password_clb().

Parameters
[out]auth_passwordCurrently set callback, NULL in case of the default callback.
[out]privCurrently set (optional) private data to be passed to the callback function.
void nc_client_ssh_ch_set_auth_interactive_clb ( char *(*)(const char *auth_name, const char *instruction, const char *prompt, int echo, void *priv)  auth_interactive,
void *  priv 
)

Set SSH Call Home interactive authentication callback.

Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for freeing the private data when necessary (the private data can be obtained by nc_client_ssh_ch_get_auth_interactive_clb()).

Parameters
[in]auth_interactiveFunction to call for every question, returns the answer for authentication name with instruction and echoing prompt. If NULL, the default callback is set.
[in]privOptional private data to be passed to the callback function.
void nc_client_ssh_ch_get_auth_interactive_clb ( char *(**)(const char *auth_name, const char *instruction, const char *prompt, int echo, void *priv)  auth_interactive,
void **  priv 
)

Get currently set SSH Call Home interactive authentication callback and its private data previously set by nc_client_ssh_ch_set_auth_interactive_clb().

Parameters
[out]auth_interactiveCurrently set callback, NULL in case of the default callback.
[out]privCurrently set (optional) private data to be passed to the callback function.
void nc_client_ssh_ch_set_auth_privkey_passphrase_clb ( char *(*)(const char *privkey_path, void *priv)  auth_privkey_passphrase,
void *  priv 
)

Set SSH Call Home publickey authentication encrypted private key passphrase callback.

Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for freeing the private data when necessary (the private data can be obtained by nc_client_ssh_ch_get_auth_privkey_passphrase_clb()).

Parameters
[in]auth_privkey_passphraseFunction to call for every question, returns the passphrase for the specific private key.
[in]privOptional private data to be passed to the callback function.
void nc_client_ssh_ch_get_auth_privkey_passphrase_clb ( char *(**)(const char *privkey_path, void *priv)  auth_privkey_passphrase,
void **  priv 
)

Get currently set SSH Call Home publickey authentication encrypted private key passphrase callback and its private data previously set by nc_client_ssh_ch_set_auth_privkey_passphrase_clb().

Parameters
[out]auth_privkey_passphraseCurrently set callback, NULL in case of the default callback.
[out]privCurrently set (optional) private data to be passed to the callback function.
int nc_client_ssh_ch_add_bind_listen ( const char *  address,
uint16_t  port 
)

Add a new client bind and start listening on it for SSH Call Home connections.

Parameters
[in]addressIP address to bind to.
[in]portPort to bind to.
Returns
0 on success, -1 on error.
int nc_client_ssh_ch_del_bind ( const char *  address,
uint16_t  port 
)

Remove an SSH listening client bind.

Parameters
[in]addressIP address the socket was bound to. NULL matches all.
[in]portPort the socket was bound to. 0 matches all.
Returns
0 on success, -1 on not found.
int nc_client_ssh_ch_add_keypair ( const char *  pub_key,
const char *  priv_key 
)

Add an SSH public and private key pair to be used for Call Home client authentication.

Private key can be encrypted, the passphrase will be asked for before using it.

Parameters
[in]pub_keyPath to the public key.
[in]priv_keyPath to the private key.
Returns
0 on success, -1 on error.
int nc_client_ssh_ch_del_keypair ( int  idx)

Remove an SSH public and private key pair that was used for Call Home client authentication.

Parameters
[in]idxIndex of the keypair starting with 0.
Returns
0 on success, -1 on error.
int nc_client_ssh_ch_get_keypair_count ( void  )

Get the number of public an private key pairs set to be used for Call Home client authentication.

Returns
Keypair count.
int nc_client_ssh_ch_get_keypair ( int  idx,
const char **  pub_key,
const char **  priv_key 
)

Get a specific keypair set to be used for Call Home client authentication.

Parameters
[in]idxIndex of the specific keypair.
[out]pub_keyPath to the public key.
[out]priv_keyPath to the private key.
Returns
0 on success, -1 on error.
void nc_client_ssh_ch_set_auth_pref ( NC_SSH_AUTH_TYPE  auth_type,
int16_t  pref 
)

Set SSH Call Home authentication method preference.

The default preference is as follows:

  • public key authentication (3)
  • password authentication (2)
  • interactive authentication (1)
Parameters
[in]auth_typeAuthentication method to modify the preference of.
[in]prefPreference of auth_type. Higher number increases priority, negative values disable the method.
int16_t nc_client_ssh_ch_get_auth_pref ( NC_SSH_AUTH_TYPE  auth_type)

Get SSH Call Home authentication method preference.

Parameters
[in]auth_typeAuthentication method to retrieve the prefrence of.
Returns
Preference of the auth_type.
int nc_client_ssh_ch_set_username ( const char *  username)

Set client Call Home SSH username used for authentication.

Parameters
[in]usernameUsername to use.
Returns
0 on success, -1 on error.
const char* nc_client_ssh_ch_get_username ( void  )

Get client Call Home SSH username used for authentication.

Returns
Username used.