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 <stdint.h>
#include <libyang/libyang.h>

#ifdef NC_ENABLED_TLS
#   include <openssl/x509.h>
#endif

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

#include "session.h"
#include "netconf.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_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_set_notif_status(struct nc_session *session, int notif_status);

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_ */