blob: 8ebb83a206dae090208b1cbb7cce2b8b15f577e8 [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
Michal Vaskoddce1212019-05-24 09:58:49 +0200110const char *
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200111nc_keytype2str(NC_SSH_KEY_TYPE type)
Michal Vaskoddce1212019-05-24 09:58:49 +0200112{
113 switch (type) {
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200114 case NC_SSH_KEY_DSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200115 return "DSA";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200116 case NC_SSH_KEY_RSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200117 return "RSA";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200118 case NC_SSH_KEY_ECDSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200119 return "EC";
120 default:
121 break;
122 }
123
124 return NULL;
125}
126
Michal Vaskobe52dc22018-10-17 09:28:17 +0200127int
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200128nc_sock_enable_keepalive(int sock, struct nc_keepalives *ka)
Michal Vaskobe52dc22018-10-17 09:28:17 +0200129{
130 int opt;
131
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200132 opt = ka->enabled;
Michal Vaskobe52dc22018-10-17 09:28:17 +0200133 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200134 ERR(NULL, "Could not set SO_KEEPALIVE option (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200135 return -1;
136 }
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200137 if (!ka->enabled) {
138 return 0;
139 }
Michal Vaskobe52dc22018-10-17 09:28:17 +0200140
141#ifdef TCP_KEEPIDLE
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200142 opt = ka->idle_time;
Michal Vaskobe52dc22018-10-17 09:28:17 +0200143 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPIDLE, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200144 ERR(NULL, "Setsockopt failed (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200145 return -1;
146 }
147#endif
148
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200149#ifdef TCP_KEEPCNT
150 opt = ka->max_probes;
151 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPCNT, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200152 ERR(NULL, "Setsockopt failed (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200153 return -1;
154 }
155#endif
156
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200157#ifdef TCP_KEEPINTVL
158 opt = ka->probe_interval;
159 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPINTVL, &opt, sizeof opt) == -1) {
Michal Vasko05532772021-06-03 12:12:38 +0200160 ERR(NULL, "Setsockopt failed (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200161 return -1;
162 }
163#endif
164
165 return 0;
166}
167
Michal Vaskoade892d2017-02-22 13:40:35 +0100168struct nc_session *
Michal Vasko131120a2018-05-29 15:44:02 +0200169nc_new_session(NC_SIDE side, int shared_ti)
Michal Vaskoade892d2017-02-22 13:40:35 +0100170{
171 struct nc_session *sess;
172
173 sess = calloc(1, sizeof *sess);
174 if (!sess) {
175 return NULL;
176 }
177
Michal Vasko131120a2018-05-29 15:44:02 +0200178 sess->side = side;
179
180 if (side == NC_SERVER) {
Michal Vaskodf68e7e2022-04-21 11:04:00 +0200181 pthread_mutex_init(&sess->opts.server.ntf_status_lock, NULL);
Michal Vaskoacf98472021-02-04 15:33:57 +0100182 pthread_mutex_init(&sess->opts.server.rpc_lock, NULL);
183 pthread_cond_init(&sess->opts.server.rpc_cond, NULL);
Michal Vaskoacf98472021-02-04 15:33:57 +0100184
185 pthread_mutex_init(&sess->opts.server.ch_lock, NULL);
186 pthread_cond_init(&sess->opts.server.ch_cond, NULL);
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200187 } else {
188 pthread_mutex_init(&sess->opts.client.msgs_lock, NULL);
Michal Vasko131120a2018-05-29 15:44:02 +0200189 }
190
191 if (!shared_ti) {
192 sess->io_lock = malloc(sizeof *sess->io_lock);
193 if (!sess->io_lock) {
194 goto error;
195 }
196 pthread_mutex_init(sess->io_lock, NULL);
Michal Vaskoade892d2017-02-22 13:40:35 +0100197 }
198
199 return sess;
Michal Vasko131120a2018-05-29 15:44:02 +0200200
201error:
Michal Vasko131120a2018-05-29 15:44:02 +0200202 free(sess);
203 return NULL;
Michal Vaskoade892d2017-02-22 13:40:35 +0100204}
205
Michal Vasko96164bf2016-01-21 15:41:58 +0100206/*
207 * @return 1 - success
208 * 0 - timeout
209 * -1 - error
210 */
211int
Michal Vasko131120a2018-05-29 15:44:02 +0200212nc_session_rpc_lock(struct nc_session *session, int timeout, const char *func)
Michal Vasko96164bf2016-01-21 15:41:58 +0100213{
214 int ret;
Michal Vasko62be1ce2016-03-03 13:24:52 +0100215 struct timespec ts_timeout;
Michal Vasko96164bf2016-01-21 15:41:58 +0100216
Michal Vasko131120a2018-05-29 15:44:02 +0200217 if (session->side != NC_SERVER) {
218 ERRINT;
219 return -1;
220 }
221
Michal Vasko96164bf2016-01-21 15:41:58 +0100222 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100223 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vasko96164bf2016-01-21 15:41:58 +0100224
Michal Vaskoade892d2017-02-22 13:40:35 +0100225 /* LOCK */
Michal Vaskod8a74192023-02-06 15:51:50 +0100226 ret = pthread_mutex_clocklock(&session->opts.server.rpc_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100227 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100228 while (session->opts.server.rpc_inuse) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100229 ret = pthread_cond_clockwait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock,
230 COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100231 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100232 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100233 break;
234 }
235 }
236 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100237 } else if (!timeout) {
Michal Vaskoade892d2017-02-22 13:40:35 +0100238 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100239 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100240 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100241 if (session->opts.server.rpc_inuse) {
242 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100243 return 0;
244 }
Michal vasko2f8e4b52016-10-05 13:04:11 +0200245 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100246 } else { /* timeout == -1 */
Michal Vaskoade892d2017-02-22 13:40:35 +0100247 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100248 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100249 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100250 while (session->opts.server.rpc_inuse) {
251 ret = pthread_cond_wait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100252 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100253 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100254 break;
255 }
256 }
257 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100258 }
259
Michal Vaskoade892d2017-02-22 13:40:35 +0100260 if (ret) {
261 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
262 /* timeout */
263 return 0;
264 }
265
Michal Vasko96164bf2016-01-21 15:41:58 +0100266 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200267 ERR(session, "%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vasko96164bf2016-01-21 15:41:58 +0100268 return -1;
269 }
270
271 /* ok */
Michal Vaskoacf98472021-02-04 15:33:57 +0100272 assert(session->opts.server.rpc_inuse == 0);
273 session->opts.server.rpc_inuse = 1;
Michal Vaskoade892d2017-02-22 13:40:35 +0100274
275 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100276 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100277 if (ret) {
278 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200279 ERR(session, "%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100280 return -1;
281 }
282
283 return 1;
284}
285
286int
Michal Vasko131120a2018-05-29 15:44:02 +0200287nc_session_rpc_unlock(struct nc_session *session, int timeout, const char *func)
Michal Vaskoade892d2017-02-22 13:40:35 +0100288{
289 int ret;
290 struct timespec ts_timeout;
291
Michal Vasko131120a2018-05-29 15:44:02 +0200292 if (session->side != NC_SERVER) {
293 ERRINT;
294 return -1;
295 }
296
Michal Vaskoacf98472021-02-04 15:33:57 +0100297 assert(session->opts.server.rpc_inuse);
Michal Vaskoade892d2017-02-22 13:40:35 +0100298
299 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100300 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100301
302 /* LOCK */
Michal Vaskod8a74192023-02-06 15:51:50 +0100303 ret = pthread_mutex_clocklock(&session->opts.server.rpc_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100304 } else if (!timeout) {
305 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100306 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100307 } else { /* timeout == -1 */
308 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100309 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100310 }
311
312 if (ret && (ret != EBUSY) && (ret != ETIMEDOUT)) {
313 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200314 ERR(session, "%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100315 return -1;
316 } else if (ret) {
Michal Vasko69e98752022-12-14 14:20:17 +0100317 WRN(session, "%s: session RPC lock timeout, should not happen.", func);
Michal Vaskoade892d2017-02-22 13:40:35 +0100318 }
319
Michal Vaskoacf98472021-02-04 15:33:57 +0100320 session->opts.server.rpc_inuse = 0;
321 pthread_cond_signal(&session->opts.server.rpc_cond);
Michal Vaskoade892d2017-02-22 13:40:35 +0100322
323 if (!ret) {
324 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100325 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100326 if (ret) {
327 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200328 ERR(session, "%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100329 return -1;
330 }
331 }
332
Michal Vasko96164bf2016-01-21 15:41:58 +0100333 return 1;
334}
335
Michal Vasko131120a2018-05-29 15:44:02 +0200336int
337nc_session_io_lock(struct nc_session *session, int timeout, const char *func)
338{
339 int ret;
340 struct timespec ts_timeout;
341
342 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100343 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vasko131120a2018-05-29 15:44:02 +0200344
Michal Vaskod8a74192023-02-06 15:51:50 +0100345 ret = pthread_mutex_clocklock(session->io_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vasko131120a2018-05-29 15:44:02 +0200346 } else if (!timeout) {
347 ret = pthread_mutex_trylock(session->io_lock);
348 } else { /* timeout == -1 */
Robin Jarry54ea2962018-10-10 10:33:40 +0200349 ret = pthread_mutex_lock(session->io_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200350 }
351
352 if (ret) {
353 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
354 /* timeout */
355 return 0;
356 }
357
358 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200359 ERR(session, "%s: failed to IO lock a session (%s).", func, strerror(ret));
Michal Vasko131120a2018-05-29 15:44:02 +0200360 return -1;
361 }
362
363 return 1;
364}
365
366int
367nc_session_io_unlock(struct nc_session *session, const char *func)
368{
369 int ret;
370
371 ret = pthread_mutex_unlock(session->io_lock);
372 if (ret) {
373 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200374 ERR(session, "%s: failed to IO unlock a session (%s).", func, strerror(ret));
Michal Vasko131120a2018-05-29 15:44:02 +0200375 return -1;
376 }
377
378 return 1;
379}
380
Michal Vasko01130bd2021-08-26 11:47:38 +0200381int
382nc_session_client_msgs_lock(struct nc_session *session, int *timeout, const char *func)
383{
384 int ret;
385 int32_t diff_msec;
roman6ece9c52022-06-22 09:29:17 +0200386 struct timespec ts_timeout, ts_start;
Michal Vasko01130bd2021-08-26 11:47:38 +0200387
388 assert(session->side == NC_CLIENT);
389
390 if (*timeout > 0) {
391 /* get current time */
Michal Vaskod8a74192023-02-06 15:51:50 +0100392 nc_timeouttime_get(&ts_start, 0);
Michal Vasko01130bd2021-08-26 11:47:38 +0200393
Michal Vaskod8a74192023-02-06 15:51:50 +0100394 nc_timeouttime_get(&ts_timeout, *timeout);
Michal Vasko01130bd2021-08-26 11:47:38 +0200395
Michal Vaskod8a74192023-02-06 15:51:50 +0100396 ret = pthread_mutex_clocklock(&session->opts.client.msgs_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vasko01130bd2021-08-26 11:47:38 +0200397 if (!ret) {
398 /* update timeout based on what was elapsed */
Michal Vaskod8a74192023-02-06 15:51:50 +0100399 diff_msec = nc_timeouttime_cur_diff(&ts_start);
Michal Vasko01130bd2021-08-26 11:47:38 +0200400 *timeout -= diff_msec;
401 }
402 } else if (!*timeout) {
403 ret = pthread_mutex_trylock(&session->opts.client.msgs_lock);
404 } else { /* timeout == -1 */
405 ret = pthread_mutex_lock(&session->opts.client.msgs_lock);
406 }
407
408 if (ret) {
409 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
410 /* timeout */
411 return 0;
412 }
413
414 /* error */
415 ERR(session, "%s: failed to MSGS lock a session (%s).", func, strerror(ret));
416 return -1;
417 }
418
419 return 1;
420}
421
422int
423nc_session_client_msgs_unlock(struct nc_session *session, const char *func)
424{
425 int ret;
426
427 assert(session->side == NC_CLIENT);
428
429 ret = pthread_mutex_unlock(&session->opts.client.msgs_lock);
430 if (ret) {
431 /* error */
432 ERR(session, "%s: failed to MSGS unlock a session (%s).", func, strerror(ret));
433 return -1;
434 }
435
436 return 1;
437}
438
Michal Vasko8dadf782016-01-15 10:29:36 +0100439API NC_STATUS
440nc_session_get_status(const struct nc_session *session)
441{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100442 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200443 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200444 return NC_STATUS_ERR;
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100445 }
446
Michal Vasko8dadf782016-01-15 10:29:36 +0100447 return session->status;
448}
449
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100450API NC_SESSION_TERM_REASON
Michal Vasko142cfea2017-08-07 10:12:11 +0200451nc_session_get_term_reason(const struct nc_session *session)
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100452{
453 if (!session) {
454 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200455 return NC_SESSION_TERM_ERR;
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100456 }
457
458 return session->term_reason;
459}
460
Michal Vasko8dadf782016-01-15 10:29:36 +0100461API uint32_t
Michal Vasko142cfea2017-08-07 10:12:11 +0200462nc_session_get_killed_by(const struct nc_session *session)
463{
464 if (!session) {
465 ERRARG("session");
466 return 0;
467 }
468
469 return session->killed_by;
470}
471
472API uint32_t
Michal Vasko8dadf782016-01-15 10:29:36 +0100473nc_session_get_id(const struct nc_session *session)
474{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100475 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200476 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100477 return 0;
478 }
479
Michal Vasko8dadf782016-01-15 10:29:36 +0100480 return session->id;
481}
482
Michal Vasko174fe8e2016-02-17 15:38:09 +0100483API int
484nc_session_get_version(const struct nc_session *session)
485{
486 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200487 ERRARG("session");
Michal Vasko174fe8e2016-02-17 15:38:09 +0100488 return -1;
489 }
490
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200491 return session->version == NC_VERSION_10 ? 0 : 1;
Michal Vasko174fe8e2016-02-17 15:38:09 +0100492}
493
Michal Vasko8dadf782016-01-15 10:29:36 +0100494API NC_TRANSPORT_IMPL
495nc_session_get_ti(const struct nc_session *session)
496{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100497 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200498 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100499 return 0;
500 }
501
Michal Vasko8dadf782016-01-15 10:29:36 +0100502 return session->ti_type;
503}
504
505API const char *
506nc_session_get_username(const struct nc_session *session)
507{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100508 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200509 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100510 return NULL;
511 }
512
Michal Vasko8dadf782016-01-15 10:29:36 +0100513 return session->username;
514}
515
516API const char *
517nc_session_get_host(const struct nc_session *session)
518{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100519 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200520 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100521 return NULL;
522 }
523
Michal Vasko8dadf782016-01-15 10:29:36 +0100524 return session->host;
525}
526
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200527API const char *
528nc_session_get_path(const struct nc_session *session)
529{
530 if (!session) {
531 ERRARG("session");
532 return NULL;
533 }
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200534 if (session->ti_type != NC_TI_UNIX) {
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200535 return NULL;
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200536 }
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200537
538 return session->path;
539}
540
Michal Vasko8dadf782016-01-15 10:29:36 +0100541API uint16_t
542nc_session_get_port(const struct nc_session *session)
543{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100544 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200545 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100546 return 0;
547 }
548
Michal Vasko8dadf782016-01-15 10:29:36 +0100549 return session->port;
550}
551
Michal Vasko93224072021-11-09 12:14:28 +0100552API const struct ly_ctx *
Michal Vasko9a25e932016-02-01 10:36:42 +0100553nc_session_get_ctx(const struct nc_session *session)
554{
555 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200556 ERRARG("session");
Michal Vasko9a25e932016-02-01 10:36:42 +0100557 return NULL;
558 }
559
560 return session->ctx;
561}
562
Michal Vasko2cc4c682016-03-01 09:16:48 +0100563API void
564nc_session_set_data(struct nc_session *session, void *data)
565{
566 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200567 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100568 return;
569 }
570
571 session->data = data;
572}
573
574API void *
575nc_session_get_data(const struct nc_session *session)
576{
577 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200578 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100579 return NULL;
580 }
581
582 return session->data;
583}
584
Michal Vasko086311b2016-01-08 09:53:11 +0100585NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +0200586nc_send_msg_io(struct nc_session *session, int io_timeout, struct lyd_node *op)
Radek Krejci695d4fa2015-10-22 13:23:54 +0200587{
Michal Vasko7e1f5fb2021-11-10 10:14:45 +0100588 if (session->ctx != LYD_CTX(op)) {
589 ERR(session, "RPC \"%s\" was created in different context than that of the session.", LYD_NAME(op));
Michal Vasko086311b2016-01-08 09:53:11 +0100590 return NC_MSG_ERROR;
Michal Vasko7df39ec2015-12-09 15:26:24 +0100591 }
592
Michal Vasko131120a2018-05-29 15:44:02 +0200593 return nc_write_msg_io(session, io_timeout, NC_MSG_RPC, op, NULL);
Michal Vasko7df39ec2015-12-09 15:26:24 +0100594}
595
Michal Vaskod4da3632022-05-25 11:49:10 +0200596/**
597 * @brief Send \<close-session\> and read the reply on a session.
598 *
599 * @param[in] session Closing NETCONF session.
600 */
601static void
602nc_session_free_close_session(struct nc_session *session)
603{
604 struct ly_in *msg;
605 struct lyd_node *close_rpc, *envp;
606 const struct lys_module *ietfnc;
607
608 ietfnc = ly_ctx_get_module_implemented(session->ctx, "ietf-netconf");
609 if (!ietfnc) {
Michal Vasko5ca5d972022-09-14 13:51:31 +0200610 WRN(session, "Missing ietf-netconf module in context, unable to send <close-session>.");
Michal Vaskod4da3632022-05-25 11:49:10 +0200611 return;
612 }
613 if (lyd_new_inner(NULL, ietfnc, "close-session", 0, &close_rpc)) {
614 WRN(session, "Failed to create <close-session> RPC.");
615 return;
616 }
617
618 /* send the RPC */
619 nc_send_msg_io(session, NC_SESSION_FREE_LOCK_TIMEOUT, close_rpc);
620
621read_msg:
622 switch (nc_read_msg_poll_io(session, NC_CLOSE_REPLY_TIMEOUT, &msg)) {
623 case 1:
624 if (!strncmp(ly_in_memory(msg, NULL), "<notification", 13)) {
625 /* ignore */
626 ly_in_free(msg, 1);
627 goto read_msg;
628 }
629 if (lyd_parse_op(session->ctx, close_rpc, msg, LYD_XML, LYD_TYPE_REPLY_NETCONF, &envp, NULL)) {
630 WRN(session, "Failed to parse <close-session> reply.");
631 } else if (!lyd_child(envp) || strcmp(LYD_NAME(lyd_child(envp)), "ok")) {
632 WRN(session, "Reply to <close-session> was not <ok> as expected.");
633 }
634 lyd_free_tree(envp);
635 ly_in_free(msg, 1);
636 break;
637 case 0:
638 WRN(session, "Timeout for receiving a reply to <close-session> elapsed.");
639 break;
640 case -1:
641 ERR(session, "Failed to receive a reply to <close-session>.");
642 break;
643 default:
644 /* cannot happen */
645 break;
646 }
647 lyd_free_tree(close_rpc);
648}
649
Michal Vasko33476c32022-09-09 11:21:40 +0200650/**
651 * @brief Free transport implementation members of a session.
652 *
653 * @param[in] session Session to free.
654 * @param[out] multisession Whether there are other NC sessions on the same SSH sessions.
655 */
656static void
657nc_session_free_transport(struct nc_session *session, int *multisession)
658{
659 int connected; /* flag to indicate whether the transport socket is still connected */
Michal Vaskoe44f2702022-12-12 07:58:06 +0100660 int sock = -1;
Michal Vasko33476c32022-09-09 11:21:40 +0200661 struct nc_session *siter;
662
663 *multisession = 0;
664 connected = nc_session_is_connected(session);
665
666 /* transport implementation cleanup */
667 switch (session->ti_type) {
668 case NC_TI_FD:
669 /* nothing needed - file descriptors were provided by caller,
670 * so it is up to the caller to close them correctly
671 * TODO use callbacks
672 */
673 /* just to avoid compiler warning */
674 (void)connected;
675 (void)siter;
676 break;
677
678 case NC_TI_UNIX:
679 sock = session->ti.unixsock.sock;
680 (void)connected;
681 (void)siter;
682 break;
683
684#ifdef NC_ENABLED_SSH
Michal Vaskoe44f2702022-12-12 07:58:06 +0100685 case NC_TI_LIBSSH: {
686 int r;
687
Michal Vasko33476c32022-09-09 11:21:40 +0200688 if (connected) {
Michal Vasko64734402022-09-09 11:22:00 +0200689 ssh_channel_send_eof(session->ti.libssh.channel);
Michal Vasko33476c32022-09-09 11:21:40 +0200690 ssh_channel_free(session->ti.libssh.channel);
691 }
692 /* There can be multiple NETCONF sessions on the same SSH session (NETCONF session maps to
693 * SSH channel). So destroy the SSH session only if there is no other NETCONF session using
694 * it. Also, avoid concurrent free by multiple threads of sessions that share the SSH session.
695 */
696 /* SESSION IO LOCK */
697 r = nc_session_io_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
698
699 if (session->ti.libssh.next) {
700 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
701 if (siter->status != NC_STATUS_STARTING) {
702 *multisession = 1;
703 break;
704 }
705 }
706 }
707
708 if (!*multisession) {
709 /* it's not multisession yet, but we still need to free the starting sessions */
710 if (session->ti.libssh.next) {
711 do {
712 siter = session->ti.libssh.next;
713 session->ti.libssh.next = siter->ti.libssh.next;
714
715 /* free starting SSH NETCONF session (channel will be freed in ssh_free()) */
716 free(siter->username);
717 free(siter->host);
718 if (!(siter->flags & NC_SESSION_SHAREDCTX)) {
719 ly_ctx_destroy((struct ly_ctx *)siter->ctx);
720 }
721
722 free(siter);
723 } while (session->ti.libssh.next != session);
724 }
725 /* remember sock so we can close it */
726 sock = ssh_get_fd(session->ti.libssh.session);
727 if (connected) {
728 ssh_disconnect(session->ti.libssh.session);
729 sock = -1;
730 }
731 ssh_free(session->ti.libssh.session);
732 } else {
733 /* remove the session from the list */
734 for (siter = session->ti.libssh.next; siter->ti.libssh.next != session; siter = siter->ti.libssh.next) {}
735 if (session->ti.libssh.next == siter) {
736 /* there will be only one session */
737 siter->ti.libssh.next = NULL;
738 } else {
739 /* there are still multiple sessions, keep the ring list */
740 siter->ti.libssh.next = session->ti.libssh.next;
741 }
Michal Vasko78939072022-12-12 07:43:18 +0100742
Michal Vasko33476c32022-09-09 11:21:40 +0200743 /* change nc_sshcb_msg() argument, we need a RUNNING session and this one will be freed */
744 if (session->flags & NC_SESSION_SSH_MSG_CB) {
745 siter = session->ti.libssh.next;
746 while (siter && (siter->status != NC_STATUS_RUNNING)) {
747 if (siter->ti.libssh.next == session) {
748 ERRINT;
749 break;
750 }
751 siter = siter->ti.libssh.next;
752 }
753 /* siter may be NULL in case all the sessions terminated at the same time (socket was disconnected),
754 * we set session to NULL because we do not expect any new message to arrive */
755 ssh_set_message_callback(session->ti.libssh.session, nc_sshcb_msg, siter);
756 if (siter) {
757 siter->flags |= NC_SESSION_SSH_MSG_CB;
758 }
759 }
760 }
761
762 /* SESSION IO UNLOCK */
763 if (r == 1) {
764 nc_session_io_unlock(session, __func__);
765 }
766 break;
Michal Vaskoe44f2702022-12-12 07:58:06 +0100767 }
Michal Vasko33476c32022-09-09 11:21:40 +0200768#endif
769
770#ifdef NC_ENABLED_TLS
771 case NC_TI_OPENSSL:
772 /* remember sock so we can close it */
773 sock = SSL_get_fd(session->ti.tls);
774
775 if (connected) {
776 SSL_shutdown(session->ti.tls);
777 }
778 SSL_free(session->ti.tls);
779
780 if (session->side == NC_SERVER) {
781 X509_free(session->opts.server.client_cert);
782 }
783 break;
784#endif
785 case NC_TI_NONE:
786 break;
787 }
788
789 /* close socket separately */
790 if (sock > -1) {
791 close(sock);
792 }
793}
794
Radek Krejci695d4fa2015-10-22 13:23:54 +0200795API void
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100796nc_session_free(struct nc_session *session, void (*data_free)(void *))
Radek Krejci695d4fa2015-10-22 13:23:54 +0200797{
Michal Vasko33476c32022-09-09 11:21:40 +0200798 int r, i, rpc_locked = 0, msgs_locked = 0, timeout;
Michal Vaskob48aa812016-01-18 14:13:09 +0100799 int multisession = 0; /* flag for more NETCONF sessions on a single SSH session */
Michal Vaskoad611702015-12-03 13:41:51 +0100800 struct nc_msg_cont *contiter;
Michal Vasko77367452021-02-16 16:32:18 +0100801 struct ly_in *msg;
roman6ece9c52022-06-22 09:29:17 +0200802 struct timespec ts;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200803 void *p;
804
Michal Vasko428087d2016-01-14 16:04:28 +0100805 if (!session || (session->status == NC_STATUS_CLOSING)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200806 return;
807 }
808
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200809 /* stop notification threads if any */
810 if ((session->side == NC_CLIENT) && ATOMIC_LOAD_RELAXED(session->opts.client.ntf_thread_running)) {
811 /* let the threads know they should quit */
812 ATOMIC_STORE_RELAXED(session->opts.client.ntf_thread_running, 0);
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200813
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200814 /* wait for them */
Michal Vaskod8a74192023-02-06 15:51:50 +0100815 nc_timeouttime_get(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200816 while (ATOMIC_LOAD_RELAXED(session->opts.client.ntf_thread_count)) {
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200817 usleep(NC_TIMEOUT_STEP);
Michal Vaskod8a74192023-02-06 15:51:50 +0100818 if (nc_timeouttime_cur_diff(&ts) < 1) {
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200819 ERR(session, "Waiting for notification thread exit failed (timed out).");
820 break;
821 }
822 }
Michal Vasko86d357c2016-03-11 13:46:38 +0100823 }
824
Michal Vaskoacf98472021-02-04 15:33:57 +0100825 if (session->side == NC_SERVER) {
Michal Vasko131120a2018-05-29 15:44:02 +0200826 r = nc_session_rpc_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100827 if (r == -1) {
Michal Vaskoadd4c792015-10-26 15:36:58 +0100828 return;
Michal Vasko131120a2018-05-29 15:44:02 +0200829 } else if (r) {
830 rpc_locked = 1;
Michal Vasko96a28a32021-02-04 15:35:20 +0100831 } else {
832 /* else failed to lock it, too bad */
Michal Vasko05532772021-06-03 12:12:38 +0200833 ERR(session, "Freeing a session while an RPC is being processed.");
Michal Vasko96a28a32021-02-04 15:35:20 +0100834 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200835 }
836
Michal Vasko8c247822020-09-07 13:23:23 +0200837 if (session->side == NC_CLIENT) {
Michal Vasko01130bd2021-08-26 11:47:38 +0200838 timeout = NC_SESSION_FREE_LOCK_TIMEOUT;
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200839
Michal Vasko01130bd2021-08-26 11:47:38 +0200840 /* MSGS LOCK */
841 r = nc_session_client_msgs_lock(session, &timeout, __func__);
842 if (r == -1) {
843 return;
844 } else if (r) {
845 msgs_locked = 1;
846 } else {
847 /* else failed to lock it, too bad */
848 ERR(session, "Freeing a session while messages are being received.");
849 }
850
851 /* cleanup message queue */
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200852 for (contiter = session->opts.client.msgs; contiter; ) {
Michal Vasko77367452021-02-16 16:32:18 +0100853 ly_in_free(contiter->msg, 1);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200854
Michal Vaskoad611702015-12-03 13:41:51 +0100855 p = contiter;
856 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200857 free(p);
858 }
859
Michal Vasko01130bd2021-08-26 11:47:38 +0200860 if (msgs_locked) {
861 /* MSGS UNLOCK */
862 nc_session_client_msgs_unlock(session, __func__);
863 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200864
Michal Vasko8c247822020-09-07 13:23:23 +0200865 if (session->status == NC_STATUS_RUNNING) {
Michal Vasko9c6d38c2021-09-03 13:02:53 +0200866 /* receive any leftover messages */
867 while (nc_read_msg_poll_io(session, 0, &msg) == 1) {
868 ly_in_free(msg, 1);
869 }
870
Michal Vasko8c247822020-09-07 13:23:23 +0200871 /* send closing info to the other side */
Michal Vaskod4da3632022-05-25 11:49:10 +0200872 nc_session_free_close_session(session);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200873 }
874
875 /* list of server's capabilities */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200876 if (session->opts.client.cpblts) {
877 for (i = 0; session->opts.client.cpblts[i]; i++) {
Michal Vasko96fc4bb2017-05-23 14:58:34 +0200878 free(session->opts.client.cpblts[i]);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200879 }
Michal Vasko2e6defd2016-10-07 15:48:15 +0200880 free(session->opts.client.cpblts);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200881 }
Michal Vasko78939072022-12-12 07:43:18 +0100882
883 /* LY ext data */
Michal Vaskoe44f2702022-12-12 07:58:06 +0100884#ifdef NC_ENABLED_SSH
885 struct nc_session *siter;
886
Michal Vasko78939072022-12-12 07:43:18 +0100887 if ((session->flags & NC_SESSION_SHAREDCTX) && session->ti.libssh.next) {
888 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
889 if (siter->status != NC_STATUS_STARTING) {
890 /* move LY ext data to this session */
891 assert(!siter->opts.client.ext_data);
892 siter->opts.client.ext_data = session->opts.client.ext_data;
893 session->opts.client.ext_data = NULL;
894 break;
895 }
896 }
Michal Vaskoe44f2702022-12-12 07:58:06 +0100897 } else
898#endif
899 {
Michal Vasko78939072022-12-12 07:43:18 +0100900 lyd_free_siblings(session->opts.client.ext_data);
901 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200902 }
903
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100904 if (session->data && data_free) {
905 data_free(session->data);
906 }
907
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200908 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
909 /* CH LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100910 pthread_mutex_lock(&session->opts.server.ch_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200911 }
912
Michal Vasko86d357c2016-03-11 13:46:38 +0100913 /* mark session for closing */
Radek Krejci695d4fa2015-10-22 13:23:54 +0200914 session->status = NC_STATUS_CLOSING;
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200915
Michal Vaskofeccb312022-03-24 15:24:59 +0100916 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CH_THREAD)) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100917 pthread_cond_signal(&session->opts.server.ch_cond);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200918
Michal Vaskod8a74192023-02-06 15:51:50 +0100919 nc_timeouttime_get(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
Michal Vasko0db3db52021-03-03 10:45:42 +0100920
921 /* wait for CH thread to actually wake up and terminate */
922 r = 0;
Michal Vaskofeccb312022-03-24 15:24:59 +0100923 while (!r && (session->flags & NC_SESSION_CH_THREAD)) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100924 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 +0100925 }
Michal Vasko0db3db52021-03-03 10:45:42 +0100926 if (r) {
Michal Vasko05532772021-06-03 12:12:38 +0200927 ERR(session, "Waiting for Call Home thread failed (%s).", strerror(r));
Michal Vasko3f05a092018-03-13 10:39:49 +0100928 }
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200929 }
930
Michal Vaskofeccb312022-03-24 15:24:59 +0100931 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
932 /* CH UNLOCK */
933 pthread_mutex_unlock(&session->opts.server.ch_lock);
934 }
935
Radek Krejci695d4fa2015-10-22 13:23:54 +0200936 /* transport implementation cleanup */
Michal Vasko33476c32022-09-09 11:21:40 +0200937 nc_session_free_transport(session, &multisession);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200938
Michal Vasko33476c32022-09-09 11:21:40 +0200939 /* final cleanup */
Michal Vasko93224072021-11-09 12:14:28 +0100940 free(session->username);
941 free(session->host);
942 free(session->path);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200943
Michal Vaskoacf98472021-02-04 15:33:57 +0100944 if (session->side == NC_SERVER) {
Michal Vaskodf68e7e2022-04-21 11:04:00 +0200945 pthread_mutex_destroy(&session->opts.server.ntf_status_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200946 if (rpc_locked) {
947 nc_session_rpc_unlock(session, NC_SESSION_LOCK_TIMEOUT, __func__);
Michal Vasko9e99f012016-03-03 13:25:20 +0100948 }
Michal Vaskoacf98472021-02-04 15:33:57 +0100949 pthread_mutex_destroy(&session->opts.server.rpc_lock);
950 pthread_cond_destroy(&session->opts.server.rpc_cond);
Michal Vasko131120a2018-05-29 15:44:02 +0200951 }
952
953 if (session->io_lock && !multisession) {
954 pthread_mutex_destroy(session->io_lock);
955 free(session->io_lock);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200956 }
957
958 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Michal Vasko93224072021-11-09 12:14:28 +0100959 ly_ctx_destroy((struct ly_ctx *)session->ctx);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200960 }
961
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200962 if (session->side == NC_SERVER) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100963 /* free CH synchronization structures */
964 pthread_cond_destroy(&session->opts.server.ch_cond);
965 pthread_mutex_destroy(&session->opts.server.ch_lock);
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200966 } else {
967 pthread_mutex_destroy(&session->opts.client.msgs_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200968 }
969
Radek Krejci695d4fa2015-10-22 13:23:54 +0200970 free(session);
971}
972
Michal Vasko086311b2016-01-08 09:53:11 +0100973static void
Michal Vasko93224072021-11-09 12:14:28 +0100974add_cpblt(const char *capab, char ***cpblts, int *size, int *count)
Michal Vasko086311b2016-01-08 09:53:11 +0100975{
Radek Krejci658782b2016-12-04 22:04:55 +0100976 size_t len;
977 int i;
978 char *p;
979
980 if (capab) {
981 /* check if already present */
982 p = strchr(capab, '?');
983 if (p) {
984 len = p - capab;
985 } else {
986 len = strlen(capab);
987 }
988 for (i = 0; i < *count; i++) {
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200989 if (!strncmp((*cpblts)[i], capab, len) && (((*cpblts)[i][len] == '\0') || ((*cpblts)[i][len] == '?'))) {
Radek Krejci658782b2016-12-04 22:04:55 +0100990 /* already present, do not duplicate it */
991 return;
992 }
993 }
994 }
995
996 /* add another capability */
Michal Vasko086311b2016-01-08 09:53:11 +0100997 if (*count == *size) {
998 *size += 5;
Michal Vasko4eb3c312016-03-01 14:09:37 +0100999 *cpblts = nc_realloc(*cpblts, *size * sizeof **cpblts);
1000 if (!(*cpblts)) {
1001 ERRMEM;
1002 return;
1003 }
Michal Vasko086311b2016-01-08 09:53:11 +01001004 }
1005
Michal Vasko93224072021-11-09 12:14:28 +01001006 (*cpblts)[*count] = capab ? strdup(capab) : NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001007 ++(*count);
1008}
1009
Michal Vasko93224072021-11-09 12:14:28 +01001010API char **
1011nc_server_get_cpblts_version(const struct ly_ctx *ctx, LYS_VERSION version)
Michal Vasko086311b2016-01-08 09:53:11 +01001012{
Michal Vasko93224072021-11-09 12:14:28 +01001013 char **cpblts;
Michal Vasko77367452021-02-16 16:32:18 +01001014 const struct lys_module *mod;
1015 struct lysp_feature *feat;
1016 int size = 10, count, features_count = 0, dev_count = 0, str_len, len;
Michal Vasko1440a742021-03-31 11:11:03 +02001017 uint32_t i, u;
Michal Vasko77367452021-02-16 16:32:18 +01001018 LY_ARRAY_COUNT_TYPE v;
Michal Vasko1440a742021-03-31 11:11:03 +02001019 char *yl_content_id;
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001020
Radek Krejci24a18412018-05-16 15:09:10 +02001021#define NC_CPBLT_BUF_LEN 4096
Michal Vasko2e47ef92016-06-20 10:03:24 +02001022 char str[NC_CPBLT_BUF_LEN];
Michal Vasko086311b2016-01-08 09:53:11 +01001023
Michal Vasko4ffa3b22016-05-24 16:36:25 +02001024 if (!ctx) {
1025 ERRARG("ctx");
1026 return NULL;
1027 }
1028
Michal Vasko086311b2016-01-08 09:53:11 +01001029 cpblts = malloc(size * sizeof *cpblts);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001030 if (!cpblts) {
1031 ERRMEM;
Radek Krejcif906e412017-09-22 14:44:45 +02001032 goto error;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001033 }
Michal Vasko93224072021-11-09 12:14:28 +01001034 cpblts[0] = strdup("urn:ietf:params:netconf:base:1.0");
1035 cpblts[1] = strdup("urn:ietf:params:netconf:base:1.1");
Michal Vasko086311b2016-01-08 09:53:11 +01001036 count = 2;
1037
1038 /* capabilities */
1039
Michal Vasko77367452021-02-16 16:32:18 +01001040 mod = ly_ctx_get_module_implemented(ctx, "ietf-netconf");
Michal Vasko086311b2016-01-08 09:53:11 +01001041 if (mod) {
Michal Vasko77367452021-02-16 16:32:18 +01001042 if (lys_feature_value(mod, "writable-running") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001043 add_cpblt("urn:ietf:params:netconf:capability:writable-running:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001044 }
Michal Vasko77367452021-02-16 16:32:18 +01001045 if (lys_feature_value(mod, "candidate") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001046 add_cpblt("urn:ietf:params:netconf:capability:candidate:1.0", &cpblts, &size, &count);
Michal Vasko77367452021-02-16 16:32:18 +01001047 if (lys_feature_value(mod, "confirmed-commit") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001048 add_cpblt("urn:ietf:params:netconf:capability:confirmed-commit:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001049 }
1050 }
Michal Vasko77367452021-02-16 16:32:18 +01001051 if (lys_feature_value(mod, "rollback-on-error") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001052 add_cpblt("urn:ietf:params:netconf:capability:rollback-on-error:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001053 }
Michal Vasko77367452021-02-16 16:32:18 +01001054 if (lys_feature_value(mod, "validate") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001055 add_cpblt("urn:ietf:params:netconf:capability:validate:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001056 }
Michal Vasko77367452021-02-16 16:32:18 +01001057 if (lys_feature_value(mod, "startup") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001058 add_cpblt("urn:ietf:params:netconf:capability:startup:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001059 }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001060
1061 /* The URL capability must be set manually using nc_server_set_capability()
1062 * because of the need for supported protocols to be included.
1063 * https://tools.ietf.org/html/rfc6241#section-8.8.3
1064 */
Michal Vasko77367452021-02-16 16:32:18 +01001065 // if (lys_feature_value(mod, "url") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001066 // add_cpblt("urn:ietf:params:netconf:capability:url:1.0", &cpblts, &size, &count);
mekleoa8de5e92020-02-13 09:05:56 +01001067 // }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001068
Michal Vasko77367452021-02-16 16:32:18 +01001069 if (lys_feature_value(mod, "xpath") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001070 add_cpblt("urn:ietf:params:netconf:capability:xpath:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001071 }
1072 }
1073
Michal Vasko77367452021-02-16 16:32:18 +01001074 mod = ly_ctx_get_module_implemented(ctx, "ietf-netconf-with-defaults");
Michal Vasko086311b2016-01-08 09:53:11 +01001075 if (mod) {
1076 if (!server_opts.wd_basic_mode) {
Michal Vasko05532772021-06-03 12:12:38 +02001077 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 +01001078 } else {
Michal Vasko3031aae2016-01-27 16:07:18 +01001079 strcpy(str, "urn:ietf:params:netconf:capability:with-defaults:1.0");
Michal Vasko086311b2016-01-08 09:53:11 +01001080 switch (server_opts.wd_basic_mode) {
1081 case NC_WD_ALL:
1082 strcat(str, "?basic-mode=report-all");
1083 break;
1084 case NC_WD_TRIM:
1085 strcat(str, "?basic-mode=trim");
1086 break;
1087 case NC_WD_EXPLICIT:
1088 strcat(str, "?basic-mode=explicit");
1089 break;
1090 default:
Michal Vasko9e036d52016-01-08 10:49:26 +01001091 ERRINT;
Michal Vasko086311b2016-01-08 09:53:11 +01001092 break;
1093 }
1094
1095 if (server_opts.wd_also_supported) {
Michal Vasko2e47ef92016-06-20 10:03:24 +02001096 strcat(str, "&also-supported=");
Michal Vasko086311b2016-01-08 09:53:11 +01001097 if (server_opts.wd_also_supported & NC_WD_ALL) {
1098 strcat(str, "report-all,");
1099 }
1100 if (server_opts.wd_also_supported & NC_WD_ALL_TAG) {
1101 strcat(str, "report-all-tagged,");
1102 }
1103 if (server_opts.wd_also_supported & NC_WD_TRIM) {
1104 strcat(str, "trim,");
1105 }
1106 if (server_opts.wd_also_supported & NC_WD_EXPLICIT) {
1107 strcat(str, "explicit,");
1108 }
1109 str[strlen(str) - 1] = '\0';
1110
Michal Vasko93224072021-11-09 12:14:28 +01001111 add_cpblt(str, &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001112 }
1113 }
1114 }
1115
Radek Krejci658782b2016-12-04 22:04:55 +01001116 /* other capabilities */
1117 for (u = 0; u < server_opts.capabilities_count; u++) {
Michal Vasko93224072021-11-09 12:14:28 +01001118 add_cpblt(server_opts.capabilities[u], &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001119 }
1120
1121 /* models */
Michal Vasko1440a742021-03-31 11:11:03 +02001122 u = 0;
Radek Krejci24a18412018-05-16 15:09:10 +02001123 while ((mod = ly_ctx_get_module_iter(ctx, &u))) {
Radek Krejci24a18412018-05-16 15:09:10 +02001124 if (!strcmp(mod->name, "ietf-yang-library")) {
Michal Vasko77367452021-02-16 16:32:18 +01001125 if (!mod->revision || (strcmp(mod->revision, "2016-06-21") && strcmp(mod->revision, "2019-01-04"))) {
Michal Vasko05532772021-06-03 12:12:38 +02001126 ERR(NULL, "Unknown \"ietf-yang-library\" revision, only 2016-06-21 and 2019-01-04 are supported.");
Michal Vaskod5ada122020-03-19 18:28:06 +01001127 goto error;
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001128 }
Michal Vaskod5ada122020-03-19 18:28:06 +01001129
Michal Vasko1440a742021-03-31 11:11:03 +02001130 /* get content-id */
1131 if (server_opts.content_id_clb) {
1132 yl_content_id = server_opts.content_id_clb(server_opts.content_id_data);
1133 if (!yl_content_id) {
1134 ERRMEM;
1135 goto error;
1136 }
1137 } else {
1138 yl_content_id = malloc(11);
1139 if (!yl_content_id) {
1140 ERRMEM;
1141 goto error;
1142 }
1143 sprintf(yl_content_id, "%u", ly_ctx_get_change_count(ctx));
1144 }
1145
Michal Vasko77367452021-02-16 16:32:18 +01001146 if (!strcmp(mod->revision, "2019-01-04")) {
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001147 /* new one (capab defined in RFC 8526 section 2) */
Michal Vasko1440a742021-03-31 11:11:03 +02001148 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.1?revision=%s&content-id=%s",
1149 mod->revision, yl_content_id);
Michal Vasko93224072021-11-09 12:14:28 +01001150 add_cpblt(str, &cpblts, &size, &count);
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001151 } else {
1152 /* old one (capab defined in RFC 7950 section 5.6.4) */
Michal Vasko1440a742021-03-31 11:11:03 +02001153 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.0?revision=%s&module-set-id=%s",
1154 mod->revision, yl_content_id);
Michal Vasko93224072021-11-09 12:14:28 +01001155 add_cpblt(str, &cpblts, &size, &count);
Michal Vaskod5ada122020-03-19 18:28:06 +01001156 }
Michal Vasko1440a742021-03-31 11:11:03 +02001157 free(yl_content_id);
Radek Krejci24a18412018-05-16 15:09:10 +02001158 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001159 } else if ((version == LYS_VERSION_1_0) && (mod->parsed->version > version)) {
Michal Vasko5ca5d972022-09-14 13:51:31 +02001160 /* skip YANG 1.1 modules */
Radek Krejci24a18412018-05-16 15:09:10 +02001161 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001162 } else if ((version == LYS_VERSION_1_1) && (mod->parsed->version != version)) {
Michal Vasko5ca5d972022-09-14 13:51:31 +02001163 /* skip YANG 1.0 modules */
Radek Krejci24a18412018-05-16 15:09:10 +02001164 continue;
1165 }
Michal Vasko086311b2016-01-08 09:53:11 +01001166
Michal Vasko77367452021-02-16 16:32:18 +01001167 str_len = sprintf(str, "%s?module=%s%s%s", mod->ns, mod->name, mod->revision ? "&revision=" : "",
1168 mod->revision ? mod->revision : "");
Radek Krejci24a18412018-05-16 15:09:10 +02001169
Michal Vaskodafdc742020-03-11 16:15:59 +01001170 features_count = 0;
1171 i = 0;
1172 feat = NULL;
Michal Vasko77367452021-02-16 16:32:18 +01001173 while ((feat = lysp_feature_next(feat, mod->parsed, &i))) {
Michal Vaskodafdc742020-03-11 16:15:59 +01001174 if (!(feat->flags & LYS_FENABLED)) {
1175 continue;
Michal Vaskoe90e4d12016-06-20 10:05:01 +02001176 }
Michal Vaskodafdc742020-03-11 16:15:59 +01001177 if (!features_count) {
1178 strcat(str, "&features=");
1179 str_len += 10;
1180 }
1181 len = strlen(feat->name);
1182 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1183 ERRINT;
1184 break;
1185 }
1186 if (features_count) {
1187 strcat(str, ",");
1188 ++str_len;
1189 }
1190 strcat(str, feat->name);
1191 str_len += len;
1192 features_count++;
Michal Vasko086311b2016-01-08 09:53:11 +01001193 }
Michal Vasko086311b2016-01-08 09:53:11 +01001194
Michal Vasko77367452021-02-16 16:32:18 +01001195 if (mod->deviated_by) {
Radek Krejci24a18412018-05-16 15:09:10 +02001196 strcat(str, "&deviations=");
1197 str_len += 12;
1198 dev_count = 0;
Michal Vasko77367452021-02-16 16:32:18 +01001199 LY_ARRAY_FOR(mod->deviated_by, v) {
1200 len = strlen(mod->deviated_by[v]->name);
1201 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1202 ERRINT;
1203 break;
Radek Krejci24a18412018-05-16 15:09:10 +02001204 }
Michal Vasko77367452021-02-16 16:32:18 +01001205 if (dev_count) {
1206 strcat(str, ",");
1207 ++str_len;
Radek Krejci24a18412018-05-16 15:09:10 +02001208 }
Michal Vasko77367452021-02-16 16:32:18 +01001209 strcat(str, mod->deviated_by[v]->name);
1210 str_len += len;
1211 dev_count++;
Radek Krejci24a18412018-05-16 15:09:10 +02001212 }
1213 }
1214
Michal Vasko93224072021-11-09 12:14:28 +01001215 add_cpblt(str, &cpblts, &size, &count);
Radek Krejci24a18412018-05-16 15:09:10 +02001216 }
Michal Vasko086311b2016-01-08 09:53:11 +01001217
1218 /* ending NULL capability */
Michal Vasko93224072021-11-09 12:14:28 +01001219 add_cpblt(NULL, &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001220
1221 return cpblts;
Radek Krejcif906e412017-09-22 14:44:45 +02001222
1223error:
Radek Krejcif906e412017-09-22 14:44:45 +02001224 free(cpblts);
Radek Krejcif906e412017-09-22 14:44:45 +02001225 return NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001226}
1227
Michal Vasko93224072021-11-09 12:14:28 +01001228API char **
1229nc_server_get_cpblts(const struct ly_ctx *ctx)
Radek Krejci24a18412018-05-16 15:09:10 +02001230{
1231 return nc_server_get_cpblts_version(ctx, LYS_VERSION_UNDEF);
1232}
1233
Radek Krejci695d4fa2015-10-22 13:23:54 +02001234static int
Michal Vasko77367452021-02-16 16:32:18 +01001235parse_cpblts(struct lyd_node *capabilities, char ***list)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001236{
Michal Vasko77367452021-02-16 16:32:18 +01001237 struct lyd_node *iter;
1238 struct lyd_node_opaq *cpblt;
Michal Vasko156d3272017-04-11 11:46:49 +02001239 int ver = -1, i = 0;
1240 const char *cpb_start, *cpb_end;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001241
1242 if (list) {
1243 /* get the storage for server's capabilities */
Michal Vasko77367452021-02-16 16:32:18 +01001244 LY_LIST_FOR(lyd_child(capabilities), iter) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001245 i++;
1246 }
Michal Vasko9e2d3a32015-11-10 13:09:18 +01001247 /* last item remains NULL */
1248 *list = calloc(i + 1, sizeof **list);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001249 if (!*list) {
1250 ERRMEM;
1251 return -1;
1252 }
1253 i = 0;
1254 }
1255
Michal Vasko77367452021-02-16 16:32:18 +01001256 LY_LIST_FOR(lyd_child(capabilities), iter) {
1257 cpblt = (struct lyd_node_opaq *)iter;
1258
1259 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 +02001260 ERR(NULL, "Unexpected <%s> element in client's <hello>.", cpblt->name.name);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001261 return -1;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001262 }
1263
Michal Vasko156d3272017-04-11 11:46:49 +02001264 /* skip leading/trailing whitespaces */
Michal Vasko77367452021-02-16 16:32:18 +01001265 for (cpb_start = cpblt->value; isspace(cpb_start[0]); ++cpb_start) {}
1266 for (cpb_end = cpblt->value + strlen(cpblt->value); (cpb_end > cpblt->value) && isspace(cpb_end[-1]); --cpb_end) {}
1267 if (!cpb_start[0] || (cpb_end == cpblt->value)) {
Michal Vasko05532772021-06-03 12:12:38 +02001268 ERR(NULL, "Empty capability \"%s\" received.", cpblt->value);
Michal Vasko156d3272017-04-11 11:46:49 +02001269 return -1;
1270 }
1271
Radek Krejci695d4fa2015-10-22 13:23:54 +02001272 /* detect NETCONF version */
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001273 if ((ver < 0) && !strncmp(cpb_start, "urn:ietf:params:netconf:base:1.0", cpb_end - cpb_start)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001274 ver = 0;
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001275 } 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 +02001276 ver = 1;
1277 }
1278
1279 /* store capabilities */
1280 if (list) {
Michal Vasko156d3272017-04-11 11:46:49 +02001281 (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
1282 if (!(*list)[i]) {
1283 ERRMEM;
1284 return -1;
1285 }
Radek Krejci695d4fa2015-10-22 13:23:54 +02001286 i++;
1287 }
1288 }
1289
1290 if (ver == -1) {
Michal Vasko05532772021-06-03 12:12:38 +02001291 ERR(NULL, "Peer does not support a compatible NETCONF version.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001292 }
1293
1294 return ver;
1295}
1296
1297static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001298nc_send_hello_io(struct nc_session *session)
Michal Vasko086311b2016-01-08 09:53:11 +01001299{
Michal Vasko131120a2018-05-29 15:44:02 +02001300 NC_MSG_TYPE ret;
1301 int i, io_timeout;
Michal Vasko93224072021-11-09 12:14:28 +01001302 char **cpblts;
Michal Vasko131120a2018-05-29 15:44:02 +02001303 uint32_t *sid;
Michal Vasko086311b2016-01-08 09:53:11 +01001304
Michal Vasko131120a2018-05-29 15:44:02 +02001305 if (session->side == NC_CLIENT) {
1306 /* client side hello - send only NETCONF base capabilities */
1307 cpblts = malloc(3 * sizeof *cpblts);
1308 if (!cpblts) {
1309 ERRMEM;
1310 return NC_MSG_ERROR;
1311 }
Michal Vasko93224072021-11-09 12:14:28 +01001312 cpblts[0] = strdup("urn:ietf:params:netconf:base:1.0");
1313 cpblts[1] = strdup("urn:ietf:params:netconf:base:1.1");
Michal Vasko131120a2018-05-29 15:44:02 +02001314 cpblts[2] = NULL;
1315
1316 io_timeout = NC_CLIENT_HELLO_TIMEOUT * 1000;
1317 sid = NULL;
1318 } else {
Michal Vasko77367452021-02-16 16:32:18 +01001319 cpblts = nc_server_get_cpblts_version(session->ctx, LYS_VERSION_1_0);
Michal Vasko5b24b6b2020-12-04 09:29:47 +01001320 if (!cpblts) {
1321 return NC_MSG_ERROR;
1322 }
Michal Vasko131120a2018-05-29 15:44:02 +02001323
1324 io_timeout = NC_SERVER_HELLO_TIMEOUT * 1000;
1325 sid = &session->id;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001326 }
Michal Vasko05ba9df2016-01-13 14:40:27 +01001327
Michal Vasko131120a2018-05-29 15:44:02 +02001328 ret = nc_write_msg_io(session, io_timeout, NC_MSG_HELLO, cpblts, sid);
Michal Vasko086311b2016-01-08 09:53:11 +01001329
Michal Vasko086311b2016-01-08 09:53:11 +01001330 for (i = 0; cpblts[i]; ++i) {
Michal Vasko93224072021-11-09 12:14:28 +01001331 free(cpblts[i]);
Michal Vasko086311b2016-01-08 09:53:11 +01001332 }
1333 free(cpblts);
1334
Michal Vasko131120a2018-05-29 15:44:02 +02001335 return ret;
Michal Vasko086311b2016-01-08 09:53:11 +01001336}
1337
1338static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001339nc_recv_client_hello_io(struct nc_session *session)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001340{
Michal Vasko77367452021-02-16 16:32:18 +01001341 struct ly_in *msg;
1342 struct lyd_node *hello = NULL, *iter;
1343 struct lyd_node_opaq *node;
1344 int r, ver = -1, flag = 0;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001345 char *str;
Michal Vasko292c5542023-02-01 14:33:17 +01001346 long long id;
Michal Vasko77367452021-02-16 16:32:18 +01001347 NC_MSG_TYPE rc = NC_MSG_HELLO;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001348
Michal Vasko77367452021-02-16 16:32:18 +01001349 r = nc_read_msg_poll_io(session, NC_CLIENT_HELLO_TIMEOUT * 1000, &msg);
1350 switch (r) {
1351 case 1:
Radek Krejci695d4fa2015-10-22 13:23:54 +02001352 /* parse <hello> data */
Michal Vasko77367452021-02-16 16:32:18 +01001353 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 +02001354 ERR(session, "Failed to parse server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001355 rc = NC_MSG_ERROR;
1356 goto cleanup;
1357 }
1358
1359 LY_LIST_FOR(lyd_child(hello), iter) {
1360 node = (struct lyd_node_opaq *)iter;
1361
1362 if (!node->name.module_ns || strcmp(node->name.module_ns, NC_NS_BASE)) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001363 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001364 } else if (!strcmp(node->name.name, "session-id")) {
1365 if (!node->value || !strlen(node->value)) {
Michal Vasko05532772021-06-03 12:12:38 +02001366 ERR(session, "No value of <session-id> element in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001367 rc = NC_MSG_ERROR;
1368 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001369 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001370 str = NULL;
Michal Vasko77367452021-02-16 16:32:18 +01001371 id = strtoll(node->value, &str, 10);
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001372 if (*str || (id < 1) || (id > UINT32_MAX)) {
Michal Vasko05532772021-06-03 12:12:38 +02001373 ERR(session, "Invalid value of <session-id> element in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001374 rc = NC_MSG_ERROR;
1375 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001376 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001377 session->id = (uint32_t)id;
1378 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001379 } else if (strcmp(node->name.name, "capabilities")) {
Michal Vasko05532772021-06-03 12:12:38 +02001380 ERR(session, "Unexpected <%s> element in server <hello>.", node->name.name);
Michal Vasko77367452021-02-16 16:32:18 +01001381 rc = NC_MSG_ERROR;
1382 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001383 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001384
1385 if (flag) {
1386 /* multiple capabilities elements */
Michal Vasko05532772021-06-03 12:12:38 +02001387 ERR(session, "Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko77367452021-02-16 16:32:18 +01001388 rc = NC_MSG_ERROR;
1389 goto cleanup;
Michal Vasko11d142a2016-01-19 15:58:24 +01001390 }
1391 flag = 1;
1392
Michal Vasko77367452021-02-16 16:32:18 +01001393 if ((ver = parse_cpblts(&node->node, &session->opts.client.cpblts)) < 0) {
1394 rc = NC_MSG_ERROR;
1395 goto cleanup;
Michal Vasko11d142a2016-01-19 15:58:24 +01001396 }
1397 session->version = ver;
1398 }
1399
1400 if (!session->id) {
Michal Vasko05532772021-06-03 12:12:38 +02001401 ERR(session, "Missing <session-id> in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001402 rc = NC_MSG_ERROR;
1403 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001404 }
1405 break;
Michal Vasko77367452021-02-16 16:32:18 +01001406 case 0:
Michal Vasko05532772021-06-03 12:12:38 +02001407 ERR(session, "Server <hello> timeout elapsed.");
Michal Vasko77367452021-02-16 16:32:18 +01001408 rc = NC_MSG_WOULDBLOCK;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001409 break;
1410 default:
Michal Vasko77367452021-02-16 16:32:18 +01001411 rc = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001412 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001413 }
1414
Michal Vasko77367452021-02-16 16:32:18 +01001415cleanup:
1416 ly_in_free(msg, 1);
1417 lyd_free_tree(hello);
1418 return rc;
Radek Krejci5686ff72015-10-09 13:33:56 +02001419}
1420
Michal Vasko11d142a2016-01-19 15:58:24 +01001421static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001422nc_recv_server_hello_io(struct nc_session *session)
Michal Vasko11d142a2016-01-19 15:58:24 +01001423{
Michal Vasko77367452021-02-16 16:32:18 +01001424 struct ly_in *msg;
1425 struct lyd_node *hello = NULL, *iter;
1426 struct lyd_node_opaq *node;
1427 NC_MSG_TYPE rc = NC_MSG_HELLO;
1428 int r, ver = -1, flag = 0, timeout_io;
Michal Vasko11d142a2016-01-19 15:58:24 +01001429
Michal Vasko77367452021-02-16 16:32:18 +01001430 timeout_io = server_opts.hello_timeout ? server_opts.hello_timeout * 1000 : NC_SERVER_HELLO_TIMEOUT * 1000;
1431 r = nc_read_msg_poll_io(session, timeout_io, &msg);
1432 switch (r) {
1433 case 1:
1434 /* parse <hello> data */
1435 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 +02001436 ERR(session, "Failed to parse client <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001437 rc = NC_MSG_ERROR;
1438 goto cleanup;
1439 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001440
Michal Vasko77367452021-02-16 16:32:18 +01001441 /* learn NETCONF version */
1442 LY_LIST_FOR(lyd_child(hello), iter) {
1443 node = (struct lyd_node_opaq *)iter;
1444
1445 if (!node->name.module_ns || strcmp(node->name.module_ns, NC_NS_BASE)) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001446 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001447 } else if (strcmp(node->name.name, "capabilities")) {
Michal Vasko05532772021-06-03 12:12:38 +02001448 ERR(session, "Unexpected <%s> element in client <hello>.", node->name.name);
Michal Vasko77367452021-02-16 16:32:18 +01001449 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001450 goto cleanup;
1451 }
1452
1453 if (flag) {
1454 /* multiple capabilities elements */
Michal Vasko05532772021-06-03 12:12:38 +02001455 ERR(session, "Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko77367452021-02-16 16:32:18 +01001456 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001457 goto cleanup;
1458 }
1459 flag = 1;
1460
Michal Vasko77367452021-02-16 16:32:18 +01001461 if ((ver = parse_cpblts(&node->node, NULL)) < 0) {
1462 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001463 goto cleanup;
1464 }
1465 session->version = ver;
1466 }
1467 break;
Michal Vasko77367452021-02-16 16:32:18 +01001468 case 0:
Michal Vasko05532772021-06-03 12:12:38 +02001469 ERR(session, "Client <hello> timeout elapsed.");
Michal Vasko77367452021-02-16 16:32:18 +01001470 rc = NC_MSG_WOULDBLOCK;
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001471 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001472 default:
Michal Vasko77367452021-02-16 16:32:18 +01001473 rc = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001474 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001475 }
1476
1477cleanup:
Michal Vasko77367452021-02-16 16:32:18 +01001478 ly_in_free(msg, 1);
1479 lyd_free_tree(hello);
1480 return rc;
Michal Vasko11d142a2016-01-19 15:58:24 +01001481}
1482
Michal Vasko71090fc2016-05-24 16:37:28 +02001483NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001484nc_handshake_io(struct nc_session *session)
Michal Vasko80cad7f2015-12-08 14:42:27 +01001485{
Michal Vasko086311b2016-01-08 09:53:11 +01001486 NC_MSG_TYPE type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001487
Michal Vasko131120a2018-05-29 15:44:02 +02001488 type = nc_send_hello_io(session);
Michal Vasko086311b2016-01-08 09:53:11 +01001489 if (type != NC_MSG_HELLO) {
Michal Vasko71090fc2016-05-24 16:37:28 +02001490 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001491 }
1492
Michal Vasko11d142a2016-01-19 15:58:24 +01001493 if (session->side == NC_CLIENT) {
Michal Vasko131120a2018-05-29 15:44:02 +02001494 type = nc_recv_client_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001495 } else {
Michal Vasko131120a2018-05-29 15:44:02 +02001496 type = nc_recv_server_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001497 }
1498
Michal Vasko71090fc2016-05-24 16:37:28 +02001499 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001500}
Michal Vasko086311b2016-01-08 09:53:11 +01001501
Michal Vasko889162e2019-09-06 14:43:37 +02001502#ifdef NC_ENABLED_SSH
1503
Michal Vasko999b64a2019-07-10 16:06:15 +02001504static void
1505nc_ssh_init(void)
1506{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001507#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
Michal Vasko999b64a2019-07-10 16:06:15 +02001508 ssh_threads_set_callbacks(ssh_threads_get_pthread());
1509 ssh_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001510#endif
Michal Vasko999b64a2019-07-10 16:06:15 +02001511}
1512
1513static void
1514nc_ssh_destroy(void)
1515{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001516#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko999b64a2019-07-10 16:06:15 +02001517 FIPS_mode_set(0);
1518 CONF_modules_unload(1);
1519 nc_thread_destroy();
Michal Vasko889162e2019-09-06 14:43:37 +02001520#endif
1521
Michal Vaskoe1e82632019-09-09 09:18:03 +02001522#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
1523 ssh_finalize();
1524#endif
1525}
1526
Michal Vasko889162e2019-09-06 14:43:37 +02001527#endif /* NC_ENABLED_SSH */
Michal Vasko999b64a2019-07-10 16:06:15 +02001528
Radek Krejci53691be2016-02-22 13:58:37 +01001529#ifdef NC_ENABLED_TLS
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001530
Michal Vasko770b4362017-02-17 14:44:18 +01001531#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1532
Michal Vaskof0c92c02016-01-29 09:41:45 +01001533struct CRYPTO_dynlock_value {
1534 pthread_mutex_t lock;
1535};
1536
Michal Vaskof0c92c02016-01-29 09:41:45 +01001537static struct CRYPTO_dynlock_value *
1538tls_dyn_create_func(const char *UNUSED(file), int UNUSED(line))
1539{
1540 struct CRYPTO_dynlock_value *value;
1541
1542 value = malloc(sizeof *value);
1543 if (!value) {
1544 ERRMEM;
1545 return NULL;
1546 }
1547 pthread_mutex_init(&value->lock, NULL);
1548
1549 return value;
1550}
1551
1552static void
1553tls_dyn_lock_func(int mode, struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1554{
1555 /* mode can also be CRYPTO_READ or CRYPTO_WRITE, but all the examples
1556 * I found ignored this fact, what do I know... */
1557 if (mode & CRYPTO_LOCK) {
1558 pthread_mutex_lock(&l->lock);
1559 } else {
1560 pthread_mutex_unlock(&l->lock);
1561 }
1562}
1563
1564static void
1565tls_dyn_destroy_func(struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1566{
1567 pthread_mutex_destroy(&l->lock);
1568 free(l);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001569}
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001570
Michal Vasko770b4362017-02-17 14:44:18 +01001571#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001572
Michal Vasko8f0c0282016-02-29 10:17:14 +01001573#endif /* NC_ENABLED_TLS */
1574
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001575#if defined (NC_ENABLED_TLS) && !defined (NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001576
Michal Vasko770b4362017-02-17 14:44:18 +01001577#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001578static pthread_mutex_t *tls_locks;
1579
1580static void
1581tls_thread_locking_func(int mode, int n, const char *UNUSED(file), int UNUSED(line))
1582{
1583 if (mode & CRYPTO_LOCK) {
1584 pthread_mutex_lock(tls_locks + n);
1585 } else {
1586 pthread_mutex_unlock(tls_locks + n);
1587 }
1588}
1589
1590static void
1591tls_thread_id_func(CRYPTO_THREADID *tid)
1592{
1593 CRYPTO_THREADID_set_numeric(tid, (unsigned long)pthread_self());
1594}
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001595
Michal Vasko770b4362017-02-17 14:44:18 +01001596#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001597
1598static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001599nc_tls_init(void)
1600{
Rosen Penev4f552d62019-06-26 16:10:43 -07001601#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001602 SSL_load_error_strings();
Michal Vasko7f1c78b2016-01-19 09:52:14 +01001603 ERR_load_BIO_strings();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001604 SSL_library_init();
1605
Michal Vaskof89948c2018-01-04 09:19:46 +01001606 int i;
1607
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001608 tls_locks = malloc(CRYPTO_num_locks() * sizeof *tls_locks);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001609 if (!tls_locks) {
1610 ERRMEM;
1611 return;
1612 }
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001613 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1614 pthread_mutex_init(tls_locks + i, NULL);
1615 }
1616
Michal Vaskof0c92c02016-01-29 09:41:45 +01001617 CRYPTO_THREADID_set_callback(tls_thread_id_func);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001618 CRYPTO_set_locking_callback(tls_thread_locking_func);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001619
1620 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1621 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1622 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001623#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001624}
1625
Michal Vasko8f0c0282016-02-29 10:17:14 +01001626static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001627nc_tls_destroy(void)
1628{
Rosen Penev4f552d62019-06-26 16:10:43 -07001629#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001630 FIPS_mode_set(0);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001631 CRYPTO_cleanup_all_ex_data();
Michal Vaskob6e37262016-02-25 14:49:00 +01001632 nc_thread_destroy();
Michal Vasko5e228792016-02-03 15:30:24 +01001633 EVP_cleanup();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001634 ERR_free_strings();
Michal Vasko770b4362017-02-17 14:44:18 +01001635#if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001636 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vasko770b4362017-02-17 14:44:18 +01001637#elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1638 SSL_COMP_free_compression_methods();
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001639#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001640
Michal Vaskof89948c2018-01-04 09:19:46 +01001641 int i;
1642
Michal Vaskob6e37262016-02-25 14:49:00 +01001643 CRYPTO_THREADID_set_callback(NULL);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001644 CRYPTO_set_locking_callback(NULL);
1645 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1646 pthread_mutex_destroy(tls_locks + i);
1647 }
1648 free(tls_locks);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001649
1650 CRYPTO_set_dynlock_create_callback(NULL);
1651 CRYPTO_set_dynlock_lock_callback(NULL);
1652 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001653#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001654}
1655
Michal Vasko8f0c0282016-02-29 10:17:14 +01001656#endif /* NC_ENABLED_TLS && !NC_ENABLED_SSH */
Michal Vasko5e228792016-02-03 15:30:24 +01001657
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001658#if defined (NC_ENABLED_SSH) && defined (NC_ENABLED_TLS)
Michal Vasko5e228792016-02-03 15:30:24 +01001659
Michal Vasko8f0c0282016-02-29 10:17:14 +01001660static void
Michal Vasko5e228792016-02-03 15:30:24 +01001661nc_ssh_tls_init(void)
1662{
Rosen Penev4f552d62019-06-26 16:10:43 -07001663#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001664 SSL_load_error_strings();
1665 ERR_load_BIO_strings();
1666 SSL_library_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001667#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001668
1669 nc_ssh_init();
1670
Michal Vaskoe1e82632019-09-09 09:18:03 +02001671#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001672 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1673 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1674 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001675#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001676}
1677
Michal Vasko8f0c0282016-02-29 10:17:14 +01001678static void
Michal Vasko5e228792016-02-03 15:30:24 +01001679nc_ssh_tls_destroy(void)
1680{
Rosen Penev4f552d62019-06-26 16:10:43 -07001681#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001682 ERR_free_strings();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001683# if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vasko5e228792016-02-03 15:30:24 +01001684 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vaskoe1e82632019-09-09 09:18:03 +02001685# elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko770b4362017-02-17 14:44:18 +01001686 SSL_COMP_free_compression_methods();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001687# endif
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001688#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001689
1690 nc_ssh_destroy();
1691
Michal Vaskoe1e82632019-09-09 09:18:03 +02001692#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001693 CRYPTO_set_dynlock_create_callback(NULL);
1694 CRYPTO_set_dynlock_lock_callback(NULL);
1695 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001696#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001697}
1698
Radek Krejci53691be2016-02-22 13:58:37 +01001699#endif /* NC_ENABLED_SSH && NC_ENABLED_TLS */
Michal Vasko8f0c0282016-02-29 10:17:14 +01001700
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001701#if defined (NC_ENABLED_SSH) || defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001702
1703API void
1704nc_thread_destroy(void)
1705{
Michal Vasko8f0c0282016-02-29 10:17:14 +01001706 /* caused data-races and seems not neccessary for avoiding valgrind reachable memory */
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001707 // CRYPTO_cleanup_all_ex_data();
Michal Vasko8f0c0282016-02-29 10:17:14 +01001708
Michal Vasko770b4362017-02-17 14:44:18 +01001709#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1710 CRYPTO_THREADID crypto_tid;
1711
Michal Vasko8f0c0282016-02-29 10:17:14 +01001712 CRYPTO_THREADID_current(&crypto_tid);
1713 ERR_remove_thread_state(&crypto_tid);
Michal Vasko770b4362017-02-17 14:44:18 +01001714#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001715}
1716
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001717#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
1718
1719void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001720nc_init(void)
1721{
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001722#if defined (NC_ENABLED_SSH) && defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001723 nc_ssh_tls_init();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001724#elif defined (NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001725 nc_ssh_init();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001726#elif defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001727 nc_tls_init();
1728#endif
1729}
1730
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001731void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001732nc_destroy(void)
1733{
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001734#if defined (NC_ENABLED_SSH) && defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001735 nc_ssh_tls_destroy();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001736#elif defined (NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001737 nc_ssh_destroy();
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001738#elif defined (NC_ENABLED_TLS)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001739 nc_tls_destroy();
1740#endif
1741}