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>
#include <sys/types.h>

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

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

typedef struct nc_server_reply *(*nc_rpc_clb)(struct lyd_node *rpc, struct nc_session *session);

typedef void (*nc_cert_exp_notif_clb)(const char *expiration_time, const char *xpath, void *user_data);

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);

struct nc_server_reply *nc_clb_default_get_schema(struct lyd_node *rpc, struct nc_session *session);

struct nc_server_reply *nc_clb_default_close_session(struct lyd_node *rpc, struct nc_session *session);

int nc_server_init(void);

void nc_server_destroy(void);

int nc_server_init_ctx(struct ly_ctx **ctx);

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));

char **nc_server_get_cpblts(const struct ly_ctx *ctx);

char **nc_server_get_cpblts_version(const struct ly_ctx *ctx, LYS_VERSION version);

NC_MSG_TYPE nc_accept_inout(int fdin, int fdout, const char *username, const struct ly_ctx *ctx,
        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);

typedef int (*nc_ps_session_match_cb)(struct nc_session *session, void *cb_data);

struct nc_session *nc_ps_find_session(const struct nc_pollsession *ps, nc_ps_session_match_cb match_cb, void *cb_data);

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_TLS
# define NC_PSPOLL_SSH_MSG 0x00100      
# define NC_PSPOLL_SSH_CHANNEL 0x0200   
#endif /* NC_ENABLED_SSH_TLS */

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_endpt_count(void);

int nc_server_add_endpt_unix_socket_listen(const char *endpt_name, const char *unix_socket_path, mode_t mode, uid_t uid, gid_t gid);

void nc_server_del_endpt_unix_socket(const char *endpt_name);

NC_MSG_TYPE nc_accept(int timeout, const struct ly_ctx *ctx, struct nc_session **session);

#ifdef NC_ENABLED_SSH_TLS

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_set_authkey_path_format(const char *path);

typedef int (*nc_server_ssh_interactive_auth_clb)(const struct nc_session *session,
        ssh_session ssh_sess, ssh_message msg, void *user_data);

void nc_server_ssh_set_interactive_auth_clb(nc_server_ssh_interactive_auth_clb auth_clb, void *user_data, void (*free_user_data)(void *user_data));

int nc_server_ssh_kbdint_get_nanswers(const struct nc_session *session, ssh_session libssh_session);

int nc_server_ssh_set_pam_conf_filename(const char *filename);

const void *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_SSH_TLS */

struct timespec 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);

#ifdef NC_ENABLED_SSH_TLS

int nc_server_notif_cert_expiration_thread_start(nc_cert_exp_notif_clb cert_exp_notif_clb,
        void *user_data, void (*free_data)(void *));

void nc_server_notif_cert_expiration_thread_stop(int wait);

#endif /* NC_ENABLED_SSH_TLS */

#ifdef __cplusplus
}
#endif

#endif /* NC_SESSION_SERVER_H_ */