blob: e48cc998d32ab1ea598f1f900112c12293fdb273 [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) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100223 pthread_mutex_init(&sess->opts.server.rpc_lock, NULL);
224 pthread_cond_init(&sess->opts.server.rpc_cond, NULL);
225 sess->opts.server.rpc_inuse = 0;
226
227 pthread_mutex_init(&sess->opts.server.ch_lock, NULL);
228 pthread_cond_init(&sess->opts.server.ch_cond, NULL);
Michal Vasko131120a2018-05-29 15:44:02 +0200229 }
230
231 if (!shared_ti) {
232 sess->io_lock = malloc(sizeof *sess->io_lock);
233 if (!sess->io_lock) {
234 goto error;
235 }
236 pthread_mutex_init(sess->io_lock, NULL);
Michal Vaskoade892d2017-02-22 13:40:35 +0100237 }
238
239 return sess;
Michal Vasko131120a2018-05-29 15:44:02 +0200240
241error:
Michal Vasko131120a2018-05-29 15:44:02 +0200242 free(sess);
243 return NULL;
Michal Vaskoade892d2017-02-22 13:40:35 +0100244}
245
Michal Vasko96164bf2016-01-21 15:41:58 +0100246/*
247 * @return 1 - success
248 * 0 - timeout
249 * -1 - error
250 */
251int
Michal Vasko131120a2018-05-29 15:44:02 +0200252nc_session_rpc_lock(struct nc_session *session, int timeout, const char *func)
Michal Vasko96164bf2016-01-21 15:41:58 +0100253{
254 int ret;
Michal Vasko62be1ce2016-03-03 13:24:52 +0100255 struct timespec ts_timeout;
Michal Vasko96164bf2016-01-21 15:41:58 +0100256
Michal Vasko131120a2018-05-29 15:44:02 +0200257 if (session->side != NC_SERVER) {
258 ERRINT;
259 return -1;
260 }
261
Michal Vasko96164bf2016-01-21 15:41:58 +0100262 if (timeout > 0) {
Michal Vasko77a6abe2017-10-05 10:02:20 +0200263 nc_gettimespec_real(&ts_timeout);
Michal Vasko81c5b302017-03-15 12:10:40 +0100264 nc_addtimespec(&ts_timeout, timeout);
Michal Vasko96164bf2016-01-21 15:41:58 +0100265
Michal Vaskoade892d2017-02-22 13:40:35 +0100266 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100267 ret = pthread_mutex_timedlock(&session->opts.server.rpc_lock, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100268 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100269 while (session->opts.server.rpc_inuse) {
270 ret = pthread_cond_timedwait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100271 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100272 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100273 break;
274 }
275 }
276 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100277 } else if (!timeout) {
Michal Vaskoade892d2017-02-22 13:40:35 +0100278 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100279 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100280 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100281 if (session->opts.server.rpc_inuse) {
282 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100283 return 0;
284 }
Michal vasko2f8e4b52016-10-05 13:04:11 +0200285 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100286 } else { /* timeout == -1 */
Michal Vaskoade892d2017-02-22 13:40:35 +0100287 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100288 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100289 if (!ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100290 while (session->opts.server.rpc_inuse) {
291 ret = pthread_cond_wait(&session->opts.server.rpc_cond, &session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100292 if (ret) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100293 pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100294 break;
295 }
296 }
297 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100298 }
299
Michal Vaskoade892d2017-02-22 13:40:35 +0100300 if (ret) {
301 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
302 /* timeout */
303 return 0;
304 }
305
Michal Vasko96164bf2016-01-21 15:41:58 +0100306 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200307 ERR("%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vasko96164bf2016-01-21 15:41:58 +0100308 return -1;
309 }
310
311 /* ok */
Michal Vaskoacf98472021-02-04 15:33:57 +0100312 assert(session->opts.server.rpc_inuse == 0);
313 session->opts.server.rpc_inuse = 1;
Michal Vaskoade892d2017-02-22 13:40:35 +0100314
315 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100316 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100317 if (ret) {
318 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200319 ERR("%s: faile to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100320 return -1;
321 }
322
323 return 1;
324}
325
326int
Michal Vasko131120a2018-05-29 15:44:02 +0200327nc_session_rpc_unlock(struct nc_session *session, int timeout, const char *func)
Michal Vaskoade892d2017-02-22 13:40:35 +0100328{
329 int ret;
330 struct timespec ts_timeout;
331
Michal Vasko131120a2018-05-29 15:44:02 +0200332 if (session->side != NC_SERVER) {
333 ERRINT;
334 return -1;
335 }
336
Michal Vaskoacf98472021-02-04 15:33:57 +0100337 assert(session->opts.server.rpc_inuse);
Michal Vaskoade892d2017-02-22 13:40:35 +0100338
339 if (timeout > 0) {
Michal Vasko77a6abe2017-10-05 10:02:20 +0200340 nc_gettimespec_real(&ts_timeout);
Michal Vasko81c5b302017-03-15 12:10:40 +0100341 nc_addtimespec(&ts_timeout, timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100342
343 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100344 ret = pthread_mutex_timedlock(&session->opts.server.rpc_lock, &ts_timeout);
Michal Vaskoade892d2017-02-22 13:40:35 +0100345 } else if (!timeout) {
346 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100347 ret = pthread_mutex_trylock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100348 } else { /* timeout == -1 */
349 /* LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100350 ret = pthread_mutex_lock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100351 }
352
353 if (ret && (ret != EBUSY) && (ret != ETIMEDOUT)) {
354 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200355 ERR("%s: failed to RPC lock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100356 return -1;
357 } else if (ret) {
Michal Vasko131120a2018-05-29 15:44:02 +0200358 WRN("%s: session RPC lock timeout, should not happen.");
Michal Vaskoade892d2017-02-22 13:40:35 +0100359 }
360
Michal Vaskoacf98472021-02-04 15:33:57 +0100361 session->opts.server.rpc_inuse = 0;
362 pthread_cond_signal(&session->opts.server.rpc_cond);
Michal Vaskoade892d2017-02-22 13:40:35 +0100363
364 if (!ret) {
365 /* UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100366 ret = pthread_mutex_unlock(&session->opts.server.rpc_lock);
Michal Vaskoade892d2017-02-22 13:40:35 +0100367 if (ret) {
368 /* error */
Michal Vasko131120a2018-05-29 15:44:02 +0200369 ERR("%s: failed to RPC unlock a session (%s).", func, strerror(ret));
Michal Vaskoade892d2017-02-22 13:40:35 +0100370 return -1;
371 }
372 }
373
Michal Vasko96164bf2016-01-21 15:41:58 +0100374 return 1;
375}
376
Michal Vasko131120a2018-05-29 15:44:02 +0200377/*
378 * @return 1 - success
379 * 0 - timeout
380 * -1 - error
381 */
382int
383nc_session_io_lock(struct nc_session *session, int timeout, const char *func)
384{
385 int ret;
386 struct timespec ts_timeout;
387
388 if (timeout > 0) {
389 nc_gettimespec_real(&ts_timeout);
390 nc_addtimespec(&ts_timeout, timeout);
391
392 ret = pthread_mutex_timedlock(session->io_lock, &ts_timeout);
393 } else if (!timeout) {
394 ret = pthread_mutex_trylock(session->io_lock);
395 } else { /* timeout == -1 */
Robin Jarry54ea2962018-10-10 10:33:40 +0200396 ret = pthread_mutex_lock(session->io_lock);
Michal Vasko131120a2018-05-29 15:44:02 +0200397 }
398
399 if (ret) {
400 if ((ret == EBUSY) || (ret == ETIMEDOUT)) {
401 /* timeout */
402 return 0;
403 }
404
405 /* error */
406 ERR("%s: failed to IO lock a session (%s).", func, strerror(ret));
407 return -1;
408 }
409
410 return 1;
411}
412
413int
414nc_session_io_unlock(struct nc_session *session, const char *func)
415{
416 int ret;
417
418 ret = pthread_mutex_unlock(session->io_lock);
419 if (ret) {
420 /* error */
421 ERR("%s: failed to IO unlock a session (%s).", func, strerror(ret));
422 return -1;
423 }
424
425 return 1;
426}
427
Michal Vasko8dadf782016-01-15 10:29:36 +0100428API NC_STATUS
429nc_session_get_status(const struct nc_session *session)
430{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100431 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200432 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200433 return NC_STATUS_ERR;
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100434 }
435
Michal Vasko8dadf782016-01-15 10:29:36 +0100436 return session->status;
437}
438
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100439API NC_SESSION_TERM_REASON
Michal Vasko142cfea2017-08-07 10:12:11 +0200440nc_session_get_term_reason(const struct nc_session *session)
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100441{
442 if (!session) {
443 ERRARG("session");
Radek Krejci465308c2017-05-22 14:49:10 +0200444 return NC_SESSION_TERM_ERR;
Radek Krejci6e36bfb2016-12-01 21:40:16 +0100445 }
446
447 return session->term_reason;
448}
449
Michal Vasko8dadf782016-01-15 10:29:36 +0100450API uint32_t
Michal Vasko142cfea2017-08-07 10:12:11 +0200451nc_session_get_killed_by(const struct nc_session *session)
452{
453 if (!session) {
454 ERRARG("session");
455 return 0;
456 }
457
458 return session->killed_by;
459}
460
461API uint32_t
Michal Vasko8dadf782016-01-15 10:29:36 +0100462nc_session_get_id(const struct nc_session *session)
463{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100464 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200465 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100466 return 0;
467 }
468
Michal Vasko8dadf782016-01-15 10:29:36 +0100469 return session->id;
470}
471
Michal Vasko174fe8e2016-02-17 15:38:09 +0100472API int
473nc_session_get_version(const struct nc_session *session)
474{
475 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200476 ERRARG("session");
Michal Vasko174fe8e2016-02-17 15:38:09 +0100477 return -1;
478 }
479
480 return (session->version == NC_VERSION_10 ? 0 : 1);
481}
482
Michal Vasko8dadf782016-01-15 10:29:36 +0100483API NC_TRANSPORT_IMPL
484nc_session_get_ti(const struct nc_session *session)
485{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100486 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200487 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100488 return 0;
489 }
490
Michal Vasko8dadf782016-01-15 10:29:36 +0100491 return session->ti_type;
492}
493
494API const char *
495nc_session_get_username(const struct nc_session *session)
496{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100497 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200498 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100499 return NULL;
500 }
501
Michal Vasko8dadf782016-01-15 10:29:36 +0100502 return session->username;
503}
504
505API const char *
506nc_session_get_host(const struct nc_session *session)
507{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100508 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200509 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100510 return NULL;
511 }
512
Michal Vasko8dadf782016-01-15 10:29:36 +0100513 return session->host;
514}
515
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200516API const char *
517nc_session_get_path(const struct nc_session *session)
518{
519 if (!session) {
520 ERRARG("session");
521 return NULL;
522 }
523 if (session->ti_type != NC_TI_UNIX)
524 return NULL;
525
526 return session->path;
527}
528
Michal Vasko8dadf782016-01-15 10:29:36 +0100529API uint16_t
530nc_session_get_port(const struct nc_session *session)
531{
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100532 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200533 ERRARG("session");
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100534 return 0;
535 }
536
Michal Vasko8dadf782016-01-15 10:29:36 +0100537 return session->port;
538}
539
Michal Vasko9a25e932016-02-01 10:36:42 +0100540API struct ly_ctx *
541nc_session_get_ctx(const struct nc_session *session)
542{
543 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200544 ERRARG("session");
Michal Vasko9a25e932016-02-01 10:36:42 +0100545 return NULL;
546 }
547
548 return session->ctx;
549}
550
Michal Vasko2cc4c682016-03-01 09:16:48 +0100551API void
552nc_session_set_data(struct nc_session *session, void *data)
553{
554 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200555 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100556 return;
557 }
558
559 session->data = data;
560}
561
562API void *
563nc_session_get_data(const struct nc_session *session)
564{
565 if (!session) {
Michal Vasko45e53ae2016-04-07 11:46:03 +0200566 ERRARG("session");
Michal Vasko2cc4c682016-03-01 09:16:48 +0100567 return NULL;
568 }
569
570 return session->data;
571}
572
Michal Vasko086311b2016-01-08 09:53:11 +0100573NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +0200574nc_send_msg_io(struct nc_session *session, int io_timeout, struct lyd_node *op)
Radek Krejci695d4fa2015-10-22 13:23:54 +0200575{
Michal Vasko086311b2016-01-08 09:53:11 +0100576 if (session->ctx != op->schema->module->ctx) {
Michal Vaskod083db62016-01-19 10:31:29 +0100577 ERR("Session %u: RPC \"%s\" was created in different context than that of the session.",
578 session->id, op->schema->name);
Michal Vasko086311b2016-01-08 09:53:11 +0100579 return NC_MSG_ERROR;
Michal Vasko7df39ec2015-12-09 15:26:24 +0100580 }
581
Michal Vasko131120a2018-05-29 15:44:02 +0200582 return nc_write_msg_io(session, io_timeout, NC_MSG_RPC, op, NULL);
Michal Vasko7df39ec2015-12-09 15:26:24 +0100583}
584
Radek Krejci695d4fa2015-10-22 13:23:54 +0200585API void
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100586nc_session_free(struct nc_session *session, void (*data_free)(void *))
Radek Krejci695d4fa2015-10-22 13:23:54 +0200587{
Michal Vasko131120a2018-05-29 15:44:02 +0200588 int r, i, rpc_locked = 0, sock = -1;
Michal Vasko428087d2016-01-14 16:04:28 +0100589 int connected; /* flag to indicate whether the transport socket is still connected */
Michal Vaskob48aa812016-01-18 14:13:09 +0100590 int multisession = 0; /* flag for more NETCONF sessions on a single SSH session */
Michal Vasko4589bbe2016-01-29 09:41:30 +0100591 struct nc_session *siter;
Michal Vaskoad611702015-12-03 13:41:51 +0100592 struct nc_msg_cont *contiter;
Michal Vaskoadd4c792015-10-26 15:36:58 +0100593 struct lyxml_elem *rpl, *child;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200594 struct lyd_node *close_rpc;
Michal Vaskoad611702015-12-03 13:41:51 +0100595 const struct lys_module *ietfnc;
Michal Vasko0db3db52021-03-03 10:45:42 +0100596 struct timespec ts;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200597 void *p;
598
Michal Vasko428087d2016-01-14 16:04:28 +0100599 if (!session || (session->status == NC_STATUS_CLOSING)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200600 return;
601 }
602
Michal Vasko86d357c2016-03-11 13:46:38 +0100603 /* stop notifications loop if any */
Michal Vasko7f1fa3c2020-09-08 16:30:41 +0200604 if ((session->side == NC_CLIENT) && ATOMIC_LOAD(session->opts.client.ntf_tid)) {
Michal Vaskob639e9c2020-09-09 09:51:48 +0200605 ATOMIC_STORE(session->opts.client.ntf_tid, (uintptr_t)NULL);
Michal Vasko86d357c2016-03-11 13:46:38 +0100606 /* the thread now knows it should quit */
Michal Vasko86d357c2016-03-11 13:46:38 +0100607 }
608
Michal Vaskoacf98472021-02-04 15:33:57 +0100609 if (session->side == NC_SERVER) {
Michal Vasko131120a2018-05-29 15:44:02 +0200610 r = nc_session_rpc_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
Michal Vasko7f1c78b2016-01-19 09:52:14 +0100611 if (r == -1) {
Michal Vaskoadd4c792015-10-26 15:36:58 +0100612 return;
Michal Vasko131120a2018-05-29 15:44:02 +0200613 } else if (r) {
614 rpc_locked = 1;
Michal Vasko96a28a32021-02-04 15:35:20 +0100615 } else {
616 /* else failed to lock it, too bad */
617 ERR("Session %u: freeing a session while an RPC is being processed.", session->id);
618 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200619 }
620
Michal Vasko8c247822020-09-07 13:23:23 +0200621 if (session->side == NC_CLIENT) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200622 /* cleanup message queues */
623 /* notifications */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200624 for (contiter = session->opts.client.notifs; contiter; ) {
Michal Vaskoad611702015-12-03 13:41:51 +0100625 lyxml_free(session->ctx, contiter->msg);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200626
Michal Vaskoad611702015-12-03 13:41:51 +0100627 p = contiter;
628 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200629 free(p);
630 }
631
632 /* rpc replies */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200633 for (contiter = session->opts.client.replies; contiter; ) {
Michal Vaskoad611702015-12-03 13:41:51 +0100634 lyxml_free(session->ctx, contiter->msg);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200635
Michal Vaskoad611702015-12-03 13:41:51 +0100636 p = contiter;
637 contiter = contiter->next;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200638 free(p);
639 }
640
Michal Vasko8c247822020-09-07 13:23:23 +0200641 if (session->status == NC_STATUS_RUNNING) {
642 /* send closing info to the other side */
643 ietfnc = ly_ctx_get_module(session->ctx, "ietf-netconf", NULL, 1);
644 if (!ietfnc) {
645 WRN("Session %u: missing ietf-netconf schema in context, unable to send <close-session>.", session->id);
646 } else {
647 close_rpc = lyd_new(NULL, ietfnc, "close-session");
648 nc_send_msg_io(session, NC_SESSION_FREE_LOCK_TIMEOUT, close_rpc);
649 lyd_free(close_rpc);
650 switch (nc_read_msg_poll_io(session, NC_CLOSE_REPLY_TIMEOUT, &rpl)) {
651 case NC_MSG_REPLY:
652 LY_TREE_FOR(rpl->child, child) {
653 if (!strcmp(child->name, "ok") && child->ns && !strcmp(child->ns->value, NC_NS_BASE)) {
654 break;
655 }
Michal Vaskofad6e912015-10-26 15:37:22 +0100656 }
Michal Vasko8c247822020-09-07 13:23:23 +0200657 if (!child) {
658 WRN("Session %u: the reply to <close-session> was not <ok> as expected.", session->id);
659 }
660 lyxml_free(session->ctx, rpl);
661 break;
662 case NC_MSG_WOULDBLOCK:
663 WRN("Session %u: timeout for receiving a reply to <close-session> elapsed.", session->id);
664 break;
665 case NC_MSG_ERROR:
666 ERR("Session %u: failed to receive a reply to <close-session>.", session->id);
667 break;
668 default:
669 /* cannot happen */
670 break;
Michal Vaskofad6e912015-10-26 15:37:22 +0100671 }
Michal Vaskofad6e912015-10-26 15:37:22 +0100672 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200673 }
674
675 /* list of server's capabilities */
Michal Vasko2e6defd2016-10-07 15:48:15 +0200676 if (session->opts.client.cpblts) {
677 for (i = 0; session->opts.client.cpblts[i]; i++) {
Michal Vasko96fc4bb2017-05-23 14:58:34 +0200678 free(session->opts.client.cpblts[i]);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200679 }
Michal Vasko2e6defd2016-10-07 15:48:15 +0200680 free(session->opts.client.cpblts);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200681 }
682 }
683
Michal Vaskoe1a64ec2016-03-01 12:21:58 +0100684 if (session->data && data_free) {
685 data_free(session->data);
686 }
687
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200688 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
689 /* CH LOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100690 pthread_mutex_lock(&session->opts.server.ch_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200691 }
692
Michal Vasko86d357c2016-03-11 13:46:38 +0100693 /* mark session for closing */
Radek Krejci695d4fa2015-10-22 13:23:54 +0200694 session->status = NC_STATUS_CLOSING;
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200695
696 if ((session->side == NC_SERVER) && (session->flags & NC_SESSION_CALLHOME)) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100697 pthread_cond_signal(&session->opts.server.ch_cond);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200698
Michal Vasko0db3db52021-03-03 10:45:42 +0100699 nc_gettimespec_real(&ts);
700 nc_addtimespec(&ts, NC_SESSION_FREE_LOCK_TIMEOUT);
701
702 /* wait for CH thread to actually wake up and terminate */
703 r = 0;
704 while (!r && (session->flags & NC_SESSION_CALLHOME)) {
705 r = pthread_cond_timedwait(&session->opts.server.ch_cond, &session->opts.server.ch_lock, &ts);
706 }
707
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200708 /* CH UNLOCK */
Michal Vaskoacf98472021-02-04 15:33:57 +0100709 pthread_mutex_unlock(&session->opts.server.ch_lock);
Michal Vasko3f05a092018-03-13 10:39:49 +0100710
Michal Vasko0db3db52021-03-03 10:45:42 +0100711 if (r) {
712 ERR("Session %u: waiting for Call Home thread failed (%s).", session->id, strerror(r));
Michal Vasko3f05a092018-03-13 10:39:49 +0100713 }
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200714 }
715
Michal Vasko428087d2016-01-14 16:04:28 +0100716 connected = nc_session_is_connected(session);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200717
718 /* transport implementation cleanup */
719 switch (session->ti_type) {
720 case NC_TI_FD:
721 /* nothing needed - file descriptors were provided by caller,
722 * so it is up to the caller to close them correctly
723 * TODO use callbacks
724 */
Michal Vasko3512e402016-01-28 16:22:34 +0100725 /* just to avoid compiler warning */
726 (void)connected;
Michal Vasko4589bbe2016-01-29 09:41:30 +0100727 (void)siter;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200728 break;
729
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200730 case NC_TI_UNIX:
731 sock = session->ti.unixsock.sock;
732 (void)connected;
733 (void)siter;
734 break;
735
Radek Krejci53691be2016-02-22 13:58:37 +0100736#ifdef NC_ENABLED_SSH
Radek Krejci695d4fa2015-10-22 13:23:54 +0200737 case NC_TI_LIBSSH:
Michal Vasko428087d2016-01-14 16:04:28 +0100738 if (connected) {
739 ssh_channel_free(session->ti.libssh.channel);
740 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200741 /* There can be multiple NETCONF sessions on the same SSH session (NETCONF session maps to
742 * SSH channel). So destroy the SSH session only if there is no other NETCONF session using
Michal Vaskoe50b6b12018-10-11 10:27:50 +0200743 * it. Also, avoid concurrent free by multiple threads of sessions that share the SSH session.
Radek Krejci695d4fa2015-10-22 13:23:54 +0200744 */
Michal Vaskoe50b6b12018-10-11 10:27:50 +0200745 /* SESSION IO LOCK */
746 r = nc_session_io_lock(session, NC_SESSION_FREE_LOCK_TIMEOUT, __func__);
747
Michal Vasko96164bf2016-01-21 15:41:58 +0100748 multisession = 0;
749 if (session->ti.libssh.next) {
750 for (siter = session->ti.libssh.next; siter != session; siter = siter->ti.libssh.next) {
751 if (siter->status != NC_STATUS_STARTING) {
752 multisession = 1;
753 break;
754 }
755 }
756 }
757
758 if (!multisession) {
759 /* it's not multisession yet, but we still need to free the starting sessions */
760 if (session->ti.libssh.next) {
761 do {
762 siter = session->ti.libssh.next;
763 session->ti.libssh.next = siter->ti.libssh.next;
764
765 /* free starting SSH NETCONF session (channel will be freed in ssh_free()) */
Michal Vasko96164bf2016-01-21 15:41:58 +0100766 lydict_remove(session->ctx, session->username);
767 lydict_remove(session->ctx, session->host);
Michal Vasko96164bf2016-01-21 15:41:58 +0100768 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Radek Krejci4ba285b2016-02-04 17:34:06 +0100769 ly_ctx_destroy(session->ctx, NULL);
Michal Vasko96164bf2016-01-21 15:41:58 +0100770 }
771
772 free(siter);
773 } while (session->ti.libssh.next != session);
774 }
Michal Vasko4d57e1b2018-03-21 12:21:25 +0100775 /* remember sock so we can close it */
776 sock = ssh_get_fd(session->ti.libssh.session);
Michal Vasko428087d2016-01-14 16:04:28 +0100777 if (connected) {
778 ssh_disconnect(session->ti.libssh.session);
Michal Vasko06e0fc22019-05-09 09:32:27 +0200779 sock = -1;
Michal Vasko428087d2016-01-14 16:04:28 +0100780 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200781 ssh_free(session->ti.libssh.session);
782 } else {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200783 /* remove the session from the list */
784 for (siter = session->ti.libssh.next; siter->ti.libssh.next != session; siter = siter->ti.libssh.next);
Michal Vaskoaec4f212015-10-26 15:37:45 +0100785 if (session->ti.libssh.next == siter) {
Radek Krejci695d4fa2015-10-22 13:23:54 +0200786 /* there will be only one session */
787 siter->ti.libssh.next = NULL;
788 } else {
789 /* there are still multiple sessions, keep the ring list */
790 siter->ti.libssh.next = session->ti.libssh.next;
791 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100792 /* change nc_sshcb_msg() argument, we need a RUNNING session and this one will be freed */
793 if (session->flags & NC_SESSION_SSH_MSG_CB) {
Michal Vasko5e0edd82020-07-29 15:26:13 +0200794 siter = session->ti.libssh.next;
795 while (siter && siter->status != NC_STATUS_RUNNING) {
Michal Vasko96164bf2016-01-21 15:41:58 +0100796 if (siter->ti.libssh.next == session) {
797 ERRINT;
798 break;
799 }
Michal Vasko5e0edd82020-07-29 15:26:13 +0200800 siter = siter->ti.libssh.next;
Michal Vasko96164bf2016-01-21 15:41:58 +0100801 }
Michal Vasko5e0edd82020-07-29 15:26:13 +0200802 /* siter may be NULL in case all the sessions terminated at the same time (socket was disconnected),
803 * we set session to NULL because we do not expect any new message to arrive */
Michal Vasko96164bf2016-01-21 15:41:58 +0100804 ssh_set_message_callback(session->ti.libssh.session, nc_sshcb_msg, siter);
Michal Vasko5e0edd82020-07-29 15:26:13 +0200805 if (siter) {
806 siter->flags |= NC_SESSION_SSH_MSG_CB;
807 }
Michal Vasko96164bf2016-01-21 15:41:58 +0100808 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200809 }
Michal Vaskoe50b6b12018-10-11 10:27:50 +0200810
811 /* SESSION IO UNLOCK */
812 if (r == 1) {
813 nc_session_io_unlock(session, __func__);
814 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200815 break;
816#endif
817
Radek Krejci53691be2016-02-22 13:58:37 +0100818#ifdef NC_ENABLED_TLS
Radek Krejci695d4fa2015-10-22 13:23:54 +0200819 case NC_TI_OPENSSL:
Michal Vasko4d57e1b2018-03-21 12:21:25 +0100820 /* remember sock so we can close it */
821 sock = SSL_get_fd(session->ti.tls);
822
Michal Vasko428087d2016-01-14 16:04:28 +0100823 if (connected) {
824 SSL_shutdown(session->ti.tls);
825 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200826 SSL_free(session->ti.tls);
Michal Vasko06e22432016-01-15 10:30:06 +0100827
Michal Vasko2e6defd2016-10-07 15:48:15 +0200828 if (session->side == NC_SERVER) {
829 X509_free(session->opts.server.client_cert);
830 }
Radek Krejci695d4fa2015-10-22 13:23:54 +0200831 break;
832#endif
Michal Vasko428087d2016-01-14 16:04:28 +0100833 case NC_TI_NONE:
Michal Vasko428087d2016-01-14 16:04:28 +0100834 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +0200835 }
Michal Vasko428087d2016-01-14 16:04:28 +0100836
Michal Vasko4d57e1b2018-03-21 12:21:25 +0100837 /* close socket separately */
838 if (sock > -1) {
839 close(sock);
840 }
841
Radek Krejciac6d3472015-10-22 15:47:18 +0200842 lydict_remove(session->ctx, session->username);
843 lydict_remove(session->ctx, session->host);
Olivier Matzac7fa2f2018-10-11 10:02:04 +0200844 lydict_remove(session->ctx, session->path);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200845
846 /* final cleanup */
Michal Vaskoacf98472021-02-04 15:33:57 +0100847 if (session->side == NC_SERVER) {
Michal Vasko131120a2018-05-29 15:44:02 +0200848 if (rpc_locked) {
849 nc_session_rpc_unlock(session, NC_SESSION_LOCK_TIMEOUT, __func__);
Michal Vasko9e99f012016-03-03 13:25:20 +0100850 }
Michal Vaskoacf98472021-02-04 15:33:57 +0100851 pthread_mutex_destroy(&session->opts.server.rpc_lock);
852 pthread_cond_destroy(&session->opts.server.rpc_cond);
Michal Vasko131120a2018-05-29 15:44:02 +0200853 }
854
855 if (session->io_lock && !multisession) {
856 pthread_mutex_destroy(session->io_lock);
857 free(session->io_lock);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200858 }
859
860 if (!(session->flags & NC_SESSION_SHAREDCTX)) {
Radek Krejci4ba285b2016-02-04 17:34:06 +0100861 ly_ctx_destroy(session->ctx, NULL);
Radek Krejci695d4fa2015-10-22 13:23:54 +0200862 }
863
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200864 if (session->side == NC_SERVER) {
Michal Vaskoacf98472021-02-04 15:33:57 +0100865 /* free CH synchronization structures */
866 pthread_cond_destroy(&session->opts.server.ch_cond);
867 pthread_mutex_destroy(&session->opts.server.ch_lock);
Michal Vaskoc4bc5812016-10-13 10:59:36 +0200868 }
869
Radek Krejci695d4fa2015-10-22 13:23:54 +0200870 free(session);
871}
872
Michal Vasko086311b2016-01-08 09:53:11 +0100873static void
874add_cpblt(struct ly_ctx *ctx, const char *capab, const char ***cpblts, int *size, int *count)
875{
Radek Krejci658782b2016-12-04 22:04:55 +0100876 size_t len;
877 int i;
878 char *p;
879
880 if (capab) {
881 /* check if already present */
882 p = strchr(capab, '?');
883 if (p) {
884 len = p - capab;
885 } else {
886 len = strlen(capab);
887 }
888 for (i = 0; i < *count; i++) {
fanchanghu5244bf42017-03-13 16:27:48 +0800889 if (!strncmp((*cpblts)[i], capab, len) && ((*cpblts)[i][len] == '\0' || (*cpblts)[i][len] == '?')) {
Radek Krejci658782b2016-12-04 22:04:55 +0100890 /* already present, do not duplicate it */
891 return;
892 }
893 }
894 }
895
896 /* add another capability */
Michal Vasko086311b2016-01-08 09:53:11 +0100897 if (*count == *size) {
898 *size += 5;
Michal Vasko4eb3c312016-03-01 14:09:37 +0100899 *cpblts = nc_realloc(*cpblts, *size * sizeof **cpblts);
900 if (!(*cpblts)) {
901 ERRMEM;
902 return;
903 }
Michal Vasko086311b2016-01-08 09:53:11 +0100904 }
905
906 if (capab) {
907 (*cpblts)[*count] = lydict_insert(ctx, capab, 0);
908 } else {
909 (*cpblts)[*count] = NULL;
910 }
911 ++(*count);
912}
913
Michal Vaskodafdc742020-03-11 16:15:59 +0100914static struct lys_feature *
915nc_lys_next_feature(struct lys_feature *last, const struct lys_module *ly_mod, int *idx)
916{
917 uint8_t i;
918
919 assert(ly_mod);
920
921 /* find the (sub)module of the last feature */
922 if (last) {
923 for (i = 0; i < ly_mod->inc_size; ++i) {
924 if (*idx >= ly_mod->inc[i].submodule->features_size) {
925 /* not a feature from this submodule, skip */
926 continue;
927 }
928 if (last != ly_mod->inc[i].submodule->features + *idx) {
929 /* feature is not from this submodule */
930 continue;
931 }
932
933 /* we have found the submodule */
934 break;
935 }
936
937 /* feature not found in submodules, it must be in the main module */
938 assert((i < ly_mod->inc_size) || ((*idx < ly_mod->features_size) && (last == ly_mod->features + *idx)));
939
940 /* we want the next feature */
941 ++(*idx);
942 } else {
943 i = 0;
944 *idx = 0;
945 }
946
947 /* find the (sub)module of the next feature */
948 while ((i < ly_mod->inc_size) && (*idx == ly_mod->inc[i].submodule->features_size)) {
949 /* next submodule */
950 ++i;
951 *idx = 0;
952 }
953
954 /* get the next feature */
955 if (i < ly_mod->inc_size) {
956 last = ly_mod->inc[i].submodule->features + *idx;
957 } else if (*idx < ly_mod->features_size) {
958 last = ly_mod->features + *idx;
959 } else {
960 last = NULL;
961 }
962
963 return last;
964}
965
966
Michal Vasko4ffa3b22016-05-24 16:36:25 +0200967API const char **
Radek Krejci24a18412018-05-16 15:09:10 +0200968nc_server_get_cpblts_version(struct ly_ctx *ctx, LYS_VERSION version)
Michal Vasko086311b2016-01-08 09:53:11 +0100969{
Michal Vaskod5ada122020-03-19 18:28:06 +0100970 const char **cpblts;
Radek Krejci24a18412018-05-16 15:09:10 +0200971 const struct lys_module *mod, *devmod;
Michal Vaskodafdc742020-03-11 16:15:59 +0100972 struct lys_feature *feat;
Radek Krejci24a18412018-05-16 15:09:10 +0200973 int size = 10, count, features_count = 0, dev_count = 0, i, str_len, len;
974 unsigned int u, v, module_set_id;
975 char *s;
976#define NC_CPBLT_BUF_LEN 4096
Michal Vasko2e47ef92016-06-20 10:03:24 +0200977 char str[NC_CPBLT_BUF_LEN];
Michal Vasko086311b2016-01-08 09:53:11 +0100978
Michal Vasko4ffa3b22016-05-24 16:36:25 +0200979 if (!ctx) {
980 ERRARG("ctx");
981 return NULL;
982 }
983
Michal Vasko086311b2016-01-08 09:53:11 +0100984 cpblts = malloc(size * sizeof *cpblts);
Michal Vasko4eb3c312016-03-01 14:09:37 +0100985 if (!cpblts) {
986 ERRMEM;
Radek Krejcif906e412017-09-22 14:44:45 +0200987 goto error;
Michal Vasko4eb3c312016-03-01 14:09:37 +0100988 }
Michal Vasko086311b2016-01-08 09:53:11 +0100989 cpblts[0] = lydict_insert(ctx, "urn:ietf:params:netconf:base:1.0", 0);
990 cpblts[1] = lydict_insert(ctx, "urn:ietf:params:netconf:base:1.1", 0);
991 count = 2;
992
993 /* capabilities */
994
Radek Krejci3222b7d2017-09-21 16:04:30 +0200995 mod = ly_ctx_get_module(ctx, "ietf-netconf", NULL, 1);
Michal Vasko086311b2016-01-08 09:53:11 +0100996 if (mod) {
997 if (lys_features_state(mod, "writable-running") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +0100998 add_cpblt(ctx, "urn:ietf:params:netconf:capability:writable-running:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +0100999 }
1000 if (lys_features_state(mod, "candidate") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001001 add_cpblt(ctx, "urn:ietf:params:netconf:capability:candidate:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001002 if (lys_features_state(mod, "confirmed-commit") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001003 add_cpblt(ctx, "urn:ietf:params:netconf:capability:confirmed-commit:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001004 }
1005 }
1006 if (lys_features_state(mod, "rollback-on-error") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001007 add_cpblt(ctx, "urn:ietf:params:netconf:capability:rollback-on-error:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001008 }
1009 if (lys_features_state(mod, "validate") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001010 add_cpblt(ctx, "urn:ietf:params:netconf:capability:validate:1.1", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001011 }
1012 if (lys_features_state(mod, "startup") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001013 add_cpblt(ctx, "urn:ietf:params:netconf:capability:startup:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001014 }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001015
1016 /* The URL capability must be set manually using nc_server_set_capability()
1017 * because of the need for supported protocols to be included.
1018 * https://tools.ietf.org/html/rfc6241#section-8.8.3
1019 */
mekleoa8de5e92020-02-13 09:05:56 +01001020 // if (lys_features_state(mod, "url") == 1) {
1021 // add_cpblt(ctx, "urn:ietf:params:netconf:capability:url:1.0", &cpblts, &size, &count);
1022 // }
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001023
Michal Vasko086311b2016-01-08 09:53:11 +01001024 if (lys_features_state(mod, "xpath") == 1) {
Michal Vasko3031aae2016-01-27 16:07:18 +01001025 add_cpblt(ctx, "urn:ietf:params:netconf:capability:xpath:1.0", &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001026 }
1027 }
1028
Radek Krejci3222b7d2017-09-21 16:04:30 +02001029 mod = ly_ctx_get_module(ctx, "ietf-netconf-with-defaults", NULL, 1);
Michal Vasko086311b2016-01-08 09:53:11 +01001030 if (mod) {
1031 if (!server_opts.wd_basic_mode) {
1032 VRB("with-defaults capability will not be advertised even though \"ietf-netconf-with-defaults\" model is present, unknown basic-mode.");
1033 } else {
Michal Vasko3031aae2016-01-27 16:07:18 +01001034 strcpy(str, "urn:ietf:params:netconf:capability:with-defaults:1.0");
Michal Vasko086311b2016-01-08 09:53:11 +01001035 switch (server_opts.wd_basic_mode) {
1036 case NC_WD_ALL:
1037 strcat(str, "?basic-mode=report-all");
1038 break;
1039 case NC_WD_TRIM:
1040 strcat(str, "?basic-mode=trim");
1041 break;
1042 case NC_WD_EXPLICIT:
1043 strcat(str, "?basic-mode=explicit");
1044 break;
1045 default:
Michal Vasko9e036d52016-01-08 10:49:26 +01001046 ERRINT;
Michal Vasko086311b2016-01-08 09:53:11 +01001047 break;
1048 }
1049
1050 if (server_opts.wd_also_supported) {
Michal Vasko2e47ef92016-06-20 10:03:24 +02001051 strcat(str, "&also-supported=");
Michal Vasko086311b2016-01-08 09:53:11 +01001052 if (server_opts.wd_also_supported & NC_WD_ALL) {
1053 strcat(str, "report-all,");
1054 }
1055 if (server_opts.wd_also_supported & NC_WD_ALL_TAG) {
1056 strcat(str, "report-all-tagged,");
1057 }
1058 if (server_opts.wd_also_supported & NC_WD_TRIM) {
1059 strcat(str, "trim,");
1060 }
1061 if (server_opts.wd_also_supported & NC_WD_EXPLICIT) {
1062 strcat(str, "explicit,");
1063 }
1064 str[strlen(str) - 1] = '\0';
1065
1066 add_cpblt(ctx, str, &cpblts, &size, &count);
1067 }
1068 }
1069 }
1070
Radek Krejci658782b2016-12-04 22:04:55 +01001071 /* other capabilities */
1072 for (u = 0; u < server_opts.capabilities_count; u++) {
1073 add_cpblt(ctx, server_opts.capabilities[u], &cpblts, &size, &count);
Michal Vasko086311b2016-01-08 09:53:11 +01001074 }
1075
1076 /* models */
Radek Krejci24a18412018-05-16 15:09:10 +02001077 u = module_set_id = 0;
1078 while ((mod = ly_ctx_get_module_iter(ctx, &u))) {
Radek Krejci24a18412018-05-16 15:09:10 +02001079 if (!strcmp(mod->name, "ietf-yang-library")) {
Michal Vaskod5ada122020-03-19 18:28:06 +01001080 if (!mod->rev_size || (strcmp(mod->rev[0].date, "2016-06-21") && strcmp(mod->rev[0].date, "2019-01-04"))) {
1081 ERR("Unknown \"ietf-yang-library\" revision, only 2016-06-21 and 2019-01-04 are supported.");
1082 goto error;
Michal Vaskof0fba4e2020-02-14 17:15:31 +01001083 }
Michal Vaskod5ada122020-03-19 18:28:06 +01001084
Michal Vaskod5ada122020-03-19 18:28:06 +01001085 if (!strcmp(mod->rev[0].date, "2019-01-04")) {
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001086 /* new one (capab defined in RFC 8526 section 2) */
Michal Vaskod5ada122020-03-19 18:28:06 +01001087 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.1?revision=%s&content-id=%u",
1088 mod->rev[0].date, ly_ctx_get_module_set_id(ctx));
1089 add_cpblt(ctx, str, &cpblts, &size, &count);
Michal Vasko7b5e3d92020-04-08 14:40:31 +02001090 } else {
1091 /* old one (capab defined in RFC 7950 section 5.6.4) */
1092 sprintf(str, "urn:ietf:params:netconf:capability:yang-library:1.0?revision=%s&module-set-id=%u",
1093 mod->rev[0].date, ly_ctx_get_module_set_id(ctx));
1094 add_cpblt(ctx, str, &cpblts, &size, &count);
Michal Vaskod5ada122020-03-19 18:28:06 +01001095 }
Radek Krejci24a18412018-05-16 15:09:10 +02001096 continue;
1097 } else if (mod->type) {
1098 /* skip submodules */
1099 continue;
1100 } else if (version == LYS_VERSION_1 && mod->version > version) {
1101 /* skip YANG 1.1 schemas */
1102 continue;
1103 } else if (version == LYS_VERSION_1_1 && mod->version != version) {
1104 /* skip YANG 1.0 schemas */
1105 continue;
1106 }
Michal Vasko086311b2016-01-08 09:53:11 +01001107
Radek Krejci24a18412018-05-16 15:09:10 +02001108 str_len = sprintf(str, "%s?module=%s%s%s", mod->ns, mod->name,
1109 mod->rev_size ? "&revision=" : "", mod->rev_size ? mod->rev[0].date : "");
1110
Michal Vaskodafdc742020-03-11 16:15:59 +01001111 features_count = 0;
1112 i = 0;
1113 feat = NULL;
1114 while ((feat = nc_lys_next_feature(feat, mod, &i))) {
1115 if (!(feat->flags & LYS_FENABLED)) {
1116 continue;
Michal Vaskoe90e4d12016-06-20 10:05:01 +02001117 }
Michal Vaskodafdc742020-03-11 16:15:59 +01001118 if (!features_count) {
1119 strcat(str, "&features=");
1120 str_len += 10;
1121 }
1122 len = strlen(feat->name);
1123 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1124 ERRINT;
1125 break;
1126 }
1127 if (features_count) {
1128 strcat(str, ",");
1129 ++str_len;
1130 }
1131 strcat(str, feat->name);
1132 str_len += len;
1133 features_count++;
Michal Vasko086311b2016-01-08 09:53:11 +01001134 }
Michal Vasko086311b2016-01-08 09:53:11 +01001135
Radek Krejci24a18412018-05-16 15:09:10 +02001136 if (mod->deviated) {
1137 strcat(str, "&deviations=");
1138 str_len += 12;
1139 dev_count = 0;
Frank Rimplercb9274f2019-03-13 16:40:34 +00001140 v = 0;
Radek Krejci24a18412018-05-16 15:09:10 +02001141 while ((devmod = ly_ctx_get_module_iter(ctx, &v))) {
1142 if (devmod == mod) {
1143 continue;
1144 }
1145
1146 for (i = 0; i < devmod->deviation_size; ++i) {
1147 s = strstr(devmod->deviation[i].target_name, mod->name);
1148 if (s && s[strlen(mod->name)] == ':') {
1149 /* we have the module deviating the module being processed */
1150 len = strlen(devmod->name);
1151 if (str_len + 1 + len >= NC_CPBLT_BUF_LEN) {
1152 ERRINT;
1153 break;
1154 }
1155 if (dev_count) {
1156 strcat(str, ",");
1157 ++str_len;
1158 }
1159 strcat(str, devmod->name);
1160 str_len += len;
1161 dev_count++;
1162
1163 break;
1164 }
1165 }
1166 }
1167 }
1168
1169 add_cpblt(ctx, str, &cpblts, &size, &count);
1170 }
Michal Vasko086311b2016-01-08 09:53:11 +01001171
1172 /* ending NULL capability */
1173 add_cpblt(ctx, NULL, &cpblts, &size, &count);
1174
1175 return cpblts;
Radek Krejcif906e412017-09-22 14:44:45 +02001176
1177error:
Radek Krejcif906e412017-09-22 14:44:45 +02001178 free(cpblts);
Radek Krejcif906e412017-09-22 14:44:45 +02001179 return NULL;
Michal Vasko086311b2016-01-08 09:53:11 +01001180}
1181
Radek Krejci24a18412018-05-16 15:09:10 +02001182API const char **
1183nc_server_get_cpblts(struct ly_ctx *ctx)
1184{
1185 return nc_server_get_cpblts_version(ctx, LYS_VERSION_UNDEF);
1186}
1187
Radek Krejci695d4fa2015-10-22 13:23:54 +02001188static int
Michal Vasko2cb24b42017-05-23 14:59:11 +02001189parse_cpblts(struct lyxml_elem *xml, char ***list)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001190{
1191 struct lyxml_elem *cpblt;
Michal Vasko156d3272017-04-11 11:46:49 +02001192 int ver = -1, i = 0;
1193 const char *cpb_start, *cpb_end;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001194
1195 if (list) {
1196 /* get the storage for server's capabilities */
1197 LY_TREE_FOR(xml->child, cpblt) {
1198 i++;
1199 }
Michal Vasko9e2d3a32015-11-10 13:09:18 +01001200 /* last item remains NULL */
1201 *list = calloc(i + 1, sizeof **list);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001202 if (!*list) {
1203 ERRMEM;
1204 return -1;
1205 }
1206 i = 0;
1207 }
1208
1209 LY_TREE_FOR(xml->child, cpblt) {
Michal Vasko5ce6d7d2018-10-12 09:33:33 +02001210 if (cpblt->name && strcmp(cpblt->name, "capability") && cpblt->ns && cpblt->ns->value &&
Radek Krejci695d4fa2015-10-22 13:23:54 +02001211 !strcmp(cpblt->ns->value, NC_NS_BASE)) {
1212 ERR("Unexpected <%s> element in client's <hello>.", cpblt->name);
1213 return -1;
Michal Vasko5ce6d7d2018-10-12 09:33:33 +02001214 } else if (!cpblt->name || !cpblt->ns || !cpblt->ns->value || strcmp(cpblt->ns->value, NC_NS_BASE)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001215 continue;
1216 }
1217
Michal Vasko156d3272017-04-11 11:46:49 +02001218 /* skip leading/trailing whitespaces */
1219 for (cpb_start = cpblt->content; isspace(cpb_start[0]); ++cpb_start);
1220 for (cpb_end = cpblt->content + strlen(cpblt->content); (cpb_end > cpblt->content) && isspace(cpb_end[-1]); --cpb_end);
1221 if (!cpb_start[0] || (cpb_end == cpblt->content)) {
1222 ERR("Empty capability \"%s\" received.", cpblt->content);
1223 return -1;
1224 }
1225
Radek Krejci695d4fa2015-10-22 13:23:54 +02001226 /* detect NETCONF version */
Michal Vasko156d3272017-04-11 11:46:49 +02001227 if (ver < 0 && !strncmp(cpb_start, "urn:ietf:params:netconf:base:1.0", cpb_end - cpb_start)) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001228 ver = 0;
Michal Vasko156d3272017-04-11 11:46:49 +02001229 } 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 +02001230 ver = 1;
1231 }
1232
1233 /* store capabilities */
1234 if (list) {
Michal Vasko156d3272017-04-11 11:46:49 +02001235 (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
1236 if (!(*list)[i]) {
1237 ERRMEM;
1238 return -1;
1239 }
Radek Krejci695d4fa2015-10-22 13:23:54 +02001240 i++;
1241 }
1242 }
1243
1244 if (ver == -1) {
Michal Vaskod083db62016-01-19 10:31:29 +01001245 ERR("Peer does not support a compatible NETCONF version.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001246 }
1247
1248 return ver;
1249}
1250
1251static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001252nc_send_hello_io(struct nc_session *session)
Michal Vasko086311b2016-01-08 09:53:11 +01001253{
Michal Vasko131120a2018-05-29 15:44:02 +02001254 NC_MSG_TYPE ret;
1255 int i, io_timeout;
Michal Vasko086311b2016-01-08 09:53:11 +01001256 const char **cpblts;
Michal Vasko131120a2018-05-29 15:44:02 +02001257 uint32_t *sid;
Michal Vasko086311b2016-01-08 09:53:11 +01001258
Michal Vasko131120a2018-05-29 15:44:02 +02001259 if (session->side == NC_CLIENT) {
1260 /* client side hello - send only NETCONF base capabilities */
1261 cpblts = malloc(3 * sizeof *cpblts);
1262 if (!cpblts) {
1263 ERRMEM;
1264 return NC_MSG_ERROR;
1265 }
1266 cpblts[0] = lydict_insert(session->ctx, "urn:ietf:params:netconf:base:1.0", 0);
1267 cpblts[1] = lydict_insert(session->ctx, "urn:ietf:params:netconf:base:1.1", 0);
1268 cpblts[2] = NULL;
1269
1270 io_timeout = NC_CLIENT_HELLO_TIMEOUT * 1000;
1271 sid = NULL;
1272 } else {
1273 cpblts = nc_server_get_cpblts_version(session->ctx, LYS_VERSION_1);
Michal Vasko5b24b6b2020-12-04 09:29:47 +01001274 if (!cpblts) {
1275 return NC_MSG_ERROR;
1276 }
Michal Vasko131120a2018-05-29 15:44:02 +02001277
1278 io_timeout = NC_SERVER_HELLO_TIMEOUT * 1000;
1279 sid = &session->id;
Michal Vasko4eb3c312016-03-01 14:09:37 +01001280 }
Michal Vasko05ba9df2016-01-13 14:40:27 +01001281
Michal Vasko131120a2018-05-29 15:44:02 +02001282 ret = nc_write_msg_io(session, io_timeout, NC_MSG_HELLO, cpblts, sid);
Michal Vasko086311b2016-01-08 09:53:11 +01001283
Michal Vasko086311b2016-01-08 09:53:11 +01001284 for (i = 0; cpblts[i]; ++i) {
1285 lydict_remove(session->ctx, cpblts[i]);
1286 }
1287 free(cpblts);
1288
Michal Vasko131120a2018-05-29 15:44:02 +02001289 return ret;
Michal Vasko086311b2016-01-08 09:53:11 +01001290}
1291
1292static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001293nc_recv_client_hello_io(struct nc_session *session)
Radek Krejci695d4fa2015-10-22 13:23:54 +02001294{
1295 struct lyxml_elem *xml = NULL, *node;
Michal Vasko131120a2018-05-29 15:44:02 +02001296 NC_MSG_TYPE msgtype;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001297 int ver = -1;
1298 char *str;
1299 long long int id;
1300 int flag = 0;
1301
Michal Vasko131120a2018-05-29 15:44:02 +02001302 msgtype = nc_read_msg_poll_io(session, NC_CLIENT_HELLO_TIMEOUT * 1000, &xml);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001303
Michal Vasko131120a2018-05-29 15:44:02 +02001304 switch (msgtype) {
Radek Krejci695d4fa2015-10-22 13:23:54 +02001305 case NC_MSG_HELLO:
1306 /* parse <hello> data */
Michal Vasko11d142a2016-01-19 15:58:24 +01001307 LY_TREE_FOR(xml->child, node) {
1308 if (!node->ns || !node->ns->value || strcmp(node->ns->value, NC_NS_BASE)) {
1309 continue;
1310 } else if (!strcmp(node->name, "session-id")) {
1311 if (!node->content || !strlen(node->content)) {
1312 ERR("No value of <session-id> element in server's <hello>.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001313 goto error;
1314 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001315 str = NULL;
1316 id = strtoll(node->content, &str, 10);
1317 if (*str || id < 1 || id > UINT32_MAX) {
1318 ERR("Invalid value of <session-id> element in server's <hello>.");
Radek Krejci695d4fa2015-10-22 13:23:54 +02001319 goto error;
1320 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001321 session->id = (uint32_t)id;
1322 continue;
1323 } else if (strcmp(node->name, "capabilities")) {
1324 ERR("Unexpected <%s> element in client's <hello>.", node->name);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001325 goto error;
1326 }
Michal Vasko11d142a2016-01-19 15:58:24 +01001327
1328 if (flag) {
1329 /* multiple capabilities elements */
1330 ERR("Invalid <hello> message (multiple <capabilities> elements).");
1331 goto error;
1332 }
1333 flag = 1;
1334
Michal Vasko2e6defd2016-10-07 15:48:15 +02001335 if ((ver = parse_cpblts(node, &session->opts.client.cpblts)) < 0) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001336 goto error;
1337 }
1338 session->version = ver;
1339 }
1340
1341 if (!session->id) {
1342 ERR("Missing <session-id> in server's <hello>.");
1343 goto error;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001344 }
1345 break;
Michal Vasko71090fc2016-05-24 16:37:28 +02001346 case NC_MSG_WOULDBLOCK:
1347 ERR("Server's <hello> timeout elapsed.");
1348 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001349 case NC_MSG_ERROR:
1350 /* nothing special, just pass it out */
1351 break;
1352 default:
1353 ERR("Unexpected message received instead of <hello>.");
1354 msgtype = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001355 break;
Radek Krejci695d4fa2015-10-22 13:23:54 +02001356 }
1357
1358 /* cleanup */
Michal Vaskoad611702015-12-03 13:41:51 +01001359 lyxml_free(session->ctx, xml);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001360
1361 return msgtype;
1362
1363error:
1364 /* cleanup */
Michal Vaskoad611702015-12-03 13:41:51 +01001365 lyxml_free(session->ctx, xml);
Radek Krejci695d4fa2015-10-22 13:23:54 +02001366
1367 return NC_MSG_ERROR;
Radek Krejci5686ff72015-10-09 13:33:56 +02001368}
1369
Michal Vasko11d142a2016-01-19 15:58:24 +01001370static NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001371nc_recv_server_hello_io(struct nc_session *session)
Michal Vasko11d142a2016-01-19 15:58:24 +01001372{
1373 struct lyxml_elem *xml = NULL, *node;
Michal Vasko71090fc2016-05-24 16:37:28 +02001374 NC_MSG_TYPE msgtype;
Michal Vasko11d142a2016-01-19 15:58:24 +01001375 int ver = -1;
1376 int flag = 0;
1377
Michal Vasko131120a2018-05-29 15:44:02 +02001378 msgtype = nc_read_msg_poll_io(session, (server_opts.hello_timeout ?
1379 server_opts.hello_timeout * 1000 : NC_SERVER_HELLO_TIMEOUT * 1000), &xml);
Michal Vasko11d142a2016-01-19 15:58:24 +01001380
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001381 switch (msgtype) {
Michal Vasko11d142a2016-01-19 15:58:24 +01001382 case NC_MSG_HELLO:
1383 /* get know NETCONF version */
1384 LY_TREE_FOR(xml->child, node) {
1385 if (!node->ns || !node->ns->value || strcmp(node->ns->value, NC_NS_BASE)) {
1386 continue;
1387 } else if (strcmp(node->name, "capabilities")) {
1388 ERR("Unexpected <%s> element in client's <hello>.", node->name);
Michal Vasko71090fc2016-05-24 16:37:28 +02001389 msgtype = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001390 goto cleanup;
1391 }
1392
1393 if (flag) {
1394 /* multiple capabilities elements */
1395 ERR("Invalid <hello> message (multiple <capabilities> elements).");
Michal Vasko71090fc2016-05-24 16:37:28 +02001396 msgtype = NC_MSG_BAD_HELLO;
Michal Vasko11d142a2016-01-19 15:58:24 +01001397 goto cleanup;
1398 }
1399 flag = 1;
1400
1401 if ((ver = parse_cpblts(node, NULL)) < 0) {
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 session->version = ver;
1406 }
1407 break;
1408 case NC_MSG_ERROR:
1409 /* nothing special, just pass it out */
1410 break;
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001411 case NC_MSG_WOULDBLOCK:
1412 ERR("Client's <hello> timeout elapsed.");
Michal Vasko5e6f4cc2016-01-20 13:27:44 +01001413 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001414 default:
1415 ERR("Unexpected message received instead of <hello>.");
1416 msgtype = NC_MSG_ERROR;
Michal Vasko71090fc2016-05-24 16:37:28 +02001417 break;
Michal Vasko11d142a2016-01-19 15:58:24 +01001418 }
1419
1420cleanup:
Michal Vasko11d142a2016-01-19 15:58:24 +01001421 lyxml_free(session->ctx, xml);
Michal Vasko11d142a2016-01-19 15:58:24 +01001422 return msgtype;
1423}
1424
Michal Vasko71090fc2016-05-24 16:37:28 +02001425NC_MSG_TYPE
Michal Vasko131120a2018-05-29 15:44:02 +02001426nc_handshake_io(struct nc_session *session)
Michal Vasko80cad7f2015-12-08 14:42:27 +01001427{
Michal Vasko086311b2016-01-08 09:53:11 +01001428 NC_MSG_TYPE type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001429
Michal Vasko131120a2018-05-29 15:44:02 +02001430 type = nc_send_hello_io(session);
Michal Vasko086311b2016-01-08 09:53:11 +01001431 if (type != NC_MSG_HELLO) {
Michal Vasko71090fc2016-05-24 16:37:28 +02001432 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001433 }
1434
Michal Vasko11d142a2016-01-19 15:58:24 +01001435 if (session->side == NC_CLIENT) {
Michal Vasko131120a2018-05-29 15:44:02 +02001436 type = nc_recv_client_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001437 } else {
Michal Vasko131120a2018-05-29 15:44:02 +02001438 type = nc_recv_server_hello_io(session);
Michal Vasko11d142a2016-01-19 15:58:24 +01001439 }
1440
Michal Vasko71090fc2016-05-24 16:37:28 +02001441 return type;
Michal Vasko80cad7f2015-12-08 14:42:27 +01001442}
Michal Vasko086311b2016-01-08 09:53:11 +01001443
Michal Vasko889162e2019-09-06 14:43:37 +02001444#ifdef NC_ENABLED_SSH
1445
Michal Vasko999b64a2019-07-10 16:06:15 +02001446static void
1447nc_ssh_init(void)
1448{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001449#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
Michal Vasko999b64a2019-07-10 16:06:15 +02001450 ssh_threads_set_callbacks(ssh_threads_get_pthread());
1451 ssh_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001452#endif
Michal Vasko999b64a2019-07-10 16:06:15 +02001453}
1454
1455static void
1456nc_ssh_destroy(void)
1457{
Michal Vaskoe1e82632019-09-09 09:18:03 +02001458#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko999b64a2019-07-10 16:06:15 +02001459 FIPS_mode_set(0);
1460 CONF_modules_unload(1);
1461 nc_thread_destroy();
Michal Vasko889162e2019-09-06 14:43:37 +02001462#endif
1463
Michal Vaskoe1e82632019-09-09 09:18:03 +02001464#if (LIBSSH_VERSION_INT < SSH_VERSION_INT(0, 8, 0))
1465 ssh_finalize();
1466#endif
1467}
1468
Michal Vasko889162e2019-09-06 14:43:37 +02001469#endif /* NC_ENABLED_SSH */
Michal Vasko999b64a2019-07-10 16:06:15 +02001470
Radek Krejci53691be2016-02-22 13:58:37 +01001471#ifdef NC_ENABLED_TLS
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001472
Michal Vasko770b4362017-02-17 14:44:18 +01001473#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1474
Michal Vaskof0c92c02016-01-29 09:41:45 +01001475struct CRYPTO_dynlock_value {
1476 pthread_mutex_t lock;
1477};
1478
Michal Vaskof0c92c02016-01-29 09:41:45 +01001479static struct CRYPTO_dynlock_value *
1480tls_dyn_create_func(const char *UNUSED(file), int UNUSED(line))
1481{
1482 struct CRYPTO_dynlock_value *value;
1483
1484 value = malloc(sizeof *value);
1485 if (!value) {
1486 ERRMEM;
1487 return NULL;
1488 }
1489 pthread_mutex_init(&value->lock, NULL);
1490
1491 return value;
1492}
1493
1494static void
1495tls_dyn_lock_func(int mode, struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1496{
1497 /* mode can also be CRYPTO_READ or CRYPTO_WRITE, but all the examples
1498 * I found ignored this fact, what do I know... */
1499 if (mode & CRYPTO_LOCK) {
1500 pthread_mutex_lock(&l->lock);
1501 } else {
1502 pthread_mutex_unlock(&l->lock);
1503 }
1504}
1505
1506static void
1507tls_dyn_destroy_func(struct CRYPTO_dynlock_value *l, const char *UNUSED(file), int UNUSED(line))
1508{
1509 pthread_mutex_destroy(&l->lock);
1510 free(l);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001511}
Michal Vasko770b4362017-02-17 14:44:18 +01001512#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001513
Michal Vasko8f0c0282016-02-29 10:17:14 +01001514#endif /* NC_ENABLED_TLS */
1515
1516#if defined(NC_ENABLED_TLS) && !defined(NC_ENABLED_SSH)
1517
Michal Vasko770b4362017-02-17 14:44:18 +01001518#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001519static pthread_mutex_t *tls_locks;
1520
1521static void
1522tls_thread_locking_func(int mode, int n, const char *UNUSED(file), int UNUSED(line))
1523{
1524 if (mode & CRYPTO_LOCK) {
1525 pthread_mutex_lock(tls_locks + n);
1526 } else {
1527 pthread_mutex_unlock(tls_locks + n);
1528 }
1529}
1530
1531static void
1532tls_thread_id_func(CRYPTO_THREADID *tid)
1533{
1534 CRYPTO_THREADID_set_numeric(tid, (unsigned long)pthread_self());
1535}
Michal Vasko770b4362017-02-17 14:44:18 +01001536#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001537
1538static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001539nc_tls_init(void)
1540{
Rosen Penev4f552d62019-06-26 16:10:43 -07001541#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001542 SSL_load_error_strings();
Michal Vasko7f1c78b2016-01-19 09:52:14 +01001543 ERR_load_BIO_strings();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001544 SSL_library_init();
1545
Michal Vaskof89948c2018-01-04 09:19:46 +01001546 int i;
1547
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001548 tls_locks = malloc(CRYPTO_num_locks() * sizeof *tls_locks);
Michal Vasko4eb3c312016-03-01 14:09:37 +01001549 if (!tls_locks) {
1550 ERRMEM;
1551 return;
1552 }
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001553 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1554 pthread_mutex_init(tls_locks + i, NULL);
1555 }
1556
Michal Vaskof0c92c02016-01-29 09:41:45 +01001557 CRYPTO_THREADID_set_callback(tls_thread_id_func);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001558 CRYPTO_set_locking_callback(tls_thread_locking_func);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001559
1560 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1561 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1562 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001563#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001564}
1565
Michal Vasko8f0c0282016-02-29 10:17:14 +01001566static void
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001567nc_tls_destroy(void)
1568{
Rosen Penev4f552d62019-06-26 16:10:43 -07001569#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko8f0c0282016-02-29 10:17:14 +01001570 FIPS_mode_set(0);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001571 CRYPTO_cleanup_all_ex_data();
Michal Vaskob6e37262016-02-25 14:49:00 +01001572 nc_thread_destroy();
Michal Vasko5e228792016-02-03 15:30:24 +01001573 EVP_cleanup();
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001574 ERR_free_strings();
Michal Vasko770b4362017-02-17 14:44:18 +01001575#if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001576 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vasko770b4362017-02-17 14:44:18 +01001577#elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1578 SSL_COMP_free_compression_methods();
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001579#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001580
Michal Vaskof89948c2018-01-04 09:19:46 +01001581 int i;
1582
Michal Vaskob6e37262016-02-25 14:49:00 +01001583 CRYPTO_THREADID_set_callback(NULL);
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001584 CRYPTO_set_locking_callback(NULL);
1585 for (i = 0; i < CRYPTO_num_locks(); ++i) {
1586 pthread_mutex_destroy(tls_locks + i);
1587 }
1588 free(tls_locks);
Michal Vaskof0c92c02016-01-29 09:41:45 +01001589
1590 CRYPTO_set_dynlock_create_callback(NULL);
1591 CRYPTO_set_dynlock_lock_callback(NULL);
1592 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001593#endif
Michal Vaskoc14e3c82016-01-11 16:14:30 +01001594}
1595
Michal Vasko8f0c0282016-02-29 10:17:14 +01001596#endif /* NC_ENABLED_TLS && !NC_ENABLED_SSH */
Michal Vasko5e228792016-02-03 15:30:24 +01001597
Radek Krejci53691be2016-02-22 13:58:37 +01001598#if defined(NC_ENABLED_SSH) && defined(NC_ENABLED_TLS)
Michal Vasko5e228792016-02-03 15:30:24 +01001599
Michal Vasko8f0c0282016-02-29 10:17:14 +01001600static void
Michal Vasko5e228792016-02-03 15:30:24 +01001601nc_ssh_tls_init(void)
1602{
Rosen Penev4f552d62019-06-26 16:10:43 -07001603#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001604 SSL_load_error_strings();
1605 ERR_load_BIO_strings();
1606 SSL_library_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001607#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001608
1609 nc_ssh_init();
1610
Michal Vaskoe1e82632019-09-09 09:18:03 +02001611#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001612 CRYPTO_set_dynlock_create_callback(tls_dyn_create_func);
1613 CRYPTO_set_dynlock_lock_callback(tls_dyn_lock_func);
1614 CRYPTO_set_dynlock_destroy_callback(tls_dyn_destroy_func);
Michal Vasko770b4362017-02-17 14:44:18 +01001615#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001616}
1617
Michal Vasko8f0c0282016-02-29 10:17:14 +01001618static void
Michal Vasko5e228792016-02-03 15:30:24 +01001619nc_ssh_tls_destroy(void)
1620{
Rosen Penev4f552d62019-06-26 16:10:43 -07001621#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001622 ERR_free_strings();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001623# if OPENSSL_VERSION_NUMBER < 0x10002000L // < 1.0.2
Michal Vasko5e228792016-02-03 15:30:24 +01001624 sk_SSL_COMP_free(SSL_COMP_get_compression_methods());
Michal Vaskoe1e82632019-09-09 09:18:03 +02001625# elif OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko770b4362017-02-17 14:44:18 +01001626 SSL_COMP_free_compression_methods();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001627# endif
Jan Kundrát47e9e1a2016-11-21 09:41:59 +01001628#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001629
1630 nc_ssh_destroy();
1631
Michal Vaskoe1e82632019-09-09 09:18:03 +02001632#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
Michal Vasko5e228792016-02-03 15:30:24 +01001633 CRYPTO_set_dynlock_create_callback(NULL);
1634 CRYPTO_set_dynlock_lock_callback(NULL);
1635 CRYPTO_set_dynlock_destroy_callback(NULL);
Michal Vasko770b4362017-02-17 14:44:18 +01001636#endif
Michal Vasko5e228792016-02-03 15:30:24 +01001637}
1638
Radek Krejci53691be2016-02-22 13:58:37 +01001639#endif /* NC_ENABLED_SSH && NC_ENABLED_TLS */
Michal Vasko8f0c0282016-02-29 10:17:14 +01001640
1641#if defined(NC_ENABLED_SSH) || defined(NC_ENABLED_TLS)
1642
1643API void
1644nc_thread_destroy(void)
1645{
Michal Vasko8f0c0282016-02-29 10:17:14 +01001646 /* caused data-races and seems not neccessary for avoiding valgrind reachable memory */
1647 //CRYPTO_cleanup_all_ex_data();
1648
Michal Vasko770b4362017-02-17 14:44:18 +01001649#if OPENSSL_VERSION_NUMBER < 0x10100000L // < 1.1.0
1650 CRYPTO_THREADID crypto_tid;
1651
Michal Vasko8f0c0282016-02-29 10:17:14 +01001652 CRYPTO_THREADID_current(&crypto_tid);
1653 ERR_remove_thread_state(&crypto_tid);
Michal Vasko770b4362017-02-17 14:44:18 +01001654#endif
Michal Vasko8f0c0282016-02-29 10:17:14 +01001655}
1656
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001657#endif /* NC_ENABLED_SSH || NC_ENABLED_TLS */
1658
1659void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001660nc_init(void)
1661{
1662#if defined(NC_ENABLED_SSH) && defined(NC_ENABLED_TLS)
1663 nc_ssh_tls_init();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001664#elif defined(NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001665 nc_ssh_init();
1666#elif defined(NC_ENABLED_TLS)
1667 nc_tls_init();
1668#endif
1669}
1670
Michal Vaskoa7b8ca52016-03-01 12:09:29 +01001671void
Michal Vasko8f0c0282016-02-29 10:17:14 +01001672nc_destroy(void)
1673{
1674#if defined(NC_ENABLED_SSH) && defined(NC_ENABLED_TLS)
1675 nc_ssh_tls_destroy();
Michal Vaskoe1e82632019-09-09 09:18:03 +02001676#elif defined(NC_ENABLED_SSH)
Michal Vasko8f0c0282016-02-29 10:17:14 +01001677 nc_ssh_destroy();
1678#elif defined(NC_ENABLED_TLS)
1679 nc_tls_destroy();
1680#endif
1681}