session_server.h
Go to the documentation of this file.
#ifndef NC_SESSION_SERVER_H_
#define NC_SESSION_SERVER_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <libyang/libyang.h>
#include <stdint.h>
#ifdef NC_ENABLED_TLS
# include <openssl/x509.h>
#endif
#ifdef NC_ENABLED_SSH
# include <libssh/callbacks.h>
# include <libssh/libssh.h>
# include <libssh/server.h>
#endif
#include "netconf.h"
#include "session.h"
typedef struct nc_server_reply *(*nc_rpc_clb)(struct lyd_node *rpc, struct nc_session *session);
void nc_session_set_term_reason(struct nc_session *session, NC_SESSION_TERM_REASON reason);
void nc_session_set_killed_by(struct nc_session *session, uint32_t sid);
void nc_session_set_status(struct nc_session *session, NC_STATUS status);
void nc_set_global_rpc_clb(nc_rpc_clb clb);
int nc_server_init(struct ly_ctx *ctx);
void nc_server_destroy(void);
int nc_server_set_capab_withdefaults(NC_WD_MODE basic_mode, int also_supported);
void nc_server_get_capab_withdefaults(NC_WD_MODE *basic_mode, int *also_supported);
int nc_server_set_capability(const char *value);
void nc_server_set_content_id_clb(char *(*content_id_clb)(void *user_data), void *user_data,
void (*free_user_data)(void *user_data));
void nc_server_set_hello_timeout(uint16_t hello_timeout);
uint16_t nc_server_get_hello_timeout(void);
void nc_server_set_idle_timeout(uint16_t idle_timeout);
uint16_t nc_server_get_idle_timeout(void);
const char **nc_server_get_cpblts(struct ly_ctx *ctx);
const char **nc_server_get_cpblts_version(struct ly_ctx *ctx, LYS_VERSION version);
NC_MSG_TYPE nc_accept_inout(int fdin, int fdout, const char *username, struct nc_session **session);
struct nc_pollsession *nc_ps_new(void);
void nc_ps_free(struct nc_pollsession *ps);
int nc_ps_add_session(struct nc_pollsession *ps, struct nc_session *session);
int nc_ps_del_session(struct nc_pollsession *ps, struct nc_session *session);
struct nc_session *nc_ps_get_session(const struct nc_pollsession *ps, uint16_t idx);
uint16_t nc_ps_session_count(struct nc_pollsession *ps);
#define NC_PSPOLL_NOSESSIONS 0x0001
#define NC_PSPOLL_TIMEOUT 0x0002
#define NC_PSPOLL_RPC 0x0004
#define NC_PSPOLL_BAD_RPC 0x0008
#define NC_PSPOLL_REPLY_ERROR 0x0010
#define NC_PSPOLL_SESSION_TERM 0x0020
#define NC_PSPOLL_SESSION_ERROR 0x0040
#define NC_PSPOLL_ERROR 0x0080
#ifdef NC_ENABLED_SSH
# define NC_PSPOLL_SSH_MSG 0x00100
# define NC_PSPOLL_SSH_CHANNEL 0x0200
#endif
int nc_ps_poll(struct nc_pollsession *ps, int timeout, struct nc_session **session);
void nc_ps_clear(struct nc_pollsession *ps, int all, void (*data_free)(void *));
int nc_server_add_endpt(const char *name, NC_TRANSPORT_IMPL ti);
int nc_server_del_endpt(const char *name, NC_TRANSPORT_IMPL ti);
int nc_server_endpt_count(void);
int nc_server_is_endpt(const char *name);
int nc_server_endpt_set_address(const char *endpt_name, const char *address);
#if defined (NC_ENABLED_SSH) || defined (NC_ENABLED_TLS)
int nc_server_endpt_set_port(const char *endpt_name, uint16_t port);
#endif
int nc_server_endpt_set_perms(const char *endpt_name, mode_t mode, uid_t uid, gid_t gid);
int nc_server_endpt_enable_keepalives(const char *endpt_name, int enable);
int nc_server_endpt_set_keepalives(const char *endpt_name, int idle_time, int max_probes, int probe_interval);
NC_MSG_TYPE nc_accept(int timeout, struct nc_session **session);
#ifdef NC_ENABLED_SSH
NC_MSG_TYPE nc_session_accept_ssh_channel(struct nc_session *orig_session, struct nc_session **session);
NC_MSG_TYPE nc_ps_accept_ssh_channel(struct nc_pollsession *ps, struct nc_session **session);
int nc_server_ssh_add_authkey(const char *pubkey_base64, NC_SSH_KEY_TYPE type, const char *username);
int nc_server_ssh_add_authkey_path(const char *pubkey_path, const char *username);
int nc_server_ssh_del_authkey(const char *pubkey_path, const char *pubkey_base64, NC_SSH_KEY_TYPE type,
const char *username);
void nc_server_ssh_set_passwd_auth_clb(int (*passwd_auth_clb)(const struct nc_session *session, const char *password,
void *user_data), void *user_data, void (*free_user_data)(void *user_data));
void nc_server_ssh_set_interactive_auth_clb(int (*interactive_auth_clb)(const struct nc_session *session,
const ssh_message msg, void *user_data), void *user_data, void (*free_user_data)(void *user_data));
void nc_server_ssh_set_pubkey_auth_clb(int (*pubkey_auth_clb)(const struct nc_session *session, ssh_key key,
void *user_data), void *user_data, void (*free_user_data)(void *user_data));
void nc_server_ssh_set_hostkey_clb(int (*hostkey_clb)(const char *name, void *user_data, char **privkey_path,
char **privkey_data, NC_SSH_KEY_TYPE *privkey_type), void *user_data, void (*free_user_data)(void *user_data));
int nc_server_ssh_endpt_add_hostkey(const char *endpt_name, const char *name, int16_t idx);
int nc_server_ssh_endpt_del_hostkey(const char *endpt_name, const char *name, int16_t idx);
int nc_server_ssh_endpt_mov_hostkey(const char *endpt_name, const char *key_mov, const char *key_after);
int nc_server_ssh_endpt_mod_hostkey(const char *endpt_name, const char *name, const char *new_name);
int nc_server_ssh_endpt_set_auth_methods(const char *endpt_name, int auth_methods);
int nc_server_ssh_endpt_get_auth_methods(const char *endpt_name);
int nc_server_ssh_endpt_set_auth_attempts(const char *endpt_name, uint16_t auth_attempts);
int nc_server_ssh_endpt_set_auth_timeout(const char *endpt_name, uint16_t auth_timeout);
#endif /* NC_ENABLED_SSH */
#ifdef NC_ENABLED_TLS
int nc_server_tls_endpt_set_server_cert(const char *endpt_name, const char *name);
void nc_server_tls_set_server_cert_clb(int (*cert_clb)(const char *name, void *user_data, char **cert_path, char **cert_data,
char **privkey_path, char **privkey_data, NC_SSH_KEY_TYPE *privkey_type), void *user_data,
void (*free_user_data)(void *user_data));
void nc_server_tls_set_server_cert_chain_clb(int (*cert_chain_clb)(const char *name, void *user_data, char ***cert_paths,
int *cert_path_count, char ***cert_data, int *cert_data_count), void *user_data, void (*free_user_data)(void *user_data));
int nc_server_tls_endpt_add_trusted_cert_list(const char *endpt_name, const char *name);
void nc_server_tls_set_trusted_cert_list_clb(int (*cert_list_clb)(const char *name, void *user_data, char ***cert_paths,
int *cert_path_count, char ***cert_data, int *cert_data_count), void *user_data, void (*free_user_data)(void *user_data));
int nc_server_tls_endpt_del_trusted_cert_list(const char *endpt_name, const char *name);
int nc_server_tls_endpt_set_trusted_ca_paths(const char *endpt_name, const char *ca_file, const char *ca_dir);
int nc_server_tls_endpt_set_crl_paths(const char *endpt_name, const char *crl_file, const char *crl_dir);
void nc_server_tls_endpt_clear_crls(const char *endpt_name);
int nc_server_tls_endpt_add_ctn(const char *endpt_name, uint32_t id, const char *fingerprint,
NC_TLS_CTN_MAPTYPE map_type, const char *name);
int nc_server_tls_endpt_del_ctn(const char *endpt_name, int64_t id, const char *fingerprint,
NC_TLS_CTN_MAPTYPE map_type, const char *name);
int nc_server_tls_endpt_get_ctn(const char *endpt_name, uint32_t *id, char **fingerprint, NC_TLS_CTN_MAPTYPE *map_type,
char **name);
const X509 *nc_session_get_client_cert(const struct nc_session *session);
void nc_server_tls_set_verify_clb(int (*verify_clb)(const struct nc_session *session));
#endif /* NC_ENABLED_TLS */
time_t nc_session_get_start_time(const struct nc_session *session);
void nc_session_inc_notif_status(struct nc_session *session);
void nc_session_dec_notif_status(struct nc_session *session);
int nc_session_get_notif_status(const struct nc_session *session);
int nc_session_is_callhome(const struct nc_session *session);
#ifdef __cplusplus
}
#endif
#endif /* NC_SESSION_SERVER_H_ */
NC_MSG_TYPE
NC_MSG_TYPE
Enumeration of NETCONF message types.
Definition: netconf.h:69
NC_WD_MODE
enum NC_WITHDEFAULTS_MODE NC_WD_MODE
Enumeration of NETCONF with-defaults capability modes.
NC_SESSION_TERM_REASON
NC_SESSION_TERM_REASON
Enumeration of reasons of the NETCONF session termination as defined in RFC 6470.
Definition: netconf.h:55
nc_session_is_callhome
int nc_session_is_callhome(const struct nc_session *session)
Learn whether a session was created using Call Home or not. Works only for server sessions.
nc_session_accept_ssh_channel
NC_MSG_TYPE nc_session_accept_ssh_channel(struct nc_session *orig_session, struct nc_session **session)
Accept a new NETCONF session on an SSH session of a running NETCONF orig_session. Call this function ...
nc_accept_inout
NC_MSG_TYPE nc_accept_inout(int fdin, int fdout, const char *username, struct nc_session **session)
Accept a new session on a pre-established transport session.
nc_rpc_clb
struct nc_server_reply *(* nc_rpc_clb)(struct lyd_node *rpc, struct nc_session *session)
Prototype of callbacks that are called if some RPCs are received.
Definition: session_server.h:58
nc_ps_poll
int nc_ps_poll(struct nc_pollsession *ps, int timeout, struct nc_session **session)
Poll sessions and process any received RPCs.
nc_session_set_term_reason
void nc_session_set_term_reason(struct nc_session *session, NC_SESSION_TERM_REASON reason)
Set the termination reason for a session. Use only in nc_rpc_clb callbacks.
nc_ps_del_session
int nc_ps_del_session(struct nc_pollsession *ps, struct nc_session *session)
Remove a session from a pollsession structure.
nc_set_global_rpc_clb
void nc_set_global_rpc_clb(nc_rpc_clb clb)
Set a global nc_rpc_clb that is called if the particular RPC request is received and the private fiel...
nc_accept
NC_MSG_TYPE nc_accept(int timeout, struct nc_session **session)
Accept new sessions on all the listening endpoints.
nc_session_set_status
void nc_session_set_status(struct nc_session *session, NC_STATUS status)
Set the status of a session.
nc_session_get_start_time
time_t nc_session_get_start_time(const struct nc_session *session)
Get session start time.
nc_session_set_killed_by
void nc_session_set_killed_by(struct nc_session *session, uint32_t sid)
Set the session-id of the session responsible for this session's termination.
nc_ps_add_session
int nc_ps_add_session(struct nc_pollsession *ps, struct nc_session *session)
Add a session to a pollsession structure.
nc_ps_free
void nc_ps_free(struct nc_pollsession *ps)
Free a pollsession structure.
nc_ps_session_count
uint16_t nc_ps_session_count(struct nc_pollsession *ps)
Learn the number of sessions in a pollsession structure.
nc_ps_new
struct nc_pollsession * nc_ps_new(void)
Create an empty structure for polling sessions.
nc_ps_clear
void nc_ps_clear(struct nc_pollsession *ps, int all, void(*data_free)(void *))
Remove sessions from a pollsession structure and call nc_session_free() on them.
nc_ps_accept_ssh_channel
NC_MSG_TYPE nc_ps_accept_ssh_channel(struct nc_pollsession *ps, struct nc_session **session)
Accept a new NETCONF session on an SSH session of a running NETCONF session that was polled in ps....
nc_session_dec_notif_status
void nc_session_dec_notif_status(struct nc_session *session)
Decrease session notification subscription flag count. Supports multiple subscriptions on one session...
nc_session_get_notif_status
int nc_session_get_notif_status(const struct nc_session *session)
Get session notification subscription flag.
nc_session_inc_notif_status
void nc_session_inc_notif_status(struct nc_session *session)
Increase session notification subscription flag count. Supports multiple subscriptions on one session...
nc_ps_get_session
struct nc_session * nc_ps_get_session(const struct nc_pollsession *ps, uint16_t idx)
Get a session from a pollsession structure matching the session ID.
nc_server_ssh_endpt_del_hostkey
int nc_server_ssh_endpt_del_hostkey(const char *endpt_name, const char *name, int16_t idx)
Delete endpoint SSH host key. Their order is preserved.
nc_server_ssh_endpt_set_auth_attempts
int nc_server_ssh_endpt_set_auth_attempts(const char *endpt_name, uint16_t auth_attempts)
Set endpoint SSH authentication attempts of every client. 3 by default.
nc_server_ssh_set_pubkey_auth_clb
void nc_server_ssh_set_pubkey_auth_clb(int(*pubkey_auth_clb)(const struct nc_session *session, ssh_key key, void *user_data), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for SSH public key authentication. If none is set, local system users are used.
nc_server_ssh_set_hostkey_clb
void nc_server_ssh_set_hostkey_clb(int(*hostkey_clb)(const char *name, void *user_data, char **privkey_path, char **privkey_data, NC_SSH_KEY_TYPE *privkey_type), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for retrieving host keys. Any RSA, DSA, and ECDSA keys can be added....
nc_server_ssh_add_authkey_path
int nc_server_ssh_add_authkey_path(const char *pubkey_path, const char *username)
Add an authorized client SSH public key. This public key can be used for publickey authentication (fo...
nc_server_ssh_endpt_set_auth_methods
int nc_server_ssh_endpt_set_auth_methods(const char *endpt_name, int auth_methods)
Set endpoint accepted SSH authentication methods. All (publickey, password, interactive) are supporte...
nc_server_ssh_endpt_get_auth_methods
int nc_server_ssh_endpt_get_auth_methods(const char *endpt_name)
Get endpoint accepted SSH authentication methods.
nc_server_ssh_set_interactive_auth_clb
void nc_server_ssh_set_interactive_auth_clb(int(*interactive_auth_clb)(const struct nc_session *session, const ssh_message msg, void *user_data), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for SSH interactive authentication. If none is set, local system users are used.
nc_server_ssh_del_authkey
int nc_server_ssh_del_authkey(const char *pubkey_path, const char *pubkey_base64, NC_SSH_KEY_TYPE type, const char *username)
Remove an authorized client SSH public key.
nc_server_ssh_add_authkey
int nc_server_ssh_add_authkey(const char *pubkey_base64, NC_SSH_KEY_TYPE type, const char *username)
Add an authorized client SSH public key. This public key can be used for publickey authentication (fo...
nc_server_ssh_endpt_mov_hostkey
int nc_server_ssh_endpt_mov_hostkey(const char *endpt_name, const char *key_mov, const char *key_after)
Move endpoint SSH host key.
nc_server_ssh_endpt_add_hostkey
int nc_server_ssh_endpt_add_hostkey(const char *endpt_name, const char *name, int16_t idx)
Add endpoint SSH host keys the server will identify itself with. Only the name is set,...
nc_server_ssh_endpt_mod_hostkey
int nc_server_ssh_endpt_mod_hostkey(const char *endpt_name, const char *name, const char *new_name)
Modify endpoint SSH host key.
nc_server_ssh_endpt_set_auth_timeout
int nc_server_ssh_endpt_set_auth_timeout(const char *endpt_name, uint16_t auth_timeout)
Set endpoint SSH authentication timeout. 30 seconds by default.
nc_server_ssh_set_passwd_auth_clb
void nc_server_ssh_set_passwd_auth_clb(int(*passwd_auth_clb)(const struct nc_session *session, const char *password, void *user_data), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for SSH password authentication. If none is set, local system users are used.
nc_server_tls_set_verify_clb
void nc_server_tls_set_verify_clb(int(*verify_clb)(const struct nc_session *session))
Set TLS authentication additional verify callback.
nc_session_get_client_cert
const X509 * nc_session_get_client_cert(const struct nc_session *session)
Get client certificate.
nc_server_tls_endpt_set_server_cert
int nc_server_tls_endpt_set_server_cert(const char *endpt_name, const char *name)
Set the server TLS certificate. Only the name is set, the certificate itself wil be retrieved using a...
nc_server_tls_set_trusted_cert_list_clb
void nc_server_tls_set_trusted_cert_list_clb(int(*cert_list_clb)(const char *name, void *user_data, char ***cert_paths, int *cert_path_count, char ***cert_data, int *cert_data_count), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for retrieving trusted certificates.
nc_server_tls_endpt_add_trusted_cert_list
int nc_server_tls_endpt_add_trusted_cert_list(const char *endpt_name, const char *name)
Add a trusted certificate list. Can be both a CA or a client one. Can be safely used together with nc...
nc_server_tls_endpt_del_ctn
int nc_server_tls_endpt_del_ctn(const char *endpt_name, int64_t id, const char *fingerprint, NC_TLS_CTN_MAPTYPE map_type, const char *name)
Remove a cert-to-name entry.
nc_server_tls_set_server_cert_clb
void nc_server_tls_set_server_cert_clb(int(*cert_clb)(const char *name, void *user_data, char **cert_path, char **cert_data, char **privkey_path, char **privkey_data, NC_SSH_KEY_TYPE *privkey_type), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for retrieving server certificate and matching private key.
nc_server_tls_endpt_set_crl_paths
int nc_server_tls_endpt_set_crl_paths(const char *endpt_name, const char *crl_file, const char *crl_dir)
Set Certificate Revocation List locations. There can only be one file and one directory,...
nc_server_tls_endpt_add_ctn
int nc_server_tls_endpt_add_ctn(const char *endpt_name, uint32_t id, const char *fingerprint, NC_TLS_CTN_MAPTYPE map_type, const char *name)
Add a cert-to-name entry.
nc_server_tls_endpt_get_ctn
int nc_server_tls_endpt_get_ctn(const char *endpt_name, uint32_t *id, char **fingerprint, NC_TLS_CTN_MAPTYPE *map_type, char **name)
Get a cert-to-name entry.
nc_server_tls_endpt_clear_crls
void nc_server_tls_endpt_clear_crls(const char *endpt_name)
Destroy and clean CRLs. Certificates, private keys, and CTN entries are not affected.
nc_server_tls_endpt_del_trusted_cert_list
int nc_server_tls_endpt_del_trusted_cert_list(const char *endpt_name, const char *name)
Remove a trusted certificate.
nc_server_tls_endpt_set_trusted_ca_paths
int nc_server_tls_endpt_set_trusted_ca_paths(const char *endpt_name, const char *ca_file, const char *ca_dir)
Set trusted Certificate Authority certificate locations. There can only be one file and one directory...
nc_server_tls_set_server_cert_chain_clb
void nc_server_tls_set_server_cert_chain_clb(int(*cert_chain_clb)(const char *name, void *user_data, char ***cert_paths, int *cert_path_count, char ***cert_data, int *cert_data_count), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for retrieving server certificate chain.
nc_server_destroy
void nc_server_destroy(void)
Destroy any dynamically allocated libssh and/or libssl/libcrypto and server resources.
nc_server_endpt_set_keepalives
int nc_server_endpt_set_keepalives(const char *endpt_name, int idle_time, int max_probes, int probe_interval)
Change endpoint keepalives parameters. Affects only new connections.
nc_server_endpt_set_perms
int nc_server_endpt_set_perms(const char *endpt_name, mode_t mode, uid_t uid, gid_t gid)
Change endpoint permissions.
nc_server_endpt_enable_keepalives
int nc_server_endpt_enable_keepalives(const char *endpt_name, int enable)
Change endpoint keepalives state. Affects only new connections.
nc_server_endpt_set_port
int nc_server_endpt_set_port(const char *endpt_name, uint16_t port)
Change endpoint listening port.
nc_server_get_cpblts_version
const char ** nc_server_get_cpblts_version(struct ly_ctx *ctx, LYS_VERSION version)
Get the server capabilities including the schemas with the specified YANG version.
nc_server_endpt_count
int nc_server_endpt_count(void)
Get the number of currently configured listening endpoints. Note that an ednpoint without address and...
nc_server_set_hello_timeout
void nc_server_set_hello_timeout(uint16_t hello_timeout)
Set server timeout for receiving a hello message.
nc_server_set_capability
int nc_server_set_capability(const char *value)
Set capability of the server.
nc_server_get_capab_withdefaults
void nc_server_get_capab_withdefaults(NC_WD_MODE *basic_mode, int *also_supported)
Get with-defaults capability extra parameters.
nc_server_add_endpt
int nc_server_add_endpt(const char *name, NC_TRANSPORT_IMPL ti)
Add a new endpoint.
nc_server_is_endpt
int nc_server_is_endpt(const char *name)
Check if an endpoint exists.
nc_server_del_endpt
int nc_server_del_endpt(const char *name, NC_TRANSPORT_IMPL ti)
Stop listening on and remove an endpoint.
nc_server_set_idle_timeout
void nc_server_set_idle_timeout(uint16_t idle_timeout)
Set server timeout for dropping an idle session.
nc_server_endpt_set_address
int nc_server_endpt_set_address(const char *endpt_name, const char *address)
Change endpoint listening address.
nc_server_set_capab_withdefaults
int nc_server_set_capab_withdefaults(NC_WD_MODE basic_mode, int also_supported)
Set the with-defaults capability extra parameters.
nc_server_set_content_id_clb
void nc_server_set_content_id_clb(char *(*content_id_clb)(void *user_data), void *user_data, void(*free_user_data)(void *user_data))
Set the callback for getting yang-library capability identifier. If none is set, libyang context chan...
nc_server_get_hello_timeout
uint16_t nc_server_get_hello_timeout(void)
get server timeout for receiving a hello message.
nc_server_get_idle_timeout
uint16_t nc_server_get_idle_timeout(void)
Get server timeout for dropping an idle session.
nc_server_init
int nc_server_init(struct ly_ctx *ctx)
Initialize libssh and/or libssl/libcrypto and the server using a libyang context.
nc_server_get_cpblts
const char ** nc_server_get_cpblts(struct ly_ctx *ctx)
Get all the server capabilities including all the schemas.
netconf.h
libnetconf2's general public functions and structures definitions.
session.h
libnetconf2 session manipulation
NC_TLS_CTN_MAPTYPE
NC_TLS_CTN_MAPTYPE
Enumeration of cert-to-name mapping types.
Definition: session.h:42
NC_STATUS
NC_STATUS
Enumeration of possible session statuses.
Definition: session.h:57
NC_SSH_KEY_TYPE
NC_SSH_KEY_TYPE
Enumeration of SSH key types.
Definition: session.h:102
NC_TRANSPORT_IMPL
NC_TRANSPORT_IMPL
Enumeration of transport implementations (ways how libnetconf implements NETCONF transport protocol)
Definition: session.h:68