blob: b04c0e92b00f28a42d86c792e9b417c49457924a [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>
roman3c5b75d2024-04-18 14:56:53 +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"
roman3f9b65c2023-06-05 14:26:58 +020033#include "config.h"
34#include "log_p.h"
35#include "netconf.h"
36#include "session_p.h"
Michal Vaskob48aa812016-01-18 14:13:09 +010037
roman2eab4742023-06-06 10:00:26 +020038#ifdef NC_ENABLED_SSH_TLS
Radek Krejci206fcd62015-10-07 15:42:48 +020039
roman15fbc592024-07-02 16:01:23 +020040#include <curl/curl.h>
roman2eab4742023-06-06 10:00:26 +020041#include <libssh/libssh.h>
roman008cfe72024-04-05 12:36:18 +020042#include "session_wrapper.h"
Radek Krejci206fcd62015-10-07 15:42:48 +020043
roman2eab4742023-06-06 10:00:26 +020044#endif /* NC_ENABLED_SSH_TLS */
Michal Vaskoc14e3c82016-01-11 16:14:30 +010045
Michal Vasko086311b2016-01-08 09:53:11 +010046/* in seconds */
47#define NC_CLIENT_HELLO_TIMEOUT 60
Michal Vaskocf898172024-01-15 15:04:28 +010048#define NC_SERVER_CH_HELLO_TIMEOUT 180
Radek Krejci695d4fa2015-10-22 13:23:54 +020049
Michal Vasko05ba9df2016-01-13 14:40:27 +010050/* in milliseconds */
51#define NC_CLOSE_REPLY_TIMEOUT 200
52
Michal Vasko086311b2016-01-08 09:53:11 +010053extern struct nc_server_opts server_opts;
54
Michal Vaskod8a74192023-02-06 15:51:50 +010055void
56nc_timeouttime_get(struct timespec *ts, uint32_t add_ms)
Radek Krejci7ac16052016-07-15 11:48:18 +020057{
Michal Vaskod8a74192023-02-06 15:51:50 +010058 if (clock_gettime(COMPAT_CLOCK_ID, ts) == -1) {
59 ERR(NULL, "clock_gettime() failed (%s).", strerror(errno));
60 return;
61 }
62
63 if (!add_ms) {
64 return;
65 }
66
67 assert((ts->tv_nsec >= 0) && (ts->tv_nsec < 1000000000L));
68
69 ts->tv_sec += add_ms / 1000;
70 ts->tv_nsec += (add_ms % 1000) * 1000000L;
71
72 if (ts->tv_nsec >= 1000000000L) {
73 ++ts->tv_sec;
74 ts->tv_nsec -= 1000000000L;
75 } else if (ts->tv_nsec < 0) {
76 --ts->tv_sec;
77 ts->tv_nsec += 1000000000L;
78 }
79
80 assert((ts->tv_nsec >= 0) && (ts->tv_nsec < 1000000000L));
81}
82
83int32_t
84nc_timeouttime_cur_diff(const struct timespec *ts)
85{
86 struct timespec cur;
87 int64_t nsec_diff = 0;
88
89 nc_timeouttime_get(&cur, 0);
90
91 nsec_diff += (((int64_t)ts->tv_sec) - ((int64_t)cur.tv_sec)) * 1000000000L;
92 nsec_diff += ((int64_t)ts->tv_nsec) - ((int64_t)cur.tv_nsec);
93
94 return nsec_diff / 1000000L;
95}
96
97void
98nc_realtime_get(struct timespec *ts)
99{
roman6ece9c52022-06-22 09:29:17 +0200100 if (clock_gettime(CLOCK_REALTIME, ts)) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100101 ERR(NULL, "clock_gettime() failed (%s).", strerror(errno));
102 return;
roman6ece9c52022-06-22 09:29:17 +0200103 }
Michal Vasko36c7be82017-02-22 13:37:59 +0100104}
105
Michal Vasko63b92d62024-04-29 10:04:56 +0200106int
107nc_poll(struct pollfd *pfd, uint16_t pfd_count, int timeout_ms)
108{
109 int rc;
110 struct timespec start_ts;
111
112 if (timeout_ms > 0) {
113 /* get current time */
114 nc_timeouttime_get(&start_ts, 0);
115 }
116
117 do {
118 /* poll */
119 rc = poll(pfd, pfd_count, timeout_ms);
120
121 if (timeout_ms > 0) {
122 /* adjust the timeout by subtracting the elapsed time (relevant in case of EINTR) */
123 timeout_ms += nc_timeouttime_cur_diff(&start_ts);
124 if (timeout_ms < 0) {
125 /* manual timeout */
126 rc = 0;
127 errno = 0;
128 break;
129 }
130 }
131 } while ((rc == -1) && (errno == EINTR));
132
133 if (rc == -1) {
134 ERR(NULL, "Poll failed (%s).", strerror(errno));
135 }
136 return rc;
137}
138
roman2eab4742023-06-06 10:00:26 +0200139#ifdef NC_ENABLED_SSH_TLS
140
Michal Vaskoddce1212019-05-24 09:58:49 +0200141const char *
roman3f9b65c2023-06-05 14:26:58 +0200142nc_privkey_format_to_str(NC_PRIVKEY_FORMAT format)
Michal Vaskoddce1212019-05-24 09:58:49 +0200143{
roman3f9b65c2023-06-05 14:26:58 +0200144 switch (format) {
145 case NC_PRIVKEY_FORMAT_RSA:
romand0fe5952024-03-21 15:59:33 +0100146 return " RSA ";
roman3f9b65c2023-06-05 14:26:58 +0200147 case NC_PRIVKEY_FORMAT_EC:
romand0fe5952024-03-21 15:59:33 +0100148 return " EC ";
roman3f9b65c2023-06-05 14:26:58 +0200149 case NC_PRIVKEY_FORMAT_X509:
romand0fe5952024-03-21 15:59:33 +0100150 return " ";
roman3f9b65c2023-06-05 14:26:58 +0200151 case NC_PRIVKEY_FORMAT_OPENSSH:
romand0fe5952024-03-21 15:59:33 +0100152 return " OPENSSH ";
Michal Vaskoddce1212019-05-24 09:58:49 +0200153 default:
roman3f9b65c2023-06-05 14:26:58 +0200154 return NULL;
Michal Vaskoddce1212019-05-24 09:58:49 +0200155 }
Michal Vaskoddce1212019-05-24 09:58:49 +0200156}
157
roman13145912023-08-17 15:36:54 +0200158int
roman51a1e192023-09-14 10:13:45 +0200159nc_is_pk_subject_public_key_info(const char *b64)
160{
161 int ret = 0;
162 long len;
romanc95a14f2024-04-23 15:13:00 +0200163 unsigned char *bin = NULL, *tmp;
roman51a1e192023-09-14 10:13:45 +0200164
roman9ba26aa2024-04-05 12:31:54 +0200165 /* decode base64 */
166 len = nc_base64_decode_wrap(b64, &bin);
roman51a1e192023-09-14 10:13:45 +0200167 if (len == -1) {
roman51a1e192023-09-14 10:13:45 +0200168 ret = -1;
169 goto cleanup;
170 }
171
172 /* for deallocation later */
173 tmp = bin;
174
roman9ba26aa2024-04-05 12:31:54 +0200175 /* try to parse the supposed SubjectPublicKeyInfo binary data */
romanc95a14f2024-04-23 15:13:00 +0200176 if (nc_tls_is_der_subpubkey_wrap(tmp, len)) {
roman9ba26aa2024-04-05 12:31:54 +0200177 /* success, it's most likely SubjectPublicKeyInfo */
roman51a1e192023-09-14 10:13:45 +0200178 ret = 1;
179 } else {
roman9ba26aa2024-04-05 12:31:54 +0200180 /* it's most likely not SubjectPublicKeyInfo */
roman51a1e192023-09-14 10:13:45 +0200181 ret = 0;
182 }
183
184cleanup:
roman51a1e192023-09-14 10:13:45 +0200185 free(bin);
186 return ret;
187}
188
roman2eab4742023-06-06 10:00:26 +0200189#endif /* NC_ENABLED_SSH_TLS */
190
Michal Vaskobe52dc22018-10-17 09:28:17 +0200191int
Michal Vaskoc4cdc9e2024-05-03 12:03:07 +0200192nc_sock_configure_ka(int sock, const struct nc_keepalives *ka)
Michal Vaskobe52dc22018-10-17 09:28:17 +0200193{
Michal Vaskoc4cdc9e2024-05-03 12:03:07 +0200194 int opt;
195
196 opt = ka->enabled;
197 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &opt, sizeof opt) == -1) {
roman56acd552024-04-18 16:00:37 +0200198 ERR(NULL, "Failed to set SO_KEEPALIVE (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200199 return -1;
200 }
roman56acd552024-04-18 16:00:37 +0200201
Michal Vaskoc4cdc9e2024-05-03 12:03:07 +0200202 if (!ka->enabled) {
203 return 0;
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200204 }
Michal Vaskobe52dc22018-10-17 09:28:17 +0200205
206#ifdef TCP_KEEPIDLE
Michal Vaskoc4cdc9e2024-05-03 12:03:07 +0200207 opt = ka->idle_time;
208 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPIDLE, &opt, sizeof opt) == -1) {
roman56acd552024-04-18 16:00:37 +0200209 ERR(NULL, "Failed to set TCP_KEEPIDLE (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200210 return -1;
211 }
212#endif
213
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200214#ifdef TCP_KEEPCNT
Michal Vaskoc4cdc9e2024-05-03 12:03:07 +0200215 opt = ka->max_probes;
216 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPCNT, &opt, sizeof opt) == -1) {
roman56acd552024-04-18 16:00:37 +0200217 ERR(NULL, "Failed to set TCP_KEEPCNT (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200218 return -1;
219 }
220#endif
221
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200222#ifdef TCP_KEEPINTVL
Michal Vaskoc4cdc9e2024-05-03 12:03:07 +0200223 opt = ka->probe_interval;
224 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPINTVL, &opt, sizeof opt) == -1) {
roman56acd552024-04-18 16:00:37 +0200225 ERR(NULL, "Failed to set TCP_KEEPINTVL (%s).", strerror(errno));
Michal Vaskobe52dc22018-10-17 09:28:17 +0200226 return -1;
227 }
228#endif
229
230 return 0;
231}
232
Michal Vaskoade892d2017-02-22 13:40:35 +0100233struct nc_session *
Michal Vasko131120a2018-05-29 15:44:02 +0200234nc_new_session(NC_SIDE side, int shared_ti)
Michal Vaskoade892d2017-02-22 13:40:35 +0100235{
236 struct nc_session *sess;
Michal Vaskocf898172024-01-15 15:04:28 +0100237 struct timespec ts_cur;
Michal Vaskoade892d2017-02-22 13:40:35 +0100238
239 sess = calloc(1, sizeof *sess);
240 if (!sess) {
241 return NULL;
242 }
243
Michal Vasko131120a2018-05-29 15:44:02 +0200244 sess->side = side;
245
246 if (side == NC_SERVER) {
Michal Vaskodf68e7e2022-04-21 11:04:00 +0200247 pthread_mutex_init(&sess->opts.server.ntf_status_lock, NULL);
Michal Vaskoacf98472021-02-04 15:33:57 +0100248 pthread_mutex_init(&sess->opts.server.rpc_lock, NULL);
249 pthread_cond_init(&sess->opts.server.rpc_cond, NULL);
Michal Vaskoacf98472021-02-04 15:33:57 +0100250
251 pthread_mutex_init(&sess->opts.server.ch_lock, NULL);
252 pthread_cond_init(&sess->opts.server.ch_cond, NULL);
Michal Vaskocf898172024-01-15 15:04:28 +0100253
254 /* initialize last_rpc for idle_timeout */
255 nc_timeouttime_get(&ts_cur, 0);
256 sess->opts.server.last_rpc = ts_cur.tv_sec;
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200257 } else {
258 pthread_mutex_init(&sess->opts.client.msgs_lock, NULL);
Michal Vasko131120a2018-05-29 15:44:02 +0200259 }
260
261 if (!shared_ti) {
262 sess->io_lock = malloc(sizeof *sess->io_lock);
263 if (!sess->io_lock) {
264 goto error;
265 }
266 pthread_mutex_init(sess->io_lock, NULL);
Michal Vaskoade892d2017-02-22 13:40:35 +0100267 }
268
269 return sess;
Michal Vasko131120a2018-05-29 15:44:02 +0200270
271error:
Michal Vasko131120a2018-05-29 15:44:02 +0200272 free(sess);
273 return NULL;
Michal Vaskoade892d2017-02-22 13:40:35 +0100274}
275
Michal Vasko96164bf2016-01-21 15:41:58 +0100276/*
277 * @return 1 - success
278 * 0 - timeout
279 * -1 - error
280 */
281int
Michal Vasko131120a2018-05-29 15:44:02 +0200282nc_session_rpc_lock(struct nc_session *session, int timeout, const char *func)
Michal Vasko96164bf2016-01-21 15:41:58 +0100283{
284 int ret;
Michal Vasko62be1ce2016-03-03 13:24:52 +0100285 struct timespec ts_timeout;
Michal Vasko96164bf2016-01-21 15:41:58 +0100286
Michal Vasko131120a2018-05-29 15:44:02 +0200287 if (session->side != NC_SERVER) {
288 ERRINT;
289 return -1;
290 }
291
Michal Vasko96164bf2016-01-21 15:41:58 +0100292 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100293 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vasko96164bf2016-01-21 15:41:58 +0100294
Michal Vaskoade892d2017-02-22 13:40:35 +0100295 /* LOCK */
Michal Vaskod8a74192023-02-06 15:51:50 +0100296 ret = pthread_mutex_clocklock(&session->opts.server.rpc_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100297 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100298 while (session->opts.server.rpc_inuse) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100299 ret = pthread_cond_clockwait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock,
300 COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100301 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100302 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100303 break;
304 }
305 }
306 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100307 } else if (!timeout) {
Michal Vaskoade892d2017-02-22 13:40:35 +0100308 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100309 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100310 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100311 if (session->opts.server.rpc_inuse) {
312 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100313 return 0;
314 }
Michal vasko2f8e4b52016-10-05 13:04:11 +0200315 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100316 } else { /* timeout == -1 */
Michal Vaskoade892d2017-02-22 13:40:35 +0100317 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100318 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100319 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100320 while (session->opts.server.rpc_inuse) {
321 ret = pthread_cond_wait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100322 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100323 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100324 break;
325 }
326 }
327 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100328 }
329
Michal Vaskoade892d2017-02-22 13:40:35 +0100330 if (ret) {
331 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
332 /* timeout */
333 return 0;
334 }
335
Michal Vasko96164bf2016-01-21 15:41:58 +0100336 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200337 ERR(session, "%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vasko96164bf2016-01-21 15:41:58 +0100338 return -1;
339 }
340
341 /* ok */
Michal Vaskoacf98472021-02-04 15:33:57 +0100342 assert(session->opts.server.rpc_inuse == 0);
343 session->opts.server.rpc_inuse = 1;
Michal Vaskoade892d2017-02-22 13:40:35 +0100344
345 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100346 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100347 if (ret) {
348 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200349 ERR(session, "%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100350 return -1;
351 }
352
353 return 1;
354}
355
356int
Michal Vasko131120a2018-05-29 15:44:02 +0200357nc_session_rpc_unlock(struct nc_session *session, int timeout, const char *func)
Michal Vaskoade892d2017-02-22 13:40:35 +0100358{
359 int ret;
360 struct timespec ts_timeout;
361
Michal Vasko131120a2018-05-29 15:44:02 +0200362 if (session->side != NC_SERVER) {
363 ERRINT;
364 return -1;
365 }
366
Michal Vaskoacf98472021-02-04 15:33:57 +0100367 assert(session->opts.server.rpc_inuse);
Michal Vaskoade892d2017-02-22 13:40:35 +0100368
369 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100370 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100371
372 /* LOCK */
Michal Vaskod8a74192023-02-06 15:51:50 +0100373 ret = pthread_mutex_clocklock(&session->opts.server.rpc_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100374 } else if (!timeout) {
375 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100376 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100377 } else { /* timeout == -1 */
378 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100379 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100380 }
381
382 if (ret && (ret != EBUSY) && (ret != ETIMEDOUT)) {
383 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200384 ERR(session, "%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100385 return -1;
386 } else if (ret) {
Michal Vasko69e98752022-12-14 14:20:17 +0100387 WRN(session, "%s: session RPC lock timeout, should not happen.", func);
Michal Vaskoade892d2017-02-22 13:40:35 +0100388 }
389
Michal Vaskoacf98472021-02-04 15:33:57 +0100390 session->opts.server.rpc_inuse = 0;
391 pthread_cond_signal(&session->opts.server.rpc_cond);
Michal Vaskoade892d2017-02-22 13:40:35 +0100392
393 if (!ret) {
394 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100395 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100396 if (ret) {
397 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200398 ERR(session, "%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100399 return -1;
400 }
401 }
402
Michal Vasko96164bf2016-01-21 15:41:58 +0100403 return 1;
404}
405
Michal Vasko131120a2018-05-29 15:44:02 +0200406int
407nc_session_io_lock(struct nc_session *session, int timeout, const char *func)
408{
409 int ret;
410 struct timespec ts_timeout;
411
412 if (timeout > 0) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100413 nc_timeouttime_get(&ts_timeout, timeout);
Michal Vasko131120a2018-05-29 15:44:02 +0200414
Michal Vaskod8a74192023-02-06 15:51:50 +0100415 ret = pthread_mutex_clocklock(session->io_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vasko131120a2018-05-29 15:44:02 +0200416 } else if (!timeout) {
417 ret = pthread_mutex_trylock(session->io_lock);
418 } else { /* timeout == -1 */
Robin Jarry54ea2962018-10-10 10:33:40 +0200419 ret = pthread_mutex_lock(session->io_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200420 }
421
422 if (ret) {
423 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
424 /* timeout */
425 return 0;
426 }
427
428 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200429 ERR(session, "%s: failed to IO lock a session (%s).", func, strerror(ret));
Michal Vasko131120a2018-05-29 15:44:02 +0200430 return -1;
431 }
432
433 return 1;
434}
435
436int
437nc_session_io_unlock(struct nc_session *session, const char *func)
438{
439 int ret;
440
441 ret = pthread_mutex_unlock(session->io_lock);
442 if (ret) {
443 /* error */
Michal Vasko05532772021-06-03 12:12:38 +0200444 ERR(session, "%s: failed to IO unlock a session (%s).", func, strerror(ret));
Michal Vasko131120a2018-05-29 15:44:02 +0200445 return -1;
446 }
447
448 return 1;
449}
450
Michal Vasko01130bd2021-08-26 11:47:38 +0200451int
452nc_session_client_msgs_lock(struct nc_session *session, int *timeout, const char *func)
453{
454 int ret;
455 int32_t diff_msec;
roman6ece9c52022-06-22 09:29:17 +0200456 struct timespec ts_timeout, ts_start;
Michal Vasko01130bd2021-08-26 11:47:38 +0200457
458 assert(session->side == NC_CLIENT);
459
460 if (*timeout > 0) {
461 /* get current time */
Michal Vaskod8a74192023-02-06 15:51:50 +0100462 nc_timeouttime_get(&ts_start, 0);
Michal Vasko01130bd2021-08-26 11:47:38 +0200463
Michal Vaskod8a74192023-02-06 15:51:50 +0100464 nc_timeouttime_get(&ts_timeout, *timeout);
Michal Vasko01130bd2021-08-26 11:47:38 +0200465
Michal Vaskod8a74192023-02-06 15:51:50 +0100466 ret = pthread_mutex_clocklock(&session->opts.client.msgs_lock, COMPAT_CLOCK_ID, &ts_timeout);
Michal Vasko01130bd2021-08-26 11:47:38 +0200467 if (!ret) {
468 /* update timeout based on what was elapsed */
Michal Vaskod8a74192023-02-06 15:51:50 +0100469 diff_msec = nc_timeouttime_cur_diff(&ts_start);
Michal Vasko01130bd2021-08-26 11:47:38 +0200470 *timeout -= diff_msec;
471 }
472 } else if (!*timeout) {
473 ret = pthread_mutex_trylock(&session->opts.client.msgs_lock);
474 } else { /* timeout == -1 */
475 ret = pthread_mutex_lock(&session->opts.client.msgs_lock);
476 }
477
478 if (ret) {
479 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
480 /* timeout */
481 return 0;
482 }
483
484 /* error */
485 ERR(session, "%s: failed to MSGS lock a session (%s).", func, strerror(ret));
486 return -1;
487 }
488
489 return 1;
490}
491
492int
493nc_session_client_msgs_unlock(struct nc_session *session, const char *func)
494{
495 int ret;
496
497 assert(session->side == NC_CLIENT);
498
499 ret = pthread_mutex_unlock(&session->opts.client.msgs_lock);
500 if (ret) {
501 /* error */
502 ERR(session, "%s: failed to MSGS unlock a session (%s).", func, strerror(ret));
503 return -1;
504 }
505
506 return 1;
507}
508
Michal Vasko8dadf782016-01-15 10:29:36 +0100509API NC_STATUS
510nc_session_get_status(const struct nc_session *session)
511{
roman40672412023-05-04 11:10:22 +0200512 NC_CHECK_ARG_RET(session, session, NC_STATUS_ERR);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100513
Michal Vasko8dadf782016-01-15 10:29:36 +0100514 return session->status;
515}
516
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100517API NC_SESSION_TERM_REASON
Michal Vasko142cfea2017-08-07 10:12:11 +0200518nc_session_get_term_reason(const struct nc_session *session)
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100519{
roman40672412023-05-04 11:10:22 +0200520 NC_CHECK_ARG_RET(session, session, NC_SESSION_TERM_ERR);
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100521
522 return session->term_reason;
523}
524
Michal Vasko8dadf782016-01-15 10:29:36 +0100525API uint32_t
Michal Vasko142cfea2017-08-07 10:12:11 +0200526nc_session_get_killed_by(const struct nc_session *session)
527{
roman40672412023-05-04 11:10:22 +0200528 NC_CHECK_ARG_RET(session, session, 0);
Michal Vasko142cfea2017-08-07 10:12:11 +0200529
530 return session->killed_by;
531}
532
533API uint32_t
Michal Vasko8dadf782016-01-15 10:29:36 +0100534nc_session_get_id(const struct nc_session *session)
535{
roman40672412023-05-04 11:10:22 +0200536 NC_CHECK_ARG_RET(session, session, 0);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100537
Michal Vasko8dadf782016-01-15 10:29:36 +0100538 return session->id;
539}
540
Michal Vasko174fe8e2016-02-17 15:38:09 +0100541API int
542nc_session_get_version(const struct nc_session *session)
543{
roman40672412023-05-04 11:10:22 +0200544 NC_CHECK_ARG_RET(session, session, -1);
Michal Vasko174fe8e2016-02-17 15:38:09 +0100545
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200546 return session->version == NC_VERSION_10 ? 0 : 1;
Michal Vasko174fe8e2016-02-17 15:38:09 +0100547}
548
Michal Vasko8dadf782016-01-15 10:29:36 +0100549API NC_TRANSPORT_IMPL
550nc_session_get_ti(const struct nc_session *session)
551{
roman40672412023-05-04 11:10:22 +0200552 NC_CHECK_ARG_RET(session, session, 0);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100553
Michal Vasko8dadf782016-01-15 10:29:36 +0100554 return session->ti_type;
555}
556
557API const char *
558nc_session_get_username(const struct nc_session *session)
559{
roman40672412023-05-04 11:10:22 +0200560 NC_CHECK_ARG_RET(session, session, NULL);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100561
Michal Vasko8dadf782016-01-15 10:29:36 +0100562 return session->username;
563}
564
565API const char *
566nc_session_get_host(const struct nc_session *session)
567{
roman40672412023-05-04 11:10:22 +0200568 NC_CHECK_ARG_RET(session, session, NULL);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100569
Michal Vasko8dadf782016-01-15 10:29:36 +0100570 return session->host;
571}
572
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200573API const char *
574nc_session_get_path(const struct nc_session *session)
575{
roman40672412023-05-04 11:10:22 +0200576 NC_CHECK_ARG_RET(session, session, NULL);
577
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200578 if (session->ti_type != NC_TI_UNIX) {
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200579 return NULL;
Michal Vaskob83a3fa2021-05-26 09:53:42 +0200580 }
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200581
582 return session->path;
583}
584
Michal Vasko8dadf782016-01-15 10:29:36 +0100585API uint16_t
586nc_session_get_port(const struct nc_session *session)
587{
roman40672412023-05-04 11:10:22 +0200588 NC_CHECK_ARG_RET(session, session, 0);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100589
Michal Vasko8dadf782016-01-15 10:29:36 +0100590 return session->port;
591}
592
Michal Vasko93224072021-11-09 12:14:28 +0100593API const struct ly_ctx *
Michal Vasko9a25e932016-02-01 10:36:42 +0100594nc_session_get_ctx(const struct nc_session *session)
595{
roman40672412023-05-04 11:10:22 +0200596 NC_CHECK_ARG_RET(session, session, NULL);
Michal Vasko9a25e932016-02-01 10:36:42 +0100597
598 return session->ctx;
599}
600
Michal Vasko2cc4c682016-03-01 09:16:48 +0100601API void
602nc_session_set_data(struct nc_session *session, void *data)
603{
604 if (!session) {
roman40672412023-05-04 11:10:22 +0200605 ERRARG(NULL, "session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100606 return;
607 }
608
609 session->data = data;
610}
611
612API void *
613nc_session_get_data(const struct nc_session *session)
614{
roman40672412023-05-04 11:10:22 +0200615 NC_CHECK_ARG_RET(session, session, NULL);
Michal Vasko2cc4c682016-03-01 09:16:48 +0100616
617 return session->data;
618}
619
Michal Vaskodc96bb92023-03-28 08:52:48 +0200620API int
621nc_session_is_callhome(const struct nc_session *session)
622{
roman40672412023-05-04 11:10:22 +0200623 NC_CHECK_ARG_RET(session, session, 0);
Michal Vaskodc96bb92023-03-28 08:52:48 +0200624
625 if (session->flags & NC_SESSION_CALLHOME) {
626 return 1;
627 }
628
629 return 0;
630}
631
Michal Vasko086311b2016-01-08 09:53:11 +0100632NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +0200633nc_send_msg_io(struct nc_session *session, int io_timeout, struct lyd_node *op)
Radek Krejci695d4fa2015-10-22 13:23:54 +0200634{
Michal Vasko7e1f5fb2021-11-10 10:14:45 +0100635 if (session->ctx != LYD_CTX(op)) {
636 ERR(session, "RPC \"%s\" was created in different context than that of the session.", LYD_NAME(op));
Michal Vasko086311b2016-01-08 09:53:11 +0100637 return NC_MSG_ERROR;
Michal Vasko7df39ec2015-12-09 15:26:24 +0100638 }
639
Michal Vasko131120a2018-05-29 15:44:02 +0200640 return nc_write_msg_io(session, io_timeout, NC_MSG_RPC, op, NULL);
Michal Vasko7df39ec2015-12-09 15:26:24 +0100641}
642
Michal Vaskod4da3632022-05-25 11:49:10 +0200643/**
644 * @brief Send \<close-session\> and read the reply on a session.
645 *
646 * @param[in] session Closing NETCONF session.
647 */
648static void
649nc_session_free_close_session(struct nc_session *session)
650{
651 struct ly_in *msg;
652 struct lyd_node *close_rpc, *envp;
653 const struct lys_module *ietfnc;
654
655 ietfnc = ly_ctx_get_module_implemented(session->ctx, "ietf-netconf");
656 if (!ietfnc) {
Michal Vasko5ca5d972022-09-14 13:51:31 +0200657 WRN(session, "Missing ietf-netconf module in context, unable to send <close-session>.");
Michal Vaskod4da3632022-05-25 11:49:10 +0200658 return;
659 }
660 if (lyd_new_inner(NULL, ietfnc, "close-session", 0, &close_rpc)) {
661 WRN(session, "Failed to create <close-session> RPC.");
662 return;
663 }
664
665 /* send the RPC */
666 nc_send_msg_io(session, NC_SESSION_FREE_LOCK_TIMEOUT, close_rpc);
667
668read_msg:
669 switch (nc_read_msg_poll_io(session, NC_CLOSE_REPLY_TIMEOUT, &msg)) {
670 case 1:
671 if (!strncmp(ly_in_memory(msg, NULL), "<notification", 13)) {
672 /* ignore */
673 ly_in_free(msg, 1);
674 goto read_msg;
675 }
676 if (lyd_parse_op(session->ctx, close_rpc, msg, LYD_XML, LYD_TYPE_REPLY_NETCONF, &envp, NULL)) {
677 WRN(session, "Failed to parse <close-session> reply.");
678 } else if (!lyd_child(envp) || strcmp(LYD_NAME(lyd_child(envp)), "ok")) {
679 WRN(session, "Reply to <close-session> was not <ok> as expected.");
680 }
681 lyd_free_tree(envp);
682 ly_in_free(msg, 1);
683 break;
684 case 0:
685 WRN(session, "Timeout for receiving a reply to <close-session> elapsed.");
686 break;
687 case -1:
688 ERR(session, "Failed to receive a reply to <close-session>.");
689 break;
690 default:
691 /* cannot happen */
692 break;
693 }
694 lyd_free_tree(close_rpc);
695}
696
Michal Vasko33476c32022-09-09 11:21:40 +0200697/**
698 * @brief Free transport implementation members of a session.
699 *
700 * @param[in] session Session to free.
701 * @param[out] multisession Whether there are other NC sessions on the same SSH sessions.
702 */
703static void
704nc_session_free_transport(struct nc_session *session, int *multisession)
705{
706 int connected; /* flag to indicate whether the transport socket is still connected */
Michal Vaskoe44f2702022-12-12 07:58:06 +0100707 int sock = -1;
Michal Vasko33476c32022-09-09 11:21:40 +0200708 struct nc_session *siter;
709
710 *multisession = 0;
711 connected = nc_session_is_connected(session);
712
713 /* transport implementation cleanup */
714 switch (session->ti_type) {
715 case NC_TI_FD:
716 /* nothing needed - file descriptors were provided by caller,
717 * so it is up to the caller to close them correctly
718 * TODO use callbacks
719 */
720 /* just to avoid compiler warning */
721 (void)connected;
722 (void)siter;
723 break;
724
725 case NC_TI_UNIX:
726 sock = session->ti.unixsock.sock;
727 (void)connected;
728 (void)siter;
729 break;
730
roman2eab4742023-06-06 10:00:26 +0200731#ifdef NC_ENABLED_SSH_TLS
roman506354a2024-04-11 09:37:22 +0200732 case NC_TI_SSH: {
Michal Vaskoe44f2702022-12-12 07:58:06 +0100733 int r;
734
Michal Vasko33476c32022-09-09 11:21:40 +0200735 if (connected) {
Michal Vasko64734402022-09-09 11:22:00 +0200736 ssh_channel_send_eof(session->ti.libssh.channel);
Michal Vasko33476c32022-09-09 11:21:40 +0200737 ssh_channel_free(session->ti.libssh.channel);
738 }
739 /* There can be multiple NETCONF sessions on the same SSH session (NETCONF session maps to
740 * SSH channel). So destroy the SSH session only if there is no other NETCONF session using
741 * it. Also, avoid concurrent free by multiple threads of sessions that share the SSH session.
742 */
743 /* SESSION IO LOCK */
744 r = nc_session_io_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
745
746 if (session->ti.libssh.next) {
747 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
748 if (siter->status != NC_STATUS_STARTING) {
749 *multisession = 1;
750 break;
751 }
752 }
753 }
754
755 if (!*multisession) {
756 /* it's not multisession yet, but we still need to free the starting sessions */
757 if (session->ti.libssh.next) {
758 do {
759 siter = session->ti.libssh.next;
760 session->ti.libssh.next = siter->ti.libssh.next;
761
762 /* free starting SSH NETCONF session (channel will be freed in ssh_free()) */
763 free(siter->username);
764 free(siter->host);
765 if (!(siter->flags & NC_SESSION_SHAREDCTX)) {
766 ly_ctx_destroy((struct ly_ctx *)siter->ctx);
767 }
768
769 free(siter);
770 } while (session->ti.libssh.next != session);
771 }
772 /* remember sock so we can close it */
773 sock = ssh_get_fd(session->ti.libssh.session);
774 if (connected) {
Michal Vasko70e90622023-12-07 08:43:14 +0100775 /* does not close sock */
Michal Vasko33476c32022-09-09 11:21:40 +0200776 ssh_disconnect(session->ti.libssh.session);
Michal Vasko33476c32022-09-09 11:21:40 +0200777 }
778 ssh_free(session->ti.libssh.session);
779 } else {
780 /* remove the session from the list */
781 for (siter = session->ti.libssh.next; siter->ti.libssh.next != session; siter = siter->ti.libssh.next) {}
782 if (session->ti.libssh.next == siter) {
783 /* there will be only one session */
784 siter->ti.libssh.next = NULL;
785 } else {
786 /* there are still multiple sessions, keep the ring list */
787 siter->ti.libssh.next = session->ti.libssh.next;
788 }
Michal Vasko33476c32022-09-09 11:21:40 +0200789 }
790
791 /* SESSION IO UNLOCK */
792 if (r == 1) {
793 nc_session_io_unlock(session, __func__);
794 }
795 break;
Michal Vaskoe44f2702022-12-12 07:58:06 +0100796 }
roman506354a2024-04-11 09:37:22 +0200797 case NC_TI_TLS:
roman9ba26aa2024-04-05 12:31:54 +0200798 sock = nc_tls_get_fd_wrap(session);
Michal Vasko33476c32022-09-09 11:21:40 +0200799
800 if (connected) {
roman9ba26aa2024-04-05 12:31:54 +0200801 /* notify the peer that we're shutting down */
802 nc_tls_close_notify_wrap(session->ti.tls.session);
Michal Vasko33476c32022-09-09 11:21:40 +0200803 }
roman9ba26aa2024-04-05 12:31:54 +0200804
805 nc_tls_ctx_destroy_wrap(&session->ti.tls.ctx);
romanc95a14f2024-04-23 15:13:00 +0200806 memset(&session->ti.tls.ctx, 0, sizeof session->ti.tls.ctx);
roman9ba26aa2024-04-05 12:31:54 +0200807 nc_tls_session_destroy_wrap(session->ti.tls.session);
romanc95a14f2024-04-23 15:13:00 +0200808 session->ti.tls.session = NULL;
roman9ba26aa2024-04-05 12:31:54 +0200809 nc_tls_config_destroy_wrap(session->ti.tls.config);
romanc95a14f2024-04-23 15:13:00 +0200810 session->ti.tls.config = NULL;
Michal Vasko33476c32022-09-09 11:21:40 +0200811
812 if (session->side == NC_SERVER) {
roman9ba26aa2024-04-05 12:31:54 +0200813 nc_tls_cert_destroy_wrap(session->opts.server.client_cert);
Michal Vasko33476c32022-09-09 11:21:40 +0200814 }
roman9ba26aa2024-04-05 12:31:54 +0200815
Michal Vasko33476c32022-09-09 11:21:40 +0200816 break;
roman2eab4742023-06-06 10:00:26 +0200817#endif /* NC_ENABLED_SSH_TLS */
Michal Vasko33476c32022-09-09 11:21:40 +0200818 case NC_TI_NONE:
819 break;
820 }
821
822 /* close socket separately */
823 if (sock > -1) {
824 close(sock);
825 }
826}
827
Radek Krejci695d4fa2015-10-22 13:23:54 +0200828API void
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100829nc_session_free(struct nc_session *session, void (*data_free)(void *))
Radek Krejci695d4fa2015-10-22 13:23:54 +0200830{
Michal Vasko33476c32022-09-09 11:21:40 +0200831 int r, i, rpc_locked = 0, msgs_locked = 0, timeout;
Michal Vaskob48aa812016-01-18 14:13:09 +0100832 int multisession = 0; /* flag for more NETCONF sessions on a single SSH session */
Michal Vaskoad611702015-12-03 13:41:51 +0100833 struct nc_msg_cont *contiter;
Michal Vasko77367452021-02-16 16:32:18 +0100834 struct ly_in *msg;
roman6ece9c52022-06-22 09:29:17 +0200835 struct timespec ts;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200836 void *p;
837
Michal Vasko428087d2016-01-14 16:04:28 +0100838 if (!session || (session->status == NC_STATUS_CLOSING)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200839 return;
840 }
841
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200842 /* stop notification threads if any */
843 if ((session->side == NC_CLIENT) && ATOMIC_LOAD_RELAXED(session->opts.client.ntf_thread_running)) {
844 /* let the threads know they should quit */
845 ATOMIC_STORE_RELAXED(session->opts.client.ntf_thread_running, 0);
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200846
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200847 /* wait for them */
Michal Vaskod8a74192023-02-06 15:51:50 +0100848 nc_timeouttime_get(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
Michal Vaskoa8ec54b2022-10-20 09:59:07 +0200849 while (ATOMIC_LOAD_RELAXED(session->opts.client.ntf_thread_count)) {
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200850 usleep(NC_TIMEOUT_STEP);
Michal Vaskod8a74192023-02-06 15:51:50 +0100851 if (nc_timeouttime_cur_diff(&ts) < 1) {
Michal Vasko5bd4a3f2021-06-17 16:40:10 +0200852 ERR(session, "Waiting for notification thread exit failed (timed out).");
853 break;
854 }
855 }
Michal Vasko86d357c2016-03-11 13:46:38 +0100856 }
857
Michal Vaskoacf98472021-02-04 15:33:57 +0100858 if (session->side == NC_SERVER) {
Michal Vasko131120a2018-05-29 15:44:02 +0200859 r = nc_session_rpc_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100860 if (r == -1) {
Michal Vaskoadd4c792015-10-26 15:36:58 +0100861 return;
Michal Vasko131120a2018-05-29 15:44:02 +0200862 } else if (r) {
863 rpc_locked = 1;
Michal Vasko96a28a32021-02-04 15:35:20 +0100864 } else {
865 /* else failed to lock it, too bad */
Michal Vasko05532772021-06-03 12:12:38 +0200866 ERR(session, "Freeing a session while an RPC is being processed.");
Michal Vasko96a28a32021-02-04 15:35:20 +0100867 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200868 }
869
Michal Vasko8c247822020-09-07 13:23:23 +0200870 if (session->side == NC_CLIENT) {
Michal Vasko01130bd2021-08-26 11:47:38 +0200871 timeout = NC_SESSION_FREE_LOCK_TIMEOUT;
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200872
Michal Vasko01130bd2021-08-26 11:47:38 +0200873 /* MSGS LOCK */
874 r = nc_session_client_msgs_lock(session, &timeout, __func__);
875 if (r == -1) {
876 return;
877 } else if (r) {
878 msgs_locked = 1;
879 } else {
880 /* else failed to lock it, too bad */
881 ERR(session, "Freeing a session while messages are being received.");
882 }
883
884 /* cleanup message queue */
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200885 for (contiter = session->opts.client.msgs; contiter; ) {
Michal Vasko77367452021-02-16 16:32:18 +0100886 ly_in_free(contiter->msg, 1);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200887
Michal Vaskoad611702015-12-03 13:41:51 +0100888 p = contiter;
889 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200890 free(p);
891 }
892
Michal Vasko01130bd2021-08-26 11:47:38 +0200893 if (msgs_locked) {
894 /* MSGS UNLOCK */
895 nc_session_client_msgs_unlock(session, __func__);
896 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200897
Michal Vasko8c247822020-09-07 13:23:23 +0200898 if (session->status == NC_STATUS_RUNNING) {
Michal Vasko9c6d38c2021-09-03 13:02:53 +0200899 /* receive any leftover messages */
900 while (nc_read_msg_poll_io(session, 0, &msg) == 1) {
901 ly_in_free(msg, 1);
902 }
903
Michal Vasko8c247822020-09-07 13:23:23 +0200904 /* send closing info to the other side */
Michal Vaskod4da3632022-05-25 11:49:10 +0200905 nc_session_free_close_session(session);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200906 }
907
908 /* list of server's capabilities */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200909 if (session->opts.client.cpblts) {
910 for (i = 0; session->opts.client.cpblts[i]; i++) {
Michal Vasko96fc4bb2017-05-23 14:58:34 +0200911 free(session->opts.client.cpblts[i]);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200912 }
Michal Vasko2e6defd2016-10-07 15:48:15 +0200913 free(session->opts.client.cpblts);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200914 }
Michal Vasko78939072022-12-12 07:43:18 +0100915
916 /* LY ext data */
roman2eab4742023-06-06 10:00:26 +0200917#ifdef NC_ENABLED_SSH_TLS
Michal Vaskoe44f2702022-12-12 07:58:06 +0100918 struct nc_session *siter;
919
Michal Vasko78939072022-12-12 07:43:18 +0100920 if ((session->flags & NC_SESSION_SHAREDCTX) && session->ti.libssh.next) {
921 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
922 if (siter->status != NC_STATUS_STARTING) {
923 /* move LY ext data to this session */
924 assert(!siter->opts.client.ext_data);
925 siter->opts.client.ext_data = session->opts.client.ext_data;
926 session->opts.client.ext_data = NULL;
927 break;
928 }
929 }
Michal Vaskoe44f2702022-12-12 07:58:06 +0100930 } else
roman2eab4742023-06-06 10:00:26 +0200931#endif /* NC_ENABLED_SSH_TLS */
Michal Vaskoe44f2702022-12-12 07:58:06 +0100932 {
Michal Vasko78939072022-12-12 07:43:18 +0100933 lyd_free_siblings(session->opts.client.ext_data);
934 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200935 }
936
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100937 if (session->data && data_free) {
938 data_free(session->data);
939 }
940
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200941 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
942 /* CH LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100943 pthread_mutex_lock(&session->opts.server.ch_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200944 }
945
Michal Vasko86d357c2016-03-11 13:46:38 +0100946 /* mark session for closing */
Radek Krejci695d4fa2015-10-22 13:23:54 +0200947 session->status = NC_STATUS_CLOSING;
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200948
Michal Vaskofeccb312022-03-24 15:24:59 +0100949 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CH_THREAD)) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100950 pthread_cond_signal(&session->opts.server.ch_cond);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200951
Michal Vaskod8a74192023-02-06 15:51:50 +0100952 nc_timeouttime_get(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
Michal Vasko0db3db52021-03-03 10:45:42 +0100953
954 /* wait for CH thread to actually wake up and terminate */
955 r = 0;
Michal Vaskofeccb312022-03-24 15:24:59 +0100956 while (!r && (session->flags & NC_SESSION_CH_THREAD)) {
Michal Vaskod8a74192023-02-06 15:51:50 +0100957 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 +0100958 }
Michal Vasko0db3db52021-03-03 10:45:42 +0100959 if (r) {
Michal Vasko05532772021-06-03 12:12:38 +0200960 ERR(session, "Waiting for Call Home thread failed (%s).", strerror(r));
Michal Vasko3f05a092018-03-13 10:39:49 +0100961 }
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200962 }
963
Michal Vaskofeccb312022-03-24 15:24:59 +0100964 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
965 /* CH UNLOCK */
966 pthread_mutex_unlock(&session->opts.server.ch_lock);
967 }
968
Radek Krejci695d4fa2015-10-22 13:23:54 +0200969 /* transport implementation cleanup */
Michal Vasko33476c32022-09-09 11:21:40 +0200970 nc_session_free_transport(session, &multisession);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200971
Michal Vasko33476c32022-09-09 11:21:40 +0200972 /* final cleanup */
Michal Vasko93224072021-11-09 12:14:28 +0100973 free(session->username);
974 free(session->host);
975 free(session->path);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200976
Michal Vaskoacf98472021-02-04 15:33:57 +0100977 if (session->side == NC_SERVER) {
Michal Vaskodf68e7e2022-04-21 11:04:00 +0200978 pthread_mutex_destroy(&session->opts.server.ntf_status_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200979 if (rpc_locked) {
980 nc_session_rpc_unlock(session, NC_SESSION_LOCK_TIMEOUT, __func__);
Michal Vasko9e99f012016-03-03 13:25:20 +0100981 }
Michal Vaskoacf98472021-02-04 15:33:57 +0100982 pthread_mutex_destroy(&session->opts.server.rpc_lock);
983 pthread_cond_destroy(&session->opts.server.rpc_cond);
Michal Vasko131120a2018-05-29 15:44:02 +0200984 }
985
986 if (session->io_lock && !multisession) {
987 pthread_mutex_destroy(session->io_lock);
988 free(session->io_lock);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200989 }
990
991 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Michal Vasko93224072021-11-09 12:14:28 +0100992 ly_ctx_destroy((struct ly_ctx *)session->ctx);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200993 }
994
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200995 if (session->side == NC_SERVER) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100996 /* free CH synchronization structures */
997 pthread_cond_destroy(&session->opts.server.ch_cond);
998 pthread_mutex_destroy(&session->opts.server.ch_lock);
tadeas-vintrlik54f142a2021-08-23 10:36:18 +0200999 } else {
1000 pthread_mutex_destroy(&session->opts.client.msgs_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +02001001 }
1002
Radek Krejci695d4fa2015-10-22 13:23:54 +02001003 free(session);
1004}
1005
Michal Vasko086311b2016-01-08 09:53:11 +01001006static void
Michal Vasko93224072021-11-09 12:14:28 +01001007add_cpblt(const char *capab, char ***cpblts, int *size, int *count)
Michal Vasko086311b2016-01-08 09:53:11 +01001008{
Radek Krejci658782b2016-12-04 22:04:55 +01001009 size_t len;
1010 int i;
1011 char *p;
1012
1013 if (capab) {
1014 /* check if already present */
1015 p = strchr(capab, '?');
1016 if (p) {
1017 len = p - capab;
1018 } else {
1019 len = strlen(capab);
1020 }
1021 for (i = 0; i < *count; i++) {
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001022 if (!strncmp((*cpblts)[i], capab, len) && (((*cpblts)[i][len] == '\0') || ((*cpblts)[i][len] == '?'))) {
Radek Krejci658782b2016-12-04 22:04:55 +01001023 /* already present, do not duplicate it */
1024 return;
1025 }
1026 }
1027 }
1028
1029 /* add another capability */
Michal Vasko086311b2016-01-08 09:53:11 +01001030 if (*count == *size) {
1031 *size += 5;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001032 *cpblts = nc_realloc(*cpblts, *size * sizeof **cpblts);
1033 if (!(*cpblts)) {
1034 ERRMEM;
1035 return;
1036 }
Michal Vasko086311b2016-01-08 09:53:11 +01001037 }
1038
Michal Vasko93224072021-11-09 12:14:28 +01001039 (*cpblts)[*count] = capab ? strdup(capab) : NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001040 ++(*count);
1041}
1042
Michal Vasko93224072021-11-09 12:14:28 +01001043API char **
1044nc_server_get_cpblts_version(const struct ly_ctx *ctx, LYS_VERSION version)
Michal Vasko086311b2016-01-08 09:53:11 +01001045{
Michal Vasko93224072021-11-09 12:14:28 +01001046 char **cpblts;
Michal Vasko77367452021-02-16 16:32:18 +01001047 const struct lys_module *mod;
1048 struct lysp_feature *feat;
1049 int size = 10, count, features_count = 0, dev_count = 0, str_len, len;
Michal Vasko1440a742021-03-31 11:11:03 +02001050 uint32_t i, u;
Michal Vasko77367452021-02-16 16:32:18 +01001051 LY_ARRAY_COUNT_TYPE v;
Michal Vasko1440a742021-03-31 11:11:03 +02001052 char *yl_content_id;
romanc1d2b092023-02-02 08:58:27 +01001053 uint32_t wd_also_supported;
1054 uint32_t wd_basic_mode;
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001055
Radek Krejci24a18412018-05-16 15:09:10 +02001056#define NC_CPBLT_BUF_LEN 4096
Michal Vasko2e47ef92016-06-20 10:03:24 +02001057 char str[NC_CPBLT_BUF_LEN];
Michal Vasko086311b2016-01-08 09:53:11 +01001058
roman40672412023-05-04 11:10:22 +02001059 NC_CHECK_ARG_RET(NULL, ctx, NULL);
Michal Vasko4ffa3b22016-05-24 16:36:25 +02001060
Michal Vasko086311b2016-01-08 09:53:11 +01001061 cpblts = malloc(size * sizeof *cpblts);
roman124a4362023-10-26 15:36:22 +02001062 NC_CHECK_ERRMEM_GOTO(!cpblts, , error);
Michal Vasko93224072021-11-09 12:14:28 +01001063 cpblts[0] = strdup("urn:ietf:params:netconf:base:1.0");
1064 cpblts[1] = strdup("urn:ietf:params:netconf:base:1.1");
Michal Vasko086311b2016-01-08 09:53:11 +01001065 count = 2;
1066
1067 /* capabilities */
1068
Michal Vasko77367452021-02-16 16:32:18 +01001069 mod = ly_ctx_get_module_implemented(ctx, "ietf-netconf");
Michal Vasko086311b2016-01-08 09:53:11 +01001070 if (mod) {
Michal Vasko77367452021-02-16 16:32:18 +01001071 if (lys_feature_value(mod, "writable-running") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001072 add_cpblt("urn:ietf:params:netconf:capability:writable-running:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001073 }
Michal Vasko77367452021-02-16 16:32:18 +01001074 if (lys_feature_value(mod, "candidate") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001075 add_cpblt("urn:ietf:params:netconf:capability:candidate:1.0", &cpblts, &size, &count);
Michal Vasko77367452021-02-16 16:32:18 +01001076 if (lys_feature_value(mod, "confirmed-commit") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001077 add_cpblt("urn:ietf:params:netconf:capability:confirmed-commit:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001078 }
1079 }
Michal Vasko77367452021-02-16 16:32:18 +01001080 if (lys_feature_value(mod, "rollback-on-error") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001081 add_cpblt("urn:ietf:params:netconf:capability:rollback-on-error:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001082 }
Michal Vasko77367452021-02-16 16:32:18 +01001083 if (lys_feature_value(mod, "validate") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001084 add_cpblt("urn:ietf:params:netconf:capability:validate:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001085 }
Michal Vasko77367452021-02-16 16:32:18 +01001086 if (lys_feature_value(mod, "startup") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001087 add_cpblt("urn:ietf:params:netconf:capability:startup:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001088 }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001089
1090 /* The URL capability must be set manually using nc_server_set_capability()
1091 * because of the need for supported protocols to be included.
1092 * https://tools.ietf.org/html/rfc6241#section-8.8.3
1093 */
Michal Vasko77367452021-02-16 16:32:18 +01001094 // if (lys_feature_value(mod, "url") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001095 // add_cpblt("urn:ietf:params:netconf:capability:url:1.0", &cpblts, &size, &count);
mekleoa8de5e92020-02-13 09:05:56 +01001096 // }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001097
Michal Vasko77367452021-02-16 16:32:18 +01001098 if (lys_feature_value(mod, "xpath") == LY_SUCCESS) {
Michal Vasko93224072021-11-09 12:14:28 +01001099 add_cpblt("urn:ietf:params:netconf:capability:xpath:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001100 }
1101 }
1102
Michal Vasko77367452021-02-16 16:32:18 +01001103 mod = ly_ctx_get_module_implemented(ctx, "ietf-netconf-with-defaults");
Michal Vasko086311b2016-01-08 09:53:11 +01001104 if (mod) {
romanc1d2b092023-02-02 08:58:27 +01001105 wd_basic_mode = ATOMIC_LOAD_RELAXED(server_opts.wd_basic_mode);
1106 if (!wd_basic_mode) {
Michal Vasko05532772021-06-03 12:12:38 +02001107 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 +01001108 } else {
Michal Vasko3031aae2016-01-27 16:07:18 +01001109 strcpy(str, "urn:ietf:params:netconf:capability:with-defaults:1.0");
romanc1d2b092023-02-02 08:58:27 +01001110 switch (wd_basic_mode) {
Michal Vasko086311b2016-01-08 09:53:11 +01001111 case NC_WD_ALL:
1112 strcat(str, "?basic-mode=report-all");
1113 break;
1114 case NC_WD_TRIM:
1115 strcat(str, "?basic-mode=trim");
1116 break;
1117 case NC_WD_EXPLICIT:
1118 strcat(str, "?basic-mode=explicit");
1119 break;
1120 default:
Michal Vasko9e036d52016-01-08 10:49:26 +01001121 ERRINT;
Michal Vasko086311b2016-01-08 09:53:11 +01001122 break;
1123 }
1124
romanc1d2b092023-02-02 08:58:27 +01001125 wd_also_supported = ATOMIC_LOAD_RELAXED(server_opts.wd_also_supported);
1126 if (wd_also_supported) {
Michal Vasko2e47ef92016-06-20 10:03:24 +02001127 strcat(str, "&also-supported=");
romanc1d2b092023-02-02 08:58:27 +01001128 if (wd_also_supported & NC_WD_ALL) {
Michal Vasko086311b2016-01-08 09:53:11 +01001129 strcat(str, "report-all,");
1130 }
romanc1d2b092023-02-02 08:58:27 +01001131 if (wd_also_supported & NC_WD_ALL_TAG) {
Michal Vasko086311b2016-01-08 09:53:11 +01001132 strcat(str, "report-all-tagged,");
1133 }
romanc1d2b092023-02-02 08:58:27 +01001134 if (wd_also_supported & NC_WD_TRIM) {
Michal Vasko086311b2016-01-08 09:53:11 +01001135 strcat(str, "trim,");
1136 }
romanc1d2b092023-02-02 08:58:27 +01001137 if (wd_also_supported & NC_WD_EXPLICIT) {
Michal Vasko086311b2016-01-08 09:53:11 +01001138 strcat(str, "explicit,");
1139 }
1140 str[strlen(str) - 1] = '\0';
1141
Michal Vasko93224072021-11-09 12:14:28 +01001142 add_cpblt(str, &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001143 }
1144 }
1145 }
1146
Radek Krejci658782b2016-12-04 22:04:55 +01001147 /* other capabilities */
1148 for (u = 0; u < server_opts.capabilities_count; u++) {
Michal Vasko93224072021-11-09 12:14:28 +01001149 add_cpblt(server_opts.capabilities[u], &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001150 }
1151
1152 /* models */
Michal Vasko1440a742021-03-31 11:11:03 +02001153 u = 0;
Radek Krejci24a18412018-05-16 15:09:10 +02001154 while ((mod = ly_ctx_get_module_iter(ctx, &u))) {
Radek Krejci24a18412018-05-16 15:09:10 +02001155 if (!strcmp(mod->name, "ietf-yang-library")) {
Michal Vasko77367452021-02-16 16:32:18 +01001156 if (!mod->revision || (strcmp(mod->revision, "2016-06-21") && strcmp(mod->revision, "2019-01-04"))) {
Michal Vasko05532772021-06-03 12:12:38 +02001157 ERR(NULL, "Unknown \"ietf-yang-library\" revision, only 2016-06-21 and 2019-01-04 are supported.");
Michal Vaskod5ada122020-03-19 18:28:06 +01001158 goto error;
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001159 }
Michal Vaskod5ada122020-03-19 18:28:06 +01001160
Michal Vasko1440a742021-03-31 11:11:03 +02001161 /* get content-id */
1162 if (server_opts.content_id_clb) {
1163 yl_content_id = server_opts.content_id_clb(server_opts.content_id_data);
roman124a4362023-10-26 15:36:22 +02001164 NC_CHECK_ERRMEM_GOTO(!yl_content_id, , error);
Michal Vasko1440a742021-03-31 11:11:03 +02001165 } else {
1166 yl_content_id = malloc(11);
roman124a4362023-10-26 15:36:22 +02001167 NC_CHECK_ERRMEM_GOTO(!yl_content_id, , error);
Michal Vasko1440a742021-03-31 11:11:03 +02001168 sprintf(yl_content_id, "%u", ly_ctx_get_change_count(ctx));
1169 }
1170
Michal Vasko77367452021-02-16 16:32:18 +01001171 if (!strcmp(mod->revision, "2019-01-04")) {
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001172 /* new one (capab defined in RFC 8526 section 2) */
Michal Vasko1440a742021-03-31 11:11:03 +02001173 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.1?revision=%s&content-id=%s",
1174 mod->revision, yl_content_id);
Michal Vasko93224072021-11-09 12:14:28 +01001175 add_cpblt(str, &cpblts, &size, &count);
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001176 } else {
1177 /* old one (capab defined in RFC 7950 section 5.6.4) */
Michal Vasko1440a742021-03-31 11:11:03 +02001178 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.0?revision=%s&module-set-id=%s",
1179 mod->revision, yl_content_id);
Michal Vasko93224072021-11-09 12:14:28 +01001180 add_cpblt(str, &cpblts, &size, &count);
Michal Vaskod5ada122020-03-19 18:28:06 +01001181 }
Michal Vasko1440a742021-03-31 11:11:03 +02001182 free(yl_content_id);
Radek Krejci24a18412018-05-16 15:09:10 +02001183 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001184 } else if ((version == LYS_VERSION_1_0) && (mod->parsed->version > version)) {
Michal Vasko5ca5d972022-09-14 13:51:31 +02001185 /* skip YANG 1.1 modules */
Radek Krejci24a18412018-05-16 15:09:10 +02001186 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001187 } else if ((version == LYS_VERSION_1_1) && (mod->parsed->version != version)) {
Michal Vasko5ca5d972022-09-14 13:51:31 +02001188 /* skip YANG 1.0 modules */
Radek Krejci24a18412018-05-16 15:09:10 +02001189 continue;
1190 }
Michal Vasko086311b2016-01-08 09:53:11 +01001191
Michal Vasko77367452021-02-16 16:32:18 +01001192 str_len = sprintf(str, "%s?module=%s%s%s", mod->ns, mod->name, mod->revision ? "&revision=" : "",
1193 mod->revision ? mod->revision : "");
Radek Krejci24a18412018-05-16 15:09:10 +02001194
Michal Vaskodafdc742020-03-11 16:15:59 +01001195 features_count = 0;
1196 i = 0;
1197 feat = NULL;
Michal Vasko77367452021-02-16 16:32:18 +01001198 while ((feat = lysp_feature_next(feat, mod->parsed, &i))) {
Michal Vaskodafdc742020-03-11 16:15:59 +01001199 if (!(feat->flags & LYS_FENABLED)) {
1200 continue;
Michal Vaskoe90e4d12016-06-20 10:05:01 +02001201 }
Michal Vaskodafdc742020-03-11 16:15:59 +01001202 if (!features_count) {
1203 strcat(str, "&features=");
1204 str_len += 10;
1205 }
1206 len = strlen(feat->name);
1207 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1208 ERRINT;
1209 break;
1210 }
1211 if (features_count) {
1212 strcat(str, ",");
1213 ++str_len;
1214 }
1215 strcat(str, feat->name);
1216 str_len += len;
1217 features_count++;
Michal Vasko086311b2016-01-08 09:53:11 +01001218 }
Michal Vasko086311b2016-01-08 09:53:11 +01001219
Michal Vasko77367452021-02-16 16:32:18 +01001220 if (mod->deviated_by) {
Radek Krejci24a18412018-05-16 15:09:10 +02001221 strcat(str, "&deviations=");
1222 str_len += 12;
1223 dev_count = 0;
Michal Vasko77367452021-02-16 16:32:18 +01001224 LY_ARRAY_FOR(mod->deviated_by, v) {
1225 len = strlen(mod->deviated_by[v]->name);
1226 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1227 ERRINT;
1228 break;
Radek Krejci24a18412018-05-16 15:09:10 +02001229 }
Michal Vasko77367452021-02-16 16:32:18 +01001230 if (dev_count) {
1231 strcat(str, ",");
1232 ++str_len;
Radek Krejci24a18412018-05-16 15:09:10 +02001233 }
Michal Vasko77367452021-02-16 16:32:18 +01001234 strcat(str, mod->deviated_by[v]->name);
1235 str_len += len;
1236 dev_count++;
Radek Krejci24a18412018-05-16 15:09:10 +02001237 }
1238 }
1239
Michal Vasko93224072021-11-09 12:14:28 +01001240 add_cpblt(str, &cpblts, &size, &count);
Radek Krejci24a18412018-05-16 15:09:10 +02001241 }
Michal Vasko086311b2016-01-08 09:53:11 +01001242
1243 /* ending NULL capability */
Michal Vasko93224072021-11-09 12:14:28 +01001244 add_cpblt(NULL, &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001245
1246 return cpblts;
Radek Krejcif906e412017-09-22 14:44:45 +02001247
1248error:
Radek Krejcif906e412017-09-22 14:44:45 +02001249 free(cpblts);
Radek Krejcif906e412017-09-22 14:44:45 +02001250 return NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001251}
1252
Michal Vasko93224072021-11-09 12:14:28 +01001253API char **
1254nc_server_get_cpblts(const struct ly_ctx *ctx)
Radek Krejci24a18412018-05-16 15:09:10 +02001255{
1256 return nc_server_get_cpblts_version(ctx, LYS_VERSION_UNDEF);
1257}
1258
Radek Krejci695d4fa2015-10-22 13:23:54 +02001259static int
Michal Vasko77367452021-02-16 16:32:18 +01001260parse_cpblts(struct lyd_node *capabilities, char ***list)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001261{
Michal Vasko77367452021-02-16 16:32:18 +01001262 struct lyd_node *iter;
1263 struct lyd_node_opaq *cpblt;
Michal Vasko156d3272017-04-11 11:46:49 +02001264 int ver = -1, i = 0;
1265 const char *cpb_start, *cpb_end;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001266
1267 if (list) {
1268 /* get the storage for server's capabilities */
Michal Vasko77367452021-02-16 16:32:18 +01001269 LY_LIST_FOR(lyd_child(capabilities), iter) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001270 i++;
1271 }
Michal Vasko9e2d3a32015-11-10 13:09:18 +01001272 /* last item remains NULL */
1273 *list = calloc(i + 1, sizeof **list);
roman3a95bb22023-10-26 11:07:17 +02001274 NC_CHECK_ERRMEM_RET(!*list, -1);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001275 i = 0;
1276 }
1277
Michal Vasko77367452021-02-16 16:32:18 +01001278 LY_LIST_FOR(lyd_child(capabilities), iter) {
1279 cpblt = (struct lyd_node_opaq *)iter;
1280
1281 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 +02001282 ERR(NULL, "Unexpected <%s> element in client's <hello>.", cpblt->name.name);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001283 return -1;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001284 }
1285
Michal Vasko156d3272017-04-11 11:46:49 +02001286 /* skip leading/trailing whitespaces */
Michal Vasko77367452021-02-16 16:32:18 +01001287 for (cpb_start = cpblt->value; isspace(cpb_start[0]); ++cpb_start) {}
1288 for (cpb_end = cpblt->value + strlen(cpblt->value); (cpb_end > cpblt->value) && isspace(cpb_end[-1]); --cpb_end) {}
1289 if (!cpb_start[0] || (cpb_end == cpblt->value)) {
Michal Vasko05532772021-06-03 12:12:38 +02001290 ERR(NULL, "Empty capability \"%s\" received.", cpblt->value);
Michal Vasko156d3272017-04-11 11:46:49 +02001291 return -1;
1292 }
1293
Radek Krejci695d4fa2015-10-22 13:23:54 +02001294 /* detect NETCONF version */
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001295 if ((ver < 0) && !strncmp(cpb_start, "urn:ietf:params:netconf:base:1.0", cpb_end - cpb_start)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001296 ver = 0;
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001297 } 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 +02001298 ver = 1;
1299 }
1300
1301 /* store capabilities */
1302 if (list) {
Michal Vasko156d3272017-04-11 11:46:49 +02001303 (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
roman3a95bb22023-10-26 11:07:17 +02001304 NC_CHECK_ERRMEM_RET(!(*list)[i], -1);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001305 i++;
1306 }
1307 }
1308
1309 if (ver == -1) {
Michal Vasko05532772021-06-03 12:12:38 +02001310 ERR(NULL, "Peer does not support a compatible NETCONF version.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001311 }
1312
1313 return ver;
1314}
1315
1316static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001317nc_send_hello_io(struct nc_session *session)
Michal Vasko086311b2016-01-08 09:53:11 +01001318{
Michal Vasko131120a2018-05-29 15:44:02 +02001319 NC_MSG_TYPE ret;
Michal Vaskocf898172024-01-15 15:04:28 +01001320 int i, timeout_io;
Michal Vasko93224072021-11-09 12:14:28 +01001321 char **cpblts;
Michal Vasko131120a2018-05-29 15:44:02 +02001322 uint32_t *sid;
Michal Vasko086311b2016-01-08 09:53:11 +01001323
Michal Vasko131120a2018-05-29 15:44:02 +02001324 if (session->side == NC_CLIENT) {
1325 /* client side hello - send only NETCONF base capabilities */
1326 cpblts = malloc(3 * sizeof *cpblts);
roman3a95bb22023-10-26 11:07:17 +02001327 NC_CHECK_ERRMEM_RET(!cpblts, NC_MSG_ERROR);
Michal Vasko93224072021-11-09 12:14:28 +01001328 cpblts[0] = strdup("urn:ietf:params:netconf:base:1.0");
1329 cpblts[1] = strdup("urn:ietf:params:netconf:base:1.1");
Michal Vasko131120a2018-05-29 15:44:02 +02001330 cpblts[2] = NULL;
1331
Michal Vaskocf898172024-01-15 15:04:28 +01001332 timeout_io = NC_CLIENT_HELLO_TIMEOUT * 1000;
Michal Vasko131120a2018-05-29 15:44:02 +02001333 sid = NULL;
1334 } else {
Michal Vasko77367452021-02-16 16:32:18 +01001335 cpblts = nc_server_get_cpblts_version(session->ctx, LYS_VERSION_1_0);
Michal Vasko5b24b6b2020-12-04 09:29:47 +01001336 if (!cpblts) {
1337 return NC_MSG_ERROR;
1338 }
Michal Vasko131120a2018-05-29 15:44:02 +02001339
Michal Vaskocf898172024-01-15 15:04:28 +01001340 if (session->flags & NC_SESSION_CALLHOME) {
1341 timeout_io = NC_SERVER_CH_HELLO_TIMEOUT * 1000;
1342 } else {
Michal Vasko5c1c9b32024-02-02 09:02:42 +01001343 timeout_io = server_opts.idle_timeout ? server_opts.idle_timeout * 1000 : -1;
Michal Vaskocf898172024-01-15 15:04:28 +01001344 }
Michal Vasko131120a2018-05-29 15:44:02 +02001345 sid = &session->id;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001346 }
Michal Vasko05ba9df2016-01-13 14:40:27 +01001347
Michal Vaskocf898172024-01-15 15:04:28 +01001348 ret = nc_write_msg_io(session, timeout_io, NC_MSG_HELLO, cpblts, sid);
Michal Vasko086311b2016-01-08 09:53:11 +01001349
Michal Vasko086311b2016-01-08 09:53:11 +01001350 for (i = 0; cpblts[i]; ++i) {
Michal Vasko93224072021-11-09 12:14:28 +01001351 free(cpblts[i]);
Michal Vasko086311b2016-01-08 09:53:11 +01001352 }
1353 free(cpblts);
1354
Michal Vasko131120a2018-05-29 15:44:02 +02001355 return ret;
Michal Vasko086311b2016-01-08 09:53:11 +01001356}
1357
Michal Vasko1022f922024-05-27 11:12:02 +02001358/**
1359 * @brief Receive server hello message on the client.
1360 *
1361 * @param[in] session Client session to use.
1362 * @return Received message type.
1363 */
Michal Vasko086311b2016-01-08 09:53:11 +01001364static NC_MSG_TYPE
Michal Vasko1022f922024-05-27 11:12:02 +02001365nc_client_recv_hello_io(struct nc_session *session)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001366{
Michal Vasko77367452021-02-16 16:32:18 +01001367 struct ly_in *msg;
1368 struct lyd_node *hello = NULL, *iter;
1369 struct lyd_node_opaq *node;
1370 int r, ver = -1, flag = 0;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001371 char *str;
Michal Vasko292c5542023-02-01 14:33:17 +01001372 long long id;
Michal Vasko77367452021-02-16 16:32:18 +01001373 NC_MSG_TYPE rc = NC_MSG_HELLO;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001374
Michal Vasko77367452021-02-16 16:32:18 +01001375 r = nc_read_msg_poll_io(session, NC_CLIENT_HELLO_TIMEOUT * 1000, &msg);
1376 switch (r) {
1377 case 1:
Radek Krejci695d4fa2015-10-22 13:23:54 +02001378 /* parse <hello> data */
Michal Vasko77367452021-02-16 16:32:18 +01001379 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 +02001380 ERR(session, "Failed to parse server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001381 rc = NC_MSG_ERROR;
1382 goto cleanup;
1383 }
1384
1385 LY_LIST_FOR(lyd_child(hello), iter) {
1386 node = (struct lyd_node_opaq *)iter;
1387
1388 if (!node->name.module_ns || strcmp(node->name.module_ns, NC_NS_BASE)) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001389 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001390 } else if (!strcmp(node->name.name, "session-id")) {
1391 if (!node->value || !strlen(node->value)) {
Michal Vasko05532772021-06-03 12:12:38 +02001392 ERR(session, "No value of <session-id> element in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001393 rc = NC_MSG_ERROR;
1394 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001395 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001396 str = NULL;
Michal Vasko77367452021-02-16 16:32:18 +01001397 id = strtoll(node->value, &str, 10);
Michal Vaskob83a3fa2021-05-26 09:53:42 +02001398 if (*str || (id < 1) || (id > UINT32_MAX)) {
Michal Vasko05532772021-06-03 12:12:38 +02001399 ERR(session, "Invalid value of <session-id> element in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001400 rc = NC_MSG_ERROR;
1401 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001402 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001403 session->id = (uint32_t)id;
1404 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001405 } else if (strcmp(node->name.name, "capabilities")) {
Michal Vasko05532772021-06-03 12:12:38 +02001406 ERR(session, "Unexpected <%s> element in server <hello>.", node->name.name);
Michal Vasko77367452021-02-16 16:32:18 +01001407 rc = NC_MSG_ERROR;
1408 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001409 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001410
1411 if (flag) {
1412 /* multiple capabilities elements */
Michal Vasko05532772021-06-03 12:12:38 +02001413 ERR(session, "Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko77367452021-02-16 16:32:18 +01001414 rc = NC_MSG_ERROR;
1415 goto cleanup;
Michal Vasko11d142a2016-01-19 15:58:24 +01001416 }
1417 flag = 1;
1418
Michal Vasko77367452021-02-16 16:32:18 +01001419 if ((ver = parse_cpblts(&node->node, &session->opts.client.cpblts)) < 0) {
1420 rc = NC_MSG_ERROR;
1421 goto cleanup;
Michal Vasko11d142a2016-01-19 15:58:24 +01001422 }
1423 session->version = ver;
1424 }
1425
1426 if (!session->id) {
Michal Vasko05532772021-06-03 12:12:38 +02001427 ERR(session, "Missing <session-id> in server <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001428 rc = NC_MSG_ERROR;
1429 goto cleanup;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001430 }
1431 break;
Michal Vasko77367452021-02-16 16:32:18 +01001432 case 0:
Michal Vasko05532772021-06-03 12:12:38 +02001433 ERR(session, "Server <hello> timeout elapsed.");
Michal Vasko77367452021-02-16 16:32:18 +01001434 rc = NC_MSG_WOULDBLOCK;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001435 break;
1436 default:
Michal Vasko77367452021-02-16 16:32:18 +01001437 rc = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001438 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001439 }
1440
Michal Vasko77367452021-02-16 16:32:18 +01001441cleanup:
1442 ly_in_free(msg, 1);
1443 lyd_free_tree(hello);
1444 return rc;
Radek Krejci5686ff72015-10-09 13:33:56 +02001445}
1446
Michal Vasko1022f922024-05-27 11:12:02 +02001447/**
1448 * @brief Receive client hello message on the server.
1449 *
1450 * @param[in] session Server session to use.
1451 * @return Received message type.
1452 */
Michal Vasko11d142a2016-01-19 15:58:24 +01001453static NC_MSG_TYPE
Michal Vasko1022f922024-05-27 11:12:02 +02001454nc_server_recv_hello_io(struct nc_session *session)
Michal Vasko11d142a2016-01-19 15:58:24 +01001455{
Michal Vasko77367452021-02-16 16:32:18 +01001456 struct ly_in *msg;
1457 struct lyd_node *hello = NULL, *iter;
1458 struct lyd_node_opaq *node;
1459 NC_MSG_TYPE rc = NC_MSG_HELLO;
1460 int r, ver = -1, flag = 0, timeout_io;
Michal Vasko11d142a2016-01-19 15:58:24 +01001461
Michal Vaskocf898172024-01-15 15:04:28 +01001462 if (session->flags & NC_SESSION_CALLHOME) {
1463 timeout_io = NC_SERVER_CH_HELLO_TIMEOUT * 1000;
1464 } else {
Michal Vasko5c1c9b32024-02-02 09:02:42 +01001465 timeout_io = server_opts.idle_timeout ? server_opts.idle_timeout * 1000 : -1;
Michal Vaskocf898172024-01-15 15:04:28 +01001466 }
1467
Michal Vasko77367452021-02-16 16:32:18 +01001468 r = nc_read_msg_poll_io(session, timeout_io, &msg);
1469 switch (r) {
1470 case 1:
1471 /* parse <hello> data */
1472 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 +02001473 ERR(session, "Failed to parse client <hello>.");
Michal Vasko77367452021-02-16 16:32:18 +01001474 rc = NC_MSG_ERROR;
1475 goto cleanup;
1476 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001477
Michal Vasko77367452021-02-16 16:32:18 +01001478 /* learn NETCONF version */
1479 LY_LIST_FOR(lyd_child(hello), iter) {
1480 node = (struct lyd_node_opaq *)iter;
1481
1482 if (!node->name.module_ns || strcmp(node->name.module_ns, NC_NS_BASE)) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001483 continue;
Michal Vasko77367452021-02-16 16:32:18 +01001484 } else if (strcmp(node->name.name, "capabilities")) {
Michal Vasko05532772021-06-03 12:12:38 +02001485 ERR(session, "Unexpected <%s> element in client <hello>.", node->name.name);
Michal Vasko77367452021-02-16 16:32:18 +01001486 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001487 goto cleanup;
1488 }
1489
1490 if (flag) {
1491 /* multiple capabilities elements */
Michal Vasko05532772021-06-03 12:12:38 +02001492 ERR(session, "Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko77367452021-02-16 16:32:18 +01001493 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001494 goto cleanup;
1495 }
1496 flag = 1;
1497
Michal Vasko77367452021-02-16 16:32:18 +01001498 if ((ver = parse_cpblts(&node->node, NULL)) < 0) {
1499 rc = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001500 goto cleanup;
1501 }
1502 session->version = ver;
1503 }
1504 break;
Michal Vasko77367452021-02-16 16:32:18 +01001505 case 0:
Michal Vasko05532772021-06-03 12:12:38 +02001506 ERR(session, "Client <hello> timeout elapsed.");
Michal Vasko77367452021-02-16 16:32:18 +01001507 rc = NC_MSG_WOULDBLOCK;
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001508 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001509 default:
Michal Vasko77367452021-02-16 16:32:18 +01001510 rc = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001511 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001512 }
1513
1514cleanup:
Michal Vasko77367452021-02-16 16:32:18 +01001515 ly_in_free(msg, 1);
1516 lyd_free_tree(hello);
1517 return rc;
Michal Vasko11d142a2016-01-19 15:58:24 +01001518}
1519
Michal Vasko71090fc2016-05-24 16:37:28 +02001520NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001521nc_handshake_io(struct nc_session *session)
Michal Vasko80cad7f2015-12-08 14:42:27 +01001522{
Michal Vasko086311b2016-01-08 09:53:11 +01001523 NC_MSG_TYPE type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001524
Michal Vasko131120a2018-05-29 15:44:02 +02001525 type = nc_send_hello_io(session);
Michal Vasko086311b2016-01-08 09:53:11 +01001526 if (type != NC_MSG_HELLO) {
Michal Vasko71090fc2016-05-24 16:37:28 +02001527 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001528 }
1529
Michal Vasko11d142a2016-01-19 15:58:24 +01001530 if (session->side == NC_CLIENT) {
Michal Vasko1022f922024-05-27 11:12:02 +02001531 type = nc_client_recv_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001532 } else {
Michal Vasko1022f922024-05-27 11:12:02 +02001533 type = nc_server_recv_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001534 }
1535
Michal Vasko71090fc2016-05-24 16:37:28 +02001536 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001537}
roman15fbc592024-07-02 16:01:23 +02001538
1539#ifdef NC_ENABLED_SSH_TLS
1540
1541/**
1542 * @brief CURL callback for downloading data.
1543 *
1544 * @param[in] ptr Downloaded data.
1545 * @param[in] size Size of one element.
1546 * @param[in] nmemb Number of elements.
1547 * @param[in,out] userdata Storage the downloaded data.
1548 * @return Number of bytes processed.
1549 */
1550static size_t
1551nc_session_curl_cb(char *ptr, size_t size, size_t nmemb, void *userdata)
1552{
1553 struct nc_curl_data *data;
1554
1555 size = nmemb;
1556
1557 data = (struct nc_curl_data *)userdata;
1558
1559 data->data = nc_realloc(data->data, data->size + size);
1560 NC_CHECK_ERRMEM_RET(!data->data, 0);
1561
1562 memcpy(&data->data[data->size], ptr, size);
1563 data->size += size;
1564
1565 return size;
1566}
1567
1568/**
1569 * @brief Download data using CURL.
1570 *
1571 * @param[in] handle CURL handle.
1572 * @param[in] url URL to download the data from.
1573 * @return 0 on success, 1 on failure.
1574 */
1575static int
1576nc_session_curl_fetch(CURL *handle, const char *url)
1577{
1578 char err_buf[CURL_ERROR_SIZE];
1579
1580 /* set uri */
1581 if (curl_easy_setopt(handle, CURLOPT_URL, url)) {
1582 ERR(NULL, "Setting URI \"%s\" to download CRL from failed.", url);
1583 return 1;
1584 }
1585
1586 /* set err buf */
1587 if (curl_easy_setopt(handle, CURLOPT_ERRORBUFFER, err_buf)) {
1588 ERR(NULL, "Setting CURL error buffer option failed.");
1589 return 1;
1590 }
1591
1592 /* download */
1593 if (curl_easy_perform(handle)) {
1594 ERR(NULL, "Downloading CRL from \"%s\" failed (%s).", url, err_buf);
1595 return 1;
1596 }
1597
1598 return 0;
1599}
1600
1601/**
1602 * @brief Initialize CURL handle for downloading CRL.
1603 *
1604 * @param[out] handle CURL handle.
1605 * @param[out] data Stores the downloaded data.
1606 * @return 0 on success, 1 on failure.
1607 */
1608static int
1609nc_session_curl_init(CURL **handle, struct nc_curl_data *data)
1610{
1611 NC_CHECK_ARG_RET(NULL, handle, data, -1);
1612
1613 *handle = NULL;
1614
1615 *handle = curl_easy_init();
1616 if (!*handle) {
1617 ERR(NULL, "Initializing CURL failed.");
1618 return 1;
1619 }
1620
1621 if (curl_easy_setopt(*handle, CURLOPT_WRITEFUNCTION, nc_session_curl_cb)) {
1622 ERR(NULL, "Setting curl callback failed.");
1623 return 1;
1624 }
1625
1626 if (curl_easy_setopt(*handle, CURLOPT_WRITEDATA, data)) {
1627 ERR(NULL, "Setting curl callback data failed.");
1628 return 1;
1629 }
1630
1631 return 0;
1632}
1633
1634int
1635nc_session_tls_crl_from_cert_ext_fetch(void *leaf_cert, void *cert_store, void **crl_store)
1636{
1637 int ret = 0, uri_count = 0, i;
1638 CURL *handle = NULL;
1639 struct nc_curl_data downloaded = {0};
1640 char **uris = NULL;
1641 void *crl_store_aux = NULL;
1642
1643 *crl_store = NULL;
1644
1645 crl_store_aux = nc_tls_crl_store_new_wrap();
1646 if (!crl_store_aux) {
1647 goto cleanup;
1648 }
1649
1650 /* init curl */
1651 ret = nc_session_curl_init(&handle, &downloaded);
1652 if (ret) {
1653 goto cleanup;
1654 }
1655
1656 /* get all the uris we can, even though some may point to the same CRL */
1657 ret = nc_server_tls_get_crl_distpoint_uris_wrap(leaf_cert, cert_store, &uris, &uri_count);
1658 if (ret) {
1659 goto cleanup;
1660 }
1661
1662 if (!uri_count) {
1663 /* no CRL distribution points, nothing to download */
1664 goto cleanup;
1665 }
1666
1667 for (i = 0; i < uri_count; i++) {
1668 VRB(NULL, "Downloading CRL from \"%s\".", uris[i]);
1669 ret = nc_session_curl_fetch(handle, uris[i]);
1670 if (ret) {
1671 /* failed to download the CRL from this entry, try the next entry */
1672 WRN(NULL, "Failed to fetch CRL from \"%s\".", uris[i]);
1673 continue;
1674 }
1675
1676 /* convert the downloaded data to CRL and add it to the store */
1677 ret = nc_server_tls_add_crl_to_store_wrap(downloaded.data, downloaded.size, crl_store_aux);
1678
1679 /* free the downloaded data */
1680 free(downloaded.data);
1681 downloaded.data = NULL;
1682 downloaded.size = 0;
1683
1684 if (ret) {
1685 goto cleanup;
1686 }
1687 }
1688
1689 *crl_store = crl_store_aux;
1690 crl_store_aux = NULL;
1691
1692cleanup:
1693 for (i = 0; i < uri_count; i++) {
1694 free(uris[i]);
1695 }
1696 free(uris);
1697 curl_easy_cleanup(handle);
1698 nc_tls_crl_store_destroy_wrap(crl_store_aux);
1699 return ret;
1700}
1701
1702#endif