blob: d5d48867318e9968c0149bed5813c82cc5697d4e [file] [log] [blame]
Radek Krejci206fcd62015-10-07 15:42:48 +02001/**
Michal Vasko95ea9ff2021-11-09 12:29:14 +01002 * @file session.c
3 * @author Michal Vasko <mvasko@cesnet.cz>
4 * @brief libnetconf2 - general session functions
Radek Krejci206fcd62015-10-07 15:42:48 +02005 *
Michal Vasko95ea9ff2021-11-09 12:29:14 +01006 * @copyright
Michal Vaskod8a74192023-02-06 15:51:50 +01007 * Copyright (c) 2015 - 2023 CESNET, z.s.p.o.
Radek Krejci206fcd62015-10-07 15:42:48 +02008 *
Radek Krejci9b81f5b2016-02-24 13:14:49 +01009 * 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 Vaskoafd416b2016-02-25 14:51:46 +010012 *
Radek Krejci9b81f5b2016-02-24 13:14:49 +010013 * https://opensource.org/licenses/BSD-3-Clause
Radek Krejci206fcd62015-10-07 15:42:48 +020014 */
Michal Vasko5bd4a3f2021-06-17 16:40:10 +020015#define _GNU_SOURCE
Radek Krejci206fcd62015-10-07 15:42:48 +020016
Michal Vasko18aeb5d2017-02-17 09:23:56 +010017#include <assert.h>
Michal Vaskob83a3fa2021-05-26 09:53:42 +020018#include <ctype.h>
Radek Krejci206fcd62015-10-07 15:42:48 +020019#include <errno.h>
Michal Vaskob83a3fa2021-05-26 09:53:42 +020020#include <libyang/libyang.h>
Michal Vaskobe52dc22018-10-17 09:28:17 +020021#include <netinet/in.h>
22#include <netinet/tcp.h>
Michal Vaskob83a3fa2021-05-26 09:53:42 +020023#include <pthread.h>
24#include <stdlib.h>
25#include <string.h>
26#include <sys/socket.h>
27#include <sys/time.h>
28#include <sys/types.h>
Michal Vasko58f31552016-01-19 12:39:15 +010029#include <time.h>
Michal Vaskob83a3fa2021-05-26 09:53:42 +020030#include <unistd.h>
Radek Krejci206fcd62015-10-07 15:42:48 +020031
Michal Vasko9e8ac262020-04-07 13:06:45 +020032#include "compat.h"
Michal Vaskob48aa812016-01-18 14:13:09 +010033#include "libnetconf.h"
Michal Vaskob83a3fa2021-05-26 09:53:42 +020034#include "session.h"
Michal Vasko11d142a2016-01-19 15:58:24 +010035#include "session_server.h"
Michal Vaskob48aa812016-01-18 14:13:09 +010036
Radek Krejci53691be2016-02-22 13:58:37 +010037#ifdef NC_ENABLED_SSH
Radek Krejci206fcd62015-10-07 15:42:48 +020038
Michal Vasko086311b2016-01-08 09:53:11 +010039# include <libssh/libssh.h>
Radek Krejci206fcd62015-10-07 15:42:48 +020040
Radek Krejci53691be2016-02-22 13:58:37 +010041#endif /* NC_ENABLED_SSH */
Radek Krejci695d4fa2015-10-22 13:23:54 +020042
Michal Vaskob83a3fa2021-05-26 09:53:42 +020043#if defined (NC_ENABLED_SSH) || defined (NC_ENABLED_TLS)
Michal Vaskoc14e3c82016-01-11 16:14:30 +010044
Michal Vasko5e228792016-02-03 15:30:24 +010045# include <openssl/conf.h>
Michal Vaskoc14e3c82016-01-11 16:14:30 +010046# include <openssl/err.h>
47
Radek Krejci53691be2016-02-22 13:58:37 +010048#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
Michal Vaskoc14e3c82016-01-11 16:14:30 +010049
Michal Vasko086311b2016-01-08 09:53:11 +010050/* in seconds */
51#define NC_CLIENT_HELLO_TIMEOUT 60
fanchanghu75888b62017-08-01 19:51:20 +080052#define NC_SERVER_HELLO_TIMEOUT 60
Radek Krejci695d4fa2015-10-22 13:23:54 +020053
Michal Vasko05ba9df2016-01-13 14:40:27 +010054/* in milliseconds */
55#define NC_CLOSE_REPLY_TIMEOUT 200
56
Michal Vasko086311b2016-01-08 09:53:11 +010057extern struct nc_server_opts server_opts;
58
Michal Vaskod8a74192023-02-06 15:51:50 +010059void
60nc_timeouttime_get(struct timespec *ts, uint32_t add_ms)
Radek Krejci7ac16052016-07-15 11:48:18 +020061{
Michal Vaskod8a74192023-02-06 15:51:50 +010062 if (clock_gettime(COMPAT_CLOCK_ID, ts) == -1) {
63 ERR(NULL, "clock_gettime() failed (%s).", strerror(errno));
64 return;
65 }
66
67 if (!add_ms) {
68 return;
69 }
70
71 assert((ts->tv_nsec >= 0) && (ts->tv_nsec < 1000000000L));
72
73 ts->tv_sec += add_ms / 1000;
74 ts->tv_nsec += (add_ms % 1000) * 1000000L;
75
76 if (ts->tv_nsec >= 1000000000L) {
77 ++ts->tv_sec;
78 ts->tv_nsec -= 1000000000L;
79 } else if (ts->tv_nsec < 0) {
80 --ts->tv_sec;
81 ts->tv_nsec += 1000000000L;
82 }
83
84 assert((ts->tv_nsec >= 0) && (ts->tv_nsec < 1000000000L));
85}
86
87int32_t
88nc_timeouttime_cur_diff(const struct timespec *ts)
89{
90 struct timespec cur;
91 int64_t nsec_diff = 0;
92
93 nc_timeouttime_get(&cur, 0);
94
95 nsec_diff += (((int64_t)ts->tv_sec) - ((int64_t)cur.tv_sec)) * 1000000000L;
96 nsec_diff += ((int64_t)ts->tv_nsec) - ((int64_t)cur.tv_nsec);
97
98 return nsec_diff / 1000000L;
99}
100
101void
102nc_realtime_get(struct timespec *ts)
103{
roman6ece9c52022-06-22 09:29:17 +0200104 if (clock_gettime(CLOCK_REALTIME, ts)) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100105 ERR(NULL, "clock_gettime() failed (%s).", strerror(errno));
106 return;
roman6ece9c52022-06-22 09:29:17 +0200107 }
Michal Vasko36c7be82017-02-22 13:37:59 +0100108}
109
roman6e5fd702023-04-27 14:30:27 +0200110/**
111 * @brief Convert key type to string.
112 *
113 * @param[in] type Type of the key.
114 * @return String literal representing the key type or NULL.
115 */
Michal Vaskoddce1212019-05-24 09:58:49 +0200116const char *
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200117nc_keytype2str(NC_SSH_KEY_TYPE type)
Michal Vaskoddce1212019-05-24 09:58:49 +0200118{
119 switch (type) {
roman6e5fd702023-04-27 14:30:27 +0200120 case NC_SSH_KEY_UNKNOWN:
121 return "unknown";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200122 case NC_SSH_KEY_DSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200123 return "DSA";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200124 case NC_SSH_KEY_RSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200125 return "RSA";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200126 case NC_SSH_KEY_ECDSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200127 return "EC";
roman6e5fd702023-04-27 14:30:27 +0200128 case NC_SSH_KEY_ECDSA_P256:
129 return "ECDSA_P256";
130 case NC_SSH_KEY_ECDSA_P384:
131 return "ECDSA_P384";
132 case NC_SSH_KEY_ECDSA_P521:
133 return "ECDSA_P521";
Michal Vaskoddce1212019-05-24 09:58:49 +0200134 default:
135 break;
136 }
137
138 return NULL;
139}
140
Michal Vaskobe52dc22018-10-17 09:28:17 +0200141int
romanc1d2b092023-02-02 08:58:27 +0100142nc_sock_configure_keepalive(int sock, struct nc_keepalives *ka)
Michal Vaskobe52dc22018-10-17 09:28:17 +0200143{
144 int opt;
145
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200146 opt = ka->enabled;
Michal Vaskobe52dc22018-10-17 09:28:17 +0200147 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200148 ERR(NULL, "Could not set SO_KEEPALIVE option (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200149 return -1;
150 }
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200151 if (!ka->enabled) {
152 return 0;
153 }
Michal Vaskobe52dc22018-10-17 09:28:17 +0200154
155#ifdef TCP_KEEPIDLE
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200156 opt = ka->idle_time;
Michal Vaskobe52dc22018-10-17 09:28:17 +0200157 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPIDLE, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200158 ERR(NULL, "Setsockopt failed (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200159 return -1;
160 }
161#endif
162
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200163#ifdef TCP_KEEPCNT
164 opt = ka->max_probes;
165 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPCNT, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200166 ERR(NULL, "Setsockopt failed (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200167 return -1;
168 }
169#endif
170
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200171#ifdef TCP_KEEPINTVL
172 opt = ka->probe_interval;
173 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPINTVL, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200174 ERR(NULL, "Setsockopt failed (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200175 return -1;
176 }
177#endif
178
179 return 0;
180}
181
Michal Vaskoade892d2017-02-22 13:40:35 +0100182struct nc_session *
Michal Vasko131120a2018-05-29 15:44:02 +0200183nc_new_session(NC_SIDE side, int shared_ti)
Michal Vaskoade892d2017-02-22 13:40:35 +0100184{
185 struct nc_session *sess;
186
187 sess = calloc(1, sizeof *sess);
188 if (!sess) {
189 return NULL;
190 }
191
Michal Vasko131120a2018-05-29 15:44:02 +0200192 sess->side = side;
193
194 if (side == NC_SERVER) {
Michal Vaskodf68e7e2022-04-21 11:04:00 +0200195 pthread_mutex_init(&sess->opts.server.ntf_status_lock, NULL);
Michal Vaskoacf98472021-02-04 15:33:57 +0100196 pthread_mutex_init(&sess->opts.server.rpc_lock, NULL);
197 pthread_cond_init(&sess->opts.server.rpc_cond, NULL);
Michal Vaskoacf98472021-02-04 15:33:57 +0100198
199 pthread_mutex_init(&sess->opts.server.ch_lock, NULL);
200 pthread_cond_init(&sess->opts.server.ch_cond, NULL);
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200201 } else {
202 pthread_mutex_init(&sess->opts.client.msgs_lock, NULL);
Michal Vasko131120a2018-05-29 15:44:02 +0200203 }
204
205 if (!shared_ti) {
206 sess->io_lock = malloc(sizeof *sess->io_lock);
207 if (!sess->io_lock) {
208 goto error;
209 }
210 pthread_mutex_init(sess->io_lock, NULL);
Michal Vaskoade892d2017-02-22 13:40:35 +0100211 }
212
213 return sess;
Michal Vasko131120a2018-05-29 15:44:02 +0200214
215error:
Michal Vasko131120a2018-05-29 15:44:02 +0200216 free(sess);
217 return NULL;
Michal Vaskoade892d2017-02-22 13:40:35 +0100218}
219
Michal Vasko96164bf2016-01-21 15:41:58 +0100220/*
221 * @return 1 - success
222 * 0 - timeout
223 * -1 - error
224 */
225int
Michal Vasko131120a2018-05-29 15:44:02 +0200226nc_session_rpc_lock(struct nc_session *session, int timeout, const char *func)
Michal Vasko96164bf2016-01-21 15:41:58 +0100227{
228 int ret;
Michal Vasko62be1ce2016-03-03 13:24:52 +0100229 struct timespec ts_timeout;
Michal Vasko96164bf2016-01-21 15:41:58 +0100230
Michal Vasko131120a2018-05-29 15:44:02 +0200231 if (session->side != NC_SERVER) {
232 ERRINT;
233 return -1;
234 }
235
Michal Vasko96164bf2016-01-21 15:41:58 +0100236 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100237 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vasko96164bf2016-01-21 15:41:58 +0100238
Michal Vaskoade892d2017-02-22 13:40:35 +0100239 /* LOCK */
Michal Vaskod8a74192023-02-06 15:51:50 +0100240 ret = pthread_mutex_clocklock(&session->opts.server.rpc_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100241 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100242 while (session->opts.server.rpc_inuse) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100243 ret = pthread_cond_clockwait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock,
244 COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100245 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100246 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100247 break;
248 }
249 }
250 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100251 } else if (!timeout) {
Michal Vaskoade892d2017-02-22 13:40:35 +0100252 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100253 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100254 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100255 if (session->opts.server.rpc_inuse) {
256 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100257 return 0;
258 }
Michal vasko2f8e4b52016-10-05 13:04:11 +0200259 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100260 } else { /* timeout == -1 */
Michal Vaskoade892d2017-02-22 13:40:35 +0100261 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100262 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100263 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100264 while (session->opts.server.rpc_inuse) {
265 ret = pthread_cond_wait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100266 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100267 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100268 break;
269 }
270 }
271 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100272 }
273
Michal Vaskoade892d2017-02-22 13:40:35 +0100274 if (ret) {
275 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
276 /* timeout */
277 return 0;
278 }
279
Michal Vasko96164bf2016-01-21 15:41:58 +0100280 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200281 ERR(session, "%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vasko96164bf2016-01-21 15:41:58 +0100282 return -1;
283 }
284
285 /* ok */
Michal Vaskoacf98472021-02-04 15:33:57 +0100286 assert(session->opts.server.rpc_inuse == 0);
287 session->opts.server.rpc_inuse = 1;
Michal Vaskoade892d2017-02-22 13:40:35 +0100288
289 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100290 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100291 if (ret) {
292 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200293 ERR(session, "%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100294 return -1;
295 }
296
297 return 1;
298}
299
300int
Michal Vasko131120a2018-05-29 15:44:02 +0200301nc_session_rpc_unlock(struct nc_session *session, int timeout, const char *func)
Michal Vaskoade892d2017-02-22 13:40:35 +0100302{
303 int ret;
304 struct timespec ts_timeout;
305
Michal Vasko131120a2018-05-29 15:44:02 +0200306 if (session->side != NC_SERVER) {
307 ERRINT;
308 return -1;
309 }
310
Michal Vaskoacf98472021-02-04 15:33:57 +0100311 assert(session->opts.server.rpc_inuse);
Michal Vaskoade892d2017-02-22 13:40:35 +0100312
313 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100314 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100315
316 /* LOCK */
Michal Vaskod8a74192023-02-06 15:51:50 +0100317 ret = pthread_mutex_clocklock(&session->opts.server.rpc_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100318 } else if (!timeout) {
319 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100320 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100321 } else { /* timeout == -1 */
322 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100323 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100324 }
325
326 if (ret && (ret != EBUSY) && (ret != ETIMEDOUT)) {
327 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200328 ERR(session, "%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100329 return -1;
330 } else if (ret) {
Michal Vasko69e98752022-12-14 14:20:17 +0100331 WRN(session, "%s: session RPC lock timeout, should not happen.", func);
Michal Vaskoade892d2017-02-22 13:40:35 +0100332 }
333
Michal Vaskoacf98472021-02-04 15:33:57 +0100334 session->opts.server.rpc_inuse = 0;
335 pthread_cond_signal(&session->opts.server.rpc_cond);
Michal Vaskoade892d2017-02-22 13:40:35 +0100336
337 if (!ret) {
338 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100339 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100340 if (ret) {
341 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200342 ERR(session, "%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100343 return -1;
344 }
345 }
346
Michal Vasko96164bf2016-01-21 15:41:58 +0100347 return 1;
348}
349
Michal Vasko131120a2018-05-29 15:44:02 +0200350int
351nc_session_io_lock(struct nc_session *session, int timeout, const char *func)
352{
353 int ret;
354 struct timespec ts_timeout;
355
356 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100357 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vasko131120a2018-05-29 15:44:02 +0200358
Michal Vaskod8a74192023-02-06 15:51:50 +0100359 ret = pthread_mutex_clocklock(session->io_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vasko131120a2018-05-29 15:44:02 +0200360 } else if (!timeout) {
361 ret = pthread_mutex_trylock(session->io_lock);
362 } else { /* timeout == -1 */
Robin Jarry54ea2962018-10-10 10:33:40 +0200363 ret = pthread_mutex_lock(session->io_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200364 }
365
366 if (ret) {
367 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
368 /* timeout */
369 return 0;
370 }
371
372 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200373 ERR(session, "%s: failed to IO lock a session (%s).", func, strerror(ret));
Michal Vasko131120a2018-05-29 15:44:02 +0200374 return -1;
375 }
376
377 return 1;
378}
379
380int
381nc_session_io_unlock(struct nc_session *session, const char *func)
382{
383 int ret;
384
385 ret = pthread_mutex_unlock(session->io_lock);
386 if (ret) {
387 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200388 ERR(session, "%s: failed to IO unlock a session (%s).", func, strerror(ret));
Michal Vasko131120a2018-05-29 15:44:02 +0200389 return -1;
390 }
391
392 return 1;
393}
394
Michal Vasko01130bd2021-08-26 11:47:38 +0200395int
396nc_session_client_msgs_lock(struct nc_session *session, int *timeout, const char *func)
397{
398 int ret;
399 int32_t diff_msec;
roman6ece9c52022-06-22 09:29:17 +0200400 struct timespec ts_timeout, ts_start;
Michal Vasko01130bd2021-08-26 11:47:38 +0200401
402 assert(session->side == NC_CLIENT);
403
404 if (*timeout > 0) {
405 /* get current time */
Michal Vaskod8a74192023-02-06 15:51:50 +0100406 nc_timeouttime_get(&ts_start, 0);
Michal Vasko01130bd2021-08-26 11:47:38 +0200407
Michal Vaskod8a74192023-02-06 15:51:50 +0100408 nc_timeouttime_get(&ts_timeout, *timeout);
Michal Vasko01130bd2021-08-26 11:47:38 +0200409
Michal Vaskod8a74192023-02-06 15:51:50 +0100410 ret = pthread_mutex_clocklock(&session->opts.client.msgs_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vasko01130bd2021-08-26 11:47:38 +0200411 if (!ret) {
412 /* update timeout based on what was elapsed */
Michal Vaskod8a74192023-02-06 15:51:50 +0100413 diff_msec = nc_timeouttime_cur_diff(&ts_start);
Michal Vasko01130bd2021-08-26 11:47:38 +0200414 *timeout -= diff_msec;
415 }
416 } else if (!*timeout) {
417 ret = pthread_mutex_trylock(&session->opts.client.msgs_lock);
418 } else { /* timeout == -1 */
419 ret = pthread_mutex_lock(&session->opts.client.msgs_lock);
420 }
421
422 if (ret) {
423 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
424 /* timeout */
425 return 0;
426 }
427
428 /* error */
429 ERR(session, "%s: failed to MSGS lock a session (%s).", func, strerror(ret));
430 return -1;
431 }
432
433 return 1;
434}
435
436int
437nc_session_client_msgs_unlock(struct nc_session *session, const char *func)
438{
439 int ret;
440
441 assert(session->side == NC_CLIENT);
442
443 ret = pthread_mutex_unlock(&session->opts.client.msgs_lock);
444 if (ret) {
445 /* error */
446 ERR(session, "%s: failed to MSGS unlock a session (%s).", func, strerror(ret));
447 return -1;
448 }
449
450 return 1;
451}
452
Michal Vasko8dadf782016-01-15 10:29:36 +0100453API NC_STATUS
454nc_session_get_status(const struct nc_session *session)
455{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100456 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200457 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200458 return NC_STATUS_ERR;
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100459 }
460
Michal Vasko8dadf782016-01-15 10:29:36 +0100461 return session->status;
462}
463
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100464API NC_SESSION_TERM_REASON
Michal Vasko142cfea2017-08-07 10:12:11 +0200465nc_session_get_term_reason(const struct nc_session *session)
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100466{
467 if (!session) {
468 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200469 return NC_SESSION_TERM_ERR;
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100470 }
471
472 return session->term_reason;
473}
474
Michal Vasko8dadf782016-01-15 10:29:36 +0100475API uint32_t
Michal Vasko142cfea2017-08-07 10:12:11 +0200476nc_session_get_killed_by(const struct nc_session *session)
477{
478 if (!session) {
479 ERRARG("session");
480 return 0;
481 }
482
483 return session->killed_by;
484}
485
486API uint32_t
Michal Vasko8dadf782016-01-15 10:29:36 +0100487nc_session_get_id(const struct nc_session *session)
488{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100489 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200490 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100491 return 0;
492 }
493
Michal Vasko8dadf782016-01-15 10:29:36 +0100494 return session->id;
495}
496
Michal Vasko174fe8e2016-02-17 15:38:09 +0100497API int
498nc_session_get_version(const struct nc_session *session)
499{
500 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200501 ERRARG("session");
Michal Vasko174fe8e2016-02-17 15:38:09 +0100502 return -1;
503 }
504
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200505 return session->version == NC_VERSION_10 ? 0 : 1;
Michal Vasko174fe8e2016-02-17 15:38:09 +0100506}
507
Michal Vasko8dadf782016-01-15 10:29:36 +0100508API NC_TRANSPORT_IMPL
509nc_session_get_ti(const struct nc_session *session)
510{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100511 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200512 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100513 return 0;
514 }
515
Michal Vasko8dadf782016-01-15 10:29:36 +0100516 return session->ti_type;
517}
518
519API const char *
520nc_session_get_username(const struct nc_session *session)
521{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100522 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200523 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100524 return NULL;
525 }
526
Michal Vasko8dadf782016-01-15 10:29:36 +0100527 return session->username;
528}
529
530API const char *
531nc_session_get_host(const struct nc_session *session)
532{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100533 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200534 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100535 return NULL;
536 }
537
Michal Vasko8dadf782016-01-15 10:29:36 +0100538 return session->host;
539}
540
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200541API const char *
542nc_session_get_path(const struct nc_session *session)
543{
544 if (!session) {
545 ERRARG("session");
546 return NULL;
547 }
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200548 if (session->ti_type != NC_TI_UNIX) {
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200549 return NULL;
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200550 }
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200551
552 return session->path;
553}
554
Michal Vasko8dadf782016-01-15 10:29:36 +0100555API uint16_t
556nc_session_get_port(const struct nc_session *session)
557{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100558 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200559 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100560 return 0;
561 }
562
Michal Vasko8dadf782016-01-15 10:29:36 +0100563 return session->port;
564}
565
Michal Vasko93224072021-11-09 12:14:28 +0100566API const struct ly_ctx *
Michal Vasko9a25e932016-02-01 10:36:42 +0100567nc_session_get_ctx(const struct nc_session *session)
568{
569 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200570 ERRARG("session");
Michal Vasko9a25e932016-02-01 10:36:42 +0100571 return NULL;
572 }
573
574 return session->ctx;
575}
576
Michal Vasko2cc4c682016-03-01 09:16:48 +0100577API void
578nc_session_set_data(struct nc_session *session, void *data)
579{
580 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200581 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100582 return;
583 }
584
585 session->data = data;
586}
587
588API void *
589nc_session_get_data(const struct nc_session *session)
590{
591 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200592 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100593 return NULL;
594 }
595
596 return session->data;
597}
598
Michal Vaskodc96bb92023-03-28 08:52:48 +0200599API int
600nc_session_is_callhome(const struct nc_session *session)
601{
602 if (!session) {
603 ERRARG("session");
604 return 0;
605 }
606
607 if (session->flags & NC_SESSION_CALLHOME) {
608 return 1;
609 }
610
611 return 0;
612}
613
Michal Vasko086311b2016-01-08 09:53:11 +0100614NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +0200615nc_send_msg_io(struct nc_session *session, int io_timeout, struct lyd_node *op)
Radek Krejci695d4fa2015-10-22 13:23:54 +0200616{
Michal Vasko7e1f5fb2021-11-10 10:14:45 +0100617 if (session->ctx != LYD_CTX(op)) {
618 ERR(session, "RPC \"%s\" was created in different context than that of the session.", LYD_NAME(op));
Michal Vasko086311b2016-01-08 09:53:11 +0100619 return NC_MSG_ERROR;
Michal Vasko7df39ec2015-12-09 15:26:24 +0100620 }
621
Michal Vasko131120a2018-05-29 15:44:02 +0200622 return nc_write_msg_io(session, io_timeout, NC_MSG_RPC, op, NULL);
Michal Vasko7df39ec2015-12-09 15:26:24 +0100623}
624
Michal Vaskod4da3632022-05-25 11:49:10 +0200625/**
626 * @brief Send \<close-session\> and read the reply on a session.
627 *
628 * @param[in] session Closing NETCONF session.
629 */
630static void
631nc_session_free_close_session(struct nc_session *session)
632{
633 struct ly_in *msg;
634 struct lyd_node *close_rpc, *envp;
635 const struct lys_module *ietfnc;
636
637 ietfnc = ly_ctx_get_module_implemented(session->ctx, "ietf-netconf");
638 if (!ietfnc) {
Michal Vasko5ca5d972022-09-14 13:51:31 +0200639 WRN(session, "Missing ietf-netconf module in context, unable to send <close-session>.");
Michal Vaskod4da3632022-05-25 11:49:10 +0200640 return;
641 }
642 if (lyd_new_inner(NULL, ietfnc, "close-session", 0, &close_rpc)) {
643 WRN(session, "Failed to create <close-session> RPC.");
644 return;
645 }
646
647 /* send the RPC */
648 nc_send_msg_io(session, NC_SESSION_FREE_LOCK_TIMEOUT, close_rpc);
649
650read_msg:
651 switch (nc_read_msg_poll_io(session, NC_CLOSE_REPLY_TIMEOUT, &msg)) {
652 case 1:
653 if (!strncmp(ly_in_memory(msg, NULL), "<notification", 13)) {
654 /* ignore */
655 ly_in_free(msg, 1);
656 goto read_msg;
657 }
658 if (lyd_parse_op(session->ctx, close_rpc, msg, LYD_XML, LYD_TYPE_REPLY_NETCONF, &envp, NULL)) {
659 WRN(session, "Failed to parse <close-session> reply.");
660 } else if (!lyd_child(envp) || strcmp(LYD_NAME(lyd_child(envp)), "ok")) {
661 WRN(session, "Reply to <close-session> was not <ok> as expected.");
662 }
663 lyd_free_tree(envp);
664 ly_in_free(msg, 1);
665 break;
666 case 0:
667 WRN(session, "Timeout for receiving a reply to <close-session> elapsed.");
668 break;
669 case -1:
670 ERR(session, "Failed to receive a reply to <close-session>.");
671 break;
672 default:
673 /* cannot happen */
674 break;
675 }
676 lyd_free_tree(close_rpc);
677}
678
Michal Vasko33476c32022-09-09 11:21:40 +0200679/**
680 * @brief Free transport implementation members of a session.
681 *
682 * @param[in] session Session to free.
683 * @param[out] multisession Whether there are other NC sessions on the same SSH sessions.
684 */
685static void
686nc_session_free_transport(struct nc_session *session, int *multisession)
687{
688 int connected; /* flag to indicate whether the transport socket is still connected */
Michal Vaskoe44f2702022-12-12 07:58:06 +0100689 int sock = -1;
Michal Vasko33476c32022-09-09 11:21:40 +0200690 struct nc_session *siter;
691
692 *multisession = 0;
693 connected = nc_session_is_connected(session);
694
695 /* transport implementation cleanup */
696 switch (session->ti_type) {
697 case NC_TI_FD:
698 /* nothing needed - file descriptors were provided by caller,
699 * so it is up to the caller to close them correctly
700 * TODO use callbacks
701 */
702 /* just to avoid compiler warning */
703 (void)connected;
704 (void)siter;
705 break;
706
707 case NC_TI_UNIX:
708 sock = session->ti.unixsock.sock;
709 (void)connected;
710 (void)siter;
711 break;
712
713#ifdef NC_ENABLED_SSH
Michal Vaskoe44f2702022-12-12 07:58:06 +0100714 case NC_TI_LIBSSH: {
715 int r;
716
Michal Vasko33476c32022-09-09 11:21:40 +0200717 if (connected) {
Michal Vasko64734402022-09-09 11:22:00 +0200718 ssh_channel_send_eof(session->ti.libssh.channel);
Michal Vasko33476c32022-09-09 11:21:40 +0200719 ssh_channel_free(session->ti.libssh.channel);
720 }
721 /* There can be multiple NETCONF sessions on the same SSH session (NETCONF session maps to
722 * SSH channel). So destroy the SSH session only if there is no other NETCONF session using
723 * it. Also, avoid concurrent free by multiple threads of sessions that share the SSH session.
724 */
725 /* SESSION IO LOCK */
726 r = nc_session_io_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
727
728 if (session->ti.libssh.next) {
729 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
730 if (siter->status != NC_STATUS_STARTING) {
731 *multisession = 1;
732 break;
733 }
734 }
735 }
736
737 if (!*multisession) {
738 /* it's not multisession yet, but we still need to free the starting sessions */
739 if (session->ti.libssh.next) {
740 do {
741 siter = session->ti.libssh.next;
742 session->ti.libssh.next = siter->ti.libssh.next;
743
744 /* free starting SSH NETCONF session (channel will be freed in ssh_free()) */
745 free(siter->username);
746 free(siter->host);
747 if (!(siter->flags & NC_SESSION_SHAREDCTX)) {
748 ly_ctx_destroy((struct ly_ctx *)siter->ctx);
749 }
750
751 free(siter);
752 } while (session->ti.libssh.next != session);
753 }
754 /* remember sock so we can close it */
755 sock = ssh_get_fd(session->ti.libssh.session);
756 if (connected) {
757 ssh_disconnect(session->ti.libssh.session);
758 sock = -1;
759 }
760 ssh_free(session->ti.libssh.session);
761 } else {
762 /* remove the session from the list */
763 for (siter = session->ti.libssh.next; siter->ti.libssh.next != session; siter = siter->ti.libssh.next) {}
764 if (session->ti.libssh.next == siter) {
765 /* there will be only one session */
766 siter->ti.libssh.next = NULL;
767 } else {
768 /* there are still multiple sessions, keep the ring list */
769 siter->ti.libssh.next = session->ti.libssh.next;
770 }
Michal Vasko33476c32022-09-09 11:21:40 +0200771 }
772
773 /* SESSION IO UNLOCK */
774 if (r == 1) {
775 nc_session_io_unlock(session, __func__);
776 }
777 break;
Michal Vaskoe44f2702022-12-12 07:58:06 +0100778 }
Michal Vasko33476c32022-09-09 11:21:40 +0200779#endif
780
781#ifdef NC_ENABLED_TLS
782 case NC_TI_OPENSSL:
783 /* remember sock so we can close it */
784 sock = SSL_get_fd(session->ti.tls);
785
786 if (connected) {
787 SSL_shutdown(session->ti.tls);
788 }
789 SSL_free(session->ti.tls);
790
791 if (session->side == NC_SERVER) {
792 X509_free(session->opts.server.client_cert);
793 }
794 break;
795#endif
796 case NC_TI_NONE:
797 break;
798 }
799
800 /* close socket separately */
801 if (sock > -1) {
802 close(sock);
803 }
804}
805
Radek Krejci695d4fa2015-10-22 13:23:54 +0200806API void
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100807nc_session_free(struct nc_session *session, void (*data_free)(void *))
Radek Krejci695d4fa2015-10-22 13:23:54 +0200808{
Michal Vasko33476c32022-09-09 11:21:40 +0200809 int r, i, rpc_locked = 0, msgs_locked = 0, timeout;
Michal Vaskob48aa812016-01-18 14:13:09 +0100810 int multisession = 0; /* flag for more NETCONF sessions on a single SSH session */
Michal Vaskoad611702015-12-03 13:41:51 +0100811 struct nc_msg_cont *contiter;
Michal Vasko77367452021-02-16 16:32:18 +0100812 struct ly_in *msg;
roman6ece9c52022-06-22 09:29:17 +0200813 struct timespec ts;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200814 void *p;
815
Michal Vasko428087d2016-01-14 16:04:28 +0100816 if (!session || (session->status == NC_STATUS_CLOSING)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200817 return;
818 }
819
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200820 /* stop notification threads if any */
821 if ((session->side == NC_CLIENT) && ATOMIC_LOAD_RELAXED(session->opts.client.ntf_thread_running)) {
822 /* let the threads know they should quit */
823 ATOMIC_STORE_RELAXED(session->opts.client.ntf_thread_running, 0);
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200824
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200825 /* wait for them */
Michal Vaskod8a74192023-02-06 15:51:50 +0100826 nc_timeouttime_get(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200827 while (ATOMIC_LOAD_RELAXED(session->opts.client.ntf_thread_count)) {
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200828 usleep(NC_TIMEOUT_STEP);
Michal Vaskod8a74192023-02-06 15:51:50 +0100829 if (nc_timeouttime_cur_diff(&ts) < 1) {
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200830 ERR(session, "Waiting for notification thread exit failed (timed out).");
831 break;
832 }
833 }
Michal Vasko86d357c2016-03-11 13:46:38 +0100834 }
835
Michal Vaskoacf98472021-02-04 15:33:57 +0100836 if (session->side == NC_SERVER) {
Michal Vasko131120a2018-05-29 15:44:02 +0200837 r = nc_session_rpc_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100838 if (r == -1) {
Michal Vaskoadd4c792015-10-26 15:36:58 +0100839 return;
Michal Vasko131120a2018-05-29 15:44:02 +0200840 } else if (r) {
841 rpc_locked = 1;
Michal Vasko96a28a32021-02-04 15:35:20 +0100842 } else {
843 /* else failed to lock it, too bad */
Michal Vasko05532772021-06-03 12:12:38 +0200844 ERR(session, "Freeing a session while an RPC is being processed.");
Michal Vasko96a28a32021-02-04 15:35:20 +0100845 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200846 }
847
Michal Vasko8c247822020-09-07 13:23:23 +0200848 if (session->side == NC_CLIENT) {
Michal Vasko01130bd2021-08-26 11:47:38 +0200849 timeout = NC_SESSION_FREE_LOCK_TIMEOUT;
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200850
Michal Vasko01130bd2021-08-26 11:47:38 +0200851 /* MSGS LOCK */
852 r = nc_session_client_msgs_lock(session, &timeout, __func__);
853 if (r == -1) {
854 return;
855 } else if (r) {
856 msgs_locked = 1;
857 } else {
858 /* else failed to lock it, too bad */
859 ERR(session, "Freeing a session while messages are being received.");
860 }
861
862 /* cleanup message queue */
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200863 for (contiter = session->opts.client.msgs; contiter; ) {
Michal Vasko77367452021-02-16 16:32:18 +0100864 ly_in_free(contiter->msg, 1);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200865
Michal Vaskoad611702015-12-03 13:41:51 +0100866 p = contiter;
867 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200868 free(p);
869 }
870
Michal Vasko01130bd2021-08-26 11:47:38 +0200871 if (msgs_locked) {
872 /* MSGS UNLOCK */
873 nc_session_client_msgs_unlock(session, __func__);
874 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200875
Michal Vasko8c247822020-09-07 13:23:23 +0200876 if (session->status == NC_STATUS_RUNNING) {
Michal Vasko9c6d38c2021-09-03 13:02:53 +0200877 /* receive any leftover messages */
878 while (nc_read_msg_poll_io(session, 0, &msg) == 1) {
879 ly_in_free(msg, 1);
880 }
881
Michal Vasko8c247822020-09-07 13:23:23 +0200882 /* send closing info to the other side */
Michal Vaskod4da3632022-05-25 11:49:10 +0200883 nc_session_free_close_session(session);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200884 }
885
886 /* list of server's capabilities */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200887 if (session->opts.client.cpblts) {
888 for (i = 0; session->opts.client.cpblts[i]; i++) {
Michal Vasko96fc4bb2017-05-23 14:58:34 +0200889 free(session->opts.client.cpblts[i]);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200890 }
Michal Vasko2e6defd2016-10-07 15:48:15 +0200891 free(session->opts.client.cpblts);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200892 }
Michal Vasko78939072022-12-12 07:43:18 +0100893
894 /* LY ext data */
Michal Vaskoe44f2702022-12-12 07:58:06 +0100895#ifdef NC_ENABLED_SSH
896 struct nc_session *siter;
897
Michal Vasko78939072022-12-12 07:43:18 +0100898 if ((session->flags & NC_SESSION_SHAREDCTX) && session->ti.libssh.next) {
899 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
900 if (siter->status != NC_STATUS_STARTING) {
901 /* move LY ext data to this session */
902 assert(!siter->opts.client.ext_data);
903 siter->opts.client.ext_data = session->opts.client.ext_data;
904 session->opts.client.ext_data = NULL;
905 break;
906 }
907 }
Michal Vaskoe44f2702022-12-12 07:58:06 +0100908 } else
909#endif
910 {
Michal Vasko78939072022-12-12 07:43:18 +0100911 lyd_free_siblings(session->opts.client.ext_data);
912 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200913 }
914
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100915 if (session->data && data_free) {
916 data_free(session->data);
917 }
918
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200919 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
920 /* CH LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100921 pthread_mutex_lock(&session->opts.server.ch_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200922 }
923
Michal Vasko86d357c2016-03-11 13:46:38 +0100924 /* mark session for closing */
Radek Krejci695d4fa2015-10-22 13:23:54 +0200925 session->status = NC_STATUS_CLOSING;
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200926
Michal Vaskofeccb312022-03-24 15:24:59 +0100927 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CH_THREAD)) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100928 pthread_cond_signal(&session->opts.server.ch_cond);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200929
Michal Vaskod8a74192023-02-06 15:51:50 +0100930 nc_timeouttime_get(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
Michal Vasko0db3db52021-03-03 10:45:42 +0100931
932 /* wait for CH thread to actually wake up and terminate */
933 r = 0;
Michal Vaskofeccb312022-03-24 15:24:59 +0100934 while (!r && (session->flags & NC_SESSION_CH_THREAD)) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100935 r = pthread_cond_clockwait(&session->opts.server.ch_cond, &session->opts.server.ch_lock, COMPAT_CLOCK_ID, &ts);
Michal Vasko0db3db52021-03-03 10:45:42 +0100936 }
Michal Vasko0db3db52021-03-03 10:45:42 +0100937 if (r) {
Michal Vasko05532772021-06-03 12:12:38 +0200938 ERR(session, "Waiting for Call Home thread failed (%s).", strerror(r));
Michal Vasko3f05a092018-03-13 10:39:49 +0100939 }
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200940 }
941
Michal Vaskofeccb312022-03-24 15:24:59 +0100942 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
943 /* CH UNLOCK */
944 pthread_mutex_unlock(&session->opts.server.ch_lock);
945 }
946
Radek Krejci695d4fa2015-10-22 13:23:54 +0200947 /* transport implementation cleanup */
Michal Vasko33476c32022-09-09 11:21:40 +0200948 nc_session_free_transport(session, &multisession);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200949
Michal Vasko33476c32022-09-09 11:21:40 +0200950 /* final cleanup */
Michal Vasko93224072021-11-09 12:14:28 +0100951 free(session->username);
952 free(session->host);
953 free(session->path);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200954
Michal Vaskoacf98472021-02-04 15:33:57 +0100955 if (session->side == NC_SERVER) {
Michal Vaskodf68e7e2022-04-21 11:04:00 +0200956 pthread_mutex_destroy(&session->opts.server.ntf_status_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200957 if (rpc_locked) {
958 nc_session_rpc_unlock(session, NC_SESSION_LOCK_TIMEOUT, __func__);
Michal Vasko9e99f012016-03-03 13:25:20 +0100959 }
Michal Vaskoacf98472021-02-04 15:33:57 +0100960 pthread_mutex_destroy(&session->opts.server.rpc_lock);
961 pthread_cond_destroy(&session->opts.server.rpc_cond);
Michal Vasko131120a2018-05-29 15:44:02 +0200962 }
963
964 if (session->io_lock && !multisession) {
965 pthread_mutex_destroy(session->io_lock);
966 free(session->io_lock);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200967 }
968
969 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Michal Vasko93224072021-11-09 12:14:28 +0100970 ly_ctx_destroy((struct ly_ctx *)session->ctx);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200971 }
972
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200973 if (session->side == NC_SERVER) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100974 /* free CH synchronization structures */
975 pthread_cond_destroy(&session->opts.server.ch_cond);
976 pthread_mutex_destroy(&session->opts.server.ch_lock);
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200977 } else {
978 pthread_mutex_destroy(&session->opts.client.msgs_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200979 }
980
Radek Krejci695d4fa2015-10-22 13:23:54 +0200981 free(session);
982}
983
Michal Vasko086311b2016-01-08 09:53:11 +0100984static void
Michal Vasko93224072021-11-09 12:14:28 +0100985add_cpblt(const char *capab, char ***cpblts, int *size, int *count)
Michal Vasko086311b2016-01-08 09:53:11 +0100986{
Radek Krejci658782b2016-12-04 22:04:55 +0100987 size_t len;
988 int i;
989 char *p;
990
991 if (capab) {
992 /* check if already present */
993 p = strchr(capab, '?');
994 if (p) {
995 len = p - capab;
996 } else {
997 len = strlen(capab);
998 }
999 for (i = 0; i < *count; i++) {
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001000 if (!strncmp((*cpblts)[i], capab, len) && (((*cpblts)[i][len] == '\0') || ((*cpblts)[i][len] == '?'))) {
Radek Krejci658782b2016-12-04 22:04:55 +01001001 /* already present, do not duplicate it */
1002 return;
1003 }
1004 }
1005 }
1006
1007 /* add another capability */
Michal Vasko086311b2016-01-08 09:53:11 +01001008 if (*count == *size) {
1009 *size += 5;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001010 *cpblts = nc_realloc(*cpblts, *size * sizeof **cpblts);
1011 if (!(*cpblts)) {
1012 ERRMEM;
1013 return;
1014 }
Michal Vasko086311b2016-01-08 09:53:11 +01001015 }
1016
Michal Vasko93224072021-11-09 12:14:28 +01001017 (*cpblts)[*count] = capab ? strdup(capab) : NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001018 ++(*count);
1019}
1020
Michal Vasko93224072021-11-09 12:14:28 +01001021API char **
1022nc_server_get_cpblts_version(const struct ly_ctx *ctx, LYS_VERSION version)
Michal Vasko086311b2016-01-08 09:53:11 +01001023{
Michal Vasko93224072021-11-09 12:14:28 +01001024 char **cpblts;
Michal Vasko77367452021-02-16 16:32:18 +01001025 const struct lys_module *mod;
1026 struct lysp_feature *feat;
1027 int size = 10, count, features_count = 0, dev_count = 0, str_len, len;
Michal Vasko1440a742021-03-31 11:11:03 +02001028 uint32_t i, u;
Michal Vasko77367452021-02-16 16:32:18 +01001029 LY_ARRAY_COUNT_TYPE v;
Michal Vasko1440a742021-03-31 11:11:03 +02001030 char *yl_content_id;
romanc1d2b092023-02-02 08:58:27 +01001031 uint32_t wd_also_supported;
1032 uint32_t wd_basic_mode;
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001033
Radek Krejci24a18412018-05-16 15:09:10 +02001034#define NC_CPBLT_BUF_LEN 4096
Michal Vasko2e47ef92016-06-20 10:03:24 +02001035 char str[NC_CPBLT_BUF_LEN];
Michal Vasko086311b2016-01-08 09:53:11 +01001036
Michal Vasko4ffa3b22016-05-24 16:36:25 +02001037 if (!ctx) {
1038 ERRARG("ctx");
1039 return NULL;
1040 }
1041
Michal Vasko086311b2016-01-08 09:53:11 +01001042 cpblts = malloc(size * sizeof *cpblts);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001043 if (!cpblts) {
1044 ERRMEM;
Radek Krejcif906e412017-09-22 14:44:45 +02001045 goto error;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001046 }
Michal Vasko93224072021-11-09 12:14:28 +01001047 cpblts[0] = strdup("urn:ietf:params:netconf:base:1.0");
1048 cpblts[1] = strdup("urn:ietf:params:netconf:base:1.1");
Michal Vasko086311b2016-01-08 09:53:11 +01001049 count = 2;
1050
1051 /* capabilities */
1052
Michal Vasko77367452021-02-16 16:32:18 +01001053 mod = ly_ctx_get_module_implemented(ctx, "ietf-netconf");
Michal Vasko086311b2016-01-08 09:53:11 +01001054 if (mod) {
Michal Vasko77367452021-02-16 16:32:18 +01001055 if (lys_feature_value(mod, "writable-running") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001056 add_cpblt("urn:ietf:params:netconf:capability:writable-running:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001057 }
Michal Vasko77367452021-02-16 16:32:18 +01001058 if (lys_feature_value(mod, "candidate") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001059 add_cpblt("urn:ietf:params:netconf:capability:candidate:1.0", &cpblts, &size, &count);
Michal Vasko77367452021-02-16 16:32:18 +01001060 if (lys_feature_value(mod, "confirmed-commit") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001061 add_cpblt("urn:ietf:params:netconf:capability:confirmed-commit:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001062 }
1063 }
Michal Vasko77367452021-02-16 16:32:18 +01001064 if (lys_feature_value(mod, "rollback-on-error") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001065 add_cpblt("urn:ietf:params:netconf:capability:rollback-on-error:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001066 }
Michal Vasko77367452021-02-16 16:32:18 +01001067 if (lys_feature_value(mod, "validate") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001068 add_cpblt("urn:ietf:params:netconf:capability:validate:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001069 }
Michal Vasko77367452021-02-16 16:32:18 +01001070 if (lys_feature_value(mod, "startup") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001071 add_cpblt("urn:ietf:params:netconf:capability:startup:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001072 }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001073
1074 /* The URL capability must be set manually using nc_server_set_capability()
1075 * because of the need for supported protocols to be included.
1076 * https://tools.ietf.org/html/rfc6241#section-8.8.3
1077 */
Michal Vasko77367452021-02-16 16:32:18 +01001078 // if (lys_feature_value(mod, "url") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001079 // add_cpblt("urn:ietf:params:netconf:capability:url:1.0", &cpblts, &size, &count);
mekleoa8de5e92020-02-13 09:05:56 +01001080 // }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001081
Michal Vasko77367452021-02-16 16:32:18 +01001082 if (lys_feature_value(mod, "xpath") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001083 add_cpblt("urn:ietf:params:netconf:capability:xpath:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001084 }
1085 }
1086
Michal Vasko77367452021-02-16 16:32:18 +01001087 mod = ly_ctx_get_module_implemented(ctx, "ietf-netconf-with-defaults");
Michal Vasko086311b2016-01-08 09:53:11 +01001088 if (mod) {
romanc1d2b092023-02-02 08:58:27 +01001089 wd_basic_mode = ATOMIC_LOAD_RELAXED(server_opts.wd_basic_mode);
1090 if (!wd_basic_mode) {
Michal Vasko05532772021-06-03 12:12:38 +02001091 VRB(NULL, "with-defaults capability will not be advertised even though \"ietf-netconf-with-defaults\" model is present, unknown basic-mode.");
Michal Vasko086311b2016-01-08 09:53:11 +01001092 } else {
Michal Vasko3031aae2016-01-27 16:07:18 +01001093 strcpy(str, "urn:ietf:params:netconf:capability:with-defaults:1.0");
romanc1d2b092023-02-02 08:58:27 +01001094 switch (wd_basic_mode) {
Michal Vasko086311b2016-01-08 09:53:11 +01001095 case NC_WD_ALL:
1096 strcat(str, "?basic-mode=report-all");
1097 break;
1098 case NC_WD_TRIM:
1099 strcat(str, "?basic-mode=trim");
1100 break;
1101 case NC_WD_EXPLICIT:
1102 strcat(str, "?basic-mode=explicit");
1103 break;
1104 default:
Michal Vasko9e036d52016-01-08 10:49:26 +01001105 ERRINT;
Michal Vasko086311b2016-01-08 09:53:11 +01001106 break;
1107 }
1108
romanc1d2b092023-02-02 08:58:27 +01001109 wd_also_supported = ATOMIC_LOAD_RELAXED(server_opts.wd_also_supported);
1110 if (wd_also_supported) {
Michal Vasko2e47ef92016-06-20 10:03:24 +02001111 strcat(str, "&also-supported=");
romanc1d2b092023-02-02 08:58:27 +01001112 if (wd_also_supported & NC_WD_ALL) {
Michal Vasko086311b2016-01-08 09:53:11 +01001113 strcat(str, "report-all,");
1114 }
romanc1d2b092023-02-02 08:58:27 +01001115 if (wd_also_supported & NC_WD_ALL_TAG) {
Michal Vasko086311b2016-01-08 09:53:11 +01001116 strcat(str, "report-all-tagged,");
1117 }
romanc1d2b092023-02-02 08:58:27 +01001118 if (wd_also_supported & NC_WD_TRIM) {
Michal Vasko086311b2016-01-08 09:53:11 +01001119 strcat(str, "trim,");
1120 }
romanc1d2b092023-02-02 08:58:27 +01001121 if (wd_also_supported & NC_WD_EXPLICIT) {
Michal Vasko086311b2016-01-08 09:53:11 +01001122 strcat(str, "explicit,");
1123 }
1124 str[strlen(str) - 1] = '\0';
1125
Michal Vasko93224072021-11-09 12:14:28 +01001126 add_cpblt(str, &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001127 }
1128 }
1129 }
1130
Radek Krejci658782b2016-12-04 22:04:55 +01001131 /* other capabilities */
1132 for (u = 0; u < server_opts.capabilities_count; u++) {
Michal Vasko93224072021-11-09 12:14:28 +01001133 add_cpblt(server_opts.capabilities[u], &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001134 }
1135
1136 /* models */
Michal Vasko1440a742021-03-31 11:11:03 +02001137 u = 0;
Radek Krejci24a18412018-05-16 15:09:10 +02001138 while ((mod = ly_ctx_get_module_iter(ctx, &u))) {
Radek Krejci24a18412018-05-16 15:09:10 +02001139 if (!strcmp(mod->name, "ietf-yang-library")) {
Michal Vasko77367452021-02-16 16:32:18 +01001140 if (!mod->revision || (strcmp(mod->revision, "2016-06-21") && strcmp(mod->revision, "2019-01-04"))) {
Michal Vasko05532772021-06-03 12:12:38 +02001141 ERR(NULL, "Unknown \"ietf-yang-library\" revision, only 2016-06-21 and 2019-01-04 are supported.");
Michal Vaskod5ada122020-03-19 18:28:06 +01001142 goto error;
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001143 }
Michal Vaskod5ada122020-03-19 18:28:06 +01001144
Michal Vasko1440a742021-03-31 11:11:03 +02001145 /* get content-id */
1146 if (server_opts.content_id_clb) {
1147 yl_content_id = server_opts.content_id_clb(server_opts.content_id_data);
1148 if (!yl_content_id) {
1149 ERRMEM;
1150 goto error;
1151 }
1152 } else {
1153 yl_content_id = malloc(11);
1154 if (!yl_content_id) {
1155 ERRMEM;
1156 goto error;
1157 }
1158 sprintf(yl_content_id, "%u", ly_ctx_get_change_count(ctx));
1159 }
1160
Michal Vasko77367452021-02-16 16:32:18 +01001161 if (!strcmp(mod->revision, "2019-01-04")) {
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001162 /* new one (capab defined in RFC 8526 section 2) */
Michal Vasko1440a742021-03-31 11:11:03 +02001163 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.1?revision=%s&content-id=%s",
1164 mod->revision, yl_content_id);
Michal Vasko93224072021-11-09 12:14:28 +01001165 add_cpblt(str, &cpblts, &size, &count);
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001166 } else {
1167 /* old one (capab defined in RFC 7950 section 5.6.4) */
Michal Vasko1440a742021-03-31 11:11:03 +02001168 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.0?revision=%s&module-set-id=%s",
1169 mod->revision, yl_content_id);
Michal Vasko93224072021-11-09 12:14:28 +01001170 add_cpblt(str, &cpblts, &size, &count);
Michal Vaskod5ada122020-03-19 18:28:06 +01001171 }
Michal Vasko1440a742021-03-31 11:11:03 +02001172 free(yl_content_id);
Radek Krejci24a18412018-05-16 15:09:10 +02001173 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001174 } else if ((version == LYS_VERSION_1_0) && (mod->parsed->version > version)) {
Michal Vasko5ca5d972022-09-14 13:51:31 +02001175 /* skip YANG 1.1 modules */
Radek Krejci24a18412018-05-16 15:09:10 +02001176 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001177 } else if ((version == LYS_VERSION_1_1) && (mod->parsed->version != version)) {
Michal Vasko5ca5d972022-09-14 13:51:31 +02001178 /* skip YANG 1.0 modules */
Radek Krejci24a18412018-05-16 15:09:10 +02001179 continue;
1180 }
Michal Vasko086311b2016-01-08 09:53:11 +01001181
Michal Vasko77367452021-02-16 16:32:18 +01001182 str_len = sprintf(str, "%s?module=%s%s%s", mod->ns, mod->name, mod->revision ? "&revision=" : "",
1183 mod->revision ? mod->revision : "");
Radek Krejci24a18412018-05-16 15:09:10 +02001184
Michal Vaskodafdc742020-03-11 16:15:59 +01001185 features_count = 0;
1186 i = 0;
1187 feat = NULL;
Michal Vasko77367452021-02-16 16:32:18 +01001188 while ((feat = lysp_feature_next(feat, mod->parsed, &i))) {
Michal Vaskodafdc742020-03-11 16:15:59 +01001189 if (!(feat->flags & LYS_FENABLED)) {
1190 continue;
Michal Vaskoe90e4d12016-06-20 10:05:01 +02001191 }
Michal Vaskodafdc742020-03-11 16:15:59 +01001192 if (!features_count) {
1193 strcat(str, "&features=");
1194 str_len += 10;
1195 }
1196 len = strlen(feat->name);
1197 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1198 ERRINT;
1199 break;
1200 }
1201 if (features_count) {
1202 strcat(str, ",");
1203 ++str_len;
1204 }
1205 strcat(str, feat->name);
1206 str_len += len;
1207 features_count++;
Michal Vasko086311b2016-01-08 09:53:11 +01001208 }
Michal Vasko086311b2016-01-08 09:53:11 +01001209
Michal Vasko77367452021-02-16 16:32:18 +01001210 if (mod->deviated_by) {
Radek Krejci24a18412018-05-16 15:09:10 +02001211 strcat(str, "&deviations=");
1212 str_len += 12;
1213 dev_count = 0;
Michal Vasko77367452021-02-16 16:32:18 +01001214 LY_ARRAY_FOR(mod->deviated_by, v) {
1215 len = strlen(mod->deviated_by[v]->name);
1216 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1217 ERRINT;
1218 break;
Radek Krejci24a18412018-05-16 15:09:10 +02001219 }
Michal Vasko77367452021-02-16 16:32:18 +01001220 if (dev_count) {
1221 strcat(str, ",");
1222 ++str_len;
Radek Krejci24a18412018-05-16 15:09:10 +02001223 }
Michal Vasko77367452021-02-16 16:32:18 +01001224 strcat(str, mod->deviated_by[v]->name);
1225 str_len += len;
1226 dev_count++;
Radek Krejci24a18412018-05-16 15:09:10 +02001227 }
1228 }
1229
Michal Vasko93224072021-11-09 12:14:28 +01001230 add_cpblt(str, &cpblts, &size, &count);
Radek Krejci24a18412018-05-16 15:09:10 +02001231 }
Michal Vasko086311b2016-01-08 09:53:11 +01001232
1233 /* ending NULL capability */
Michal Vasko93224072021-11-09 12:14:28 +01001234 add_cpblt(NULL, &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001235
1236 return cpblts;
Radek Krejcif906e412017-09-22 14:44:45 +02001237
1238error:
Radek Krejcif906e412017-09-22 14:44:45 +02001239 free(cpblts);
Radek Krejcif906e412017-09-22 14:44:45 +02001240 return NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001241}
1242
Michal Vasko93224072021-11-09 12:14:28 +01001243API char **
1244nc_server_get_cpblts(const struct ly_ctx *ctx)
Radek Krejci24a18412018-05-16 15:09:10 +02001245{
1246 return nc_server_get_cpblts_version(ctx, LYS_VERSION_UNDEF);
1247}
1248
Radek Krejci695d4fa2015-10-22 13:23:54 +02001249static int
Michal Vasko77367452021-02-16 16:32:18 +01001250parse_cpblts(struct lyd_node *capabilities, char ***list)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001251{
Michal Vasko77367452021-02-16 16:32:18 +01001252 struct lyd_node *iter;
1253 struct lyd_node_opaq *cpblt;
Michal Vasko156d3272017-04-11 11:46:49 +02001254 int ver = -1, i = 0;
1255 const char *cpb_start, *cpb_end;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001256
1257 if (list) {
1258 /* get the storage for server's capabilities */
Michal Vasko77367452021-02-16 16:32:18 +01001259 LY_LIST_FOR(lyd_child(capabilities), iter) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001260 i++;
1261 }
Michal Vasko9e2d3a32015-11-10 13:09:18 +01001262 /* last item remains NULL */
1263 *list = calloc(i + 1, sizeof **list);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001264 if (!*list) {
1265 ERRMEM;
1266 return -1;
1267 }
1268 i = 0;
1269 }
1270
Michal Vasko77367452021-02-16 16:32:18 +01001271 LY_LIST_FOR(lyd_child(capabilities), iter) {
1272 cpblt = (struct lyd_node_opaq *)iter;
1273
1274 if (strcmp(cpblt->name.name, "capability") || !cpblt->name.module_ns || strcmp(cpblt->name.module_ns, NC_NS_BASE)) {
Michal Vasko05532772021-06-03 12:12:38 +02001275 ERR(NULL, "Unexpected <%s> element in client's <hello>.", cpblt->name.name);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001276 return -1;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001277 }
1278
Michal Vasko156d3272017-04-11 11:46:49 +02001279 /* skip leading/trailing whitespaces */
Michal Vasko77367452021-02-16 16:32:18 +01001280 for (cpb_start = cpblt->value; isspace(cpb_start[0]); ++cpb_start) {}
1281 for (cpb_end = cpblt->value + strlen(cpblt->value); (cpb_end > cpblt->value) && isspace(cpb_end[-1]); --cpb_end) {}
1282 if (!cpb_start[0] || (cpb_end == cpblt->value)) {
Michal Vasko05532772021-06-03 12:12:38 +02001283 ERR(NULL, "Empty capability \"%s\" received.", cpblt->value);
Michal Vasko156d3272017-04-11 11:46:49 +02001284 return -1;
1285 }
1286
Radek Krejci695d4fa2015-10-22 13:23:54 +02001287 /* detect NETCONF version */
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001288 if ((ver < 0) && !strncmp(cpb_start, "urn:ietf:params:netconf:base:1.0", cpb_end - cpb_start)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001289 ver = 0;
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001290 } else if ((ver < 1) && !strncmp(cpb_start, "urn:ietf:params:netconf:base:1.1", cpb_end - cpb_start)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001291 ver = 1;
1292 }
1293
1294 /* store capabilities */
1295 if (list) {
Michal Vasko156d3272017-04-11 11:46:49 +02001296 (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
1297 if (!(*list)[i]) {
1298 ERRMEM;
1299 return -1;
1300 }
Radek Krejci695d4fa2015-10-22 13:23:54 +02001301 i++;
1302 }
1303 }
1304
1305 if (ver == -1) {
Michal Vasko05532772021-06-03 12:12:38 +02001306 ERR(NULL, "Peer does not support a compatible NETCONF version.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001307 }
1308
1309 return ver;
1310}
1311
1312static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001313nc_send_hello_io(struct nc_session *session)
Michal Vasko086311b2016-01-08 09:53:11 +01001314{
Michal Vasko131120a2018-05-29 15:44:02 +02001315 NC_MSG_TYPE ret;
1316 int i, io_timeout;
Michal Vasko93224072021-11-09 12:14:28 +01001317 char **cpblts;
Michal Vasko131120a2018-05-29 15:44:02 +02001318 uint32_t *sid;
Michal Vasko086311b2016-01-08 09:53:11 +01001319
Michal Vasko131120a2018-05-29 15:44:02 +02001320 if (session->side == NC_CLIENT) {
1321 /* client side hello - send only NETCONF base capabilities */
1322 cpblts = malloc(3 * sizeof *cpblts);
1323 if (!cpblts) {
1324 ERRMEM;
1325 return NC_MSG_ERROR;
1326 }
Michal Vasko93224072021-11-09 12:14:28 +01001327 cpblts[0] = strdup("urn:ietf:params:netconf:base:1.0");
1328 cpblts[1] = strdup("urn:ietf:params:netconf:base:1.1");
Michal Vasko131120a2018-05-29 15:44:02 +02001329 cpblts[2] = NULL;
1330
1331 io_timeout = NC_CLIENT_HELLO_TIMEOUT * 1000;
1332 sid = NULL;
1333 } else {
Michal Vasko77367452021-02-16 16:32:18 +01001334 cpblts = nc_server_get_cpblts_version(session->ctx, LYS_VERSION_1_0);
Michal Vasko5b24b6b2020-12-04 09:29:47 +01001335 if (!cpblts) {
1336 return NC_MSG_ERROR;
1337 }
Michal Vasko131120a2018-05-29 15:44:02 +02001338
1339 io_timeout = NC_SERVER_HELLO_TIMEOUT * 1000;
1340 sid = &session->id;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001341 }
Michal Vasko05ba9df2016-01-13 14:40:27 +01001342
Michal Vasko131120a2018-05-29 15:44:02 +02001343 ret = nc_write_msg_io(session, io_timeout, NC_MSG_HELLO, cpblts, sid);
Michal Vasko086311b2016-01-08 09:53:11 +01001344
Michal Vasko086311b2016-01-08 09:53:11 +01001345 for (i = 0; cpblts[i]; ++i) {
Michal Vasko93224072021-11-09 12:14:28 +01001346 free(cpblts[i]);
Michal Vasko086311b2016-01-08 09:53:11 +01001347 }
1348 free(cpblts);
1349
Michal Vasko131120a2018-05-29 15:44:02 +02001350 return ret;
Michal Vasko086311b2016-01-08 09:53:11 +01001351}
1352
1353static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001354nc_recv_client_hello_io(struct nc_session *session)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001355{
Michal Vasko77367452021-02-16 16:32:18 +01001356 struct ly_in *msg;
1357 struct lyd_node *hello = NULL, *iter;
1358 struct lyd_node_opaq *node;
1359 int r, ver = -1, flag = 0;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001360 char *str;
Michal Vasko292c5542023-02-01 14:33:17 +01001361 long long id;
Michal Vasko77367452021-02-16 16:32:18 +01001362 NC_MSG_TYPE rc = NC_MSG_HELLO;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001363
Michal Vasko77367452021-02-16 16:32:18 +01001364 r = nc_read_msg_poll_io(session, NC_CLIENT_HELLO_TIMEOUT * 1000, &msg);
1365 switch (r) {
1366 case 1:
Radek Krejci695d4fa2015-10-22 13:23:54 +02001367 /* parse <hello> data */
Michal Vasko77367452021-02-16 16:32:18 +01001368 if (lyd_parse_data(session->ctx, NULL, msg, LYD_XML, LYD_PARSE_ONLY | LYD_PARSE_OPAQ, 0, &hello)) {
Michal Vasko05532772021-06-03 12:12:38 +02001369 ERR(session, "Failed to parse server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001370 rc = NC_MSG_ERROR;
1371 goto cleanup;
1372 }
1373
1374 LY_LIST_FOR(lyd_child(hello), iter) {
1375 node = (struct lyd_node_opaq *)iter;
1376
1377 if (!node->name.module_ns || strcmp(node->name.module_ns, NC_NS_BASE)) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001378 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001379 } else if (!strcmp(node->name.name, "session-id")) {
1380 if (!node->value || !strlen(node->value)) {
Michal Vasko05532772021-06-03 12:12:38 +02001381 ERR(session, "No value of <session-id> element in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001382 rc = NC_MSG_ERROR;
1383 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001384 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001385 str = NULL;
Michal Vasko77367452021-02-16 16:32:18 +01001386 id = strtoll(node->value, &str, 10);
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001387 if (*str || (id < 1) || (id > UINT32_MAX)) {
Michal Vasko05532772021-06-03 12:12:38 +02001388 ERR(session, "Invalid value of <session-id> element in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001389 rc = NC_MSG_ERROR;
1390 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001391 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001392 session->id = (uint32_t)id;
1393 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001394 } else if (strcmp(node->name.name, "capabilities")) {
Michal Vasko05532772021-06-03 12:12:38 +02001395 ERR(session, "Unexpected <%s> element in server <hello>.", node->name.name);
Michal Vasko77367452021-02-16 16:32:18 +01001396 rc = NC_MSG_ERROR;
1397 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001398 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001399
1400 if (flag) {
1401 /* multiple capabilities elements */
Michal Vasko05532772021-06-03 12:12:38 +02001402 ERR(session, "Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko77367452021-02-16 16:32:18 +01001403 rc = NC_MSG_ERROR;
1404 goto cleanup;
Michal Vasko11d142a2016-01-19 15:58:24 +01001405 }
1406 flag = 1;
1407
Michal Vasko77367452021-02-16 16:32:18 +01001408 if ((ver = parse_cpblts(&node->node, &session->opts.client.cpblts)) < 0) {
1409 rc = NC_MSG_ERROR;
1410 goto cleanup;
Michal Vasko11d142a2016-01-19 15:58:24 +01001411 }
1412 session->version = ver;
1413 }
1414
1415 if (!session->id) {
Michal Vasko05532772021-06-03 12:12:38 +02001416 ERR(session, "Missing <session-id> in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001417 rc = NC_MSG_ERROR;
1418 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001419 }
1420 break;
Michal Vasko77367452021-02-16 16:32:18 +01001421 case 0:
Michal Vasko05532772021-06-03 12:12:38 +02001422 ERR(session, "Server <hello> timeout elapsed.");
Michal Vasko77367452021-02-16 16:32:18 +01001423 rc = NC_MSG_WOULDBLOCK;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001424 break;
1425 default:
Michal Vasko77367452021-02-16 16:32:18 +01001426 rc = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001427 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001428 }
1429
Michal Vasko77367452021-02-16 16:32:18 +01001430cleanup:
1431 ly_in_free(msg, 1);
1432 lyd_free_tree(hello);
1433 return rc;
Radek Krejci5686ff72015-10-09 13:33:56 +02001434}
1435
Michal Vasko11d142a2016-01-19 15:58:24 +01001436static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001437nc_recv_server_hello_io(struct nc_session *session)
Michal Vasko11d142a2016-01-19 15:58:24 +01001438{
Michal Vasko77367452021-02-16 16:32:18 +01001439 struct ly_in *msg;
1440 struct lyd_node *hello = NULL, *iter;
1441 struct lyd_node_opaq *node;
1442 NC_MSG_TYPE rc = NC_MSG_HELLO;
1443 int r, ver = -1, flag = 0, timeout_io;
Michal Vasko11d142a2016-01-19 15:58:24 +01001444
Michal Vasko77367452021-02-16 16:32:18 +01001445 timeout_io = server_opts.hello_timeout ? server_opts.hello_timeout * 1000 : NC_SERVER_HELLO_TIMEOUT * 1000;
1446 r = nc_read_msg_poll_io(session, timeout_io, &msg);
1447 switch (r) {
1448 case 1:
1449 /* parse <hello> data */
1450 if (lyd_parse_data(session->ctx, NULL, msg, LYD_XML, LYD_PARSE_ONLY | LYD_PARSE_OPAQ, 0, &hello)) {
Michal Vasko05532772021-06-03 12:12:38 +02001451 ERR(session, "Failed to parse client <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001452 rc = NC_MSG_ERROR;
1453 goto cleanup;
1454 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001455
Michal Vasko77367452021-02-16 16:32:18 +01001456 /* learn NETCONF version */
1457 LY_LIST_FOR(lyd_child(hello), iter) {
1458 node = (struct lyd_node_opaq *)iter;
1459
1460 if (!node->name.module_ns || strcmp(node->name.module_ns, NC_NS_BASE)) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001461 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001462 } else if (strcmp(node->name.name, "capabilities")) {
Michal Vasko05532772021-06-03 12:12:38 +02001463 ERR(session, "Unexpected <%s> element in client <hello>.", node->name.name);
Michal Vasko77367452021-02-16 16:32:18 +01001464 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001465 goto cleanup;
1466 }
1467
1468 if (flag) {
1469 /* multiple capabilities elements */
Michal Vasko05532772021-06-03 12:12:38 +02001470 ERR(session, "Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko77367452021-02-16 16:32:18 +01001471 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001472 goto cleanup;
1473 }
1474 flag = 1;
1475
Michal Vasko77367452021-02-16 16:32:18 +01001476 if ((ver = parse_cpblts(&node->node, NULL)) < 0) {
1477 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001478 goto cleanup;
1479 }
1480 session->version = ver;
1481 }
1482 break;
Michal Vasko77367452021-02-16 16:32:18 +01001483 case 0:
Michal Vasko05532772021-06-03 12:12:38 +02001484 ERR(session, "Client <hello> timeout elapsed.");
Michal Vasko77367452021-02-16 16:32:18 +01001485 rc = NC_MSG_WOULDBLOCK;
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001486 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001487 default:
Michal Vasko77367452021-02-16 16:32:18 +01001488 rc = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001489 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001490 }
1491
1492cleanup:
Michal Vasko77367452021-02-16 16:32:18 +01001493 ly_in_free(msg, 1);
1494 lyd_free_tree(hello);
1495 return rc;
Michal Vasko11d142a2016-01-19 15:58:24 +01001496}
1497
Michal Vasko71090fc2016-05-24 16:37:28 +02001498NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001499nc_handshake_io(struct nc_session *session)
Michal Vasko80cad7f2015-12-08 14:42:27 +01001500{
Michal Vasko086311b2016-01-08 09:53:11 +01001501 NC_MSG_TYPE type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001502
Michal Vasko131120a2018-05-29 15:44:02 +02001503 type = nc_send_hello_io(session);
Michal Vasko086311b2016-01-08 09:53:11 +01001504 if (type != NC_MSG_HELLO) {
Michal Vasko71090fc2016-05-24 16:37:28 +02001505 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001506 }
1507
Michal Vasko11d142a2016-01-19 15:58:24 +01001508 if (session->side == NC_CLIENT) {
Michal Vasko131120a2018-05-29 15:44:02 +02001509 type = nc_recv_client_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001510 } else {
Michal Vasko131120a2018-05-29 15:44:02 +02001511 type = nc_recv_server_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001512 }
1513
Michal Vasko71090fc2016-05-24 16:37:28 +02001514 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001515}
Michal Vasko086311b2016-01-08 09:53:11 +01001516
Michal Vasko889162e2019-09-06 14:43:37 +02001517#ifdef NC_ENABLED_SSH
1518
Michal Vasko999b64a2019-07-10 16:06:15 +02001519static void
1520nc_ssh_init(void)
1521{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001522#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
Michal Vasko999b64a2019-07-10 16:06:15 +02001523 ssh_threads_set_callbacks(ssh_threads_get_pthread());
1524 ssh_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001525#endif
Michal Vasko999b64a2019-07-10 16:06:15 +02001526}
1527
1528static void
1529nc_ssh_destroy(void)
1530{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001531#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko999b64a2019-07-10 16:06:15 +02001532 FIPS_mode_set(0);
1533 CONF_modules_unload(1);
1534 nc_thread_destroy();
Michal Vasko889162e2019-09-06 14:43:37 +02001535#endif
1536
Michal Vaskoe1e82632019-09-09 09:18:03 +02001537#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
1538 ssh_finalize();
1539#endif
1540}
1541
Michal Vasko889162e2019-09-06 14:43:37 +02001542#endif /* NC_ENABLED_SSH */
Michal Vasko999b64a2019-07-10 16:06:15 +02001543
Radek Krejci53691be2016-02-22 13:58:37 +01001544#ifdef NC_ENABLED_TLS
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001545
Michal Vasko770b4362017-02-17 14:44:18 +01001546#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1547
Michal Vaskof0c92c02016-01-29 09:41:45 +01001548struct CRYPTO_dynlock_value {
1549 pthread_mutex_t lock;
1550};
1551
Michal Vaskof0c92c02016-01-29 09:41:45 +01001552static struct CRYPTO_dynlock_value *
1553tls_dyn_create_func(const char *UNUSED(file), int UNUSED(line))
1554{
1555 struct CRYPTO_dynlock_value *value;
1556
1557 value = malloc(sizeof *value);
1558 if (!value) {
1559 ERRMEM;
1560 return NULL;
1561 }
1562 pthread_mutex_init(&value->lock, NULL);
1563
1564 return value;
1565}
1566
1567static void
1568tls_dyn_lock_func(int mode, struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1569{
1570 /* mode can also be CRYPTO_READ or CRYPTO_WRITE, but all the examples
1571 * I found ignored this fact, what do I know... */
1572 if (mode & CRYPTO_LOCK) {
1573 pthread_mutex_lock(&l->lock);
1574 } else {
1575 pthread_mutex_unlock(&l->lock);
1576 }
1577}
1578
1579static void
1580tls_dyn_destroy_func(struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1581{
1582 pthread_mutex_destroy(&l->lock);
1583 free(l);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001584}
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001585
Michal Vasko770b4362017-02-17 14:44:18 +01001586#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001587
Michal Vasko8f0c0282016-02-29 10:17:14 +01001588#endif /* NC_ENABLED_TLS */
1589
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001590#if defined (NC_ENABLED_TLS) && !defined (NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001591
Michal Vasko770b4362017-02-17 14:44:18 +01001592#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001593static pthread_mutex_t *tls_locks;
1594
1595static void
1596tls_thread_locking_func(int mode, int n, const char *UNUSED(file), int UNUSED(line))
1597{
1598 if (mode & CRYPTO_LOCK) {
1599 pthread_mutex_lock(tls_locks + n);
1600 } else {
1601 pthread_mutex_unlock(tls_locks + n);
1602 }
1603}
1604
1605static void
1606tls_thread_id_func(CRYPTO_THREADID *tid)
1607{
1608 CRYPTO_THREADID_set_numeric(tid, (unsigned long)pthread_self());
1609}
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001610
Michal Vasko770b4362017-02-17 14:44:18 +01001611#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001612
1613static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001614nc_tls_init(void)
1615{
Rosen Penev4f552d62019-06-26 16:10:43 -07001616#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001617 SSL_load_error_strings();
Michal Vasko7f1c78b2016-01-19 09:52:14 +01001618 ERR_load_BIO_strings();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001619 SSL_library_init();
1620
Michal Vaskof89948c2018-01-04 09:19:46 +01001621 int i;
1622
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001623 tls_locks = malloc(CRYPTO_num_locks() * sizeof *tls_locks);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001624 if (!tls_locks) {
1625 ERRMEM;
1626 return;
1627 }
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001628 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1629 pthread_mutex_init(tls_locks + i, NULL);
1630 }
1631
Michal Vaskof0c92c02016-01-29 09:41:45 +01001632 CRYPTO_THREADID_set_callback(tls_thread_id_func);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001633 CRYPTO_set_locking_callback(tls_thread_locking_func);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001634
1635 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1636 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1637 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001638#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001639}
1640
Michal Vasko8f0c0282016-02-29 10:17:14 +01001641static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001642nc_tls_destroy(void)
1643{
Rosen Penev4f552d62019-06-26 16:10:43 -07001644#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001645 FIPS_mode_set(0);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001646 CRYPTO_cleanup_all_ex_data();
Michal Vaskob6e37262016-02-25 14:49:00 +01001647 nc_thread_destroy();
Michal Vasko5e228792016-02-03 15:30:24 +01001648 EVP_cleanup();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001649 ERR_free_strings();
Michal Vasko770b4362017-02-17 14:44:18 +01001650#if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001651 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vasko770b4362017-02-17 14:44:18 +01001652#elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1653 SSL_COMP_free_compression_methods();
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001654#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001655
Michal Vaskof89948c2018-01-04 09:19:46 +01001656 int i;
1657
Michal Vaskob6e37262016-02-25 14:49:00 +01001658 CRYPTO_THREADID_set_callback(NULL);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001659 CRYPTO_set_locking_callback(NULL);
1660 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1661 pthread_mutex_destroy(tls_locks + i);
1662 }
1663 free(tls_locks);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001664
1665 CRYPTO_set_dynlock_create_callback(NULL);
1666 CRYPTO_set_dynlock_lock_callback(NULL);
1667 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001668#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001669}
1670
Michal Vasko8f0c0282016-02-29 10:17:14 +01001671#endif /* NC_ENABLED_TLS && !NC_ENABLED_SSH */
Michal Vasko5e228792016-02-03 15:30:24 +01001672
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001673#if defined (NC_ENABLED_SSH) && defined (NC_ENABLED_TLS)
Michal Vasko5e228792016-02-03 15:30:24 +01001674
Michal Vasko8f0c0282016-02-29 10:17:14 +01001675static void
Michal Vasko5e228792016-02-03 15:30:24 +01001676nc_ssh_tls_init(void)
1677{
Rosen Penev4f552d62019-06-26 16:10:43 -07001678#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001679 SSL_load_error_strings();
1680 ERR_load_BIO_strings();
1681 SSL_library_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001682#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001683
1684 nc_ssh_init();
1685
Michal Vaskoe1e82632019-09-09 09:18:03 +02001686#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001687 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1688 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1689 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001690#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001691}
1692
Michal Vasko8f0c0282016-02-29 10:17:14 +01001693static void
Michal Vasko5e228792016-02-03 15:30:24 +01001694nc_ssh_tls_destroy(void)
1695{
Rosen Penev4f552d62019-06-26 16:10:43 -07001696#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001697 ERR_free_strings();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001698# if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vasko5e228792016-02-03 15:30:24 +01001699 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vaskoe1e82632019-09-09 09:18:03 +02001700# elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko770b4362017-02-17 14:44:18 +01001701 SSL_COMP_free_compression_methods();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001702# endif
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001703#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001704
1705 nc_ssh_destroy();
1706
Michal Vaskoe1e82632019-09-09 09:18:03 +02001707#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001708 CRYPTO_set_dynlock_create_callback(NULL);
1709 CRYPTO_set_dynlock_lock_callback(NULL);
1710 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001711#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001712}
1713
Radek Krejci53691be2016-02-22 13:58:37 +01001714#endif /* NC_ENABLED_SSH && NC_ENABLED_TLS */
Michal Vasko8f0c0282016-02-29 10:17:14 +01001715
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001716#if defined (NC_ENABLED_SSH) || defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001717
1718API void
1719nc_thread_destroy(void)
1720{
Michal Vasko8f0c0282016-02-29 10:17:14 +01001721 /* caused data-races and seems not neccessary for avoiding valgrind reachable memory */
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001722 // CRYPTO_cleanup_all_ex_data();
Michal Vasko8f0c0282016-02-29 10:17:14 +01001723
Michal Vasko770b4362017-02-17 14:44:18 +01001724#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1725 CRYPTO_THREADID crypto_tid;
1726
Michal Vasko8f0c0282016-02-29 10:17:14 +01001727 CRYPTO_THREADID_current(&crypto_tid);
1728 ERR_remove_thread_state(&crypto_tid);
Michal Vasko770b4362017-02-17 14:44:18 +01001729#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001730}
1731
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001732#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
1733
1734void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001735nc_init(void)
1736{
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001737#if defined (NC_ENABLED_SSH) && defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001738 nc_ssh_tls_init();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001739#elif defined (NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001740 nc_ssh_init();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001741#elif defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001742 nc_tls_init();
1743#endif
1744}
1745
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001746void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001747nc_destroy(void)
1748{
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001749#if defined (NC_ENABLED_SSH) && defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001750 nc_ssh_tls_destroy();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001751#elif defined (NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001752 nc_ssh_destroy();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001753#elif defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001754 nc_tls_destroy();
1755#endif
1756}