blob: 4190af1e018a5033df5519221fffcf8955bc205e [file] [log] [blame]
Radek Krejci206fcd62015-10-07 15:42:48 +02001/**
2 * \file session.c
Michal Vasko086311b2016-01-08 09:53:11 +01003 * \author Michal Vasko <mvasko@cesnet.cz>
4 * \brief libnetconf2 - general session functions
Radek Krejci206fcd62015-10-07 15:42:48 +02005 *
Michal Vaskob85767d2018-03-21 12:21:10 +01006 * Copyright (c) 2015 - 2018 CESNET, z.s.p.o.
Radek Krejci206fcd62015-10-07 15:42:48 +02007 *
Radek Krejci9b81f5b2016-02-24 13:14:49 +01008 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
Michal Vaskoafd416b2016-02-25 14:51:46 +010011 *
Radek Krejci9b81f5b2016-02-24 13:14:49 +010012 * https://opensource.org/licenses/BSD-3-Clause
Radek Krejci206fcd62015-10-07 15:42:48 +020013 */
Michal Vaskob85767d2018-03-21 12:21:10 +010014#define _DEFAULT_SOURCE
Radek Krejci206fcd62015-10-07 15:42:48 +020015
Michal Vasko18aeb5d2017-02-17 09:23:56 +010016#include <assert.h>
Radek Krejci206fcd62015-10-07 15:42:48 +020017#include <errno.h>
Radek Krejci952eb862016-01-08 14:22:55 +010018#include <stdlib.h>
Michal Vasko3512e402016-01-28 16:22:34 +010019#include <string.h>
Michal Vaskob85767d2018-03-21 12:21:10 +010020#include <unistd.h>
Radek Krejciac6d3472015-10-22 15:47:18 +020021#include <pthread.h>
Radek Krejcid6b73e12016-07-15 12:00:23 +020022#include <sys/time.h>
Michal Vaskobe52dc22018-10-17 09:28:17 +020023#include <sys/types.h>
24#include <sys/socket.h>
25#include <netinet/in.h>
26#include <netinet/tcp.h>
Michal Vasko58f31552016-01-19 12:39:15 +010027#include <time.h>
Michal Vasko156d3272017-04-11 11:46:49 +020028#include <ctype.h>
Radek Krejci206fcd62015-10-07 15:42:48 +020029#include <libyang/libyang.h>
30
Michal Vasko9e8ac262020-04-07 13:06:45 +020031#include "compat.h"
Michal Vasko5e228792016-02-03 15:30:24 +010032#include "session.h"
Michal Vaskob48aa812016-01-18 14:13:09 +010033#include "libnetconf.h"
Michal Vasko11d142a2016-01-19 15:58:24 +010034#include "session_server.h"
Michal Vaskob48aa812016-01-18 14:13:09 +010035
Radek Krejci53691be2016-02-22 13:58:37 +010036#ifdef NC_ENABLED_SSH
Radek Krejci206fcd62015-10-07 15:42:48 +020037
Michal Vasko086311b2016-01-08 09:53:11 +010038# include <libssh/libssh.h>
Radek Krejci206fcd62015-10-07 15:42:48 +020039
Radek Krejci53691be2016-02-22 13:58:37 +010040#endif /* NC_ENABLED_SSH */
Radek Krejci695d4fa2015-10-22 13:23:54 +020041
Radek Krejci53691be2016-02-22 13:58:37 +010042#if defined(NC_ENABLED_SSH) || defined(NC_ENABLED_TLS)
Michal Vaskoc14e3c82016-01-11 16:14:30 +010043
Michal Vasko5e228792016-02-03 15:30:24 +010044# include <openssl/conf.h>
Michal Vaskoc14e3c82016-01-11 16:14:30 +010045# include <openssl/err.h>
46
Radek Krejci53691be2016-02-22 13:58:37 +010047#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
Michal Vaskoc14e3c82016-01-11 16:14:30 +010048
Michal Vasko086311b2016-01-08 09:53:11 +010049/* in seconds */
50#define NC_CLIENT_HELLO_TIMEOUT 60
fanchanghu75888b62017-08-01 19:51:20 +080051#define NC_SERVER_HELLO_TIMEOUT 60
Radek Krejci695d4fa2015-10-22 13:23:54 +020052
Michal Vasko05ba9df2016-01-13 14:40:27 +010053/* in milliseconds */
54#define NC_CLOSE_REPLY_TIMEOUT 200
55
Michal Vasko086311b2016-01-08 09:53:11 +010056extern struct nc_server_opts server_opts;
57
Radek Krejci7ac16052016-07-15 11:48:18 +020058int
Michal Vasko77a6abe2017-10-05 10:02:20 +020059nc_gettimespec_mono(struct timespec *ts)
60{
61#ifdef CLOCK_MONOTONIC_RAW
62 return clock_gettime(CLOCK_MONOTONIC_RAW, ts);
63#elif defined(CLOCK_MONOTONIC)
64 return clock_gettime(CLOCK_MONOTONIC, ts);
65#else
66 /* no monotonic clock available, return realtime */
67 return nc_gettimespec_real(ts);
68#endif
69}
70
71int
72nc_gettimespec_real(struct timespec *ts)
Radek Krejci7ac16052016-07-15 11:48:18 +020073{
Michal Vasko0ef46df2016-09-21 14:03:18 +020074#ifdef CLOCK_REALTIME
Radek Krejci7ac16052016-07-15 11:48:18 +020075 return clock_gettime(CLOCK_REALTIME, ts);
76#else
77 int rc;
78 struct timeval tv;
79
80 rc = gettimeofday(&tv, NULL);
81 if (!rc) {
82 ts->tv_sec = (time_t)tv.tv_sec;
83 ts->tv_nsec = 1000L * (long)tv.tv_usec;
84 }
85 return rc;
86#endif
87}
88
Michal Vasko36c7be82017-02-22 13:37:59 +010089/* ts1 < ts2 -> +, ts1 > ts2 -> -, returns milliseconds */
90int32_t
Radek Krejcida0afb22017-05-26 16:25:59 +020091nc_difftimespec(const struct timespec *ts1, const struct timespec *ts2)
Michal Vasko99f251b2017-01-11 11:31:46 +010092{
Michal Vasko36c7be82017-02-22 13:37:59 +010093 int64_t nsec_diff = 0;
Michal Vasko99f251b2017-01-11 11:31:46 +010094
Michal Vaskoa82bd202017-03-03 14:07:29 +010095 nsec_diff += (((int64_t)ts2->tv_sec) - ((int64_t)ts1->tv_sec)) * 1000000000L;
96 nsec_diff += ((int64_t)ts2->tv_nsec) - ((int64_t)ts1->tv_nsec);
Michal Vasko99f251b2017-01-11 11:31:46 +010097
98 return (nsec_diff ? nsec_diff / 1000000L : 0);
99}
100
Michal Vasko36c7be82017-02-22 13:37:59 +0100101void
102nc_addtimespec(struct timespec *ts, uint32_t msec)
103{
Michal Vasko81c5b302017-03-15 12:10:40 +0100104 assert((ts->tv_nsec >= 0) && (ts->tv_nsec < 1000000000L));
105
Michal Vasko0dfcd332017-03-03 13:14:39 +0100106 ts->tv_sec += msec / 1000;
107 ts->tv_nsec += (msec % 1000) * 1000000L;
Michal Vasko36c7be82017-02-22 13:37:59 +0100108
Michal Vasko81c5b302017-03-15 12:10:40 +0100109 if (ts->tv_nsec >= 1000000000L) {
110 ++ts->tv_sec;
111 ts->tv_nsec -= 1000000000L;
112 } else if (ts->tv_nsec < 0) {
113 --ts->tv_sec;
114 ts->tv_nsec += 1000000000L;
Michal Vasko36c7be82017-02-22 13:37:59 +0100115 }
Michal Vasko81c5b302017-03-15 12:10:40 +0100116
117 assert((ts->tv_nsec >= 0) && (ts->tv_nsec < 1000000000L));
Michal Vasko36c7be82017-02-22 13:37:59 +0100118}
119
Michal Vaskoddce1212019-05-24 09:58:49 +0200120const char *
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200121nc_keytype2str(NC_SSH_KEY_TYPE type)
Michal Vaskoddce1212019-05-24 09:58:49 +0200122{
123 switch (type) {
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200124 case NC_SSH_KEY_DSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200125 return "DSA";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200126 case NC_SSH_KEY_RSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200127 return "RSA";
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200128 case NC_SSH_KEY_ECDSA:
Michal Vaskoddce1212019-05-24 09:58:49 +0200129 return "EC";
130 default:
131 break;
132 }
133
134 return NULL;
135}
136
Michal Vaskobe52dc22018-10-17 09:28:17 +0200137int
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200138nc_sock_enable_keepalive(int sock, struct nc_keepalives *ka)
Michal Vaskobe52dc22018-10-17 09:28:17 +0200139{
140 int opt;
141
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200142 opt = ka->enabled;
Michal Vaskobe52dc22018-10-17 09:28:17 +0200143 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &opt, sizeof opt) == -1) {
144 ERR("Could not set SO_KEEPALIVE option (%s).", strerror(errno));
145 return -1;
146 }
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200147 if (!ka->enabled) {
148 return 0;
149 }
Michal Vaskobe52dc22018-10-17 09:28:17 +0200150
151#ifdef TCP_KEEPIDLE
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200152 opt = ka->idle_time;
Michal Vaskobe52dc22018-10-17 09:28:17 +0200153 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPIDLE, &opt, sizeof opt) == -1) {
154 ERR("Setsockopt failed (%s).", strerror(errno));
155 return -1;
156 }
157#endif
158
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200159#ifdef TCP_KEEPCNT
160 opt = ka->max_probes;
161 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPCNT, &opt, sizeof opt) == -1) {
Michal Vaskobe52dc22018-10-17 09:28:17 +0200162 ERR("Setsockopt failed (%s).", strerror(errno));
163 return -1;
164 }
165#endif
166
Michal Vaskoe49a15f2019-05-27 14:18:36 +0200167#ifdef TCP_KEEPINTVL
168 opt = ka->probe_interval;
169 if (setsockopt(sock, IPPROTO_TCP, TCP_KEEPINTVL, &opt, sizeof opt) == -1) {
Michal Vaskobe52dc22018-10-17 09:28:17 +0200170 ERR("Setsockopt failed (%s).", strerror(errno));
171 return -1;
172 }
173#endif
174
175 return 0;
176}
177
Radek Krejci28472922016-07-15 11:51:16 +0200178#ifndef HAVE_PTHREAD_MUTEX_TIMEDLOCK
179int
180pthread_mutex_timedlock(pthread_mutex_t *mutex, const struct timespec *abstime)
181{
Michal Vasko81c5b302017-03-15 12:10:40 +0100182 int32_t diff;
Radek Krejci28472922016-07-15 11:51:16 +0200183 int rc;
184 struct timespec cur, dur;
185
186 /* Try to acquire the lock and, if we fail, sleep for 5ms. */
187 while ((rc = pthread_mutex_trylock(mutex)) == EBUSY) {
Michal Vasko145619f2018-02-16 10:08:45 +0100188 nc_gettimespec_real(&cur);
Radek Krejci28472922016-07-15 11:51:16 +0200189
Michal Vasko81c5b302017-03-15 12:10:40 +0100190 if ((diff = nc_difftimespec(&cur, abstime)) < 1) {
191 /* timeout */
Radek Krejci28472922016-07-15 11:51:16 +0200192 break;
Michal Vasko81c5b302017-03-15 12:10:40 +0100193 } else if (diff < 5) {
194 /* sleep until timeout */
Michal Vaskobf378cb2018-09-21 15:18:52 +0200195 dur.tv_sec = 0;
196 dur.tv_nsec = (long)diff * 1000000;
Michal Vasko81c5b302017-03-15 12:10:40 +0100197 } else {
198 /* sleep 5 ms */
Radek Krejci28472922016-07-15 11:51:16 +0200199 dur.tv_sec = 0;
200 dur.tv_nsec = 5000000;
201 }
202
203 nanosleep(&dur, NULL);
204 }
205
206 return rc;
207}
208#endif
209
Michal Vaskoade892d2017-02-22 13:40:35 +0100210struct nc_session *
Michal Vasko131120a2018-05-29 15:44:02 +0200211nc_new_session(NC_SIDE side, int shared_ti)
Michal Vaskoade892d2017-02-22 13:40:35 +0100212{
213 struct nc_session *sess;
214
215 sess = calloc(1, sizeof *sess);
216 if (!sess) {
217 return NULL;
218 }
219
Michal Vasko131120a2018-05-29 15:44:02 +0200220 sess->side = side;
221
222 if (side == NC_SERVER) {
223 sess->opts.server.rpc_lock = malloc(sizeof *sess->opts.server.rpc_lock);
224 sess->opts.server.rpc_cond = malloc(sizeof *sess->opts.server.rpc_cond);
225 sess->opts.server.rpc_inuse = malloc(sizeof *sess->opts.server.rpc_inuse);
226 if (!sess->opts.server.rpc_lock || !sess->opts.server.rpc_cond || !sess->opts.server.rpc_inuse) {
227 goto error;
Michal Vaskoade892d2017-02-22 13:40:35 +0100228 }
Michal Vasko131120a2018-05-29 15:44:02 +0200229 pthread_mutex_init(sess->opts.server.rpc_lock, NULL);
230 pthread_cond_init(sess->opts.server.rpc_cond, NULL);
231 *sess->opts.server.rpc_inuse = 0;
232 }
233
234 if (!shared_ti) {
235 sess->io_lock = malloc(sizeof *sess->io_lock);
236 if (!sess->io_lock) {
237 goto error;
238 }
239 pthread_mutex_init(sess->io_lock, NULL);
Michal Vaskoade892d2017-02-22 13:40:35 +0100240 }
241
242 return sess;
Michal Vasko131120a2018-05-29 15:44:02 +0200243
244error:
245 if (side == NC_SERVER) {
246 free(sess->opts.server.rpc_lock);
247 free(sess->opts.server.rpc_cond);
248 free((int *)sess->opts.server.rpc_inuse);
249 }
250 free(sess);
251 return NULL;
Michal Vaskoade892d2017-02-22 13:40:35 +0100252}
253
Michal Vasko96164bf2016-01-21 15:41:58 +0100254/*
255 * @return 1 - success
256 * 0 - timeout
257 * -1 - error
258 */
259int
Michal Vasko131120a2018-05-29 15:44:02 +0200260nc_session_rpc_lock(struct nc_session *session, int timeout, const char *func)
Michal Vasko96164bf2016-01-21 15:41:58 +0100261{
262 int ret;
Michal Vasko62be1ce2016-03-03 13:24:52 +0100263 struct timespec ts_timeout;
Michal Vasko96164bf2016-01-21 15:41:58 +0100264
Michal Vasko131120a2018-05-29 15:44:02 +0200265 if (session->side != NC_SERVER) {
266 ERRINT;
267 return -1;
268 }
269
Michal Vasko96164bf2016-01-21 15:41:58 +0100270 if (timeout > 0) {
Michal Vasko77a6abe2017-10-05 10:02:20 +0200271 nc_gettimespec_real(&ts_timeout);
Michal Vasko81c5b302017-03-15 12:10:40 +0100272 nc_addtimespec(&ts_timeout, timeout);
Michal Vasko96164bf2016-01-21 15:41:58 +0100273
Michal Vaskoade892d2017-02-22 13:40:35 +0100274 /* LOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200275 ret = pthread_mutex_timedlock(session->opts.server.rpc_lock, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100276 if (!ret) {
Michal Vasko131120a2018-05-29 15:44:02 +0200277 while (*session->opts.server.rpc_inuse) {
278 ret = pthread_cond_timedwait(session->opts.server.rpc_cond, session->opts.server.rpc_lock, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100279 if (ret) {
Michal Vasko131120a2018-05-29 15:44:02 +0200280 pthread_mutex_unlock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100281 break;
282 }
283 }
284 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100285 } else if (!timeout) {
Michal Vasko131120a2018-05-29 15:44:02 +0200286 if (*session->opts.server.rpc_inuse) {
Michal Vaskoade892d2017-02-22 13:40:35 +0100287 /* immediate timeout */
288 return 0;
289 }
290
291 /* LOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200292 ret = pthread_mutex_trylock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100293 if (!ret) {
294 /* be extra careful, someone could have been faster */
Michal Vasko131120a2018-05-29 15:44:02 +0200295 if (*session->opts.server.rpc_inuse) {
296 pthread_mutex_unlock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100297 return 0;
298 }
Michal vasko2f8e4b52016-10-05 13:04:11 +0200299 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100300 } else { /* timeout == -1 */
Michal Vaskoade892d2017-02-22 13:40:35 +0100301 /* LOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200302 ret = pthread_mutex_lock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100303 if (!ret) {
Michal Vasko131120a2018-05-29 15:44:02 +0200304 while (*session->opts.server.rpc_inuse) {
305 ret = pthread_cond_wait(session->opts.server.rpc_cond, session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100306 if (ret) {
Michal Vasko131120a2018-05-29 15:44:02 +0200307 pthread_mutex_unlock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100308 break;
309 }
310 }
311 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100312 }
313
Michal Vaskoade892d2017-02-22 13:40:35 +0100314 if (ret) {
315 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
316 /* timeout */
317 return 0;
318 }
319
Michal Vasko96164bf2016-01-21 15:41:58 +0100320 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200321 ERR("%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vasko96164bf2016-01-21 15:41:58 +0100322 return -1;
323 }
324
325 /* ok */
Michal Vasko131120a2018-05-29 15:44:02 +0200326 assert(*session->opts.server.rpc_inuse == 0);
327 *session->opts.server.rpc_inuse = 1;
Michal Vaskoade892d2017-02-22 13:40:35 +0100328
329 /* UNLOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200330 ret = pthread_mutex_unlock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100331 if (ret) {
332 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200333 ERR("%s: faile to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100334 return -1;
335 }
336
337 return 1;
338}
339
340int
Michal Vasko131120a2018-05-29 15:44:02 +0200341nc_session_rpc_unlock(struct nc_session *session, int timeout, const char *func)
Michal Vaskoade892d2017-02-22 13:40:35 +0100342{
343 int ret;
344 struct timespec ts_timeout;
345
Michal Vasko131120a2018-05-29 15:44:02 +0200346 if (session->side != NC_SERVER) {
347 ERRINT;
348 return -1;
349 }
350
351 assert(*session->opts.server.rpc_inuse);
Michal Vaskoade892d2017-02-22 13:40:35 +0100352
353 if (timeout > 0) {
Michal Vasko77a6abe2017-10-05 10:02:20 +0200354 nc_gettimespec_real(&ts_timeout);
Michal Vasko81c5b302017-03-15 12:10:40 +0100355 nc_addtimespec(&ts_timeout, timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100356
357 /* LOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200358 ret = pthread_mutex_timedlock(session->opts.server.rpc_lock, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100359 } else if (!timeout) {
360 /* LOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200361 ret = pthread_mutex_trylock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100362 } else { /* timeout == -1 */
363 /* LOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200364 ret = pthread_mutex_lock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100365 }
366
367 if (ret && (ret != EBUSY) && (ret != ETIMEDOUT)) {
368 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200369 ERR("%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100370 return -1;
371 } else if (ret) {
Michal Vasko131120a2018-05-29 15:44:02 +0200372 WRN("%s: session RPC lock timeout, should not happen.");
Michal Vaskoade892d2017-02-22 13:40:35 +0100373 }
374
Michal Vasko131120a2018-05-29 15:44:02 +0200375 *session->opts.server.rpc_inuse = 0;
376 pthread_cond_signal(session->opts.server.rpc_cond);
Michal Vaskoade892d2017-02-22 13:40:35 +0100377
378 if (!ret) {
379 /* UNLOCK */
Michal Vasko131120a2018-05-29 15:44:02 +0200380 ret = pthread_mutex_unlock(session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100381 if (ret) {
382 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200383 ERR("%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100384 return -1;
385 }
386 }
387
Michal Vasko96164bf2016-01-21 15:41:58 +0100388 return 1;
389}
390
Michal Vasko131120a2018-05-29 15:44:02 +0200391/*
392 * @return 1 - success
393 * 0 - timeout
394 * -1 - error
395 */
396int
397nc_session_io_lock(struct nc_session *session, int timeout, const char *func)
398{
399 int ret;
400 struct timespec ts_timeout;
401
402 if (timeout > 0) {
403 nc_gettimespec_real(&ts_timeout);
404 nc_addtimespec(&ts_timeout, timeout);
405
406 ret = pthread_mutex_timedlock(session->io_lock, &ts_timeout);
407 } else if (!timeout) {
408 ret = pthread_mutex_trylock(session->io_lock);
409 } else { /* timeout == -1 */
Robin Jarry54ea2962018-10-10 10:33:40 +0200410 ret = pthread_mutex_lock(session->io_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200411 }
412
413 if (ret) {
414 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
415 /* timeout */
416 return 0;
417 }
418
419 /* error */
420 ERR("%s: failed to IO lock a session (%s).", func, strerror(ret));
421 return -1;
422 }
423
424 return 1;
425}
426
427int
428nc_session_io_unlock(struct nc_session *session, const char *func)
429{
430 int ret;
431
432 ret = pthread_mutex_unlock(session->io_lock);
433 if (ret) {
434 /* error */
435 ERR("%s: failed to IO unlock a session (%s).", func, strerror(ret));
436 return -1;
437 }
438
439 return 1;
440}
441
Michal Vasko8dadf782016-01-15 10:29:36 +0100442API NC_STATUS
443nc_session_get_status(const struct nc_session *session)
444{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100445 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200446 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200447 return NC_STATUS_ERR;
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100448 }
449
Michal Vasko8dadf782016-01-15 10:29:36 +0100450 return session->status;
451}
452
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100453API NC_SESSION_TERM_REASON
Michal Vasko142cfea2017-08-07 10:12:11 +0200454nc_session_get_term_reason(const struct nc_session *session)
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100455{
456 if (!session) {
457 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200458 return NC_SESSION_TERM_ERR;
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100459 }
460
461 return session->term_reason;
462}
463
Michal Vasko8dadf782016-01-15 10:29:36 +0100464API uint32_t
Michal Vasko142cfea2017-08-07 10:12:11 +0200465nc_session_get_killed_by(const struct nc_session *session)
466{
467 if (!session) {
468 ERRARG("session");
469 return 0;
470 }
471
472 return session->killed_by;
473}
474
475API uint32_t
Michal Vasko8dadf782016-01-15 10:29:36 +0100476nc_session_get_id(const struct nc_session *session)
477{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100478 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200479 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100480 return 0;
481 }
482
Michal Vasko8dadf782016-01-15 10:29:36 +0100483 return session->id;
484}
485
Michal Vasko174fe8e2016-02-17 15:38:09 +0100486API int
487nc_session_get_version(const struct nc_session *session)
488{
489 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200490 ERRARG("session");
Michal Vasko174fe8e2016-02-17 15:38:09 +0100491 return -1;
492 }
493
494 return (session->version == NC_VERSION_10 ? 0 : 1);
495}
496
Michal Vasko8dadf782016-01-15 10:29:36 +0100497API NC_TRANSPORT_IMPL
498nc_session_get_ti(const struct nc_session *session)
499{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100500 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200501 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100502 return 0;
503 }
504
Michal Vasko8dadf782016-01-15 10:29:36 +0100505 return session->ti_type;
506}
507
508API const char *
509nc_session_get_username(const struct nc_session *session)
510{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100511 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200512 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100513 return NULL;
514 }
515
Michal Vasko8dadf782016-01-15 10:29:36 +0100516 return session->username;
517}
518
519API const char *
520nc_session_get_host(const struct nc_session *session)
521{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100522 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200523 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100524 return NULL;
525 }
526
Michal Vasko8dadf782016-01-15 10:29:36 +0100527 return session->host;
528}
529
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200530API const char *
531nc_session_get_path(const struct nc_session *session)
532{
533 if (!session) {
534 ERRARG("session");
535 return NULL;
536 }
537 if (session->ti_type != NC_TI_UNIX)
538 return NULL;
539
540 return session->path;
541}
542
Michal Vasko8dadf782016-01-15 10:29:36 +0100543API uint16_t
544nc_session_get_port(const struct nc_session *session)
545{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100546 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200547 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100548 return 0;
549 }
550
Michal Vasko8dadf782016-01-15 10:29:36 +0100551 return session->port;
552}
553
Michal Vasko9a25e932016-02-01 10:36:42 +0100554API struct ly_ctx *
555nc_session_get_ctx(const struct nc_session *session)
556{
557 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200558 ERRARG("session");
Michal Vasko9a25e932016-02-01 10:36:42 +0100559 return NULL;
560 }
561
562 return session->ctx;
563}
564
Michal Vasko2cc4c682016-03-01 09:16:48 +0100565API void
566nc_session_set_data(struct nc_session *session, void *data)
567{
568 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200569 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100570 return;
571 }
572
573 session->data = data;
574}
575
576API void *
577nc_session_get_data(const struct nc_session *session)
578{
579 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200580 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100581 return NULL;
582 }
583
584 return session->data;
585}
586
Michal Vasko086311b2016-01-08 09:53:11 +0100587NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +0200588nc_send_msg_io(struct nc_session *session, int io_timeout, struct lyd_node *op)
Radek Krejci695d4fa2015-10-22 13:23:54 +0200589{
Michal Vasko086311b2016-01-08 09:53:11 +0100590 if (session->ctx != op->schema->module->ctx) {
Michal Vaskod083db62016-01-19 10:31:29 +0100591 ERR("Session %u: RPC \"%s\" was created in different context than that of the session.",
592 session->id, op->schema->name);
Michal Vasko086311b2016-01-08 09:53:11 +0100593 return NC_MSG_ERROR;
Michal Vasko7df39ec2015-12-09 15:26:24 +0100594 }
595
Michal Vasko131120a2018-05-29 15:44:02 +0200596 return nc_write_msg_io(session, io_timeout, NC_MSG_RPC, op, NULL);
Michal Vasko7df39ec2015-12-09 15:26:24 +0100597}
598
Radek Krejci695d4fa2015-10-22 13:23:54 +0200599API void
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100600nc_session_free(struct nc_session *session, void (*data_free)(void *))
Radek Krejci695d4fa2015-10-22 13:23:54 +0200601{
Michal Vasko131120a2018-05-29 15:44:02 +0200602 int r, i, rpc_locked = 0, sock = -1;
Michal Vasko428087d2016-01-14 16:04:28 +0100603 int connected; /* flag to indicate whether the transport socket is still connected */
Michal Vaskob48aa812016-01-18 14:13:09 +0100604 int multisession = 0; /* flag for more NETCONF sessions on a single SSH session */
Michal Vasko4589bbe2016-01-29 09:41:30 +0100605 struct nc_session *siter;
Michal Vaskoad611702015-12-03 13:41:51 +0100606 struct nc_msg_cont *contiter;
Michal Vaskoadd4c792015-10-26 15:36:58 +0100607 struct lyxml_elem *rpl, *child;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200608 struct lyd_node *close_rpc;
Michal Vaskoad611702015-12-03 13:41:51 +0100609 const struct lys_module *ietfnc;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200610 void *p;
611
Michal Vasko428087d2016-01-14 16:04:28 +0100612 if (!session || (session->status == NC_STATUS_CLOSING)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200613 return;
614 }
615
Michal Vasko86d357c2016-03-11 13:46:38 +0100616 /* stop notifications loop if any */
Michal Vasko7f1fa3c2020-09-08 16:30:41 +0200617 if ((session->side == NC_CLIENT) && ATOMIC_LOAD(session->opts.client.ntf_tid)) {
Michal Vaskob639e9c2020-09-09 09:51:48 +0200618 ATOMIC_STORE(session->opts.client.ntf_tid, (uintptr_t)NULL);
Michal Vasko86d357c2016-03-11 13:46:38 +0100619 /* the thread now knows it should quit */
Michal Vasko86d357c2016-03-11 13:46:38 +0100620 }
621
Michal Vasko131120a2018-05-29 15:44:02 +0200622 if ((session->side == NC_SERVER) && session->opts.server.rpc_lock) {
623 r = nc_session_rpc_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100624 if (r == -1) {
Michal Vaskoadd4c792015-10-26 15:36:58 +0100625 return;
Michal Vasko131120a2018-05-29 15:44:02 +0200626 } else if (r) {
627 rpc_locked = 1;
628 } /* else failed to lock it, too bad */
Radek Krejci695d4fa2015-10-22 13:23:54 +0200629 }
630
Michal Vasko8c247822020-09-07 13:23:23 +0200631 if (session->side == NC_CLIENT) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200632 /* cleanup message queues */
633 /* notifications */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200634 for (contiter = session->opts.client.notifs; contiter; ) {
Michal Vaskoad611702015-12-03 13:41:51 +0100635 lyxml_free(session->ctx, contiter->msg);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200636
Michal Vaskoad611702015-12-03 13:41:51 +0100637 p = contiter;
638 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200639 free(p);
640 }
641
642 /* rpc replies */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200643 for (contiter = session->opts.client.replies; contiter; ) {
Michal Vaskoad611702015-12-03 13:41:51 +0100644 lyxml_free(session->ctx, contiter->msg);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200645
Michal Vaskoad611702015-12-03 13:41:51 +0100646 p = contiter;
647 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200648 free(p);
649 }
650
Michal Vasko8c247822020-09-07 13:23:23 +0200651 if (session->status == NC_STATUS_RUNNING) {
652 /* send closing info to the other side */
653 ietfnc = ly_ctx_get_module(session->ctx, "ietf-netconf", NULL, 1);
654 if (!ietfnc) {
655 WRN("Session %u: missing ietf-netconf schema in context, unable to send <close-session>.", session->id);
656 } else {
657 close_rpc = lyd_new(NULL, ietfnc, "close-session");
658 nc_send_msg_io(session, NC_SESSION_FREE_LOCK_TIMEOUT, close_rpc);
659 lyd_free(close_rpc);
660 switch (nc_read_msg_poll_io(session, NC_CLOSE_REPLY_TIMEOUT, &rpl)) {
661 case NC_MSG_REPLY:
662 LY_TREE_FOR(rpl->child, child) {
663 if (!strcmp(child->name, "ok") && child->ns && !strcmp(child->ns->value, NC_NS_BASE)) {
664 break;
665 }
Michal Vaskofad6e912015-10-26 15:37:22 +0100666 }
Michal Vasko8c247822020-09-07 13:23:23 +0200667 if (!child) {
668 WRN("Session %u: the reply to <close-session> was not <ok> as expected.", session->id);
669 }
670 lyxml_free(session->ctx, rpl);
671 break;
672 case NC_MSG_WOULDBLOCK:
673 WRN("Session %u: timeout for receiving a reply to <close-session> elapsed.", session->id);
674 break;
675 case NC_MSG_ERROR:
676 ERR("Session %u: failed to receive a reply to <close-session>.", session->id);
677 break;
678 default:
679 /* cannot happen */
680 break;
Michal Vaskofad6e912015-10-26 15:37:22 +0100681 }
Michal Vaskofad6e912015-10-26 15:37:22 +0100682 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200683 }
684
685 /* list of server's capabilities */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200686 if (session->opts.client.cpblts) {
687 for (i = 0; session->opts.client.cpblts[i]; i++) {
Michal Vasko96fc4bb2017-05-23 14:58:34 +0200688 free(session->opts.client.cpblts[i]);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200689 }
Michal Vasko2e6defd2016-10-07 15:48:15 +0200690 free(session->opts.client.cpblts);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200691 }
692 }
693
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100694 if (session->data && data_free) {
695 data_free(session->data);
696 }
697
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200698 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
699 /* CH LOCK */
700 pthread_mutex_lock(session->opts.server.ch_lock);
701 }
702
Michal Vasko86d357c2016-03-11 13:46:38 +0100703 /* mark session for closing */
Radek Krejci695d4fa2015-10-22 13:23:54 +0200704 session->status = NC_STATUS_CLOSING;
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200705
706 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
707 pthread_cond_signal(session->opts.server.ch_cond);
708
709 /* CH UNLOCK */
710 pthread_mutex_unlock(session->opts.server.ch_lock);
Michal Vasko3f05a092018-03-13 10:39:49 +0100711
712 /* wait for CH thread to actually wake up */
713 i = (NC_SESSION_FREE_LOCK_TIMEOUT * 1000) / NC_TIMEOUT_STEP;
714 while (i && (session->flags & NC_SESSION_CALLHOME)) {
715 usleep(NC_TIMEOUT_STEP);
716 --i;
717 }
718 if (session->flags & NC_SESSION_CALLHOME) {
719 ERR("Session %u: Call Home thread failed to wake up in a timely manner, fatal synchronization problem.", session->id);
720 }
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200721 }
722
Michal Vasko428087d2016-01-14 16:04:28 +0100723 connected = nc_session_is_connected(session);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200724
725 /* transport implementation cleanup */
726 switch (session->ti_type) {
727 case NC_TI_FD:
728 /* nothing needed - file descriptors were provided by caller,
729 * so it is up to the caller to close them correctly
730 * TODO use callbacks
731 */
Michal Vasko3512e402016-01-28 16:22:34 +0100732 /* just to avoid compiler warning */
733 (void)connected;
Michal Vasko4589bbe2016-01-29 09:41:30 +0100734 (void)siter;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200735 break;
736
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200737 case NC_TI_UNIX:
738 sock = session->ti.unixsock.sock;
739 (void)connected;
740 (void)siter;
741 break;
742
Radek Krejci53691be2016-02-22 13:58:37 +0100743#ifdef NC_ENABLED_SSH
Radek Krejci695d4fa2015-10-22 13:23:54 +0200744 case NC_TI_LIBSSH:
Michal Vasko428087d2016-01-14 16:04:28 +0100745 if (connected) {
746 ssh_channel_free(session->ti.libssh.channel);
747 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200748 /* There can be multiple NETCONF sessions on the same SSH session (NETCONF session maps to
749 * SSH channel). So destroy the SSH session only if there is no other NETCONF session using
Michal Vaskoe50b6b12018-10-11 10:27:50 +0200750 * it. Also, avoid concurrent free by multiple threads of sessions that share the SSH session.
Radek Krejci695d4fa2015-10-22 13:23:54 +0200751 */
Michal Vaskoe50b6b12018-10-11 10:27:50 +0200752 /* SESSION IO LOCK */
753 r = nc_session_io_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
754
Michal Vasko96164bf2016-01-21 15:41:58 +0100755 multisession = 0;
756 if (session->ti.libssh.next) {
757 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
758 if (siter->status != NC_STATUS_STARTING) {
759 multisession = 1;
760 break;
761 }
762 }
763 }
764
765 if (!multisession) {
766 /* it's not multisession yet, but we still need to free the starting sessions */
767 if (session->ti.libssh.next) {
768 do {
769 siter = session->ti.libssh.next;
770 session->ti.libssh.next = siter->ti.libssh.next;
771
772 /* free starting SSH NETCONF session (channel will be freed in ssh_free()) */
Michal Vasko96164bf2016-01-21 15:41:58 +0100773 lydict_remove(session->ctx, session->username);
774 lydict_remove(session->ctx, session->host);
Michal Vasko96164bf2016-01-21 15:41:58 +0100775 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Radek Krejci4ba285b2016-02-04 17:34:06 +0100776 ly_ctx_destroy(session->ctx, NULL);
Michal Vasko96164bf2016-01-21 15:41:58 +0100777 }
778
779 free(siter);
780 } while (session->ti.libssh.next != session);
781 }
Michal Vasko4d57e1b2018-03-21 12:21:25 +0100782 /* remember sock so we can close it */
783 sock = ssh_get_fd(session->ti.libssh.session);
Michal Vasko428087d2016-01-14 16:04:28 +0100784 if (connected) {
785 ssh_disconnect(session->ti.libssh.session);
Michal Vasko06e0fc22019-05-09 09:32:27 +0200786 sock = -1;
Michal Vasko428087d2016-01-14 16:04:28 +0100787 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200788 ssh_free(session->ti.libssh.session);
789 } else {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200790 /* remove the session from the list */
791 for (siter = session->ti.libssh.next; siter->ti.libssh.next != session; siter = siter->ti.libssh.next);
Michal Vaskoaec4f212015-10-26 15:37:45 +0100792 if (session->ti.libssh.next == siter) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200793 /* there will be only one session */
794 siter->ti.libssh.next = NULL;
795 } else {
796 /* there are still multiple sessions, keep the ring list */
797 siter->ti.libssh.next = session->ti.libssh.next;
798 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100799 /* change nc_sshcb_msg() argument, we need a RUNNING session and this one will be freed */
800 if (session->flags & NC_SESSION_SSH_MSG_CB) {
Michal Vasko5e0edd82020-07-29 15:26:13 +0200801 siter = session->ti.libssh.next;
802 while (siter && siter->status != NC_STATUS_RUNNING) {
Michal Vasko96164bf2016-01-21 15:41:58 +0100803 if (siter->ti.libssh.next == session) {
804 ERRINT;
805 break;
806 }
Michal Vasko5e0edd82020-07-29 15:26:13 +0200807 siter = siter->ti.libssh.next;
Michal Vasko96164bf2016-01-21 15:41:58 +0100808 }
Michal Vasko5e0edd82020-07-29 15:26:13 +0200809 /* siter may be NULL in case all the sessions terminated at the same time (socket was disconnected),
810 * we set session to NULL because we do not expect any new message to arrive */
Michal Vasko96164bf2016-01-21 15:41:58 +0100811 ssh_set_message_callback(session->ti.libssh.session, nc_sshcb_msg, siter);
Michal Vasko5e0edd82020-07-29 15:26:13 +0200812 if (siter) {
813 siter->flags |= NC_SESSION_SSH_MSG_CB;
814 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100815 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200816 }
Michal Vaskoe50b6b12018-10-11 10:27:50 +0200817
818 /* SESSION IO UNLOCK */
819 if (r == 1) {
820 nc_session_io_unlock(session, __func__);
821 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200822 break;
823#endif
824
Radek Krejci53691be2016-02-22 13:58:37 +0100825#ifdef NC_ENABLED_TLS
Radek Krejci695d4fa2015-10-22 13:23:54 +0200826 case NC_TI_OPENSSL:
Michal Vasko4d57e1b2018-03-21 12:21:25 +0100827 /* remember sock so we can close it */
828 sock = SSL_get_fd(session->ti.tls);
829
Michal Vasko428087d2016-01-14 16:04:28 +0100830 if (connected) {
831 SSL_shutdown(session->ti.tls);
832 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200833 SSL_free(session->ti.tls);
Michal Vasko06e22432016-01-15 10:30:06 +0100834
Michal Vasko2e6defd2016-10-07 15:48:15 +0200835 if (session->side == NC_SERVER) {
836 X509_free(session->opts.server.client_cert);
837 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200838 break;
839#endif
Michal Vasko428087d2016-01-14 16:04:28 +0100840 case NC_TI_NONE:
Michal Vasko428087d2016-01-14 16:04:28 +0100841 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200842 }
Michal Vasko428087d2016-01-14 16:04:28 +0100843
Michal Vasko4d57e1b2018-03-21 12:21:25 +0100844 /* close socket separately */
845 if (sock > -1) {
846 close(sock);
847 }
848
Radek Krejciac6d3472015-10-22 15:47:18 +0200849 lydict_remove(session->ctx, session->username);
850 lydict_remove(session->ctx, session->host);
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200851 lydict_remove(session->ctx, session->path);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200852
853 /* final cleanup */
Michal Vasko131120a2018-05-29 15:44:02 +0200854 if ((session->side == NC_SERVER) && session->opts.server.rpc_lock) {
855 if (rpc_locked) {
856 nc_session_rpc_unlock(session, NC_SESSION_LOCK_TIMEOUT, __func__);
Michal Vasko9e99f012016-03-03 13:25:20 +0100857 }
Michal Vasko131120a2018-05-29 15:44:02 +0200858 pthread_mutex_destroy(session->opts.server.rpc_lock);
859 pthread_cond_destroy(session->opts.server.rpc_cond);
860 free(session->opts.server.rpc_lock);
861 free(session->opts.server.rpc_cond);
862 free((int *)session->opts.server.rpc_inuse);
863 }
864
865 if (session->io_lock && !multisession) {
866 pthread_mutex_destroy(session->io_lock);
867 free(session->io_lock);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200868 }
869
870 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Radek Krejci4ba285b2016-02-04 17:34:06 +0100871 ly_ctx_destroy(session->ctx, NULL);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200872 }
873
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200874 if (session->side == NC_SERVER) {
Michal Vasko3f05a092018-03-13 10:39:49 +0100875 /* free CH synchronization structures if used */
876 if (session->opts.server.ch_cond) {
877 pthread_cond_destroy(session->opts.server.ch_cond);
878 free(session->opts.server.ch_cond);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200879 }
Michal Vasko3f05a092018-03-13 10:39:49 +0100880 if (session->opts.server.ch_lock) {
881 pthread_mutex_destroy(session->opts.server.ch_lock);
882 free(session->opts.server.ch_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200883 }
884 }
885
Radek Krejci695d4fa2015-10-22 13:23:54 +0200886 free(session);
887}
888
Michal Vasko086311b2016-01-08 09:53:11 +0100889static void
890add_cpblt(struct ly_ctx *ctx, const char *capab, const char ***cpblts, int *size, int *count)
891{
Radek Krejci658782b2016-12-04 22:04:55 +0100892 size_t len;
893 int i;
894 char *p;
895
896 if (capab) {
897 /* check if already present */
898 p = strchr(capab, '?');
899 if (p) {
900 len = p - capab;
901 } else {
902 len = strlen(capab);
903 }
904 for (i = 0; i < *count; i++) {
fanchanghu5244bf42017-03-13 16:27:48 +0800905 if (!strncmp((*cpblts)[i], capab, len) && ((*cpblts)[i][len] == '\0' || (*cpblts)[i][len] == '?')) {
Radek Krejci658782b2016-12-04 22:04:55 +0100906 /* already present, do not duplicate it */
907 return;
908 }
909 }
910 }
911
912 /* add another capability */
Michal Vasko086311b2016-01-08 09:53:11 +0100913 if (*count == *size) {
914 *size += 5;
Michal Vasko4eb3c312016-03-01 14:09:37 +0100915 *cpblts = nc_realloc(*cpblts, *size * sizeof **cpblts);
916 if (!(*cpblts)) {
917 ERRMEM;
918 return;
919 }
Michal Vasko086311b2016-01-08 09:53:11 +0100920 }
921
922 if (capab) {
923 (*cpblts)[*count] = lydict_insert(ctx, capab, 0);
924 } else {
925 (*cpblts)[*count] = NULL;
926 }
927 ++(*count);
928}
929
Michal Vaskodafdc742020-03-11 16:15:59 +0100930static struct lys_feature *
931nc_lys_next_feature(struct lys_feature *last, const struct lys_module *ly_mod, int *idx)
932{
933 uint8_t i;
934
935 assert(ly_mod);
936
937 /* find the (sub)module of the last feature */
938 if (last) {
939 for (i = 0; i < ly_mod->inc_size; ++i) {
940 if (*idx >= ly_mod->inc[i].submodule->features_size) {
941 /* not a feature from this submodule, skip */
942 continue;
943 }
944 if (last != ly_mod->inc[i].submodule->features + *idx) {
945 /* feature is not from this submodule */
946 continue;
947 }
948
949 /* we have found the submodule */
950 break;
951 }
952
953 /* feature not found in submodules, it must be in the main module */
954 assert((i < ly_mod->inc_size) || ((*idx < ly_mod->features_size) && (last == ly_mod->features + *idx)));
955
956 /* we want the next feature */
957 ++(*idx);
958 } else {
959 i = 0;
960 *idx = 0;
961 }
962
963 /* find the (sub)module of the next feature */
964 while ((i < ly_mod->inc_size) && (*idx == ly_mod->inc[i].submodule->features_size)) {
965 /* next submodule */
966 ++i;
967 *idx = 0;
968 }
969
970 /* get the next feature */
971 if (i < ly_mod->inc_size) {
972 last = ly_mod->inc[i].submodule->features + *idx;
973 } else if (*idx < ly_mod->features_size) {
974 last = ly_mod->features + *idx;
975 } else {
976 last = NULL;
977 }
978
979 return last;
980}
981
982
Michal Vasko4ffa3b22016-05-24 16:36:25 +0200983API const char **
Radek Krejci24a18412018-05-16 15:09:10 +0200984nc_server_get_cpblts_version(struct ly_ctx *ctx, LYS_VERSION version)
Michal Vasko086311b2016-01-08 09:53:11 +0100985{
Michal Vaskod5ada122020-03-19 18:28:06 +0100986 const char **cpblts;
Radek Krejci24a18412018-05-16 15:09:10 +0200987 const struct lys_module *mod, *devmod;
Michal Vaskodafdc742020-03-11 16:15:59 +0100988 struct lys_feature *feat;
Radek Krejci24a18412018-05-16 15:09:10 +0200989 int size = 10, count, features_count = 0, dev_count = 0, i, str_len, len;
990 unsigned int u, v, module_set_id;
991 char *s;
992#define NC_CPBLT_BUF_LEN 4096
Michal Vasko2e47ef92016-06-20 10:03:24 +0200993 char str[NC_CPBLT_BUF_LEN];
Michal Vasko086311b2016-01-08 09:53:11 +0100994
Michal Vasko4ffa3b22016-05-24 16:36:25 +0200995 if (!ctx) {
996 ERRARG("ctx");
997 return NULL;
998 }
999
Michal Vasko086311b2016-01-08 09:53:11 +01001000 cpblts = malloc(size * sizeof *cpblts);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001001 if (!cpblts) {
1002 ERRMEM;
Radek Krejcif906e412017-09-22 14:44:45 +02001003 goto error;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001004 }
Michal Vasko086311b2016-01-08 09:53:11 +01001005 cpblts[0] = lydict_insert(ctx, "urn:ietf:params:netconf:base:1.0", 0);
1006 cpblts[1] = lydict_insert(ctx, "urn:ietf:params:netconf:base:1.1", 0);
1007 count = 2;
1008
1009 /* capabilities */
1010
Radek Krejci3222b7d2017-09-21 16:04:30 +02001011 mod = ly_ctx_get_module(ctx, "ietf-netconf", NULL, 1);
Michal Vasko086311b2016-01-08 09:53:11 +01001012 if (mod) {
1013 if (lys_features_state(mod, "writable-running") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001014 add_cpblt(ctx, "urn:ietf:params:netconf:capability:writable-running:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001015 }
1016 if (lys_features_state(mod, "candidate") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001017 add_cpblt(ctx, "urn:ietf:params:netconf:capability:candidate:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001018 if (lys_features_state(mod, "confirmed-commit") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001019 add_cpblt(ctx, "urn:ietf:params:netconf:capability:confirmed-commit:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001020 }
1021 }
1022 if (lys_features_state(mod, "rollback-on-error") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001023 add_cpblt(ctx, "urn:ietf:params:netconf:capability:rollback-on-error:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001024 }
1025 if (lys_features_state(mod, "validate") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001026 add_cpblt(ctx, "urn:ietf:params:netconf:capability:validate:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001027 }
1028 if (lys_features_state(mod, "startup") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001029 add_cpblt(ctx, "urn:ietf:params:netconf:capability:startup:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001030 }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001031
1032 /* The URL capability must be set manually using nc_server_set_capability()
1033 * because of the need for supported protocols to be included.
1034 * https://tools.ietf.org/html/rfc6241#section-8.8.3
1035 */
mekleoa8de5e92020-02-13 09:05:56 +01001036 // if (lys_features_state(mod, "url") == 1) {
1037 // add_cpblt(ctx, "urn:ietf:params:netconf:capability:url:1.0", &cpblts, &size, &count);
1038 // }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001039
Michal Vasko086311b2016-01-08 09:53:11 +01001040 if (lys_features_state(mod, "xpath") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001041 add_cpblt(ctx, "urn:ietf:params:netconf:capability:xpath:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001042 }
1043 }
1044
Radek Krejci3222b7d2017-09-21 16:04:30 +02001045 mod = ly_ctx_get_module(ctx, "ietf-netconf-with-defaults", NULL, 1);
Michal Vasko086311b2016-01-08 09:53:11 +01001046 if (mod) {
1047 if (!server_opts.wd_basic_mode) {
1048 VRB("with-defaults capability will not be advertised even though \"ietf-netconf-with-defaults\" model is present, unknown basic-mode.");
1049 } else {
Michal Vasko3031aae2016-01-27 16:07:18 +01001050 strcpy(str, "urn:ietf:params:netconf:capability:with-defaults:1.0");
Michal Vasko086311b2016-01-08 09:53:11 +01001051 switch (server_opts.wd_basic_mode) {
1052 case NC_WD_ALL:
1053 strcat(str, "?basic-mode=report-all");
1054 break;
1055 case NC_WD_TRIM:
1056 strcat(str, "?basic-mode=trim");
1057 break;
1058 case NC_WD_EXPLICIT:
1059 strcat(str, "?basic-mode=explicit");
1060 break;
1061 default:
Michal Vasko9e036d52016-01-08 10:49:26 +01001062 ERRINT;
Michal Vasko086311b2016-01-08 09:53:11 +01001063 break;
1064 }
1065
1066 if (server_opts.wd_also_supported) {
Michal Vasko2e47ef92016-06-20 10:03:24 +02001067 strcat(str, "&also-supported=");
Michal Vasko086311b2016-01-08 09:53:11 +01001068 if (server_opts.wd_also_supported & NC_WD_ALL) {
1069 strcat(str, "report-all,");
1070 }
1071 if (server_opts.wd_also_supported & NC_WD_ALL_TAG) {
1072 strcat(str, "report-all-tagged,");
1073 }
1074 if (server_opts.wd_also_supported & NC_WD_TRIM) {
1075 strcat(str, "trim,");
1076 }
1077 if (server_opts.wd_also_supported & NC_WD_EXPLICIT) {
1078 strcat(str, "explicit,");
1079 }
1080 str[strlen(str) - 1] = '\0';
1081
1082 add_cpblt(ctx, str, &cpblts, &size, &count);
1083 }
1084 }
1085 }
1086
Radek Krejci658782b2016-12-04 22:04:55 +01001087 /* other capabilities */
1088 for (u = 0; u < server_opts.capabilities_count; u++) {
1089 add_cpblt(ctx, server_opts.capabilities[u], &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001090 }
1091
1092 /* models */
Radek Krejci24a18412018-05-16 15:09:10 +02001093 u = module_set_id = 0;
1094 while ((mod = ly_ctx_get_module_iter(ctx, &u))) {
Radek Krejci24a18412018-05-16 15:09:10 +02001095 if (!strcmp(mod->name, "ietf-yang-library")) {
Michal Vaskod5ada122020-03-19 18:28:06 +01001096 if (!mod->rev_size || (strcmp(mod->rev[0].date, "2016-06-21") && strcmp(mod->rev[0].date, "2019-01-04"))) {
1097 ERR("Unknown \"ietf-yang-library\" revision, only 2016-06-21 and 2019-01-04 are supported.");
1098 goto error;
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001099 }
Michal Vaskod5ada122020-03-19 18:28:06 +01001100
Michal Vaskod5ada122020-03-19 18:28:06 +01001101 if (!strcmp(mod->rev[0].date, "2019-01-04")) {
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001102 /* new one (capab defined in RFC 8526 section 2) */
Michal Vaskod5ada122020-03-19 18:28:06 +01001103 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.1?revision=%s&content-id=%u",
1104 mod->rev[0].date, ly_ctx_get_module_set_id(ctx));
1105 add_cpblt(ctx, str, &cpblts, &size, &count);
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001106 } else {
1107 /* old one (capab defined in RFC 7950 section 5.6.4) */
1108 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.0?revision=%s&module-set-id=%u",
1109 mod->rev[0].date, ly_ctx_get_module_set_id(ctx));
1110 add_cpblt(ctx, str, &cpblts, &size, &count);
Michal Vaskod5ada122020-03-19 18:28:06 +01001111 }
Radek Krejci24a18412018-05-16 15:09:10 +02001112 continue;
1113 } else if (mod->type) {
1114 /* skip submodules */
1115 continue;
1116 } else if (version == LYS_VERSION_1 && mod->version > version) {
1117 /* skip YANG 1.1 schemas */
1118 continue;
1119 } else if (version == LYS_VERSION_1_1 && mod->version != version) {
1120 /* skip YANG 1.0 schemas */
1121 continue;
1122 }
Michal Vasko086311b2016-01-08 09:53:11 +01001123
Radek Krejci24a18412018-05-16 15:09:10 +02001124 str_len = sprintf(str, "%s?module=%s%s%s", mod->ns, mod->name,
1125 mod->rev_size ? "&revision=" : "", mod->rev_size ? mod->rev[0].date : "");
1126
Michal Vaskodafdc742020-03-11 16:15:59 +01001127 features_count = 0;
1128 i = 0;
1129 feat = NULL;
1130 while ((feat = nc_lys_next_feature(feat, mod, &i))) {
1131 if (!(feat->flags & LYS_FENABLED)) {
1132 continue;
Michal Vaskoe90e4d12016-06-20 10:05:01 +02001133 }
Michal Vaskodafdc742020-03-11 16:15:59 +01001134 if (!features_count) {
1135 strcat(str, "&features=");
1136 str_len += 10;
1137 }
1138 len = strlen(feat->name);
1139 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1140 ERRINT;
1141 break;
1142 }
1143 if (features_count) {
1144 strcat(str, ",");
1145 ++str_len;
1146 }
1147 strcat(str, feat->name);
1148 str_len += len;
1149 features_count++;
Michal Vasko086311b2016-01-08 09:53:11 +01001150 }
Michal Vasko086311b2016-01-08 09:53:11 +01001151
Radek Krejci24a18412018-05-16 15:09:10 +02001152 if (mod->deviated) {
1153 strcat(str, "&deviations=");
1154 str_len += 12;
1155 dev_count = 0;
Frank Rimplercb9274f2019-03-13 16:40:34 +00001156 v = 0;
Radek Krejci24a18412018-05-16 15:09:10 +02001157 while ((devmod = ly_ctx_get_module_iter(ctx, &v))) {
1158 if (devmod == mod) {
1159 continue;
1160 }
1161
1162 for (i = 0; i < devmod->deviation_size; ++i) {
1163 s = strstr(devmod->deviation[i].target_name, mod->name);
1164 if (s && s[strlen(mod->name)] == ':') {
1165 /* we have the module deviating the module being processed */
1166 len = strlen(devmod->name);
1167 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1168 ERRINT;
1169 break;
1170 }
1171 if (dev_count) {
1172 strcat(str, ",");
1173 ++str_len;
1174 }
1175 strcat(str, devmod->name);
1176 str_len += len;
1177 dev_count++;
1178
1179 break;
1180 }
1181 }
1182 }
1183 }
1184
1185 add_cpblt(ctx, str, &cpblts, &size, &count);
1186 }
Michal Vasko086311b2016-01-08 09:53:11 +01001187
1188 /* ending NULL capability */
1189 add_cpblt(ctx, NULL, &cpblts, &size, &count);
1190
1191 return cpblts;
Radek Krejcif906e412017-09-22 14:44:45 +02001192
1193error:
Radek Krejcif906e412017-09-22 14:44:45 +02001194 free(cpblts);
Radek Krejcif906e412017-09-22 14:44:45 +02001195 return NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001196}
1197
Radek Krejci24a18412018-05-16 15:09:10 +02001198API const char **
1199nc_server_get_cpblts(struct ly_ctx *ctx)
1200{
1201 return nc_server_get_cpblts_version(ctx, LYS_VERSION_UNDEF);
1202}
1203
Radek Krejci695d4fa2015-10-22 13:23:54 +02001204static int
Michal Vasko2cb24b42017-05-23 14:59:11 +02001205parse_cpblts(struct lyxml_elem *xml, char ***list)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001206{
1207 struct lyxml_elem *cpblt;
Michal Vasko156d3272017-04-11 11:46:49 +02001208 int ver = -1, i = 0;
1209 const char *cpb_start, *cpb_end;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001210
1211 if (list) {
1212 /* get the storage for server's capabilities */
1213 LY_TREE_FOR(xml->child, cpblt) {
1214 i++;
1215 }
Michal Vasko9e2d3a32015-11-10 13:09:18 +01001216 /* last item remains NULL */
1217 *list = calloc(i + 1, sizeof **list);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001218 if (!*list) {
1219 ERRMEM;
1220 return -1;
1221 }
1222 i = 0;
1223 }
1224
1225 LY_TREE_FOR(xml->child, cpblt) {
Michal Vasko5ce6d7d2018-10-12 09:33:33 +02001226 if (cpblt->name && strcmp(cpblt->name, "capability") && cpblt->ns && cpblt->ns->value &&
Radek Krejci695d4fa2015-10-22 13:23:54 +02001227 !strcmp(cpblt->ns->value, NC_NS_BASE)) {
1228 ERR("Unexpected <%s> element in client's <hello>.", cpblt->name);
1229 return -1;
Michal Vasko5ce6d7d2018-10-12 09:33:33 +02001230 } else if (!cpblt->name || !cpblt->ns || !cpblt->ns->value || strcmp(cpblt->ns->value, NC_NS_BASE)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001231 continue;
1232 }
1233
Michal Vasko156d3272017-04-11 11:46:49 +02001234 /* skip leading/trailing whitespaces */
1235 for (cpb_start = cpblt->content; isspace(cpb_start[0]); ++cpb_start);
1236 for (cpb_end = cpblt->content + strlen(cpblt->content); (cpb_end > cpblt->content) && isspace(cpb_end[-1]); --cpb_end);
1237 if (!cpb_start[0] || (cpb_end == cpblt->content)) {
1238 ERR("Empty capability \"%s\" received.", cpblt->content);
1239 return -1;
1240 }
1241
Radek Krejci695d4fa2015-10-22 13:23:54 +02001242 /* detect NETCONF version */
Michal Vasko156d3272017-04-11 11:46:49 +02001243 if (ver < 0 && !strncmp(cpb_start, "urn:ietf:params:netconf:base:1.0", cpb_end - cpb_start)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001244 ver = 0;
Michal Vasko156d3272017-04-11 11:46:49 +02001245 } 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 +02001246 ver = 1;
1247 }
1248
1249 /* store capabilities */
1250 if (list) {
Michal Vasko156d3272017-04-11 11:46:49 +02001251 (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
1252 if (!(*list)[i]) {
1253 ERRMEM;
1254 return -1;
1255 }
Radek Krejci695d4fa2015-10-22 13:23:54 +02001256 i++;
1257 }
1258 }
1259
1260 if (ver == -1) {
Michal Vaskod083db62016-01-19 10:31:29 +01001261 ERR("Peer does not support a compatible NETCONF version.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001262 }
1263
1264 return ver;
1265}
1266
1267static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001268nc_send_hello_io(struct nc_session *session)
Michal Vasko086311b2016-01-08 09:53:11 +01001269{
Michal Vasko131120a2018-05-29 15:44:02 +02001270 NC_MSG_TYPE ret;
1271 int i, io_timeout;
Michal Vasko086311b2016-01-08 09:53:11 +01001272 const char **cpblts;
Michal Vasko131120a2018-05-29 15:44:02 +02001273 uint32_t *sid;
Michal Vasko086311b2016-01-08 09:53:11 +01001274
Michal Vasko131120a2018-05-29 15:44:02 +02001275 if (session->side == NC_CLIENT) {
1276 /* client side hello - send only NETCONF base capabilities */
1277 cpblts = malloc(3 * sizeof *cpblts);
1278 if (!cpblts) {
1279 ERRMEM;
1280 return NC_MSG_ERROR;
1281 }
1282 cpblts[0] = lydict_insert(session->ctx, "urn:ietf:params:netconf:base:1.0", 0);
1283 cpblts[1] = lydict_insert(session->ctx, "urn:ietf:params:netconf:base:1.1", 0);
1284 cpblts[2] = NULL;
1285
1286 io_timeout = NC_CLIENT_HELLO_TIMEOUT * 1000;
1287 sid = NULL;
1288 } else {
1289 cpblts = nc_server_get_cpblts_version(session->ctx, LYS_VERSION_1);
1290
1291 io_timeout = NC_SERVER_HELLO_TIMEOUT * 1000;
1292 sid = &session->id;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001293 }
Michal Vasko05ba9df2016-01-13 14:40:27 +01001294
Michal Vasko131120a2018-05-29 15:44:02 +02001295 ret = nc_write_msg_io(session, io_timeout, NC_MSG_HELLO, cpblts, sid);
Michal Vasko086311b2016-01-08 09:53:11 +01001296
Michal Vasko086311b2016-01-08 09:53:11 +01001297 for (i = 0; cpblts[i]; ++i) {
1298 lydict_remove(session->ctx, cpblts[i]);
1299 }
1300 free(cpblts);
1301
Michal Vasko131120a2018-05-29 15:44:02 +02001302 return ret;
Michal Vasko086311b2016-01-08 09:53:11 +01001303}
1304
1305static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001306nc_recv_client_hello_io(struct nc_session *session)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001307{
1308 struct lyxml_elem *xml = NULL, *node;
Michal Vasko131120a2018-05-29 15:44:02 +02001309 NC_MSG_TYPE msgtype;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001310 int ver = -1;
1311 char *str;
1312 long long int id;
1313 int flag = 0;
1314
Michal Vasko131120a2018-05-29 15:44:02 +02001315 msgtype = nc_read_msg_poll_io(session, NC_CLIENT_HELLO_TIMEOUT * 1000, &xml);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001316
Michal Vasko131120a2018-05-29 15:44:02 +02001317 switch (msgtype) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001318 case NC_MSG_HELLO:
1319 /* parse <hello> data */
Michal Vasko11d142a2016-01-19 15:58:24 +01001320 LY_TREE_FOR(xml->child, node) {
1321 if (!node->ns || !node->ns->value || strcmp(node->ns->value, NC_NS_BASE)) {
1322 continue;
1323 } else if (!strcmp(node->name, "session-id")) {
1324 if (!node->content || !strlen(node->content)) {
1325 ERR("No value of <session-id> element in server's <hello>.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001326 goto error;
1327 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001328 str = NULL;
1329 id = strtoll(node->content, &str, 10);
1330 if (*str || id < 1 || id > UINT32_MAX) {
1331 ERR("Invalid value of <session-id> element in server's <hello>.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001332 goto error;
1333 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001334 session->id = (uint32_t)id;
1335 continue;
1336 } else if (strcmp(node->name, "capabilities")) {
1337 ERR("Unexpected <%s> element in client's <hello>.", node->name);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001338 goto error;
1339 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001340
1341 if (flag) {
1342 /* multiple capabilities elements */
1343 ERR("Invalid <hello> message (multiple <capabilities> elements).");
1344 goto error;
1345 }
1346 flag = 1;
1347
Michal Vasko2e6defd2016-10-07 15:48:15 +02001348 if ((ver = parse_cpblts(node, &session->opts.client.cpblts)) < 0) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001349 goto error;
1350 }
1351 session->version = ver;
1352 }
1353
1354 if (!session->id) {
1355 ERR("Missing <session-id> in server's <hello>.");
1356 goto error;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001357 }
1358 break;
Michal Vasko71090fc2016-05-24 16:37:28 +02001359 case NC_MSG_WOULDBLOCK:
1360 ERR("Server's <hello> timeout elapsed.");
1361 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001362 case NC_MSG_ERROR:
1363 /* nothing special, just pass it out */
1364 break;
1365 default:
1366 ERR("Unexpected message received instead of <hello>.");
1367 msgtype = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001368 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001369 }
1370
1371 /* cleanup */
Michal Vaskoad611702015-12-03 13:41:51 +01001372 lyxml_free(session->ctx, xml);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001373
1374 return msgtype;
1375
1376error:
1377 /* cleanup */
Michal Vaskoad611702015-12-03 13:41:51 +01001378 lyxml_free(session->ctx, xml);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001379
1380 return NC_MSG_ERROR;
Radek Krejci5686ff72015-10-09 13:33:56 +02001381}
1382
Michal Vasko11d142a2016-01-19 15:58:24 +01001383static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001384nc_recv_server_hello_io(struct nc_session *session)
Michal Vasko11d142a2016-01-19 15:58:24 +01001385{
1386 struct lyxml_elem *xml = NULL, *node;
Michal Vasko71090fc2016-05-24 16:37:28 +02001387 NC_MSG_TYPE msgtype;
Michal Vasko11d142a2016-01-19 15:58:24 +01001388 int ver = -1;
1389 int flag = 0;
1390
Michal Vasko131120a2018-05-29 15:44:02 +02001391 msgtype = nc_read_msg_poll_io(session, (server_opts.hello_timeout ?
1392 server_opts.hello_timeout * 1000 : NC_SERVER_HELLO_TIMEOUT * 1000), &xml);
Michal Vasko11d142a2016-01-19 15:58:24 +01001393
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001394 switch (msgtype) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001395 case NC_MSG_HELLO:
1396 /* get know NETCONF version */
1397 LY_TREE_FOR(xml->child, node) {
1398 if (!node->ns || !node->ns->value || strcmp(node->ns->value, NC_NS_BASE)) {
1399 continue;
1400 } else if (strcmp(node->name, "capabilities")) {
1401 ERR("Unexpected <%s> element in client's <hello>.", node->name);
Michal Vasko71090fc2016-05-24 16:37:28 +02001402 msgtype = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001403 goto cleanup;
1404 }
1405
1406 if (flag) {
1407 /* multiple capabilities elements */
1408 ERR("Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko71090fc2016-05-24 16:37:28 +02001409 msgtype = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001410 goto cleanup;
1411 }
1412 flag = 1;
1413
1414 if ((ver = parse_cpblts(node, NULL)) < 0) {
Michal Vasko71090fc2016-05-24 16:37:28 +02001415 msgtype = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001416 goto cleanup;
1417 }
1418 session->version = ver;
1419 }
1420 break;
1421 case NC_MSG_ERROR:
1422 /* nothing special, just pass it out */
1423 break;
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001424 case NC_MSG_WOULDBLOCK:
1425 ERR("Client's <hello> timeout elapsed.");
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001426 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001427 default:
1428 ERR("Unexpected message received instead of <hello>.");
1429 msgtype = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001430 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001431 }
1432
1433cleanup:
Michal Vasko11d142a2016-01-19 15:58:24 +01001434 lyxml_free(session->ctx, xml);
Michal Vasko11d142a2016-01-19 15:58:24 +01001435 return msgtype;
1436}
1437
Michal Vasko71090fc2016-05-24 16:37:28 +02001438NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001439nc_handshake_io(struct nc_session *session)
Michal Vasko80cad7f2015-12-08 14:42:27 +01001440{
Michal Vasko086311b2016-01-08 09:53:11 +01001441 NC_MSG_TYPE type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001442
Michal Vasko131120a2018-05-29 15:44:02 +02001443 type = nc_send_hello_io(session);
Michal Vasko086311b2016-01-08 09:53:11 +01001444 if (type != NC_MSG_HELLO) {
Michal Vasko71090fc2016-05-24 16:37:28 +02001445 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001446 }
1447
Michal Vasko11d142a2016-01-19 15:58:24 +01001448 if (session->side == NC_CLIENT) {
Michal Vasko131120a2018-05-29 15:44:02 +02001449 type = nc_recv_client_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001450 } else {
Michal Vasko131120a2018-05-29 15:44:02 +02001451 type = nc_recv_server_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001452 }
1453
Michal Vasko71090fc2016-05-24 16:37:28 +02001454 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001455}
Michal Vasko086311b2016-01-08 09:53:11 +01001456
Michal Vasko889162e2019-09-06 14:43:37 +02001457#ifdef NC_ENABLED_SSH
1458
Michal Vasko999b64a2019-07-10 16:06:15 +02001459static void
1460nc_ssh_init(void)
1461{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001462#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
Michal Vasko999b64a2019-07-10 16:06:15 +02001463 ssh_threads_set_callbacks(ssh_threads_get_pthread());
1464 ssh_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001465#endif
Michal Vasko999b64a2019-07-10 16:06:15 +02001466}
1467
1468static void
1469nc_ssh_destroy(void)
1470{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001471#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko999b64a2019-07-10 16:06:15 +02001472 FIPS_mode_set(0);
1473 CONF_modules_unload(1);
1474 nc_thread_destroy();
Michal Vasko889162e2019-09-06 14:43:37 +02001475#endif
1476
Michal Vaskoe1e82632019-09-09 09:18:03 +02001477#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
1478 ssh_finalize();
1479#endif
1480}
1481
Michal Vasko889162e2019-09-06 14:43:37 +02001482#endif /* NC_ENABLED_SSH */
Michal Vasko999b64a2019-07-10 16:06:15 +02001483
Radek Krejci53691be2016-02-22 13:58:37 +01001484#ifdef NC_ENABLED_TLS
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001485
Michal Vasko770b4362017-02-17 14:44:18 +01001486#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1487
Michal Vaskof0c92c02016-01-29 09:41:45 +01001488struct CRYPTO_dynlock_value {
1489 pthread_mutex_t lock;
1490};
1491
Michal Vaskof0c92c02016-01-29 09:41:45 +01001492static struct CRYPTO_dynlock_value *
1493tls_dyn_create_func(const char *UNUSED(file), int UNUSED(line))
1494{
1495 struct CRYPTO_dynlock_value *value;
1496
1497 value = malloc(sizeof *value);
1498 if (!value) {
1499 ERRMEM;
1500 return NULL;
1501 }
1502 pthread_mutex_init(&value->lock, NULL);
1503
1504 return value;
1505}
1506
1507static void
1508tls_dyn_lock_func(int mode, struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1509{
1510 /* mode can also be CRYPTO_READ or CRYPTO_WRITE, but all the examples
1511 * I found ignored this fact, what do I know... */
1512 if (mode & CRYPTO_LOCK) {
1513 pthread_mutex_lock(&l->lock);
1514 } else {
1515 pthread_mutex_unlock(&l->lock);
1516 }
1517}
1518
1519static void
1520tls_dyn_destroy_func(struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1521{
1522 pthread_mutex_destroy(&l->lock);
1523 free(l);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001524}
Michal Vasko770b4362017-02-17 14:44:18 +01001525#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001526
Michal Vasko8f0c0282016-02-29 10:17:14 +01001527#endif /* NC_ENABLED_TLS */
1528
1529#if defined(NC_ENABLED_TLS) && !defined(NC_ENABLED_SSH)
1530
Michal Vasko770b4362017-02-17 14:44:18 +01001531#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001532static pthread_mutex_t *tls_locks;
1533
1534static void
1535tls_thread_locking_func(int mode, int n, const char *UNUSED(file), int UNUSED(line))
1536{
1537 if (mode & CRYPTO_LOCK) {
1538 pthread_mutex_lock(tls_locks + n);
1539 } else {
1540 pthread_mutex_unlock(tls_locks + n);
1541 }
1542}
1543
1544static void
1545tls_thread_id_func(CRYPTO_THREADID *tid)
1546{
1547 CRYPTO_THREADID_set_numeric(tid, (unsigned long)pthread_self());
1548}
Michal Vasko770b4362017-02-17 14:44:18 +01001549#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001550
1551static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001552nc_tls_init(void)
1553{
Rosen Penev4f552d62019-06-26 16:10:43 -07001554#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001555 SSL_load_error_strings();
Michal Vasko7f1c78b2016-01-19 09:52:14 +01001556 ERR_load_BIO_strings();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001557 SSL_library_init();
1558
Michal Vaskof89948c2018-01-04 09:19:46 +01001559 int i;
1560
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001561 tls_locks = malloc(CRYPTO_num_locks() * sizeof *tls_locks);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001562 if (!tls_locks) {
1563 ERRMEM;
1564 return;
1565 }
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001566 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1567 pthread_mutex_init(tls_locks + i, NULL);
1568 }
1569
Michal Vaskof0c92c02016-01-29 09:41:45 +01001570 CRYPTO_THREADID_set_callback(tls_thread_id_func);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001571 CRYPTO_set_locking_callback(tls_thread_locking_func);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001572
1573 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1574 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1575 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001576#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001577}
1578
Michal Vasko8f0c0282016-02-29 10:17:14 +01001579static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001580nc_tls_destroy(void)
1581{
Rosen Penev4f552d62019-06-26 16:10:43 -07001582#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001583 FIPS_mode_set(0);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001584 CRYPTO_cleanup_all_ex_data();
Michal Vaskob6e37262016-02-25 14:49:00 +01001585 nc_thread_destroy();
Michal Vasko5e228792016-02-03 15:30:24 +01001586 EVP_cleanup();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001587 ERR_free_strings();
Michal Vasko770b4362017-02-17 14:44:18 +01001588#if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001589 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vasko770b4362017-02-17 14:44:18 +01001590#elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1591 SSL_COMP_free_compression_methods();
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001592#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001593
Michal Vaskof89948c2018-01-04 09:19:46 +01001594 int i;
1595
Michal Vaskob6e37262016-02-25 14:49:00 +01001596 CRYPTO_THREADID_set_callback(NULL);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001597 CRYPTO_set_locking_callback(NULL);
1598 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1599 pthread_mutex_destroy(tls_locks + i);
1600 }
1601 free(tls_locks);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001602
1603 CRYPTO_set_dynlock_create_callback(NULL);
1604 CRYPTO_set_dynlock_lock_callback(NULL);
1605 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001606#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001607}
1608
Michal Vasko8f0c0282016-02-29 10:17:14 +01001609#endif /* NC_ENABLED_TLS && !NC_ENABLED_SSH */
Michal Vasko5e228792016-02-03 15:30:24 +01001610
Radek Krejci53691be2016-02-22 13:58:37 +01001611#if defined(NC_ENABLED_SSH) && defined(NC_ENABLED_TLS)
Michal Vasko5e228792016-02-03 15:30:24 +01001612
Michal Vasko8f0c0282016-02-29 10:17:14 +01001613static void
Michal Vasko5e228792016-02-03 15:30:24 +01001614nc_ssh_tls_init(void)
1615{
Rosen Penev4f552d62019-06-26 16:10:43 -07001616#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001617 SSL_load_error_strings();
1618 ERR_load_BIO_strings();
1619 SSL_library_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001620#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001621
1622 nc_ssh_init();
1623
Michal Vaskoe1e82632019-09-09 09:18:03 +02001624#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001625 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1626 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1627 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001628#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001629}
1630
Michal Vasko8f0c0282016-02-29 10:17:14 +01001631static void
Michal Vasko5e228792016-02-03 15:30:24 +01001632nc_ssh_tls_destroy(void)
1633{
Rosen Penev4f552d62019-06-26 16:10:43 -07001634#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001635 ERR_free_strings();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001636# if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vasko5e228792016-02-03 15:30:24 +01001637 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vaskoe1e82632019-09-09 09:18:03 +02001638# elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko770b4362017-02-17 14:44:18 +01001639 SSL_COMP_free_compression_methods();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001640# endif
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001641#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001642
1643 nc_ssh_destroy();
1644
Michal Vaskoe1e82632019-09-09 09:18:03 +02001645#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001646 CRYPTO_set_dynlock_create_callback(NULL);
1647 CRYPTO_set_dynlock_lock_callback(NULL);
1648 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001649#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001650}
1651
Radek Krejci53691be2016-02-22 13:58:37 +01001652#endif /* NC_ENABLED_SSH && NC_ENABLED_TLS */
Michal Vasko8f0c0282016-02-29 10:17:14 +01001653
1654#if defined(NC_ENABLED_SSH) || defined(NC_ENABLED_TLS)
1655
1656API void
1657nc_thread_destroy(void)
1658{
Michal Vasko8f0c0282016-02-29 10:17:14 +01001659 /* caused data-races and seems not neccessary for avoiding valgrind reachable memory */
1660 //CRYPTO_cleanup_all_ex_data();
1661
Michal Vasko770b4362017-02-17 14:44:18 +01001662#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1663 CRYPTO_THREADID crypto_tid;
1664
Michal Vasko8f0c0282016-02-29 10:17:14 +01001665 CRYPTO_THREADID_current(&crypto_tid);
1666 ERR_remove_thread_state(&crypto_tid);
Michal Vasko770b4362017-02-17 14:44:18 +01001667#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001668}
1669
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001670#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
1671
1672void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001673nc_init(void)
1674{
1675#if defined(NC_ENABLED_SSH) && defined(NC_ENABLED_TLS)
1676 nc_ssh_tls_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001677#elif defined(NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001678 nc_ssh_init();
1679#elif defined(NC_ENABLED_TLS)
1680 nc_tls_init();
1681#endif
1682}
1683
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001684void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001685nc_destroy(void)
1686{
1687#if defined(NC_ENABLED_SSH) && defined(NC_ENABLED_TLS)
1688 nc_ssh_tls_destroy();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001689#elif defined(NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001690 nc_ssh_destroy();
1691#elif defined(NC_ENABLED_TLS)
1692 nc_tls_destroy();
1693#endif
1694}