session BUGFIX store client capabilities as well

Author: michalvasko

src/session.c

@@ -4,7 +4,7 @@
  * @brief libnetconf2 - general session functions
  *
  * @copyright
- * Copyright (c) 2015 - 2023 CESNET, z.s.p.o.
+ * Copyright (c) 2015 - 2026 CESNET, z.s.p.o.
  *
  * This source code is licensed under BSD 3-Clause License (the "License").
  * You may not use this file except in compliance with the License.
@@ -663,6 +663,31 @@ nc_session_get_ctx(const struct nc_session *session)
     return session->ctx;
 }
 
+API const char * const *
+nc_session_get_cpblts(const struct nc_session *session)
+{
+    NC_CHECK_ARG_RET(session, session, NULL);
+
+    return (const char * const *)session->cpblts;
+}
+
+API const char *
+nc_session_cpblt(const struct nc_session *session, const char *capab)
+{
+    int i, len;
+
+    NC_CHECK_ARG_RET(session, session, capab, NULL);
+
+    len = strlen(capab);
+    for (i = 0; session->cpblts[i]; ++i) {
+        if (!strncmp(session->cpblts[i], capab, len)) {
+            return session->cpblts[i];
+        }
+    }
+
+    return NULL;
+}
+
 API void
 nc_session_set_data(struct nc_session *session, void *data)
 {
@@ -1106,15 +1131,11 @@ nc_session_free(struct nc_session *session, void (*data_free)(void *))
     free(session->username);
     free(session->host);
     free(session->path);
-
-    if (session->side == NC_CLIENT) {
-        /* list of server's capabilities */
-        if (session->opts.client.cpblts) {
-            for (i = 0; session->opts.client.cpblts[i]; i++) {
-                free(session->opts.client.cpblts[i]);
-            }
-            free(session->opts.client.cpblts);
+    if (session->cpblts) {
+        for (i = 0; session->cpblts[i]; i++) {
+            free(session->cpblts[i]);
         }
+        free(session->cpblts);
     }
 
     if (session->data && data_free) {
@@ -1440,24 +1461,30 @@ nc_server_get_cpblts(const struct ly_ctx *ctx)
     return _nc_server_get_cpblts_version(ctx, LYS_VERSION_UNDEF, 0);
 }
 
+/**
+ * @brief Parse received capabilities.
+ *
+ * @param[in] capabilities Opaque capability nodes.
+ * @param[out] list List of parsed capabilities terminated by NULL.
+ * @return NETCONF version;
+ * @return -1 on error.
+ */
 static int
-parse_cpblts(struct lyd_node *capabilities, char ***list)
+nc_parse_cpblts(struct lyd_node *capabilities, char ***list)
 {
     struct lyd_node *iter;
     struct lyd_node_opaq *cpblt;
     int ver = -1, i = 0;
     const char *cpb_start, *cpb_end;
 
-    if (list) {
-        /* get the storage for server's capabilities */
-        LY_LIST_FOR(lyd_child(capabilities), iter) {
-            i++;
-        }
-        /* last item remains NULL */
-        *list = calloc(i + 1, sizeof **list);
-        NC_CHECK_ERRMEM_RET(!*list, -1);
-        i = 0;
+    /* get the storage for capabilities */
+    LY_LIST_FOR(lyd_child(capabilities), iter) {
+        i++;
     }
+    /* last item remains NULL */
+    *list = calloc(i + 1, sizeof **list);
+    NC_CHECK_ERRMEM_RET(!*list, -1);
+    i = 0;
 
     LY_LIST_FOR(lyd_child(capabilities), iter) {
         cpblt = (struct lyd_node_opaq *)iter;
@@ -1483,11 +1510,9 @@ parse_cpblts(struct lyd_node *capabilities, char ***list)
         }
 
         /* store capabilities */
-        if (list) {
-            (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
-            NC_CHECK_ERRMEM_RET(!(*list)[i], -1);
-            i++;
-        }
+        (*list)[i] = strndup(cpb_start, cpb_end - cpb_start);
+        NC_CHECK_ERRMEM_RET(!(*list)[i], -1);
+        i++;
     }
 
     if (ver == -1) {
@@ -1644,7 +1669,7 @@ nc_client_recv_hello_io(struct nc_session *session)
             }
             flag = 1;
 
-            if ((ver = parse_cpblts(&node->node, &session->opts.client.cpblts)) < 0) {
+            if ((ver = nc_parse_cpblts(&node->node, &session->cpblts)) < 0) {
                 rc = NC_MSG_ERROR;
                 goto cleanup;
             }
@@ -1723,7 +1748,7 @@ nc_server_recv_hello_io(struct nc_session *session)
             }
             flag = 1;
 
-            if ((ver = parse_cpblts(&node->node, NULL)) < 0) {
+            if ((ver = nc_parse_cpblts(&node->node, &session->cpblts)) < 0) {
                 rc = NC_MSG_BAD_HELLO;
                 goto cleanup;
             }

src/session.h

@@ -217,6 +217,23 @@ const char *nc_session_get_path(const struct nc_session *session);
  */
 const struct ly_ctx *nc_session_get_ctx(const struct nc_session *session);
 
+/**
+ * @brief Get session capabilities.
+ *
+ * @param[in] session Session to get the information from.
+ * @return NULL-terminated array of the @p session capabilities.
+ */
+const char * const *nc_session_get_cpblts(const struct nc_session *session);
+
+/**
+ * @brief Check capability presence in a session.
+ *
+ * @param[in] session Session to check.
+ * @param[in] capab Capability to look for, capability with any additional suffix will match.
+ * @return Matching capability, NULL if none found.
+ */
+const char *nc_session_cpblt(const struct nc_session *session, const char *capab);
+
 /**
  * @brief Assign arbitrary data to a session.
  *

src/session_client.c

@@ -1217,7 +1217,7 @@ nc_ctx_check_and_fill(struct nc_session *session)
     char *revision;
     struct module_info *server_modules = NULL, *sm = NULL;
 
-    assert(session->opts.client.cpblts && session->ctx);
+    assert(session->cpblts && session->ctx);
 
     if (client_opts.auto_context_fill_disabled) {
         VRB(session, "Context of the new session is left only with the default YANG modules.");
@@ -1235,12 +1235,12 @@ nc_ctx_check_and_fill(struct nc_session *session)
     ly_ctx_set_module_imp_clb(session->ctx, NULL, NULL);
 
     /* check if get-schema and yang-library is supported */
-    for (i = 0; session->opts.client.cpblts[i]; ++i) {
-        if (!strncmp(session->opts.client.cpblts[i], "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?", 52)) {
+    for (i = 0; session->cpblts[i]; ++i) {
+        if (!strncmp(session->cpblts[i], "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?", 52)) {
             get_schema_support = 1 + i;
-        } else if (!strncmp(session->opts.client.cpblts[i], "urn:ietf:params:netconf:capability:yang-library:", 48)) {
+        } else if (!strncmp(session->cpblts[i], "urn:ietf:params:netconf:capability:yang-library:", 48)) {
             yanglib_support = 1 + i;
-        } else if (!strncmp(session->opts.client.cpblts[i], "urn:ietf:params:netconf:capability:xpath:1.0", 44)) {
+        } else if (!strncmp(session->cpblts[i], "urn:ietf:params:netconf:capability:xpath:1.0", 44)) {
             xpath_support = 1 + i;
         }
         /* NMDA is YANG 1.1 module, which is not present in the capabilities */
@@ -1250,7 +1250,7 @@ nc_ctx_check_and_fill(struct nc_session *session)
     VRB(session, "Capability for XPath filter support%s found.", xpath_support ? "" : " not");
 
     /* get information about server's modules from capabilities list until we will have yang-library */
-    if (build_module_info_cpblts(session->opts.client.cpblts, &server_modules) || !server_modules) {
+    if (build_module_info_cpblts(session->cpblts, &server_modules) || !server_modules) {
         ERR(session, "Unable to get server module information from the <hello>'s capabilities.");
         goto cleanup;
     }
@@ -1270,7 +1270,7 @@ nc_ctx_check_and_fill(struct nc_session *session)
     /* get correct version of ietf-yang-library into context */
     if (yanglib_support) {
         /* use get-schema to get server's ietf-yang-library */
-        revision = strstr(session->opts.client.cpblts[yanglib_support - 1], "revision=");
+        revision = strstr(session->cpblts[yanglib_support - 1], "revision=");
         if (!revision) {
             WRN(session, "Loading NETCONF ietf-yang-library module failed, missing revision in NETCONF <hello> message.");
             WRN(session, "Unable to automatically use <get-schema>.");
@@ -1944,31 +1944,6 @@ nc_accept_callhome(int timeout, struct ly_ctx *ctx, struct nc_session **session)
 
 #endif /* NC_ENABLED_SSH_TLS */
 
-API const char * const *
-nc_session_get_cpblts(const struct nc_session *session)
-{
-    NC_CHECK_ARG_RET(session, session, NULL);
-
-    return (const char * const *)session->opts.client.cpblts;
-}
-
-API const char *
-nc_session_cpblt(const struct nc_session *session, const char *capab)
-{
-    int i, len;
-
-    NC_CHECK_ARG_RET(session, session, capab, NULL);
-
-    len = strlen(capab);
-    for (i = 0; session->opts.client.cpblts[i]; ++i) {
-        if (!strncmp(session->opts.client.cpblts[i], capab, len)) {
-            return session->opts.client.cpblts[i];
-        }
-    }
-
-    return NULL;
-}
-
 API int
 nc_session_ntf_thread_running(const struct nc_session *session)
 {

src/session_client.h

@@ -489,23 +489,6 @@ struct nc_session *nc_connect_tls(const char *host, uint16_t port, struct ly_ctx
  * @{
  */
 
-/**
- * @brief Get session capabilities.
- *
- * @param[in] session Session to get the information from.
- * @return NULL-terminated array of the @p session capabilities.
- */
-const char * const *nc_session_get_cpblts(const struct nc_session *session);
-
-/**
- * @brief Check capability presence in a session.
- *
- * @param[in] session Session to check.
- * @param[in] capab Capability to look for, capability with any additional suffix will match.
- * @return Matching capability, NULL if none found.
- */
-const char *nc_session_cpblt(const struct nc_session *session, const char *capab);
-
 /**
  * @brief Check whether the session has a notification thread running.
  *

src/session_p.h

@@ -876,6 +876,7 @@ struct nc_session {
     /* NETCONF data */
     uint32_t id;                 /**< NETCONF session ID (session-id-type) */
     NC_PROT_VERSION version;     /**< NETCONF protocol version */
+    char **cpblts;               /**< NETCONF capabilities received from the other end */
 
     /* Transport implementation */
     NC_TRANSPORT_IMPL ti_type;   /**< transport implementation type to select items from ti union */
@@ -936,7 +937,6 @@ struct nc_session {
         struct {
             /* client side only data */
             uint64_t msgid;
-            char **cpblts;                 /**< list of server's capabilities on client side */
             pthread_mutex_t msgs_lock;     /**< lock for the msgs buffer */
             struct nc_msg_cont *msgs;      /**< queue for messages received of different type than expected */
             ATOMIC_T ntf_thread_count;     /**< number of running notification threads */

tests/test_client_monitoring.c

@@ -100,6 +100,7 @@ server_thread(void *arg)
     struct ln2_test_ctx *test_ctx = arg;
     int fd;
     struct linger ling = {1, 0};
+    const char *cpb;
 
     ps = nc_ps_new();
     assert_non_null(ps);
@@ -111,6 +112,10 @@ server_thread(void *arg)
     msgtype = nc_accept(NC_ACCEPT_TIMEOUT, test_ctx->ctx, &session);
     assert_int_equal(msgtype, NC_MSG_HELLO);
 
+    /* just check capabilities function on the client */
+    cpb = nc_session_cpblt(session, "urn:ietf:params:netconf:base:1.1");
+    assert_non_null(cpb);
+
     /* get the session's fd */
     fd = ssh_get_fd(session->ti.libssh.session);
     assert_int_not_equal(fd, -1);