session_client.h

Go to the documentation of this file.

#ifndef NC_SESSION_CLIENT_H_
#define NC_SESSION_CLIENT_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <libyang/libyang.h>

#include "messages_client.h"
#include "netconf.h"
#include "session.h"

#ifdef NC_ENABLED_SSH_TLS
# include <libssh/libssh.h>
#endif /* NC_ENABLED_SSH_TLS */

int nc_client_set_schema_searchpath(const char *path);

const char *nc_client_get_schema_searchpath(void);

int nc_client_set_schema_callback(ly_module_imp_clb clb, void *user_data);

ly_module_imp_clb nc_client_get_schema_callback(void **user_data);

void nc_client_set_new_session_context_autofill(int enabled);

int nc_client_set_new_session_context_schema_mount(struct nc_session *session);

void nc_client_set_thread_context(void *context);

void *nc_client_get_thread_context(void);

int nc_client_init(void);

void nc_client_destroy(void);

struct nc_session *nc_connect_inout(int fdin, int fdout, struct ly_ctx *ctx);

struct nc_session *nc_connect_unix(const char *address, struct ly_ctx *ctx);

#ifdef NC_ENABLED_SSH_TLS

void nc_client_ssh_set_knownhosts_mode(NC_SSH_KNOWNHOSTS_MODE mode);

int nc_client_ssh_set_knownhosts_path(const char *path);

void nc_client_ssh_set_auth_password_clb(char *(*auth_password)(const char *username, const char *hostname, void *priv),
        void *priv);

void nc_client_ssh_get_auth_password_clb(char *(**auth_password)(const char *username, const char *hostname, void *priv),
        void **priv);

void nc_client_ssh_set_auth_interactive_clb(char *(*auth_interactive)(const char *auth_name, const char *instruction,
        const char *prompt, int echo, void *priv),
        void *priv);

void nc_client_ssh_get_auth_interactive_clb(char *(**auth_interactive)(const char *auth_name, const char *instruction,
        const char *prompt, int echo, void *priv),
        void **priv);

void nc_client_ssh_set_auth_privkey_passphrase_clb(char *(*auth_privkey_passphrase)(const char *privkey_path, void *priv),
        void *priv);

void nc_client_ssh_get_auth_privkey_passphrase_clb(char *(**auth_privkey_passphrase)(const char *privkey_path, void *priv),
        void **priv);

int nc_client_ssh_add_keypair(const char *pub_key, const char *priv_key);

int nc_client_ssh_del_keypair(int idx);

int nc_client_ssh_get_keypair_count(void);

int nc_client_ssh_get_keypair(int idx, const char **pub_key, const char **priv_key);

void nc_client_ssh_set_auth_pref(NC_SSH_AUTH_TYPE auth_type, int16_t pref);

int16_t nc_client_ssh_get_auth_pref(NC_SSH_AUTH_TYPE auth_type);

int nc_client_ssh_set_username(const char *username);

const char *nc_client_ssh_get_username(void);

struct nc_session *nc_connect_ssh(const char *host, uint16_t port, struct ly_ctx *ctx);

struct nc_session *nc_connect_libssh(ssh_session ssh_session, struct ly_ctx *ctx);

struct nc_session *nc_connect_ssh_channel(struct nc_session *session, struct ly_ctx *ctx);

int nc_client_tls_set_cert_key_paths(const char *client_cert, const char *client_key);

void nc_client_tls_get_cert_key_paths(const char **client_cert, const char **client_key);

int nc_client_tls_set_trusted_ca_paths(const char *ca_file, const char *ca_dir);

void nc_client_tls_get_trusted_ca_paths(const char **ca_file, const char **ca_dir);

int nc_client_tls_set_crl_paths(const char *crl_file, const char *crl_dir);

void nc_client_tls_get_crl_paths(const char **crl_file, const char **crl_dir);

struct nc_session *nc_connect_tls(const char *host, uint16_t port, struct ly_ctx *ctx);

struct nc_session *nc_connect_libssl(void *tls, struct ly_ctx *ctx);

#endif /* NC_ENABLED_SSH_TLS */

const char * const *nc_session_get_cpblts(const struct nc_session *session);

const char *nc_session_cpblt(const struct nc_session *session, const char *capab);

int nc_session_ntf_thread_running(const struct nc_session *session);

NC_MSG_TYPE nc_recv_reply(struct nc_session *session, struct nc_rpc *rpc, uint64_t msgid, int timeout,
        struct lyd_node **envp, struct lyd_node **op);

NC_MSG_TYPE nc_recv_notif(struct nc_session *session, int timeout, struct lyd_node **envp, struct lyd_node **op);

typedef void (*nc_notif_dispatch_clb)(struct nc_session *session, const struct lyd_node *envp, const struct lyd_node *op,
        void *user_data);

int nc_recv_notif_dispatch(struct nc_session *session, nc_notif_dispatch_clb notif_clb);

int nc_recv_notif_dispatch_data(struct nc_session *session, nc_notif_dispatch_clb notif_clb, void *user_data,
        void (*free_data)(void *));

NC_MSG_TYPE nc_send_rpc(struct nc_session *session, struct nc_rpc *rpc, int timeout, uint64_t *msgid);

void nc_client_session_set_not_strict(struct nc_session *session);

typedef void (*nc_client_monitoring_clb)(struct nc_session *session, void *user_data);

int nc_client_monitoring_thread_start(nc_client_monitoring_clb monitoring_clb, void *user_data, void (*free_data)(void *));

void nc_client_monitoring_thread_stop(void);

void nc_client_enable_tcp_keepalives(int enable);

void nc_client_set_tcp_keepalives(uint16_t idle_time, uint16_t max_probes, uint16_t probe_interval);

#ifdef __cplusplus
}
#endif

#endif /* NC_SESSION_CLIENT_H_ */