Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 1 | /** |
| 2 | * \file session_p.h |
| 3 | * \author Radek Krejci <rkrejci@cesnet.cz> |
Michal Vasko | b48aa81 | 2016-01-18 14:13:09 +0100 | [diff] [blame] | 4 | * \author Michal Vasko <mvasko@cesnet.cz> |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 5 | * \brief libnetconf2 session manipulation |
| 6 | * |
Michal Vasko | 4c1fb49 | 2017-01-30 14:31:07 +0100 | [diff] [blame] | 7 | * Copyright (c) 2017 CESNET, z.s.p.o. |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 8 | * |
Radek Krejci | 9b81f5b | 2016-02-24 13:14:49 +0100 | [diff] [blame] | 9 | * This source code is licensed under BSD 3-Clause License (the "License"). |
| 10 | * You may not use this file except in compliance with the License. |
| 11 | * You may obtain a copy of the License at |
Michal Vasko | afd416b | 2016-02-25 14:51:46 +0100 | [diff] [blame] | 12 | * |
Radek Krejci | 9b81f5b | 2016-02-24 13:14:49 +0100 | [diff] [blame] | 13 | * https://opensource.org/licenses/BSD-3-Clause |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 14 | */ |
| 15 | |
| 16 | #ifndef NC_SESSION_PRIVATE_H_ |
| 17 | #define NC_SESSION_PRIVATE_H_ |
| 18 | |
Radek Krejci | fe0b347 | 2015-10-12 13:43:42 +0200 | [diff] [blame] | 19 | #include <stdint.h> |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 20 | #include <pthread.h> |
| 21 | |
Michal Vasko | 4ef1493 | 2015-12-04 11:09:10 +0100 | [diff] [blame] | 22 | #include <libyang/libyang.h> |
Michal Vasko | 7bcb48e | 2016-01-15 10:28:54 +0100 | [diff] [blame] | 23 | |
Michal Vasko | 4ef1493 | 2015-12-04 11:09:10 +0100 | [diff] [blame] | 24 | #include "libnetconf.h" |
Michal Vasko | 7bcb48e | 2016-01-15 10:28:54 +0100 | [diff] [blame] | 25 | #include "netconf.h" |
Michal Vasko | 4ef1493 | 2015-12-04 11:09:10 +0100 | [diff] [blame] | 26 | #include "session.h" |
Michal Vasko | a8ad448 | 2016-01-28 14:25:54 +0100 | [diff] [blame] | 27 | #include "messages_client.h" |
Michal Vasko | 4ef1493 | 2015-12-04 11:09:10 +0100 | [diff] [blame] | 28 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 29 | #ifdef NC_ENABLED_SSH |
Michal Vasko | 4ef1493 | 2015-12-04 11:09:10 +0100 | [diff] [blame] | 30 | |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 31 | # include <libssh/libssh.h> |
| 32 | # include <libssh/callbacks.h> |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 33 | # include <libssh/server.h> |
Michal Vasko | 7b62fed | 2015-10-26 15:39:46 +0100 | [diff] [blame] | 34 | |
| 35 | /* seconds */ |
Michal Vasko | c111ac5 | 2015-12-08 14:36:36 +0100 | [diff] [blame] | 36 | # define NC_SSH_TIMEOUT 10 |
Michal Vasko | 5c2f795 | 2016-01-22 13:16:31 +0100 | [diff] [blame] | 37 | /* number of all supported authentication methods */ |
Michal Vasko | c111ac5 | 2015-12-08 14:36:36 +0100 | [diff] [blame] | 38 | # define NC_SSH_AUTH_COUNT 3 |
Michal Vasko | 7b62fed | 2015-10-26 15:39:46 +0100 | [diff] [blame] | 39 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 40 | /* ACCESS unlocked */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 41 | struct nc_client_ssh_opts { |
Michal Vasko | 7b62fed | 2015-10-26 15:39:46 +0100 | [diff] [blame] | 42 | /* SSH authentication method preferences */ |
| 43 | struct { |
| 44 | NC_SSH_AUTH_TYPE type; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 45 | int16_t value; |
Michal Vasko | c111ac5 | 2015-12-08 14:36:36 +0100 | [diff] [blame] | 46 | } auth_pref[NC_SSH_AUTH_COUNT]; |
Michal Vasko | 7b62fed | 2015-10-26 15:39:46 +0100 | [diff] [blame] | 47 | |
| 48 | /* SSH key pairs */ |
| 49 | struct { |
| 50 | char *pubkey_path; |
| 51 | char *privkey_path; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 52 | int8_t privkey_crypt; |
Michal Vasko | 7b62fed | 2015-10-26 15:39:46 +0100 | [diff] [blame] | 53 | } *keys; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 54 | uint16_t key_count; |
| 55 | |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 56 | /* SSH authentication callbacks */ |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 57 | int (*auth_hostkey_check)(const char *, ssh_session, void *); |
| 58 | char *(*auth_password)(const char *, const char *, void *); |
| 59 | char *(*auth_interactive)(const char *, const char *, const char *, int, void *); |
| 60 | char *(*auth_privkey_passphrase)(const char *, void *); |
| 61 | |
| 62 | /* private data for the callbacks */ |
| 63 | void *auth_hostkey_check_priv; |
| 64 | void *auth_password_priv; |
| 65 | void *auth_interactive_priv; |
| 66 | void *auth_privkey_passphrase_priv; |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 67 | |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 68 | char *username; |
Michal Vasko | 7b62fed | 2015-10-26 15:39:46 +0100 | [diff] [blame] | 69 | }; |
| 70 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 71 | /* ACCESS locked, separate locks */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 72 | struct nc_server_ssh_opts { |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 73 | /* SSH bind options */ |
| 74 | const char **hostkeys; |
| 75 | uint8_t hostkey_count; |
| 76 | const char *banner; |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 77 | |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 78 | int auth_methods; |
| 79 | uint16_t auth_attempts; |
| 80 | uint16_t auth_timeout; |
| 81 | }; |
| 82 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 83 | #endif /* NC_ENABLED_SSH */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 84 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 85 | #ifdef NC_ENABLED_TLS |
Michal Vasko | 4ef1493 | 2015-12-04 11:09:10 +0100 | [diff] [blame] | 86 | |
Michal Vasko | c111ac5 | 2015-12-08 14:36:36 +0100 | [diff] [blame] | 87 | # include <openssl/bio.h> |
| 88 | # include <openssl/ssl.h> |
Michal Vasko | 11d4cdb | 2015-10-29 11:42:52 +0100 | [diff] [blame] | 89 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 90 | /* ACCESS unlocked */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 91 | struct nc_client_tls_opts { |
| 92 | char *cert_path; |
| 93 | char *key_path; |
| 94 | char *ca_file; |
| 95 | char *ca_dir; |
| 96 | int8_t tls_ctx_change; |
Michal Vasko | 11d4cdb | 2015-10-29 11:42:52 +0100 | [diff] [blame] | 97 | SSL_CTX *tls_ctx; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 98 | |
| 99 | char *crl_file; |
| 100 | char *crl_dir; |
| 101 | int8_t crl_store_change; |
| 102 | X509_STORE *crl_store; |
Michal Vasko | 11d4cdb | 2015-10-29 11:42:52 +0100 | [diff] [blame] | 103 | }; |
| 104 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 105 | /* ACCESS locked, separate locks */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 106 | struct nc_server_tls_opts { |
Michal Vasko | 4c1fb49 | 2017-01-30 14:31:07 +0100 | [diff] [blame] | 107 | const char *server_cert; |
| 108 | const char **trusted_cert_lists; |
| 109 | uint16_t trusted_cert_list_count; |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 110 | const char *trusted_ca_file; |
| 111 | const char *trusted_ca_dir; |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 112 | X509_STORE *crl_store; |
| 113 | |
Michal Vasko | 5e3f339 | 2016-01-20 11:13:01 +0100 | [diff] [blame] | 114 | struct nc_ctn { |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 115 | uint32_t id; |
| 116 | const char *fingerprint; |
Michal Vasko | c14e3c8 | 2016-01-11 16:14:30 +0100 | [diff] [blame] | 117 | NC_TLS_CTN_MAPTYPE map_type; |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 118 | const char *name; |
Michal Vasko | 5e3f339 | 2016-01-20 11:13:01 +0100 | [diff] [blame] | 119 | struct nc_ctn *next; |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 120 | } *ctn; |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 121 | }; |
| 122 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 123 | #endif /* NC_ENABLED_TLS */ |
Radek Krejci | 4339024 | 2015-10-08 15:34:04 +0200 | [diff] [blame] | 124 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 125 | /* ACCESS unlocked */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 126 | struct nc_client_opts { |
| 127 | char *schema_searchpath; |
| 128 | |
| 129 | struct nc_bind { |
| 130 | const char *address; |
| 131 | uint16_t port; |
| 132 | int sock; |
Michal Vasko | 0a3f375 | 2016-10-13 14:58:38 +0200 | [diff] [blame] | 133 | int pollin; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 134 | } *ch_binds; |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 135 | NC_TRANSPORT_IMPL *ch_bind_ti; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 136 | uint16_t ch_bind_count; |
| 137 | }; |
| 138 | |
Radek Krejci | 62aa064 | 2017-05-25 16:33:49 +0200 | [diff] [blame] | 139 | /* ACCESS unlocked */ |
| 140 | struct nc_client_context { |
Radek Krejci | 5cebc6b | 2017-05-26 13:24:38 +0200 | [diff] [blame] | 141 | unsigned int refcount; |
Radek Krejci | 62aa064 | 2017-05-25 16:33:49 +0200 | [diff] [blame] | 142 | struct nc_client_opts opts; |
| 143 | #ifdef NC_ENABLED_SSH |
| 144 | struct nc_client_ssh_opts ssh_opts; |
| 145 | struct nc_client_ssh_opts ssh_ch_opts; |
| 146 | #endif /* NC_ENABLED_SSH */ |
| 147 | #ifdef NC_ENABLED_TLS |
| 148 | struct nc_client_tls_opts tls_opts; |
| 149 | struct nc_client_tls_opts tls_ch_opts; |
| 150 | #endif /* NC_ENABLED_TLS */ |
| 151 | }; |
| 152 | |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 153 | struct nc_server_opts { |
Michal Vasko | a43589b | 2016-02-17 13:24:59 +0100 | [diff] [blame] | 154 | /* ACCESS unlocked (dictionary locked internally in libyang) */ |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 155 | struct ly_ctx *ctx; |
| 156 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 157 | /* ACCESS unlocked */ |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 158 | NC_WD_MODE wd_basic_mode; |
| 159 | int wd_also_supported; |
Radek Krejci | 658782b | 2016-12-04 22:04:55 +0100 | [diff] [blame] | 160 | unsigned int capabilities_count; |
| 161 | const char **capabilities; |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 162 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 163 | /* ACCESS unlocked */ |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 164 | uint16_t hello_timeout; |
| 165 | uint16_t idle_timeout; |
Michal Vasko | 7060bcf | 2016-11-28 14:48:11 +0100 | [diff] [blame] | 166 | #ifdef NC_ENABLED_TLS |
| 167 | int (*user_verify_clb)(const struct nc_session *session); |
Michal Vasko | 4c1fb49 | 2017-01-30 14:31:07 +0100 | [diff] [blame] | 168 | |
| 169 | int (*server_cert_clb)(const char *name, void *user_data, char **cert_path, char **cert_data,char **privkey_path, |
| 170 | char **privkey_data, int *privkey_data_rsa); |
| 171 | void *server_cert_data; |
| 172 | void (*server_cert_data_free)(void *data); |
| 173 | |
| 174 | int (*trusted_cert_list_clb)(const char *name, void *user_data, char ***cert_paths, int *cert_path_count, |
| 175 | char ***cert_data, int *cert_data_count); |
| 176 | void *trusted_cert_list_data; |
| 177 | void (*trusted_cert_list_data_free)(void *data); |
Michal Vasko | 7060bcf | 2016-11-28 14:48:11 +0100 | [diff] [blame] | 178 | #endif |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 179 | |
Michal Vasko | 17dfda9 | 2016-12-01 14:06:16 +0100 | [diff] [blame] | 180 | #ifdef NC_ENABLED_SSH |
| 181 | /* ACCESS locked with authkey_lock */ |
| 182 | struct { |
| 183 | const char *path; |
| 184 | const char *base64; |
| 185 | NC_SSH_KEY_TYPE type; |
| 186 | const char *username; |
| 187 | } *authkeys; |
| 188 | uint16_t authkey_count; |
| 189 | pthread_mutex_t authkey_lock; |
Michal Vasko | 4c1fb49 | 2017-01-30 14:31:07 +0100 | [diff] [blame] | 190 | |
| 191 | int (*hostkey_clb)(const char *name, void *user_data, char **privkey_path, char **privkey_data, int *privkey_data_rsa); |
| 192 | void *hostkey_data; |
| 193 | void (*hostkey_data_free)(void *data); |
Michal Vasko | 17dfda9 | 2016-12-01 14:06:16 +0100 | [diff] [blame] | 194 | #endif |
| 195 | |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 196 | /* ACCESS locked, add/remove endpts/binds - bind_lock + WRITE endpt_lock (strict order!) |
| 197 | * modify endpts - WRITE endpt_lock |
| 198 | * access endpts - READ endpt_lock |
| 199 | * modify/poll binds - bind_lock */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 200 | struct nc_bind *binds; |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 201 | pthread_mutex_t bind_lock; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 202 | struct nc_endpt { |
| 203 | const char *name; |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 204 | NC_TRANSPORT_IMPL ti; |
| 205 | union { |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 206 | #ifdef NC_ENABLED_SSH |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 207 | struct nc_server_ssh_opts *ssh; |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 208 | #endif |
Michal Vasko | 6b15106 | 2016-08-22 16:20:47 +0200 | [diff] [blame] | 209 | #ifdef NC_ENABLED_TLS |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 210 | struct nc_server_tls_opts *tls; |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 211 | #endif |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 212 | } opts; |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 213 | } *endpts; |
| 214 | uint16_t endpt_count; |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 215 | pthread_rwlock_t endpt_lock; |
| 216 | |
| 217 | /* ACCESS locked, add/remove CH clients - WRITE lock ch_client_lock |
| 218 | * modify CH clients - READ lock ch_client_lock + ch_client_lock */ |
| 219 | struct nc_ch_client { |
| 220 | const char *name; |
| 221 | NC_TRANSPORT_IMPL ti; |
| 222 | struct nc_ch_endpt { |
| 223 | const char *name; |
| 224 | const char *address; |
| 225 | uint16_t port; |
| 226 | } *ch_endpts; |
| 227 | uint16_t ch_endpt_count; |
| 228 | union { |
| 229 | #ifdef NC_ENABLED_SSH |
| 230 | struct nc_server_ssh_opts *ssh; |
| 231 | #endif |
| 232 | #ifdef NC_ENABLED_TLS |
| 233 | struct nc_server_tls_opts *tls; |
| 234 | #endif |
| 235 | } opts; |
| 236 | NC_CH_CONN_TYPE conn_type; |
| 237 | union { |
| 238 | struct { |
| 239 | uint32_t idle_timeout; |
| 240 | uint16_t ka_max_wait; |
| 241 | uint8_t ka_max_attempts; |
| 242 | } persist; |
| 243 | struct { |
| 244 | uint16_t idle_timeout; |
| 245 | uint16_t reconnect_timeout; |
| 246 | } period; |
| 247 | } conn; |
| 248 | NC_CH_START_WITH start_with; |
| 249 | uint8_t max_attempts; |
| 250 | pthread_mutex_t lock; |
| 251 | } *ch_clients; |
| 252 | uint16_t ch_client_count; |
| 253 | pthread_rwlock_t ch_client_lock; |
Michal Vasko | b48aa81 | 2016-01-18 14:13:09 +0100 | [diff] [blame] | 254 | |
Michal Vasko | 7227f35 | 2016-02-01 12:11:40 +0100 | [diff] [blame] | 255 | /* ACCESS locked with sid_lock */ |
Michal Vasko | b48aa81 | 2016-01-18 14:13:09 +0100 | [diff] [blame] | 256 | uint32_t new_session_id; |
| 257 | pthread_spinlock_t sid_lock; |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 258 | }; |
| 259 | |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 260 | /** |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 261 | * Sleep time in msec to wait between nc_recv_notif() calls. |
Michal Vasko | a8ad448 | 2016-01-28 14:25:54 +0100 | [diff] [blame] | 262 | */ |
| 263 | #define NC_CLIENT_NOTIF_THREAD_SLEEP 10000 |
| 264 | |
| 265 | /** |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 266 | * Timeout in msec for transport-related data to arrive (ssh_handle_key_exchange(), SSL_accept(), SSL_connect()). |
Michal Vasko | 36c7be8 | 2017-02-22 13:37:59 +0100 | [diff] [blame] | 267 | * It can be quite a lot on slow machines (waiting for TLS cert-to-name resolution, ...). |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 268 | */ |
Michal Vasko | 23edb63 | 2017-02-23 15:15:52 +0100 | [diff] [blame] | 269 | #define NC_TRANSPORT_TIMEOUT 10000 |
Michal Vasko | 36c7be8 | 2017-02-22 13:37:59 +0100 | [diff] [blame] | 270 | |
| 271 | /** |
| 272 | * Timeout in msec for acquiring a lock of a session (used with a condition, so higher numbers could be required |
| 273 | * only in case of extreme concurrency). |
| 274 | */ |
| 275 | #define NC_SESSION_LOCK_TIMEOUT 500 |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 276 | |
| 277 | /** |
Michal Vasko | f471fa0 | 2017-02-15 10:48:12 +0100 | [diff] [blame] | 278 | * Timeout in msec for acquiring a lock of a session that is supposed to be freed. |
| 279 | */ |
Michal Vasko | 36c7be8 | 2017-02-22 13:37:59 +0100 | [diff] [blame] | 280 | #define NC_SESSION_FREE_LOCK_TIMEOUT 1000 |
Michal Vasko | f471fa0 | 2017-02-15 10:48:12 +0100 | [diff] [blame] | 281 | |
| 282 | /** |
| 283 | * Timeout in msec for acquiring a lock of a pollsession structure. |
| 284 | */ |
| 285 | #define NC_PS_LOCK_TIMEOUT 500 |
| 286 | |
| 287 | /** |
Michal Vasko | 1a22db4 | 2017-03-17 09:09:15 +0100 | [diff] [blame] | 288 | * Time slept in msec if no endpoint was created for a running Call Home client. |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 289 | */ |
| 290 | #define NC_CH_NO_ENDPT_WAIT 1000 |
| 291 | |
| 292 | /** |
Michal Vasko | 1a22db4 | 2017-03-17 09:09:15 +0100 | [diff] [blame] | 293 | * Time slept in msec after a failed Call Home endpoint session creation. |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 294 | */ |
| 295 | #define NC_CH_ENDPT_FAIL_WAIT 1000 |
| 296 | |
| 297 | /** |
Michal Vasko | 80cad7f | 2015-12-08 14:42:27 +0100 | [diff] [blame] | 298 | * Number of sockets kept waiting to be accepted. |
| 299 | */ |
Michal Vasko | 0a3f375 | 2016-10-13 14:58:38 +0200 | [diff] [blame] | 300 | #define NC_REVERSE_QUEUE 5 |
Michal Vasko | 80cad7f | 2015-12-08 14:42:27 +0100 | [diff] [blame] | 301 | |
| 302 | /** |
Michal Vasko | 5c2f795 | 2016-01-22 13:16:31 +0100 | [diff] [blame] | 303 | * @brief Type of the session |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 304 | */ |
| 305 | typedef enum { |
Radek Krejci | 695d4fa | 2015-10-22 13:23:54 +0200 | [diff] [blame] | 306 | NC_CLIENT, /**< client side */ |
| 307 | NC_SERVER /**< server side */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 308 | } NC_SIDE; |
| 309 | |
| 310 | /** |
| 311 | * @brief Enumeration of the supported NETCONF protocol versions |
| 312 | */ |
| 313 | typedef enum { |
Michal Vasko | 5c2f795 | 2016-01-22 13:16:31 +0100 | [diff] [blame] | 314 | NC_VERSION_10 = 0, /**< NETCONF 1.0 - RFC 4741, 4742 */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 315 | NC_VERSION_11 = 1 /**< NETCONF 1.1 - RFC 6241, 6242 */ |
| 316 | } NC_VERSION; |
| 317 | |
| 318 | #define NC_VERSION_10_ENDTAG "]]>]]>" |
| 319 | #define NC_VERSION_10_ENDTAG_LEN 6 |
| 320 | |
| 321 | /** |
Michal Vasko | ad61170 | 2015-12-03 13:41:51 +0100 | [diff] [blame] | 322 | * @brief Container to serialize PRC messages |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 323 | */ |
Michal Vasko | ad61170 | 2015-12-03 13:41:51 +0100 | [diff] [blame] | 324 | struct nc_msg_cont { |
| 325 | struct lyxml_elem *msg; |
| 326 | struct nc_msg_cont *next; |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 327 | }; |
| 328 | |
| 329 | /** |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 330 | * @brief NETCONF session structure |
| 331 | */ |
| 332 | struct nc_session { |
Radek Krejci | 695d4fa | 2015-10-22 13:23:54 +0200 | [diff] [blame] | 333 | NC_STATUS status; /**< status of the session */ |
Michal Vasko | 428087d | 2016-01-14 16:04:28 +0100 | [diff] [blame] | 334 | NC_SESSION_TERM_REASON term_reason; /**< reason of termination, if status is NC_STATUS_INVALID */ |
Radek Krejci | 695d4fa | 2015-10-22 13:23:54 +0200 | [diff] [blame] | 335 | NC_SIDE side; /**< side of the session: client or server */ |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 336 | |
| 337 | /* NETCONF data */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 338 | uint32_t id; /**< NETCONF session ID (session-id-type) */ |
| 339 | NC_VERSION version; /**< NETCONF protocol version */ |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 340 | |
| 341 | /* Transport implementation */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 342 | NC_TRANSPORT_IMPL ti_type; /**< transport implementation type to select items from ti union */ |
Radek Krejci | 695d4fa | 2015-10-22 13:23:54 +0200 | [diff] [blame] | 343 | pthread_mutex_t *ti_lock; /**< lock to access ti. Note that in case of libssh TI, it can be shared with other |
Michal Vasko | b7ea243 | 2015-10-26 15:38:40 +0100 | [diff] [blame] | 344 | NETCONF sessions on the same SSH session (but different SSH channel) */ |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 345 | pthread_cond_t *ti_cond; /**< ti_inuse condition */ |
| 346 | volatile int *ti_inuse; /**< variable indicating whether TI is being communicated on or not, protected by |
| 347 | ti_cond and ti_lock */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 348 | union { |
| 349 | struct { |
| 350 | int in; /**< input file descriptor */ |
| 351 | int out; /**< output file descriptor */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 352 | } fd; /**< NC_TI_FD transport implementation structure */ |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 353 | #ifdef NC_ENABLED_SSH |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 354 | struct { |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 355 | ssh_channel channel; |
Radek Krejci | 695d4fa | 2015-10-22 13:23:54 +0200 | [diff] [blame] | 356 | ssh_session session; |
| 357 | struct nc_session *next; /**< pointer to the next NETCONF session on the same |
| 358 | SSH session, but different SSH channel. If no such session exists, it is NULL. |
| 359 | otherwise there is a ring list of the NETCONF sessions */ |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 360 | } libssh; |
| 361 | #endif |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 362 | #ifdef NC_ENABLED_TLS |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 363 | SSL *tls; |
| 364 | #endif |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 365 | } ti; /**< transport implementation data */ |
Radek Krejci | ac6d347 | 2015-10-22 15:47:18 +0200 | [diff] [blame] | 366 | const char *username; |
| 367 | const char *host; |
Michal Vasko | 38a7c6c | 2015-12-04 12:29:20 +0100 | [diff] [blame] | 368 | uint16_t port; |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 369 | |
| 370 | /* other */ |
| 371 | struct ly_ctx *ctx; /**< libyang context of the session */ |
Michal Vasko | 2cc4c68 | 2016-03-01 09:16:48 +0100 | [diff] [blame] | 372 | void *data; /**< arbitrary user data */ |
Radek Krejci | 695d4fa | 2015-10-22 13:23:54 +0200 | [diff] [blame] | 373 | uint8_t flags; /**< various flags of the session - TODO combine with status and/or side */ |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 374 | #define NC_SESSION_SHAREDCTX 0x01 |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 375 | #define NC_SESSION_CALLHOME 0x02 |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 376 | |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 377 | union { |
| 378 | struct { |
Radek Krejci | f637ba8 | 2016-10-18 14:18:14 +0200 | [diff] [blame] | 379 | /* client side only data */ |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 380 | uint64_t msgid; |
Michal Vasko | 2cb24b4 | 2017-05-23 14:59:11 +0200 | [diff] [blame] | 381 | char **cpblts; /**< list of server's capabilities on client side */ |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 382 | struct nc_msg_cont *replies; /**< queue for RPC replies received instead of notifications */ |
| 383 | struct nc_msg_cont *notifs; /**< queue for notifications received instead of RPC reply */ |
Radek Krejci | f637ba8 | 2016-10-18 14:18:14 +0200 | [diff] [blame] | 384 | volatile pthread_t *ntf_tid; /**< running notifications receiving thread */ |
Michal Vasko | eee9941 | 2016-11-21 10:19:43 +0100 | [diff] [blame] | 385 | |
| 386 | /* client flags */ |
| 387 | /* some server modules failed to load so the data from them will be ignored - not use strict flag for parsing */ |
| 388 | # define NC_SESSION_CLIENT_NOT_STRICT 0x40 |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 389 | } client; |
| 390 | struct { |
Radek Krejci | f637ba8 | 2016-10-18 14:18:14 +0200 | [diff] [blame] | 391 | /* server side only data */ |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 392 | time_t session_start; /**< time the session was created */ |
| 393 | time_t last_rpc; /**< time the last RPC was received on this session */ |
Michal Vasko | 3486a7c | 2017-03-03 13:28:07 +0100 | [diff] [blame] | 394 | int ntf_status; /**< flag whether the session is subscribed to any stream */ |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 395 | pthread_mutex_t *ch_lock; /**< Call Home thread lock */ |
| 396 | pthread_cond_t *ch_cond; /**< Call Home thread condition */ |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 397 | |
Michal Vasko | eee9941 | 2016-11-21 10:19:43 +0100 | [diff] [blame] | 398 | /* server flags */ |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 399 | #ifdef NC_ENABLED_SSH |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 400 | /* SSH session authenticated */ |
| 401 | # define NC_SESSION_SSH_AUTHENTICATED 0x04 |
| 402 | /* netconf subsystem requested */ |
| 403 | # define NC_SESSION_SSH_SUBSYS_NETCONF 0x08 |
| 404 | /* new SSH message arrived */ |
| 405 | # define NC_SESSION_SSH_NEW_MSG 0x10 |
| 406 | /* this session is passed to nc_sshcb_msg() */ |
| 407 | # define NC_SESSION_SSH_MSG_CB 0x20 |
Michal Vasko | 06e2243 | 2016-01-15 10:30:06 +0100 | [diff] [blame] | 408 | |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 409 | uint16_t ssh_auth_attempts; /**< number of failed SSH authentication attempts */ |
Michal Vasko | c14e3c8 | 2016-01-11 16:14:30 +0100 | [diff] [blame] | 410 | #endif |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 411 | #ifdef NC_ENABLED_TLS |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 412 | X509 *client_cert; /**< TLS client certificate if used for authentication */ |
Michal Vasko | c14e3c8 | 2016-01-11 16:14:30 +0100 | [diff] [blame] | 413 | #endif |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 414 | } server; |
| 415 | } opts; |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 416 | }; |
| 417 | |
Michal Vasko | e4300a8 | 2017-05-24 10:35:42 +0200 | [diff] [blame] | 418 | enum nc_ps_session_state { |
| 419 | NC_PS_STATE_NONE = 0, /**< session is not being worked with */ |
| 420 | NC_PS_STATE_BUSY, /**< session is being polled or communicated on (and locked) */ |
| 421 | NC_PS_STATE_INVALID /**< session is invalid and was already returned by another poll */ |
| 422 | }; |
| 423 | |
Michal Vasko | 48a63ed | 2016-03-01 09:48:21 +0100 | [diff] [blame] | 424 | /* ACCESS locked */ |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 425 | struct nc_pollsession { |
Michal Vasko | e4300a8 | 2017-05-24 10:35:42 +0200 | [diff] [blame] | 426 | struct { |
| 427 | struct nc_session *session; |
| 428 | enum nc_ps_session_state state; |
| 429 | } *sessions; |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 430 | uint16_t session_count; |
Michal Vasko | 99f251b | 2017-01-11 11:31:46 +0100 | [diff] [blame] | 431 | uint16_t last_event_session; |
Michal Vasko | be86fe3 | 2016-04-07 10:43:03 +0200 | [diff] [blame] | 432 | |
| 433 | pthread_cond_t cond; |
Michal Vasko | 48a63ed | 2016-03-01 09:48:21 +0100 | [diff] [blame] | 434 | pthread_mutex_t lock; |
Michal Vasko | be86fe3 | 2016-04-07 10:43:03 +0200 | [diff] [blame] | 435 | uint8_t queue[NC_PS_QUEUE_SIZE]; /**< round buffer, queue is empty when queue_len == 0 */ |
| 436 | uint8_t queue_begin; /**< queue starts on queue[queue_begin] */ |
| 437 | uint8_t queue_len; /**< queue ends on queue[queue_begin + queue_len - 1] */ |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 438 | }; |
| 439 | |
Michal Vasko | a8ad448 | 2016-01-28 14:25:54 +0100 | [diff] [blame] | 440 | struct nc_ntf_thread_arg { |
| 441 | struct nc_session *session; |
| 442 | void (*notif_clb)(struct nc_session *session, const struct nc_notif *notif); |
| 443 | }; |
| 444 | |
Michal Vasko | 4eb3c31 | 2016-03-01 14:09:37 +0100 | [diff] [blame] | 445 | void *nc_realloc(void *ptr, size_t size); |
| 446 | |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 447 | NC_MSG_TYPE nc_send_msg(struct nc_session *session, struct lyd_node *op); |
| 448 | |
Radek Krejci | 2847292 | 2016-07-15 11:51:16 +0200 | [diff] [blame] | 449 | #ifndef HAVE_PTHREAD_MUTEX_TIMEDLOCK |
| 450 | int pthread_mutex_timedlock(pthread_mutex_t *mutex, const struct timespec *abstime); |
| 451 | #endif |
| 452 | |
Radek Krejci | 7ac1605 | 2016-07-15 11:48:18 +0200 | [diff] [blame] | 453 | int nc_gettimespec(struct timespec *ts); |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 454 | |
Radek Krejci | da0afb2 | 2017-05-26 16:25:59 +0200 | [diff] [blame^] | 455 | int32_t nc_difftimespec(const struct timespec *ts1, const struct timespec *ts2); |
Michal Vasko | 36c7be8 | 2017-02-22 13:37:59 +0100 | [diff] [blame] | 456 | |
| 457 | void nc_addtimespec(struct timespec *ts, uint32_t msec); |
Michal Vasko | 99f251b | 2017-01-11 11:31:46 +0100 | [diff] [blame] | 458 | |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 459 | struct nc_session *nc_new_session(int not_allocate_ti); |
| 460 | |
| 461 | int nc_session_lock(struct nc_session *session, int timeout, const char *func); |
| 462 | |
| 463 | int nc_session_unlock(struct nc_session *session, int timeout, const char *func); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 464 | |
Michal Vasko | 227f8ff | 2016-07-26 14:08:59 +0200 | [diff] [blame] | 465 | int nc_ps_lock(struct nc_pollsession *ps, uint8_t *id, const char *func); |
Michal Vasko | f04a52a | 2016-04-07 10:52:10 +0200 | [diff] [blame] | 466 | |
Michal Vasko | 227f8ff | 2016-07-26 14:08:59 +0200 | [diff] [blame] | 467 | int nc_ps_unlock(struct nc_pollsession *ps, uint8_t id, const char *func); |
Michal Vasko | f04a52a | 2016-04-07 10:52:10 +0200 | [diff] [blame] | 468 | |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 469 | /** |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 470 | * @brief Fill libyang context in \p session. Context models are based on the stored session |
| 471 | * capabilities. If the server does not support \<get-schema\>, the models are searched |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 472 | * for in the directory set using nc_client_schema_searchpath(). |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 473 | * |
| 474 | * @param[in] session Session to create the context for. |
Michal Vasko | ef57833 | 2016-01-25 13:20:09 +0100 | [diff] [blame] | 475 | * @return 0 on success, 1 on some missing schemas, -1 on error. |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 476 | */ |
Michal Vasko | 57eb940 | 2015-12-08 14:38:12 +0100 | [diff] [blame] | 477 | int nc_ctx_check_and_fill(struct nc_session *session); |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 478 | |
| 479 | /** |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 480 | * @brief Perform NETCONF handshake on \p session. |
| 481 | * |
| 482 | * @param[in] session NETCONF session to use. |
Michal Vasko | 71090fc | 2016-05-24 16:37:28 +0200 | [diff] [blame] | 483 | * @return NC_MSG_HELLO on success, NC_MSG_BAD_HELLO on client \<hello\> message parsing fail |
| 484 | * (server-side only), NC_MSG_WOULDBLOCK on timeout, NC_MSG_ERROR on other error. |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 485 | */ |
Michal Vasko | 71090fc | 2016-05-24 16:37:28 +0200 | [diff] [blame] | 486 | NC_MSG_TYPE nc_handshake(struct nc_session *session); |
Michal Vasko | 9e2d3a3 | 2015-11-10 13:09:18 +0100 | [diff] [blame] | 487 | |
| 488 | /** |
Michal Vasko | f05562c | 2016-01-20 12:06:43 +0100 | [diff] [blame] | 489 | * @brief Create a socket connection. |
| 490 | * |
| 491 | * @param[in] host Hostname to connect to. |
| 492 | * @param[in] port Port to connect on. |
| 493 | * @return Connected socket or -1 on error. |
| 494 | */ |
| 495 | int nc_sock_connect(const char *host, uint16_t port); |
| 496 | |
| 497 | /** |
| 498 | * @brief Accept a new socket connection. |
Michal Vasko | 80cad7f | 2015-12-08 14:42:27 +0100 | [diff] [blame] | 499 | * |
Michal Vasko | c61c449 | 2016-01-25 11:13:34 +0100 | [diff] [blame] | 500 | * @param[in] sock Listening socket. |
Michal Vasko | f05562c | 2016-01-20 12:06:43 +0100 | [diff] [blame] | 501 | * @param[in] timeout Timeout in milliseconds. |
| 502 | * @param[out] peer_host Host the new connection was initiated from. Can be NULL. |
| 503 | * @param[out] peer_port Port the new connection is connected on. Can be NULL. |
Michal Vasko | 80cad7f | 2015-12-08 14:42:27 +0100 | [diff] [blame] | 504 | * @return Connected socket with the new connection, -1 on error. |
| 505 | */ |
Michal Vasko | c61c449 | 2016-01-25 11:13:34 +0100 | [diff] [blame] | 506 | int nc_sock_accept(int sock, int timeout, char **peer_host, uint16_t *peer_port); |
Michal Vasko | 80cad7f | 2015-12-08 14:42:27 +0100 | [diff] [blame] | 507 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 508 | /** |
| 509 | * @brief Create a listening socket. |
| 510 | * |
| 511 | * @param[in] address IP address to listen on. |
| 512 | * @param[in] port Port to listen on. |
| 513 | * @return Listening socket, -1 on error. |
| 514 | */ |
Michal Vasko | f05562c | 2016-01-20 12:06:43 +0100 | [diff] [blame] | 515 | int nc_sock_listen(const char *address, uint16_t port); |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 516 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 517 | /** |
| 518 | * @brief Accept a new connection on a listening socket. |
| 519 | * |
| 520 | * @param[in] binds Structure with the listening sockets. |
| 521 | * @param[in] bind_count Number of \p binds. |
| 522 | * @param[in] timeout Timeout for accepting. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 523 | * @param[out] host Host of the remote peer. Can be NULL. |
| 524 | * @param[out] port Port of the new connection. Can be NULL. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 525 | * @param[out] idx Index of the bind that was accepted. Can be NULL. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 526 | * @return Accepted socket of the new connection, -1 on error. |
| 527 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 528 | int nc_sock_accept_binds(struct nc_bind *binds, uint16_t bind_count, int timeout, char **host, uint16_t *port, uint16_t *idx); |
| 529 | |
| 530 | /** |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 531 | * @brief Lock endpoint structures for reading and the specific endpoint. |
| 532 | * |
| 533 | * @param[in] name Name of the endpoint. |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 534 | * @param[in] ti Expected transport. |
Michal Vasko | e2713da | 2016-08-22 16:06:40 +0200 | [diff] [blame] | 535 | * @param[out] idx Index of the endpoint. Optional. |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 536 | * @return Endpoint structure. |
| 537 | */ |
Michal Vasko | ade892d | 2017-02-22 13:40:35 +0100 | [diff] [blame] | 538 | struct nc_endpt *nc_server_endpt_lock_get(const char *name, NC_TRANSPORT_IMPL ti, uint16_t *idx); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 539 | |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 540 | /** |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 541 | * @brief Lock CH client structures for reading and the specific client. |
| 542 | * |
| 543 | * @param[in] name Name of the CH client. |
| 544 | * @param[in] ti Expected transport. |
| 545 | * @param[out] idx Index of the client. Optional. |
| 546 | * @return CH client structure. |
| 547 | */ |
| 548 | struct nc_ch_client *nc_server_ch_client_lock(const char *name, NC_TRANSPORT_IMPL ti, uint16_t *idx); |
| 549 | |
| 550 | /** |
| 551 | * @brief Unlock CH client strcutures and the specific client. |
| 552 | * |
| 553 | * @param[in] endpt Locked CH client structure. |
| 554 | */ |
| 555 | void nc_server_ch_client_unlock(struct nc_ch_client *client); |
| 556 | |
| 557 | /** |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 558 | * @brief Add a client Call Home bind, listen on it. |
| 559 | * |
| 560 | * @param[in] address Address to bind to. |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 561 | * @param[in] port Port to bind to. |
| 562 | * @param[in] ti Transport to use. |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 563 | * @return 0 on success, -1 on error. |
| 564 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 565 | int nc_client_ch_add_bind_listen(const char *address, uint16_t port, NC_TRANSPORT_IMPL ti); |
| 566 | |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 567 | /** |
| 568 | * @brief Remove a client Call Home bind, stop listening on it. |
| 569 | * |
| 570 | * @param[in] address Address of the bind. NULL matches any address. |
| 571 | * @param[in] port Port of the bind. 0 matches all ports. |
Michal Vasko | 2e6defd | 2016-10-07 15:48:15 +0200 | [diff] [blame] | 572 | * @param[in] ti Transport of the bind. 0 matches all transports. |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 573 | * @return 0 on success, -1 on no matches found. |
| 574 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 575 | int nc_client_ch_del_bind(const char *address, uint16_t port, NC_TRANSPORT_IMPL ti); |
| 576 | |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 577 | /** |
| 578 | * @brief Connect to a listening NETCONF client using Call Home. |
| 579 | * |
| 580 | * @param[in] host Hostname to connect to. |
| 581 | * @param[in] port Port to connect to. |
| 582 | * @param[in] ti Transport fo the connection. |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 583 | * @param[out] session New Call Home session. |
Michal Vasko | 71090fc | 2016-05-24 16:37:28 +0200 | [diff] [blame] | 584 | * @return NC_MSG_HELLO on success, NC_MSG_BAD_HELLO on client \<hello\> message |
| 585 | * parsing fail, NC_MSG_WOULDBLOCK on timeout, NC_MSG_ERROR on other errors. |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 586 | */ |
Michal Vasko | 71090fc | 2016-05-24 16:37:28 +0200 | [diff] [blame] | 587 | NC_MSG_TYPE nc_connect_callhome(const char *host, uint16_t port, NC_TRANSPORT_IMPL ti, struct nc_session **session); |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 588 | |
Michal Vasko | a7b8ca5 | 2016-03-01 12:09:29 +0100 | [diff] [blame] | 589 | void nc_init(void); |
| 590 | |
| 591 | void nc_destroy(void); |
| 592 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 593 | #ifdef NC_ENABLED_SSH |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 594 | |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 595 | /** |
| 596 | * @brief Accept a server Call Home connection on a socket. |
| 597 | * |
| 598 | * @param[in] sock Socket with a new connection. |
| 599 | * @param[in] host Hostname of the server. |
| 600 | * @param[in] port Port of the server. |
| 601 | * @param[in] ctx Context for the session. Can be NULL. |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 602 | * @param[in] timeout Transport operations timeout in msec. |
Michal Vasko | da51477 | 2016-02-01 11:32:01 +0100 | [diff] [blame] | 603 | * @return New session, NULL on error. |
| 604 | */ |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 605 | struct nc_session *nc_accept_callhome_ssh_sock(int sock, const char *host, uint16_t port, struct ly_ctx *ctx, int timeout); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 606 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 607 | /** |
| 608 | * @brief Establish SSH transport on a socket. |
| 609 | * |
| 610 | * @param[in] session Session structure of the new connection. |
| 611 | * @param[in] sock Socket of the new connection. |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 612 | * @param[in] timeout Transport operations timeout in msec (not SSH authentication one). |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 613 | * @return 1 on success, 0 on timeout, -1 on error. |
| 614 | */ |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 615 | int nc_accept_ssh_session(struct nc_session *session, int sock, int timeout); |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 616 | |
Michal Vasko | 96164bf | 2016-01-21 15:41:58 +0100 | [diff] [blame] | 617 | /** |
| 618 | * @brief Callback called when a new SSH message is received. |
| 619 | * |
| 620 | * @param[in] sshsession SSH session the message arrived on. |
| 621 | * @param[in] msg SSH message itself. |
| 622 | * @param[in] data NETCONF session running on \p sshsession. |
| 623 | * @return 0 if the message was handled, 1 if it is left up to libssh. |
| 624 | */ |
| 625 | int nc_sshcb_msg(ssh_session sshsession, ssh_message msg, void *data); |
| 626 | |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 627 | void nc_server_ssh_clear_opts(struct nc_server_ssh_opts *opts); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 628 | |
Michal Vasko | b7558c5 | 2016-02-26 15:04:19 +0100 | [diff] [blame] | 629 | void nc_client_ssh_destroy_opts(void); |
| 630 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 631 | #endif /* NC_ENABLED_SSH */ |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 632 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 633 | #ifdef NC_ENABLED_TLS |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 634 | |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 635 | struct nc_session *nc_accept_callhome_tls_sock(int sock, const char *host, uint16_t port, struct ly_ctx *ctx, int timeout); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 636 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 637 | /** |
| 638 | * @brief Establish TLS transport on a socket. |
| 639 | * |
| 640 | * @param[in] session Session structure of the new connection. |
| 641 | * @param[in] sock Socket of the new connection. |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 642 | * @param[in] timeout Transport operations timeout in msec. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 643 | * @return 1 on success, 0 on timeout, -1 on error. |
| 644 | */ |
Michal Vasko | 0190bc3 | 2016-03-02 15:47:49 +0100 | [diff] [blame] | 645 | int nc_accept_tls_session(struct nc_session *session, int sock, int timeout); |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 646 | |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 647 | void nc_server_tls_clear_opts(struct nc_server_tls_opts *opts); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 648 | |
Michal Vasko | b7558c5 | 2016-02-26 15:04:19 +0100 | [diff] [blame] | 649 | void nc_client_tls_destroy_opts(void); |
| 650 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 651 | #endif /* NC_ENABLED_TLS */ |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 652 | |
Michal Vasko | 80cad7f | 2015-12-08 14:42:27 +0100 | [diff] [blame] | 653 | /** |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 654 | * Functions |
| 655 | * - io.c |
| 656 | */ |
| 657 | |
| 658 | /** |
| 659 | * @brief Read message from the wire. |
| 660 | * |
| 661 | * Accepts hello, rpc, rpc-reply and notification. Received string is transformed into |
| 662 | * libyang XML tree and the message type is detected from the top level element. |
| 663 | * |
| 664 | * @param[in] session NETCONF session from which the message is being read. |
| 665 | * @param[in] timeout Timeout in milliseconds. Negative value means infinite timeout, |
| 666 | * zero value causes to return immediately. |
| 667 | * @param[out] data XML tree built from the read data. |
| 668 | * @return Type of the read message. #NC_MSG_WOULDBLOCK is returned if timeout is positive |
Radek Krejci | 5686ff7 | 2015-10-09 13:33:56 +0200 | [diff] [blame] | 669 | * (or zero) value and it passed out without any data on the wire. #NC_MSG_ERROR is |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 670 | * returned on error and #NC_MSG_NONE is never returned by this function. |
| 671 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 672 | NC_MSG_TYPE nc_read_msg_poll(struct nc_session* session, int timeout, struct lyxml_elem **data); |
| 673 | |
| 674 | /** |
| 675 | * @brief Read message from the wire. |
| 676 | * |
| 677 | * Accepts hello, rpc, rpc-reply and notification. Received string is transformed into |
| 678 | * libyang XML tree and the message type is detected from the top level element. |
| 679 | * |
| 680 | * @param[in] session NETCONF session from which the message is being read. |
| 681 | * @param[out] data XML tree built from the read data. |
| 682 | * @return Type of the read message. #NC_MSG_WOULDBLOCK is returned if timeout is positive |
| 683 | * (or zero) value and it passed out without any data on the wire. #NC_MSG_ERROR is |
| 684 | * returned on error and #NC_MSG_NONE is never returned by this function. |
| 685 | */ |
| 686 | NC_MSG_TYPE nc_read_msg(struct nc_session* session, struct lyxml_elem **data); |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 687 | |
Radek Krejci | fe0b347 | 2015-10-12 13:43:42 +0200 | [diff] [blame] | 688 | /** |
| 689 | * @brief Write message into wire. |
| 690 | * |
| 691 | * @param[in] session NETCONF session to which the message will be written. |
Radek Krejci | 127f895 | 2016-10-12 14:57:16 +0200 | [diff] [blame] | 692 | * @param[in] type The type of the message to write, specified as #NC_MSG_TYPE value. According to the type, the |
Radek Krejci | fe0b347 | 2015-10-12 13:43:42 +0200 | [diff] [blame] | 693 | * specific additional parameters are required or accepted: |
| 694 | * - #NC_MSG_RPC |
| 695 | * - `struct lyd_node *op;` - operation (content of the \<rpc/\> to be sent. Required parameter. |
| 696 | * - `const char *attrs;` - additional attributes to be added into the \<rpc/\> element. |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 697 | * Required parameter. |
| 698 | * `message-id` attribute is added automatically and default namespace is set to #NC_NS_BASE. |
| 699 | * Optional parameter. |
Radek Krejci | fe0b347 | 2015-10-12 13:43:42 +0200 | [diff] [blame] | 700 | * - #NC_MSG_REPLY |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 701 | * - `struct lyxml_node *rpc_elem;` - root of the RPC object to reply to. Required parameter. |
| 702 | * - `struct nc_server_reply *reply;` - RPC reply. Required parameter. |
Radek Krejci | fe0b347 | 2015-10-12 13:43:42 +0200 | [diff] [blame] | 703 | * - #NC_MSG_NOTIF |
| 704 | * - TODO: content |
| 705 | * @return 0 on success |
| 706 | */ |
Radek Krejci | 127f895 | 2016-10-12 14:57:16 +0200 | [diff] [blame] | 707 | int nc_write_msg(struct nc_session *session, int type, ...); |
Radek Krejci | fe0b347 | 2015-10-12 13:43:42 +0200 | [diff] [blame] | 708 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 709 | /** |
| 710 | * @brief Check whether a session is still connected (on transport layer). |
| 711 | * |
| 712 | * @param[in] session Session to check. |
| 713 | * @return 1 if connected, 0 if not. |
| 714 | */ |
Michal Vasko | 428087d | 2016-01-14 16:04:28 +0100 | [diff] [blame] | 715 | int nc_session_is_connected(struct nc_session *session); |
| 716 | |
Radek Krejci | 206fcd6 | 2015-10-07 15:42:48 +0200 | [diff] [blame] | 717 | #endif /* NC_SESSION_PRIVATE_H_ */ |