Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 1 | /** |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 2 | * @file session_client.h |
| 3 | * @author Michal Vasko <mvasko@cesnet.cz> |
| 4 | * @brief libnetconf2 session client manipulation |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 5 | * |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 6 | * Copyright (c) 2015 - 2021 CESNET, z.s.p.o. |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 7 | * |
Radek Krejci | 9b81f5b | 2016-02-24 13:14:49 +0100 | [diff] [blame] | 8 | * 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 Vasko | afd416b | 2016-02-25 14:51:46 +0100 | [diff] [blame] | 11 | * |
Radek Krejci | 9b81f5b | 2016-02-24 13:14:49 +0100 | [diff] [blame] | 12 | * https://opensource.org/licenses/BSD-3-Clause |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 13 | */ |
| 14 | |
| 15 | #ifndef NC_SESSION_CLIENT_H_ |
| 16 | #define NC_SESSION_CLIENT_H_ |
| 17 | |
Michal Vasko | c09730e | 2019-01-17 10:07:26 +0100 | [diff] [blame] | 18 | #ifdef __cplusplus |
| 19 | extern "C" { |
| 20 | #endif |
| 21 | |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 22 | #include <libyang/libyang.h> |
| 23 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 24 | #ifdef NC_ENABLED_SSH |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 25 | # include <libssh/libssh.h> |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 26 | #endif |
| 27 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 28 | #ifdef NC_ENABLED_TLS |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 29 | # include <openssl/ssl.h> |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 30 | #endif |
| 31 | |
Michal Vasko | 7bcb48e | 2016-01-15 10:28:54 +0100 | [diff] [blame] | 32 | #include "messages_client.h" |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 33 | #include "netconf.h" |
| 34 | #include "session.h" |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 35 | |
| 36 | /** |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 37 | * @addtogroup client |
| 38 | * @{ |
| 39 | */ |
| 40 | |
| 41 | /** |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 42 | * @brief Set location where libnetconf tries to search for YANG/YIN schemas. |
| 43 | * |
Michal Vasko | 7f1c0ef | 2016-03-11 11:13:06 +0100 | [diff] [blame] | 44 | * The location is searched when connecting to a NETCONF server and building |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 45 | * YANG context for further processing of the NETCONF messages and data. |
| 46 | * |
Radek Krejci | fd5b668 | 2017-06-13 15:52:53 +0200 | [diff] [blame] | 47 | * The searchpath is also used to store schemas retreived via \<get-schema\> |
| 48 | * operation - if the schema is not found in searchpath neither via schema |
| 49 | * callback provided via nc_client_set_schema_callback() and server supports |
| 50 | * the NETCONF \<get-schema\> operation, the schema is retrieved this way and |
| 51 | * stored into the searchpath (if specified). |
| 52 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 53 | * @param[in] path Directory where to search for YANG/YIN schemas. |
| 54 | * @return 0 on success, 1 on (memory allocation) failure. |
| 55 | */ |
Michal Vasko | 7f1c0ef | 2016-03-11 11:13:06 +0100 | [diff] [blame] | 56 | int nc_client_set_schema_searchpath(const char *path); |
| 57 | |
| 58 | /** |
| 59 | * @brief Get schema searchpath that was set by nc_client_set_schema_searchpath(). |
| 60 | * |
| 61 | * @return Schema searchpath directory, NULL if not set. |
| 62 | */ |
| 63 | const char *nc_client_get_schema_searchpath(void); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 64 | |
| 65 | /** |
Radek Krejci | fd5b668 | 2017-06-13 15:52:53 +0200 | [diff] [blame] | 66 | * @brief Set callback function to get missing schemas. |
| 67 | * |
| 68 | * @param[in] clb Callback responsible for returning the missing model. |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 69 | * @param[in] user_data Arbitrary data that will always be passed to the callback @p clb. |
Radek Krejci | fd5b668 | 2017-06-13 15:52:53 +0200 | [diff] [blame] | 70 | * @return 0 on success, 1 on (memory allocation) failure. |
| 71 | */ |
| 72 | int nc_client_set_schema_callback(ly_module_imp_clb clb, void *user_data); |
| 73 | |
| 74 | /** |
| 75 | * @brief Get callback function used to get missing schemas. |
| 76 | * |
| 77 | * @param[out] user_data Optionally return the private data set with the callback. |
| 78 | * Note that the caller is responsible for freeing the private data, so before |
| 79 | * changing the callback, private data used for the previous callback should be |
| 80 | * freed. |
| 81 | * @return Pointer to the set callback, NULL if no such callback was set. |
| 82 | */ |
| 83 | ly_module_imp_clb nc_client_get_schema_callback(void **user_data); |
| 84 | |
| 85 | /** |
Radek Krejci | 5cebc6b | 2017-05-26 13:24:38 +0200 | [diff] [blame] | 86 | * @brief Use the provided thread-specific client's context in the current thread. |
| 87 | * |
| 88 | * Note that from this point the context is shared with the thread from which the context was taken and any |
| 89 | * nc_client_*set* functions and functions creating connection in these threads should be protected from the |
| 90 | * concurrent execution. |
| 91 | * |
Radek Krejci | fd5b668 | 2017-06-13 15:52:53 +0200 | [diff] [blame] | 92 | * Context contains schema searchpath/callback, call home binds, TLS and SSH authentication data (username, keys, |
Radek Krejci | 5cebc6b | 2017-05-26 13:24:38 +0200 | [diff] [blame] | 93 | * various certificates and callbacks). |
| 94 | * |
| 95 | * @param[in] context Client's thread-specific context provided by nc_client_get_thread_context(). |
| 96 | */ |
| 97 | void nc_client_set_thread_context(void *context); |
| 98 | |
| 99 | /** |
| 100 | * @brief Get thread-specific client context for sharing with some other thread using |
| 101 | * nc_client_set_thread_context(). |
| 102 | * |
| 103 | * @return Pointer to the client's context of the current thread. |
| 104 | */ |
| 105 | void *nc_client_get_thread_context(void); |
| 106 | |
| 107 | /** |
Michal Vasko | a7b8ca5 | 2016-03-01 12:09:29 +0100 | [diff] [blame] | 108 | * @brief Initialize libssh and/or libssl/libcrypto for use in the client. |
| 109 | */ |
| 110 | void nc_client_init(void); |
| 111 | |
| 112 | /** |
| 113 | * @brief Destroy all libssh and/or libssl/libcrypto dynamic memory and |
| 114 | * the client options, for both SSH and TLS, and for Call Home too. |
Michal Vasko | b7558c5 | 2016-02-26 15:04:19 +0100 | [diff] [blame] | 115 | */ |
| 116 | void nc_client_destroy(void); |
| 117 | |
Michal Vasko | 4e6d324 | 2021-05-26 09:13:24 +0200 | [diff] [blame] | 118 | /** @} Client */ |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 119 | |
| 120 | /** |
| 121 | * @defgroup client_session Client Session |
| 122 | * @ingroup client |
| 123 | * |
| 124 | * @brief Client-side NETCONF session manipulation. |
| 125 | * @{ |
| 126 | */ |
| 127 | |
Michal Vasko | b7558c5 | 2016-02-26 15:04:19 +0100 | [diff] [blame] | 128 | /** |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 129 | * @brief Connect to the NETCONF server via proviaded input/output file descriptors. |
| 130 | * |
| 131 | * Transport layer is supposed to be already set. Function do not cover authentication |
| 132 | * or any other manipulation with the transport layer, it only establish NETCONF session |
| 133 | * by sending and processing NETCONF \<hello\> messages. |
| 134 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 135 | * @param[in] fdin Input file descriptor for reading (clear) data from NETCONF server. |
| 136 | * @param[in] fdout Output file descriptor for writing (clear) data for NETCONF server. |
| 137 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 138 | * (ignoring what is actually supported by the server side). If not set, |
| 139 | * YANG context is created for the session using \<get-schema\> (if supported |
| 140 | * by the server side) or/and by searching for YANG schemas in the searchpath |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 141 | * (see nc_client_schema_searchpath()). In every case except not providing context |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 142 | * to connect to a server supporting \<get-schema\> it is possible that |
| 143 | * the session context will not include all the models supported by the server. |
| 144 | * @return Created NETCONF session object or NULL in case of error. |
| 145 | */ |
| 146 | struct nc_session *nc_connect_inout(int fdin, int fdout, struct ly_ctx *ctx); |
| 147 | |
Olivier Matz | ac7fa2f | 2018-10-11 10:02:04 +0200 | [diff] [blame] | 148 | /** |
| 149 | * @brief Connect to the NETCONF server via unix socket. |
| 150 | * |
| 151 | * Connect to netconf server via an unix socket. Function do not cover authentication |
| 152 | * or any other manipulation with the transport layer, it only establish NETCONF session |
| 153 | * by sending and processing NETCONF \<hello\> messages. |
| 154 | * |
| 155 | * @param[in] address Path to the unix socket. |
| 156 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 157 | * (ignoring what is actually supported by the server side). If not set, |
| 158 | * YANG context is created for the session using \<get-schema\> (if supported |
| 159 | * by the server side) or/and by searching for YANG schemas in the searchpath |
| 160 | * (see nc_client_schema_searchpath()). In every case except not providing context |
| 161 | * to connect to a server supporting \<get-schema\> it is possible that |
| 162 | * the session context will not include all the models supported by the server. |
| 163 | * @return Created NETCONF session object or NULL in case of error. |
| 164 | */ |
| 165 | struct nc_session *nc_connect_unix(const char *address, struct ly_ctx *ctx); |
| 166 | |
Michal Vasko | 4e6d324 | 2021-05-26 09:13:24 +0200 | [diff] [blame] | 167 | /** @} Client Session */ |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 168 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 169 | #ifdef NC_ENABLED_SSH |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 170 | |
| 171 | /** |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 172 | * @defgroup client_ssh Client SSH |
| 173 | * @ingroup client |
| 174 | * |
| 175 | * @brief Client-side settings for SSH connections. |
| 176 | * @{ |
| 177 | */ |
| 178 | |
| 179 | /** |
Michal Vasko | ef112d7 | 2016-02-18 13:28:25 +0100 | [diff] [blame] | 180 | * @brief Set SSH authentication hostkey check (knownhosts) callback. |
| 181 | * |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 182 | * Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for |
| 183 | * freeing the private data when necessary (the private data can be obtained by |
| 184 | * nc_client_ssh_get_auth_hostkey_check_clb()). |
| 185 | * |
Michal Vasko | ef112d7 | 2016-02-18 13:28:25 +0100 | [diff] [blame] | 186 | * @param[in] auth_hostkey_check Function to call, returns 0 on success, non-zero in error. |
| 187 | * If NULL, the default callback is set. |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 188 | * @param[in] priv Optional private data to be passed to the callback function. |
Michal Vasko | ef112d7 | 2016-02-18 13:28:25 +0100 | [diff] [blame] | 189 | */ |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 190 | void nc_client_ssh_set_auth_hostkey_check_clb(int (*auth_hostkey_check)(const char *hostname, ssh_session session, void *priv), |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 191 | void *priv); |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 192 | |
| 193 | /** |
| 194 | * @brief Get currently set SSH authentication hostkey check (knownhosts) callback and its private data previously set |
| 195 | * by nc_client_ssh_set_auth_hostkey_check_clb(). |
| 196 | * |
| 197 | * @param[out] auth_hostkey_check Currently set callback, NULL in case of the default callback. |
| 198 | * @param[out] priv Currently set (optional) private data to be passed to the callback function. |
| 199 | */ |
| 200 | void nc_client_ssh_get_auth_hostkey_check_clb(int (**auth_hostkey_check)(const char *hostname, ssh_session session, void *priv), |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 201 | void **priv); |
Michal Vasko | ef112d7 | 2016-02-18 13:28:25 +0100 | [diff] [blame] | 202 | |
| 203 | /** |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 204 | * @brief Set SSH password authentication callback. |
| 205 | * |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 206 | * Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for |
| 207 | * freeing the private data when necessary (the private data can be obtained by |
| 208 | * nc_client_ssh_get_auth_password_clb()). |
| 209 | * |
Michal Vasko | fdfd9dd | 2016-02-29 10:18:46 +0100 | [diff] [blame] | 210 | * @param[in] auth_password Function to call, returns the password for username\@hostname. |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 211 | * If NULL, the default callback is set. |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 212 | * @param[in] priv Optional private data to be passed to the callback function. |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 213 | */ |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 214 | void nc_client_ssh_set_auth_password_clb(char *(*auth_password)(const char *username, const char *hostname, void *priv), |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 215 | void *priv); |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 216 | |
| 217 | /** |
| 218 | * @brief Get currently set SSH password authentication callback and its private data previously set |
| 219 | * by nc_client_ssh_set_auth_password_clb(). |
| 220 | * |
| 221 | * @param[out] auth_password Currently set callback, NULL in case of the default callback. |
| 222 | * @param[out] priv Currently set (optional) private data to be passed to the callback function. |
| 223 | */ |
| 224 | void nc_client_ssh_get_auth_password_clb(char *(**auth_password)(const char *username, const char *hostname, void *priv), |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 225 | void **priv); |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 226 | |
| 227 | /** |
| 228 | * @brief Set SSH interactive authentication callback. |
| 229 | * |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 230 | * Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for |
| 231 | * freeing the private data when necessary (the private data can be obtained by |
| 232 | * nc_client_ssh_get_auth_interactive_clb()). |
| 233 | * |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 234 | * @param[in] auth_interactive Function to call for every question, returns the answer for |
| 235 | * authentication name with instruction and echoing prompt. |
| 236 | * If NULL, the default callback is set. |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 237 | * @param[in] priv Optional private data to be passed to the callback function. |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 238 | */ |
| 239 | void nc_client_ssh_set_auth_interactive_clb(char *(*auth_interactive)(const char *auth_name, const char *instruction, |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 240 | const char *prompt, int echo, void *priv), |
| 241 | void *priv); |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 242 | |
| 243 | /** |
| 244 | * @brief Get currently set SSH interactive authentication callback and its private data previously set |
| 245 | * by nc_client_ssh_set_auth_interactive_clb(). |
| 246 | * |
| 247 | * @param[out] auth_interactive Currently set callback, NULL in case of the default callback. |
| 248 | * @param[out] priv Currently set (optional) private data to be passed to the callback function. |
| 249 | */ |
| 250 | void nc_client_ssh_get_auth_interactive_clb(char *(**auth_interactive)(const char *auth_name, const char *instruction, |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 251 | const char *prompt, int echo, void *priv), |
| 252 | void **priv); |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 253 | |
| 254 | /** |
| 255 | * @brief Set SSH publickey authentication encrypted private key passphrase callback. |
| 256 | * |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 257 | * Repetitive calling causes replacing of the previous callback and its private data. Caller is responsible for |
| 258 | * freeing the private data when necessary (the private data can be obtained by |
| 259 | * nc_client_ssh_get_auth_privkey_passphrase_clb()). |
| 260 | * |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 261 | * @param[in] auth_privkey_passphrase Function to call for every question, returns |
| 262 | * the passphrase for the specific private key. |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 263 | * @param[in] priv Optional private data to be passed to the callback function. |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 264 | */ |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 265 | void nc_client_ssh_set_auth_privkey_passphrase_clb(char *(*auth_privkey_passphrase)(const char *privkey_path, void *priv), |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 266 | void *priv); |
Radek Krejci | 90a84a2 | 2017-05-25 13:53:00 +0200 | [diff] [blame] | 267 | |
| 268 | /** |
| 269 | * @brief Get currently set SSH publickey authentication encrypted private key passphrase callback and its private data |
| 270 | * previously set by nc_client_ssh_set_auth_privkey_passphrase_clb(). |
| 271 | * |
| 272 | * @param[out] auth_privkey_passphrase Currently set callback, NULL in case of the default callback. |
| 273 | * @param[out] priv Currently set (optional) private data to be passed to the callback function. |
| 274 | */ |
| 275 | void nc_client_ssh_get_auth_privkey_passphrase_clb(char *(**auth_privkey_passphrase)(const char *privkey_path, void *priv), |
Michal Vasko | b83a3fa | 2021-05-26 09:53:42 +0200 | [diff] [blame] | 276 | void **priv); |
Michal Vasko | 30e2c87 | 2016-02-18 10:03:21 +0100 | [diff] [blame] | 277 | |
| 278 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 279 | * @brief Add an SSH public and private key pair to be used for client authentication. |
| 280 | * |
| 281 | * Private key can be encrypted, the passphrase will be asked for before using it. |
| 282 | * |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 283 | * @param[in] pub_key Path to the public key. |
| 284 | * @param[in] priv_key Path to the private key. |
Michal Vasko | f0537d8 | 2016-01-29 14:42:38 +0100 | [diff] [blame] | 285 | * @return 0 on success, -1 on error. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 286 | */ |
| 287 | int nc_client_ssh_add_keypair(const char *pub_key, const char *priv_key); |
| 288 | |
| 289 | /** |
| 290 | * @brief Remove an SSH public and private key pair that was used for client authentication. |
| 291 | * |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 292 | * @param[in] idx Index of the keypair starting with 0. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 293 | * @return 0 on success, -1 on error. |
| 294 | */ |
| 295 | int nc_client_ssh_del_keypair(int idx); |
| 296 | |
| 297 | /** |
| 298 | * @brief Get the number of public an private key pairs set to be used for client authentication. |
| 299 | * |
| 300 | * @return Keypair count. |
| 301 | */ |
| 302 | int nc_client_ssh_get_keypair_count(void); |
| 303 | |
| 304 | /** |
| 305 | * @brief Get a specific keypair set to be used for client authentication. |
| 306 | * |
| 307 | * @param[in] idx Index of the specific keypair. |
| 308 | * @param[out] pub_key Path to the public key. |
| 309 | * @param[out] priv_key Path to the private key. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 310 | * @return 0 on success, -1 on error. |
| 311 | */ |
| 312 | int nc_client_ssh_get_keypair(int idx, const char **pub_key, const char **priv_key); |
| 313 | |
| 314 | /** |
| 315 | * @brief Set SSH authentication method preference. |
| 316 | * |
Radek Krejci | 62aa064 | 2017-05-25 16:33:49 +0200 | [diff] [blame] | 317 | * The default preference is as follows: |
| 318 | * - interactive authentication (3) |
| 319 | * - password authentication (2) |
| 320 | * - public key authentication (1) |
| 321 | * |
| 322 | * @param[in] auth_type Authentication method to modify the preference of. |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 323 | * @param[in] pref Preference of @p auth_type. Higher number increases priority, negative values disable the method. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 324 | */ |
| 325 | void nc_client_ssh_set_auth_pref(NC_SSH_AUTH_TYPE auth_type, int16_t pref); |
| 326 | |
| 327 | /** |
| 328 | * @brief Get SSH authentication method preference. |
| 329 | * |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 330 | * @param[in] auth_type Authentication method to retrieve the prefrence of. |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 331 | * @return Preference of the @p auth_type. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 332 | */ |
| 333 | int16_t nc_client_ssh_get_auth_pref(NC_SSH_AUTH_TYPE auth_type); |
| 334 | |
| 335 | /** |
| 336 | * @brief Set client SSH username used for authentication. |
| 337 | * |
| 338 | * @param[in] username Username to use. |
| 339 | * @return 0 on success, -1 on error. |
| 340 | */ |
| 341 | int nc_client_ssh_set_username(const char *username); |
| 342 | |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 343 | /** |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 344 | * @brief Get client SSH username used for authentication. |
| 345 | * |
| 346 | * @return Username used. |
| 347 | */ |
| 348 | const char *nc_client_ssh_get_username(void); |
| 349 | |
| 350 | /** |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 351 | * @brief Connect to the NETCONF server using SSH transport (via libssh). |
| 352 | * |
| 353 | * SSH session is created with default options. If the caller needs to use specific SSH session properties, |
| 354 | * they are supposed to use nc_connect_libssh(). |
| 355 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 356 | * @param[in] host Hostname or address (both Ipv4 and IPv6 are accepted) of the target server. |
| 357 | * 'localhost' is used by default if NULL is specified. |
| 358 | * @param[in] port Port number of the target server. Default value 830 is used if 0 is specified. |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 359 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 360 | * (ignoring what is actually supported by the server side). If not set, |
| 361 | * YANG context is created for the session using \<get-schema\> (if supported |
| 362 | * by the server side) or/and by searching for YANG schemas in the searchpath |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 363 | * (see nc_client_schema_searchpath()). In every case except not providing context |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 364 | * to connect to a server supporting \<get-schema\> it is possible that |
| 365 | * the session context will not include all the models supported by the server. |
| 366 | * @return Created NETCONF session object or NULL on error. |
| 367 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 368 | struct nc_session *nc_connect_ssh(const char *host, uint16_t port, struct ly_ctx *ctx); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 369 | |
| 370 | /** |
| 371 | * @brief Connect to the NETCONF server using the provided SSH (libssh) session. |
| 372 | * |
| 373 | * SSH session can have any options set, they will not be modified. If no options were set, |
| 374 | * host 'localhost', port 22, and the username detected from the EUID is used. If socket is |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 375 | * set and connected only the host and the username must be set/is detected. Or the @p ssh_session |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 376 | * can already be authenticated in which case it is used directly. |
| 377 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 378 | * @param[in] ssh_session libssh structure representing SSH session object. After passing it |
| 379 | * to libnetconf2 this way, it is fully managed by it (including freeing!). |
| 380 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 381 | * (ignoring what is actually supported by the server side). If not set, |
| 382 | * YANG context is created for the session using \<get-schema\> (if supported |
| 383 | * by the server side) or/and by searching for YANG schemas in the searchpath |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 384 | * (see nc_client_schema_searchpath()). In every case except not providing context |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 385 | * to connect to a server supporting \<get-schema\> it is possible that |
| 386 | * the session context will not include all the models supported by the server. |
| 387 | * @return Created NETCONF session object or NULL on error. |
| 388 | */ |
| 389 | struct nc_session *nc_connect_libssh(ssh_session ssh_session, struct ly_ctx *ctx); |
| 390 | |
| 391 | /** |
| 392 | * @brief Create another NETCONF session on existing SSH session using separated SSH channel. |
| 393 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 394 | * @param[in] session Existing NETCONF session. The session has to be created on SSH transport layer using libssh - |
| 395 | * it has to be created by nc_connect_ssh(), nc_connect_libssh() or nc_connect_ssh_channel(). |
| 396 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 397 | * (ignoring what is actually supported by the server side). If not set, |
| 398 | * YANG context is created for the session using \<get-schema\> (if supported |
| 399 | * by the server side) or/and by searching for YANG schemas in the searchpath |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 400 | * (see nc_client_schema_searchpath()). In every case except not providing context |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 401 | * to connect to a server supporting \<get-schema\> it is possible that |
| 402 | * the session context will not include all the models supported by the server. |
| 403 | * @return Created NETCONF session object or NULL on error. |
| 404 | */ |
| 405 | struct nc_session *nc_connect_ssh_channel(struct nc_session *session, struct ly_ctx *ctx); |
| 406 | |
Michal Vasko | 4e6d324 | 2021-05-26 09:13:24 +0200 | [diff] [blame] | 407 | /** @} Client SSH */ |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 408 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 409 | #endif /* NC_ENABLED_SSH */ |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 410 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 411 | #ifdef NC_ENABLED_TLS |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 412 | |
| 413 | /** |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 414 | * @defgroup client_tls Client TLS |
| 415 | * @ingroup client |
| 416 | * |
| 417 | * @brief Client-side settings for TLS connections. |
| 418 | * @{ |
| 419 | */ |
| 420 | |
| 421 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 422 | * @brief Set client authentication identity - a certificate and a private key. |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 423 | * |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 424 | * @param[in] client_cert Path to the file containing the client certificate. |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 425 | * @param[in] client_key Path to the file containing the private key for the @p client_cert. |
| 426 | * If NULL, key is expected to be stored with @p client_cert. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 427 | * @return 0 on success, -1 on error. |
| 428 | */ |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 429 | int nc_client_tls_set_cert_key_paths(const char *client_cert, const char *client_key); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 430 | |
| 431 | /** |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 432 | * @brief Get client authentication identity - a certificate and a private key. |
| 433 | * |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 434 | * @param[out] client_cert Path to the file containing the client certificate. Can be NULL. |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 435 | * @param[out] client_key Path to the file containing the private key for the @p client_cert. Can be NULL. |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 436 | */ |
| 437 | void nc_client_tls_get_cert_key_paths(const char **client_cert, const char **client_key); |
| 438 | |
| 439 | /** |
| 440 | * @brief Set client trusted CA certificates paths. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 441 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 442 | * @param[in] ca_file Location of the CA certificate file used to verify server certificates. |
| 443 | * For more info, see the documentation for SSL_CTX_load_verify_locations() from OpenSSL. |
| 444 | * @param[in] ca_dir Location of the CA certificates directory used to verify the server certificates. |
| 445 | * For more info, see the documentation for SSL_CTX_load_verify_locations() from OpenSSL. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 446 | * @return 0 on success, -1 on error. |
| 447 | */ |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 448 | int nc_client_tls_set_trusted_ca_paths(const char *ca_file, const char *ca_dir); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 449 | |
| 450 | /** |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 451 | * @brief Get client trusted CA certificates paths. |
| 452 | * |
| 453 | * @param[out] ca_file Location of the CA certificate file used to verify server certificates. |
| 454 | * Can be NULL. |
| 455 | * @param[out] ca_dir Location of the CA certificates directory used to verify the server certificates. |
| 456 | * Can be NULL. |
| 457 | */ |
| 458 | void nc_client_tls_get_trusted_ca_paths(const char **ca_file, const char **ca_dir); |
| 459 | |
| 460 | /** |
| 461 | * @brief Set client Certificate Revocation List paths. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 462 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 463 | * @param[in] crl_file Location of the CRL certificate file used to check for revocated certificates. |
| 464 | * @param[in] crl_dir Location of the CRL certificate directory used to check for revocated certificates. |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 465 | * @return 0 on success, -1 on error. |
| 466 | */ |
Michal Vasko | e22c673 | 2016-01-29 11:03:02 +0100 | [diff] [blame] | 467 | int nc_client_tls_set_crl_paths(const char *crl_file, const char *crl_dir); |
| 468 | |
| 469 | /** |
| 470 | * @brief Get client Certificate Revocation List paths. |
| 471 | * |
| 472 | * @param[out] crl_file Location of the CRL certificate file used to check for revocated certificates. |
| 473 | * @param[out] crl_dir Location of the CRL certificate directory used to check for revocated certificates. |
| 474 | */ |
| 475 | void nc_client_tls_get_crl_paths(const char **crl_file, const char **crl_dir); |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 476 | |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 477 | /** |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 478 | * @brief Connect to the NETCONF server using TLS transport (via libssl) |
| 479 | * |
Michal Vasko | fdfd9dd | 2016-02-29 10:18:46 +0100 | [diff] [blame] | 480 | * TLS session is created with the certificates set using nc_client_tls_* functions, which must be called beforehand! |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 481 | * If the caller needs to use specific TLS session properties, they are supposed to use nc_connect_libssl(). |
| 482 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 483 | * @param[in] host Hostname or address (both Ipv4 and IPv6 are accepted) of the target server. |
| 484 | * 'localhost' is used by default if NULL is specified. |
| 485 | * @param[in] port Port number of the target server. Default value 6513 is used if 0 is specified. |
| 486 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 487 | * (ignoring what is actually supported by the server side). If not set, |
| 488 | * YANG context is created for the session using \<get-schema\> (if supported |
| 489 | * by the server side) or/and by searching for YANG schemas in the searchpath |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 490 | * (see nc_client_schema_searchpath()). In every case except not providing context |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 491 | * to connect to a server supporting \<get-schema\> it is possible that |
| 492 | * the session context will not include all the models supported by the server. |
| 493 | * @return Created NETCONF session object or NULL on error. |
| 494 | */ |
| 495 | struct nc_session *nc_connect_tls(const char *host, uint16_t port, struct ly_ctx *ctx); |
| 496 | |
| 497 | /** |
| 498 | * @brief Connect to the NETCONF server using the provided TLS (libssl) session. |
| 499 | * |
| 500 | * The TLS session supplied is expected to be fully connected and authenticated! |
| 501 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 502 | * @param[in] tls libssl structure representing the TLS session object. |
| 503 | * @param[in] ctx Optional parameter. If set, provides strict YANG context for the session |
| 504 | * (ignoring what is actually supported by the server side). If not set, |
| 505 | * YANG context is created for the session using \<get-schema\> (if supported |
| 506 | * by the server side) or/and by searching for YANG schemas in the searchpath |
Radek Krejci | c9a6d25 | 2016-03-04 14:50:34 +0100 | [diff] [blame] | 507 | * (see nc_client_schema_searchpath()). In every case except not providing context |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 508 | * to connect to a server supporting \<get-schema\> it is possible that |
| 509 | * the session context will not include all the models supported by the server. |
| 510 | * @return Created NETCONF session object or NULL on error. |
| 511 | */ |
| 512 | struct nc_session *nc_connect_libssl(SSL *tls, struct ly_ctx *ctx); |
| 513 | |
Michal Vasko | 4e6d324 | 2021-05-26 09:13:24 +0200 | [diff] [blame] | 514 | /** @} Client TLS */ |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 515 | |
Radek Krejci | 53691be | 2016-02-22 13:58:37 +0100 | [diff] [blame] | 516 | #endif /* NC_ENABLED_TLS */ |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 517 | |
| 518 | /** |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 519 | * @addtogroup client_session |
| 520 | * @{ |
| 521 | */ |
| 522 | |
| 523 | /** |
Michal Vasko | bdfb524 | 2016-05-24 09:11:01 +0200 | [diff] [blame] | 524 | * @brief Get session capabilities. |
| 525 | * |
| 526 | * @param[in] session Session to get the information from. |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 527 | * @return NULL-terminated array of the @p session capabilities. |
Michal Vasko | bdfb524 | 2016-05-24 09:11:01 +0200 | [diff] [blame] | 528 | */ |
Michal Vasko | 1b2ddc9 | 2017-05-24 08:59:49 +0200 | [diff] [blame] | 529 | const char * const *nc_session_get_cpblts(const struct nc_session *session); |
Michal Vasko | bdfb524 | 2016-05-24 09:11:01 +0200 | [diff] [blame] | 530 | |
| 531 | /** |
| 532 | * @brief Check capability presence in a session. |
| 533 | * |
| 534 | * @param[in] session Session to check. |
| 535 | * @param[in] capab Capability to look for, capability with any additional suffix will match. |
| 536 | * @return Matching capability, NULL if none found. |
| 537 | */ |
| 538 | const char *nc_session_cpblt(const struct nc_session *session, const char *capab); |
| 539 | |
| 540 | /** |
Michal Vasko | 9cd26a8 | 2016-05-31 08:58:48 +0200 | [diff] [blame] | 541 | * @brief Check whether the session has a notification thread running. |
| 542 | * |
| 543 | * @param[in] session Session to check. |
| 544 | * @return 1 if notfication thread is running, 0 otherwise. |
| 545 | */ |
| 546 | int nc_session_ntf_thread_running(const struct nc_session *session); |
| 547 | |
| 548 | /** |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 549 | * @brief Receive NETCONF RPC reply. |
| 550 | * |
tadeas-vintrlik | 399af30 | 2021-08-25 10:32:21 +0200 | [diff] [blame] | 551 | * @note This function can be called in a single thread only. |
| 552 | * |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 553 | * @param[in] session NETCONF session from which the function gets data. It must be the |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 554 | * client side session object. |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 555 | * @param[in] rpc Original RPC this should be the reply to. |
| 556 | * @param[in] msgid Expected message ID of the reply. |
| 557 | * @param[in] timeout Timeout for reading in milliseconds. Use negative value for infinite |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 558 | * waiting and 0 for immediate return if data are not available on the wire. |
| 559 | * @param[out] envp NETCONF rpc-reply XML envelopes. |
| 560 | * @param[out] op Parsed NETCONF reply data, if any (none for \<ok\> or error replies). Set only on #NC_MSG_REPLY |
| 561 | * and #NC_MSG_REPLY_ERR_MSGID return. |
Michal Vasko | 71ba2da | 2016-05-04 10:53:16 +0200 | [diff] [blame] | 562 | * @return #NC_MSG_REPLY for success, |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 563 | * #NC_MSG_WOULDBLOCK if @p timeout has elapsed, |
Michal Vasko | 71ba2da | 2016-05-04 10:53:16 +0200 | [diff] [blame] | 564 | * #NC_MSG_ERROR if reading has failed, |
| 565 | * #NC_MSG_NOTIF if a notification was read instead (call this function again to get the reply), and |
| 566 | * #NC_MSG_REPLY_ERR_MSGID if a reply with missing or wrong message-id was received. |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 567 | */ |
Michal Vasko | d083db6 | 2016-01-19 10:31:29 +0100 | [diff] [blame] | 568 | NC_MSG_TYPE nc_recv_reply(struct nc_session *session, struct nc_rpc *rpc, uint64_t msgid, int timeout, |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 569 | struct lyd_node **envp, struct lyd_node **op); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 570 | |
| 571 | /** |
| 572 | * @brief Receive NETCONF Notification. |
| 573 | * |
| 574 | * @param[in] session NETCONF session from which the function gets data. It must be the |
| 575 | * client side session object. |
| 576 | * @param[in] timeout Timeout for reading in milliseconds. Use negative value for infinite |
Michal Vasko | 71ba2da | 2016-05-04 10:53:16 +0200 | [diff] [blame] | 577 | * waiting and 0 for immediate return if data are not available on the wire. |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 578 | * @param[out] envp NETCONF notification XML envelopes. |
| 579 | * @param[out] op Parsed NETCONF notification data. |
Michal Vasko | 71ba2da | 2016-05-04 10:53:16 +0200 | [diff] [blame] | 580 | * @return #NC_MSG_NOTIF for success, |
Michal Vasko | c446a38 | 2021-06-18 08:54:05 +0200 | [diff] [blame] | 581 | * #NC_MSG_WOULDBLOCK if @p timeout has elapsed, |
Michal Vasko | 71ba2da | 2016-05-04 10:53:16 +0200 | [diff] [blame] | 582 | * #NC_MSG_ERROR if reading has failed, and |
| 583 | * #NC_MSG_REPLY if a reply was read instead (call this function again to get a notification). |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 584 | */ |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 585 | NC_MSG_TYPE nc_recv_notif(struct nc_session *session, int timeout, struct lyd_node **envp, struct lyd_node **op); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 586 | |
| 587 | /** |
Michal Vasko | a8ad448 | 2016-01-28 14:25:54 +0100 | [diff] [blame] | 588 | * @brief Receive NETCONF Notifications in a separate thread until the session is terminated |
| 589 | * or \<notificationComplete\> is received. |
| 590 | * |
| 591 | * @param[in] session Netconf session to read notifications from. |
| 592 | * @param[in] notif_clb Function that is called for every received notification (including |
| 593 | * \<notificationComplete\>). Parameters are the session the notification was received on |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 594 | * and the notification data. |
Michal Vasko | a8ad448 | 2016-01-28 14:25:54 +0100 | [diff] [blame] | 595 | * @return 0 if the thread was successfully created, -1 on error. |
| 596 | */ |
| 597 | int nc_recv_notif_dispatch(struct nc_session *session, |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 598 | void (*notif_clb)(struct nc_session *session, const struct lyd_node *envp, const struct lyd_node *op)); |
Michal Vasko | a8ad448 | 2016-01-28 14:25:54 +0100 | [diff] [blame] | 599 | |
| 600 | /** |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 601 | * @brief Send NETCONF RPC message via the session. |
| 602 | * |
| 603 | * @param[in] session NETCONF session where the RPC will be written. |
| 604 | * @param[in] rpc NETCOFN RPC object to send via specified session. Object can be created by |
| 605 | * nc_rpc_lock(), nc_rpc_unlock() and nc_rpc_generic() functions. |
| 606 | * @param[in] timeout Timeout for writing in milliseconds. Use negative value for infinite |
| 607 | * waiting and 0 for return if data cannot be sent immediately. |
| 608 | * @param[out] msgid If RPC was successfully sent, this is it's message ID. |
Michal Vasko | 71ba2da | 2016-05-04 10:53:16 +0200 | [diff] [blame] | 609 | * @return #NC_MSG_RPC on success, |
| 610 | * #NC_MSG_WOULDBLOCK in case of a busy session, and |
| 611 | * #NC_MSG_ERROR on error. |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 612 | */ |
Michal Vasko | d083db6 | 2016-01-19 10:31:29 +0100 | [diff] [blame] | 613 | NC_MSG_TYPE nc_send_rpc(struct nc_session *session, struct nc_rpc *rpc, int timeout, uint64_t *msgid); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 614 | |
Michal Vasko | de2946c | 2017-01-12 12:19:26 +0100 | [diff] [blame] | 615 | /** |
| 616 | * @brief Make a session not strict when sending RPCs and receiving RPC replies. In other words, |
| 617 | * it will silently skip unknown nodes without an error. |
| 618 | * |
| 619 | * Generally, no such data should be worked with, so use this function only when you know what you |
| 620 | * are doing and you understand the consequences. |
| 621 | * |
| 622 | * @param[in] session NETCONF client session. |
| 623 | */ |
| 624 | void nc_client_session_set_not_strict(struct nc_session *session); |
| 625 | |
Michal Vasko | 7736745 | 2021-02-16 16:32:18 +0100 | [diff] [blame] | 626 | /** @} Client Session */ |
Radek Krejci | 6799a05 | 2017-05-19 14:23:23 +0200 | [diff] [blame] | 627 | |
Michal Vasko | c09730e | 2019-01-17 10:07:26 +0100 | [diff] [blame] | 628 | #ifdef __cplusplus |
| 629 | } |
| 630 | #endif |
| 631 | |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 632 | #endif /* NC_SESSION_CLIENT_H_ */ |