libnetconf2  3.5.1
NETCONF server and client library in C.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Client-side Call Home on TLS

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

Collaboration diagram for Client-side Call Home on TLS:

Functions

int nc_client_tls_ch_add_bind_hostname_listen (const char *address, uint16_t port, const char *hostname)
 Add a new client bind and start listening on it for TLS Call Home connections coming from the specified hostname. More...
 
int nc_client_tls_ch_add_bind_listen (const char *address, uint16_t port)
 Add a new client bind and start listening on it for TLS Call Home connections. More...
 
int nc_client_tls_ch_del_bind (const char *address, uint16_t port)
 Remove a TLS listening client bind. More...
 
void nc_client_tls_ch_get_cert_key_paths (const char **client_cert, const char **client_key)
 Get client Call Home authentication identity - a certificate and a private key. More...
 
void nc_client_tls_ch_get_crl_paths (const char **crl_file, const char **crl_dir)
 Deprecated. More...
 
void nc_client_tls_ch_get_trusted_ca_paths (const char **ca_file, const char **ca_dir)
 Get client Call Home trusted CA certificates. More...
 
int nc_client_tls_ch_set_cert_key_paths (const char *client_cert, const char *client_key)
 Set client Call Home authentication identity - a certificate and a private key. More...
 
int nc_client_tls_ch_set_crl_paths (const char *crl_file, const char *crl_dir)
 Deprecated. More...
 
int nc_client_tls_ch_set_trusted_ca_paths (const char *ca_file, const char *ca_dir)
 Set client Call Home trusted CA certificates. More...
 

Detailed Description

TLS settings for the Call Home functionality.

Function Documentation

int nc_client_tls_ch_add_bind_listen ( const char *  address,
uint16_t  port 
)

Add a new client bind and start listening on it for TLS 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_tls_ch_add_bind_hostname_listen ( const char *  address,
uint16_t  port,
const char *  hostname 
)

Add a new client bind and start listening on it for TLS Call Home connections coming from the specified hostname.

Parameters
[in]addressIP address to bind to.
[in]portPort to bind to.
[in]hostnameExpected server hostname, verified by TLS when connecting to it. If NULL, the check is skipped.
Returns
0 on success, -1 on error.
int nc_client_tls_ch_del_bind ( const char *  address,
uint16_t  port 
)

Remove a TLS 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_tls_ch_set_cert_key_paths ( const char *  client_cert,
const char *  client_key 
)

Set client Call Home authentication identity - a certificate and a private key.

Parameters
[in]client_certPath to the file containing the client certificate.
[in]client_keyPath to the file containing the private key for the client_cert. If NULL, key is expected to be stored with client_cert.
Returns
0 on success, -1 on error.
void nc_client_tls_ch_get_cert_key_paths ( const char **  client_cert,
const char **  client_key 
)

Get client Call Home authentication identity - a certificate and a private key.

Parameters
[out]client_certPath to the file containing the client certificate. Can be NULL.
[out]client_keyPath to the file containing the private key for the client_cert. Can be NULL.
int nc_client_tls_ch_set_trusted_ca_paths ( const char *  ca_file,
const char *  ca_dir 
)

Set client Call Home trusted CA certificates.

Parameters
[in]ca_fileLocation of the CA certificate file used to verify server certificates. For more info, see the documentation for SSL_CTX_load_verify_locations() from OpenSSL.
[in]ca_dirLocation of the CA certificates directory used to verify the server certificates. For more info, see the documentation for SSL_CTX_load_verify_locations() from OpenSSL.
Returns
0 on success, -1 on error.
void nc_client_tls_ch_get_trusted_ca_paths ( const char **  ca_file,
const char **  ca_dir 
)

Get client Call Home trusted CA certificates.

Parameters
[out]ca_fileLocation of the CA certificate file used to verify server certificates. Can be NULL.
[out]ca_dirLocation of the CA certificates directory used to verify the server certificates. Can be NULL.
int nc_client_tls_ch_set_crl_paths ( const char *  crl_file,
const char *  crl_dir 
)

Deprecated.

void nc_client_tls_ch_get_crl_paths ( const char **  crl_file,
const char **  crl_dir 
)

Deprecated.