Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 1 | /** |
| 2 | * \file session_server.h |
| 3 | * \author Michal Vasko <mvasko@cesnet.cz> |
| 4 | * \brief libnetconf2 session server manipulation |
| 5 | * |
| 6 | * Copyright (c) 2015 CESNET, z.s.p.o. |
| 7 | * |
| 8 | * Redistribution and use in source and binary forms, with or without |
| 9 | * modification, are permitted provided that the following conditions |
| 10 | * are met: |
| 11 | * 1. Redistributions of source code must retain the above copyright |
| 12 | * notice, this list of conditions and the following disclaimer. |
| 13 | * 2. Redistributions in binary form must reproduce the above copyright |
| 14 | * notice, this list of conditions and the following disclaimer in |
| 15 | * the documentation and/or other materials provided with the |
| 16 | * distribution. |
| 17 | * 3. Neither the name of the Company nor the names of its contributors |
| 18 | * may be used to endorse or promote products derived from this |
| 19 | * software without specific prior written permission. |
| 20 | * |
| 21 | */ |
| 22 | |
| 23 | #ifndef NC_SESSION_SERVER_H_ |
| 24 | #define NC_SESSION_SERVER_H_ |
| 25 | |
| 26 | #include <stdint.h> |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 27 | #include <libyang/libyang.h> |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 28 | |
| 29 | #include "session.h" |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 30 | #include "netconf.h" |
| 31 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 32 | /** |
| 33 | * @brief Prototype of callbacks that are called if some RPCs are received. |
| 34 | * |
| 35 | * If \p session termination reason is changed in the callback, one last reply |
| 36 | * is sent and then the session is considered invalid. |
| 37 | * |
| 38 | * @param[in] rpc Parsed client RPC request. |
| 39 | * @param[in] session Session the RPC arrived on. |
| 40 | * @return Server reply. If NULL, an operation-failed error will be sent to the client. |
| 41 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 42 | typedef struct nc_server_reply *(*nc_rpc_clb)(struct lyd_node *rpc, struct nc_session *session); |
| 43 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 44 | /** |
| 45 | * @brief Set the termination reason for a session. |
| 46 | * |
| 47 | * @param[in] session Session to modify. |
| 48 | * @param[in] reason Reason of termination. |
| 49 | */ |
| 50 | void nc_session_set_term_reason(struct nc_session *session, NC_SESSION_TERM_REASON reason); |
| 51 | |
| 52 | /** |
| 53 | * @brief Initialize the server using a libyang context. |
| 54 | * |
| 55 | * The context is not modified internally, only its dictionary is used for holding |
Michal Vasko | 11d142a | 2016-01-19 15:58:24 +0100 | [diff] [blame] | 56 | * all the strings. When the dictionary is being written to or removed from, |
| 57 | * libnetconf2 always holds ctx lock using nc_ctx_lock(). Reading models is considered |
| 58 | * thread-safe as models cannot be removed and are rarely modified. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 59 | * |
| 60 | * Server capabilities are generated based on its content. Changing the context |
| 61 | * in ways that result in changed capabilities (adding models, changing features) |
| 62 | * is discouraged after sessions are established as it is not possible to change |
| 63 | * capabilities of a session. |
| 64 | * |
| 65 | * This context can safely be destroyed only after calling the last libnetconf2 |
| 66 | * function in an application. |
| 67 | * |
| 68 | * Supported RPCs of models in the context are expected to have the private field |
| 69 | * in the corresponding RPC schema node set to a nc_rpc_clb function callback. |
| 70 | * This callback is called by nc_ps_poll() if the particular RPC request is |
| 71 | * received. Callbacks for ietf-netconf:get-schema (supporting YANG and YIN format |
| 72 | * only) and ietf-netconf:close-session are set internally if left unset. |
| 73 | * |
| 74 | * Access to the context in libnetconf2 functions is not managed in any way, |
| 75 | * the application is responsible for handling it in a thread-safe manner. |
| 76 | * |
| 77 | * @param[in] ctx Core NETCONF server context. |
| 78 | * @return 0 on success, -1 on error. |
| 79 | */ |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 80 | int nc_server_init(struct ly_ctx *ctx); |
| 81 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 82 | /** |
Michal Vasko | b48aa81 | 2016-01-18 14:13:09 +0100 | [diff] [blame] | 83 | * @brief Destroy any dynamically allocated server resources. |
| 84 | */ |
| 85 | void nc_server_destroy(void); |
| 86 | |
| 87 | /** |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 88 | * @brief Set the with-defaults capability extra parameters. |
| 89 | * |
| 90 | * For the capability to be actually advertised, the server context must also |
| 91 | * include the ietf-netconf-with-defaults model. |
| 92 | * |
| 93 | * Changing this option has the same ill effects as changing capabilities while |
| 94 | * sessions are already established. |
| 95 | * |
| 96 | * @param[in] basic_mode basic-mode with-defaults parameter. |
| 97 | * @param[in] also_supported NC_WD_MODE bit array, also-supported with-defaults |
| 98 | * parameter. |
| 99 | * @return 0 on success, -1 on error. |
| 100 | */ |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 101 | int nc_server_set_capab_withdefaults(NC_WD_MODE basic_mode, int also_supported); |
| 102 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 103 | /** |
| 104 | * @brief Set the interleave capability. |
| 105 | * |
| 106 | * For the capability to be actually advertised, the server context must also |
| 107 | * include the nc-notifications model. |
| 108 | * |
| 109 | * Changing this option has the same ill effects as changing capabilities while |
| 110 | * sessions are already established. |
| 111 | * |
| 112 | * @param[in] interleave_support 1 to suport interleave, 0 to not. |
| 113 | */ |
| 114 | void nc_server_set_capab_interleave(int interleave_support); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 115 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 116 | /** |
| 117 | * @brief Set server timeout for receiving a hello message. |
| 118 | * |
| 119 | * @param[in] hello_timeout Hello message timeout. 0 for infinite waiting. |
| 120 | */ |
| 121 | void nc_server_set_hello_timeout(uint16_t hello_timeout); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 122 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 123 | /** |
| 124 | * @brief Set server timeout for dropping an idle session. |
| 125 | * |
| 126 | * @param[in] idle_timeout Idle session timeout. 0 to never drop a session |
| 127 | * because of inactivity. |
| 128 | */ |
| 129 | void nc_server_set_idle_timeout(uint16_t idle_timeout); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 130 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 131 | /** |
| 132 | * @brief Accept a new session on a pre-established transport session. |
| 133 | * |
| 134 | * @param[in] fdin File descriptor to read (unencrypted) XML data from. |
| 135 | * @param[in] fdout File descriptor to write (unencrypted) XML data to. |
| 136 | * @param[in] username NETCONF username as provided by the transport protocol. |
| 137 | * @param[out] session New session on success. |
| 138 | * @return 0 on success, -1 on error. |
| 139 | */ |
| 140 | int nc_accept_inout(int fdin, int fdout, const char *username, struct nc_session **session); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 141 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 142 | /** |
| 143 | * @brief Create an empty structure for polling sessions. |
| 144 | * |
| 145 | * @return Empty pollsession structure, NULL on error. |
| 146 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 147 | struct nc_pollsession *nc_ps_new(void); |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 148 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 149 | /** |
| 150 | * @brief Free a pollsession structure. |
| 151 | * |
| 152 | * @param[in] ps Pollsession structure to free. |
| 153 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 154 | void nc_ps_free(struct nc_pollsession *ps); |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 155 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 156 | /** |
| 157 | * @brief Add a session to a pollsession structure. |
| 158 | * |
| 159 | * @param[in] ps Pollsession structure to modify. |
| 160 | * @param[in] session Session to add to \p ps. |
| 161 | * @return 0 on success, -1 on error. |
| 162 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 163 | int nc_ps_add_session(struct nc_pollsession *ps, struct nc_session *session); |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 164 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 165 | /** |
| 166 | * @brief Remove a session from a pollsession structure. |
| 167 | * |
| 168 | * @param[in] ps Pollsession structure to modify. |
| 169 | * @param[in] session Session to remove from \p ps. |
| 170 | * @return 0 on success, 1 if not found, -1 on error. |
| 171 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 172 | int nc_ps_del_session(struct nc_pollsession *ps, struct nc_session *session); |
| 173 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 174 | /** |
| 175 | * @brief Poll sessions and process any received RPCs. |
| 176 | * |
| 177 | * All the sessions must be running. If a session fails causing it to change its |
Michal Vasko | 96164bf | 2016-01-21 15:41:58 +0100 | [diff] [blame] | 178 | * status, it can be learnt from the return value. Only one event on one session |
| 179 | * is handled in one function call. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 180 | * |
| 181 | * @param[in] ps Pollsession structure to use. |
Michal Vasko | 11d142a | 2016-01-19 15:58:24 +0100 | [diff] [blame] | 182 | * @param[in] timeout Poll timeout in milliseconds. 0 for non-blocking call, -1 for |
| 183 | * infinite waiting. |
Michal Vasko | bd8ef26 | 2016-01-20 11:09:27 +0100 | [diff] [blame] | 184 | * @return 0 on elapsed timeout, |
| 185 | * 1 if an RPC was processed, |
| 186 | * 2 if an RPC was processed and there are unhandled events on other sessions, |
| 187 | * 3 if a session from \p ps changed its status (was invalidated), |
| 188 | * -1 on error. |
Michal Vasko | 96164bf | 2016-01-21 15:41:58 +0100 | [diff] [blame] | 189 | * |
| 190 | * Only with SSH support: |
| 191 | * 4 if an SSH message was processed, |
| 192 | * 5 if a new NETCONF SSH channel was created; call nc_ssh_ps_accept_channel() |
| 193 | * to establish a new NETCONF session. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 194 | */ |
Michal Vasko | 05ba9df | 2016-01-13 14:40:27 +0100 | [diff] [blame] | 195 | int nc_ps_poll(struct nc_pollsession *ps, int timeout); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 196 | |
Michal Vasko | 11d142a | 2016-01-19 15:58:24 +0100 | [diff] [blame] | 197 | /** |
| 198 | * @brief Lock server context. |
| 199 | * |
| 200 | * @param[in] timeout Timeout in milliseconds. 0 for non-blocking call, -1 for |
| 201 | * infinite waiting. |
| 202 | * @param[out] elapsed Elapsed milliseconds will be added to this variable. |
| 203 | * Can be NULL. |
| 204 | * @return 0 on elapsed timeout, 1 on success, -1 on error. |
| 205 | */ |
| 206 | int nc_ctx_lock(int timeout, int *elapsed); |
| 207 | |
| 208 | /** |
| 209 | * @brief Unlock server context. |
| 210 | * |
| 211 | * @return 0 on success, -1 on error. |
| 212 | */ |
| 213 | int nc_ctx_unlock(void); |
| 214 | |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 215 | #if defined(ENABLE_SSH) || defined(ENABLE_TLS) |
| 216 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 217 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 218 | * @brief Accept new sessions on all the listening endpoints. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 219 | * |
Michal Vasko | 11d142a | 2016-01-19 15:58:24 +0100 | [diff] [blame] | 220 | * @param[in] timeout Timeout for receiving a new connection in milliseconds, 0 for |
| 221 | * non-blocking call, -1 for infinite waiting. |
Michal Vasko | 96164bf | 2016-01-21 15:41:58 +0100 | [diff] [blame] | 222 | * @param[out] session New session. |
Michal Vasko | c61c449 | 2016-01-25 11:13:34 +0100 | [diff] [blame] | 223 | * @return 1 on success, 0 on timeout, -1 on error. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 224 | */ |
| 225 | int nc_accept(int timeout, struct nc_session **session); |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 226 | |
Michal Vasko | fb89d77 | 2016-01-08 12:25:35 +0100 | [diff] [blame] | 227 | #endif /* ENABLE_SSH || ENABLE_TLS */ |
Michal Vasko | 9e036d5 | 2016-01-08 10:49:26 +0100 | [diff] [blame] | 228 | |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 229 | #ifdef ENABLE_SSH |
| 230 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 231 | /** |
Michal Vasko | 96164bf | 2016-01-21 15:41:58 +0100 | [diff] [blame] | 232 | * @brief Accept a new NETCONF session on an SSH session of a running NETCONF session |
| 233 | * that was polled in \p ps. Call this function only when nc_ps_poll() on \p ps returns 5. |
| 234 | * |
| 235 | * @param[in] ps Unmodified pollsession structure from the previous nc_ps_poll() call. |
| 236 | * @param[out] session New session. |
| 237 | * @return 1 on success, -1 on error. |
| 238 | */ |
| 239 | int nc_ps_accept_ssh_channel(struct nc_pollsession *ps, struct nc_session **session); |
| 240 | |
| 241 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 242 | * @brief Add a new SSH endpoint and start listening on it. |
| 243 | * |
| 244 | * @param[in] name Arbitrary unique endpoint name. There can be a TLS endpoint with |
| 245 | * the same name. |
| 246 | * @param[in] address IP address to listen on. |
| 247 | * @param[in] port Port to listen on. |
| 248 | * @return 0 on success, -1 on error. |
| 249 | */ |
| 250 | int nc_server_ssh_add_endpt_listen(const char *name, const char *address, uint16_t port); |
| 251 | |
| 252 | /** |
| 253 | * @brief Stop listening on and remove an SSH endpoint. |
| 254 | * |
| 255 | * @param[in] name Endpoint name. NULL matches all (SSH) endpoints. |
| 256 | * @return 0 on success, -1 on not finding any match. |
| 257 | */ |
| 258 | int nc_server_ssh_del_endpt(const char *name); |
| 259 | |
| 260 | /** |
| 261 | * @brief Set endpoint SSH host keys the server will identify itself with. Each of RSA, DSA, and |
Michal Vasko | 5c2f795 | 2016-01-22 13:16:31 +0100 | [diff] [blame] | 262 | * ECDSA keys can be set. If the particular type was already set, it is replaced. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 263 | * |
| 264 | * @param[in] privkey_path Path to a private key. |
| 265 | * @return 0 on success, -1 on error. |
| 266 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 267 | int nc_server_ssh_endpt_set_hostkey(const char *endpt_name, const char *privkey_path); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 268 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 269 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 270 | * @brief Set endpoint SSH banner the server will send to every client. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 271 | * |
| 272 | * @param[in] banner SSH banner. |
| 273 | * @return 0 on success, -1 on error. |
| 274 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 275 | int nc_server_ssh_endpt_set_banner(const char *endpt_name, const char *banner); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 276 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 277 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 278 | * @brief Set endpoint accepted SSH authentication methods. All (publickey, password, interactive) |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 279 | * are supported by default. |
| 280 | * |
| 281 | * @param[in] auth_methods Accepted authentication methods bit field of NC_SSH_AUTH_TYPE. |
| 282 | * @return 0 on success, -1 on error. |
| 283 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 284 | int nc_server_ssh_endpt_set_auth_methods(const char *endpt_name, int auth_methods); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 285 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 286 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 287 | * @brief Set endpoint SSH authentication attempts of every client. 3 by default. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 288 | * |
Michal Vasko | 5e6f4cc | 2016-01-20 13:27:44 +0100 | [diff] [blame] | 289 | * @param[in] auth_attempts Failed authentication attempts before a client is dropped. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 290 | * @return 0 on success, -1 on error. |
| 291 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 292 | int nc_server_ssh_endpt_set_auth_attempts(const char *endpt_name, uint16_t auth_attempts); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 293 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 294 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 295 | * @brief Set endpoint SSH authentication timeout. 10 seconds by default. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 296 | * |
| 297 | * @param[in] auth_timeout Number of seconds before an unauthenticated client is dropped. |
| 298 | * @return 0 on success, -1 on error. |
| 299 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 300 | int nc_server_ssh_endpt_set_auth_timeout(const char *endpt_name, uint16_t auth_timeout); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 301 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 302 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 303 | * @brief Add an endpoint authorized client SSH public key. This public key can be used for |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 304 | * publickey authentication afterwards. |
| 305 | * |
| 306 | * @param[in] pubkey_path Path to the public key. |
| 307 | * @param[in] username Username that the client with the public key must use. |
| 308 | * @return 0 on success, -1 on error. |
| 309 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 310 | int nc_server_ssh_endpt_add_authkey(const char *endpt_name, const char *pubkey_path, const char *username); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 311 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 312 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 313 | * @brief Remove an endpoint authorized client SSH public key. |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 314 | * |
| 315 | * @param[in] pubkey_path Path to an authorized public key. NULL matches all the keys. |
| 316 | * @param[in] username Username for an authorized public key. NULL matches all the usernames. |
| 317 | * @return 0 on success, -1 on not finding any match. |
| 318 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 319 | int nc_server_ssh_endpt_del_authkey(const char *endpt_name, const char *pubkey_path, const char *username); |
| 320 | |
| 321 | /** |
| 322 | * @brief Free all the various SSH server options (excluding Call Home). |
| 323 | */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 324 | void nc_server_ssh_destroy_opts(void); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 325 | |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 326 | /* |
| 327 | * Call Home |
| 328 | */ |
| 329 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 330 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 331 | * @brief Establish an SSH Call Home connection with a listening NETCONF client. |
| 332 | * |
| 333 | * @param[in] host Host the client is listening on. |
| 334 | * @param[in] port Port the client is listening on. |
| 335 | * @param[in] timeout Timeout for transport-related operations, 0 for non-blocking |
| 336 | * call, -1 for infinite waiting. |
| 337 | * @param[out] session New Call Home session. |
| 338 | * @return 1 on success, 0 on timeout, -1 on error. |
| 339 | */ |
| 340 | int nc_connect_callhome_ssh(const char *host, uint16_t port, int timeout, struct nc_session **session); |
| 341 | |
| 342 | /** |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 343 | * @brief Set Call Home SSH host keys the server will identify itself with. Each of RSA, DSA, and |
| 344 | * ECDSA keys can be set. If the particular type was already set, it is replaced. |
| 345 | * |
| 346 | * @param[in] privkey_path Path to a private key. |
| 347 | * @return 0 on success, -1 on error. |
| 348 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 349 | int nc_server_ssh_ch_set_hostkey(const char *privkey_path); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 350 | |
| 351 | /** |
| 352 | * @brief Set Call Home SSH banner the server will send to every client. |
| 353 | * |
| 354 | * @param[in] banner SSH banner. |
| 355 | * @return 0 on success, -1 on error. |
| 356 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 357 | int nc_server_ssh_ch_set_banner(const char *banner); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 358 | |
| 359 | /** |
| 360 | * @brief Set accepted Call Home SSH authentication methods. All (publickey, password, interactive) |
| 361 | * are supported by default. |
| 362 | * |
| 363 | * @param[in] auth_methods Accepted authentication methods bit field of NC_SSH_AUTH_TYPE. |
| 364 | * @return 0 on success, -1 on error. |
| 365 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 366 | int nc_server_ssh_ch_set_auth_methods(int auth_methods); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 367 | |
| 368 | /** |
| 369 | * @brief Set Call Home SSH authentication attempts of every client. 3 by default. |
| 370 | * |
| 371 | * @param[in] auth_attempts Failed authentication attempts before a client is dropped. |
| 372 | * @return 0 on success, -1 on error. |
| 373 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 374 | int nc_server_ssh_ch_set_auth_attempts(uint16_t auth_attempts); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 375 | |
| 376 | /** |
| 377 | * @brief Set Call Home SSH authentication timeout. 10 seconds by default. |
| 378 | * |
| 379 | * @param[in] auth_timeout Number of seconds before an unauthenticated client is dropped. |
| 380 | * @return 0 on success, -1 on error. |
| 381 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 382 | int nc_server_ssh_ch_set_auth_timeout(uint16_t auth_timeout); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 383 | |
| 384 | /** |
| 385 | * @brief Add an authorized Call Home client SSH public key. This public key can be used for |
| 386 | * publickey authentication afterwards. |
| 387 | * |
| 388 | * @param[in] pubkey_path Path to the public key. |
| 389 | * @param[in] username Username that the client with the public key must use. |
| 390 | * @return 0 on success, -1 on error. |
| 391 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 392 | int nc_server_ssh_ch_add_authkey(const char *pubkey_path, const char *username); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 393 | |
| 394 | /** |
| 395 | * @brief Remove an authorized Call Home client SSH public key. |
| 396 | * |
| 397 | * @param[in] pubkey_path Path to an authorized public key. NULL matches all the keys. |
| 398 | * @param[in] username Username for an authorized public key. NULL matches all the usernames. |
| 399 | * @return 0 on success, -1 on not finding any match. |
| 400 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 401 | int nc_server_ssh_ch_del_authkey(const char *pubkey_path, const char *username); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 402 | |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 403 | /* TODO */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 404 | void nc_server_ssh_ch_clear_opts(void); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 405 | |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 406 | #endif /* ENABLE_SSH */ |
| 407 | |
| 408 | #ifdef ENABLE_TLS |
| 409 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 410 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 411 | * @brief Add a new TLS endpoint and start listening on it. |
| 412 | * |
| 413 | * @param[in] name Arbitrary unique endpoint name. There can be an SSH endpoint with |
| 414 | * the same name. |
| 415 | * @param[in] address IP address to listen on. |
| 416 | * @param[in] port Port to listen on. |
| 417 | * @return 0 on success, -1 on error. |
| 418 | */ |
| 419 | int nc_server_tls_add_endpt_listen(const char *name, const char *address, uint16_t port); |
| 420 | |
| 421 | /** |
| 422 | * @brief Stop listening on and remove a TLS endpoint. |
| 423 | * |
| 424 | * @param[in] name Endpoint name. NULL matches all (TLS) endpoints. |
| 425 | * @return 0 on success, -1 on not finding any match. |
| 426 | */ |
| 427 | int nc_server_tls_del_endpt(const char *name); |
| 428 | |
| 429 | /** |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 430 | * @brief Set server TLS certificate. Alternative to nc_tls_server_set_cert_path(). |
| 431 | * There can only be one certificate for each key type, it is replaced if already set. |
| 432 | * |
| 433 | * @param[in] cert Base64-encoded certificate in ASN.1 DER encoding. |
| 434 | * @return 0 on success, -1 on error. |
| 435 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 436 | int nc_server_tls_endpt_set_cert(const char *endpt_name, const char *cert); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 437 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 438 | /** |
| 439 | * @brief Set server TLS certificate. Alternative to nc_tls_server_set_cert(). |
| 440 | * There can only be one certificate for each key type, it is replaced if already set. |
| 441 | * |
| 442 | * @param[in] cert_path Path to a certificate file in PEM format. |
| 443 | * @return 0 on success, -1 on error. |
| 444 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 445 | int nc_server_tls_endpt_set_cert_path(const char *endpt_name, const char *cert_path); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 446 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 447 | /** |
| 448 | * @brief Set server TLS private key matching the certificate. |
| 449 | * Alternative to nc_tls_server_set_key_path(). There can only be one of every key |
| 450 | * type, it is replaced if already set. |
| 451 | * |
| 452 | * @param[in] privkey Base64-encoded certificate in ASN.1 DER encoding. |
| 453 | * @param[in] is_rsa Whether \p privkey are the data of an RSA (1) or DSA (0) key. |
| 454 | * @return 0 on success, -1 on error. |
| 455 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 456 | int nc_server_tls_endpt_set_key(const char *endpt_name, const char *privkey, int is_rsa); |
Michal Vasko | c14e3c8 | 2016-01-11 16:14:30 +0100 | [diff] [blame] | 457 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 458 | /** |
| 459 | * @brief Set server TLS private key matching the certificate. |
| 460 | * Alternative to nc_tls_server_set_key_path(). There can only be one of every key |
| 461 | * type, it is replaced if already set. |
| 462 | * |
| 463 | * @param[in] privkey_path Path to a private key file in PEM format. |
| 464 | * @return 0 on success, -1 on error. |
| 465 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 466 | int nc_server_tls_endpt_set_key_path(const char *endpt_name, const char *privkey_path); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 467 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 468 | /** |
| 469 | * @brief Add a trusted certificate. Can be both a CA or a client one. |
| 470 | * |
| 471 | * @param[in] cert Base64-enocded certificate in ASN.1DER encoding. |
| 472 | * @return 0 on success, -1 on error. |
| 473 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 474 | int nc_server_tls_endpt_add_trusted_cert(const char *endpt_name, const char *cert); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 475 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 476 | /** |
| 477 | * @brief Add a trusted certificate. Can be both a CA or a client one. |
| 478 | * |
| 479 | * @param[in] cert_path Path to a trusted certificate file in PEM format. |
| 480 | * @return 0 on success, -1 on error. |
| 481 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 482 | int nc_server_tls_endpt_add_trusted_cert_path(const char *endpt_name, const char *cert_path); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 483 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 484 | /** |
| 485 | * @brief Set trusted Certificate Authority certificate locations. There can only be |
| 486 | * one file and one directory, they are replaced if already set. |
| 487 | * |
| 488 | * @param[in] cacert_file_path Path to a trusted CA cert store file in PEM format. |
| 489 | * Can be NULL. |
| 490 | * @param[in] cacert_dir_path Path to a trusted CA cert store hashed directory |
| 491 | * (c_rehash utility can be used to create hashes) with PEM files. Can be NULL. |
| 492 | * @return 0 on success, -1 on error. |
| 493 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 494 | int nc_server_tls_endpt_set_trusted_cacert_locations(const char *endpt_name, const char *cacert_file_path, const char *cacert_dir_path); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 495 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 496 | /** |
| 497 | * @brief Destroy and clean all the set certificates and private keys. CRLs and |
| 498 | * CTN entries are not affected. |
| 499 | */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 500 | void nc_server_tls_endpt_clear_certs(const char *endpt_name); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 501 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 502 | /** |
| 503 | * @brief Set Certificate Revocation List locations. There can only be one file |
| 504 | * and one directory, they are replaced if already set. |
| 505 | * |
| 506 | * @param[in] crl_file_path Path to a CRL store file in PEM format. Can be NULL. |
| 507 | * @param[in] crl_dir_path Path to a CRL store hashed directory (c_rehash utility |
| 508 | * can be used to create hashes) with PEM files. Can be NULL. |
| 509 | * @return 0 on success, -1 on error. |
| 510 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 511 | int nc_server_tls_endpt_set_crl_locations(const char *endpt_name, const char *crl_file_path, const char *crl_dir_path); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 512 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 513 | /** |
| 514 | * @brief Destroy and clean CRLs. Certificates, priavte keys, and CTN entries are |
| 515 | * not affected. |
| 516 | */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 517 | void nc_server_tls_endpt_clear_crls(const char *endpt_name); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 518 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 519 | /** |
| 520 | * @brief Add a Cert-to-name entry. |
| 521 | * |
| 522 | * @param[in] id Priority of the entry. |
| 523 | * @param[in] fingerprint Matching certificate fingerprint. |
| 524 | * @param[in] map_type Type of username-certificate mapping. |
| 525 | * @param[in] name Specific username if \p map_type == NC_TLS_CTN_SPECIFED. Must be NULL otherwise. |
| 526 | * @return 0 on success, -1 on error. |
| 527 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 528 | int nc_server_tls_endpt_add_ctn(const char *endpt_name, uint32_t id, const char *fingerprint, NC_TLS_CTN_MAPTYPE map_type, const char *name); |
Michal Vasko | c14e3c8 | 2016-01-11 16:14:30 +0100 | [diff] [blame] | 529 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 530 | /** |
| 531 | * @brief Remove a Cert-to-name entry. |
| 532 | * |
| 533 | * @param[in] id Priority of the entry. -1 matches all the priorities. |
| 534 | * @param[in] fingerprint Fingerprint fo the entry. NULL matches all the fingerprints. |
| 535 | * @param[in] map_type Mapping type of the entry. 0 matches all the mapping types. |
| 536 | * @param[in] name Specific username for the entry. NULL matches all the usernames. |
| 537 | * @return 0 on success, -1 on not finding any match. |
| 538 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 539 | int nc_server_tls_endpt_del_ctn(const char *endpt_name, int64_t id, const char *fingerprint, NC_TLS_CTN_MAPTYPE map_type, const char *name); |
Michal Vasko | 0457bb4 | 2016-01-08 15:49:13 +0100 | [diff] [blame] | 540 | |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 541 | /* |
| 542 | * Call Home |
| 543 | */ |
| 544 | |
Michal Vasko | 1a38c86 | 2016-01-15 15:50:07 +0100 | [diff] [blame] | 545 | /** |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 546 | * @brief Establish a TLS Call Home connection with a listening NETCONF client. |
| 547 | * |
| 548 | * @param[in] host Host the client is listening on. |
| 549 | * @param[in] port Port the client is listening on. |
| 550 | * @param[in] timeout Timeout for transport-related operations, 0 for non-blocking |
| 551 | * call, -1 for infinite waiting. |
| 552 | * @param[out] session New Call Home session. |
| 553 | * @return 1 on success, 0 on timeout, -1 on error. |
| 554 | */ |
| 555 | int nc_connect_callhome_tls(const char *host, uint16_t port, int timeout, struct nc_session **session); |
| 556 | |
| 557 | /** |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 558 | * @brief Set server Call Home TLS certificate. Alternative to nc_tls_server_set_cert_path(). |
| 559 | * There can only be one certificate for each key type, it is replaced if already set. |
| 560 | * |
| 561 | * @param[in] cert Base64-encoded certificate in ASN.1 DER encoding. |
| 562 | * @return 0 on success, -1 on error. |
| 563 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 564 | int nc_server_tls_ch_set_cert(const char *cert); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 565 | |
| 566 | /** |
| 567 | * @brief Set server Call Home TLS certificate. Alternative to nc_tls_server_set_cert(). |
| 568 | * There can only be one certificate for each key type, it is replaced if already set. |
| 569 | * |
| 570 | * @param[in] cert_path Path to a certificate file in PEM format. |
| 571 | * @return 0 on success, -1 on error. |
| 572 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 573 | int nc_server_tls_ch_set_cert_path(const char *cert_path); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 574 | |
| 575 | /** |
| 576 | * @brief Set server Call Home TLS private key matching the certificate. |
| 577 | * Alternative to nc_tls_server_set_key_path(). There can only be one of every key |
| 578 | * type, it is replaced if already set. |
| 579 | * |
| 580 | * @param[in] privkey Base64-encoded certificate in ASN.1 DER encoding. |
| 581 | * @param[in] is_rsa Whether \p privkey are the data of an RSA (1) or DSA (0) key. |
| 582 | * @return 0 on success, -1 on error. |
| 583 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 584 | int nc_server_tls_ch_set_key(const char *privkey, int is_rsa); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 585 | |
| 586 | /** |
| 587 | * @brief Set server Call Home TLS private key matching the certificate. |
| 588 | * Alternative to nc_tls_server_set_key_path(). There can only be one of every key |
| 589 | * type, it is replaced if already set. |
| 590 | * |
| 591 | * @param[in] privkey_path Path to a private key file in PEM format. |
| 592 | * @return 0 on success, -1 on error. |
| 593 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 594 | int nc_server_tls_ch_set_key_path(const char *privkey_path); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 595 | |
| 596 | /** |
| 597 | * @brief Add a Call Home trusted certificate. Can be both a CA or a client one. |
| 598 | * |
| 599 | * @param[in] cert Base64-enocded certificate in ASN.1DER encoding. |
| 600 | * @return 0 on success, -1 on error. |
| 601 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 602 | int nc_server_tls_ch_add_trusted_cert(const char *cert); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 603 | |
| 604 | /** |
| 605 | * @brief Add a Call Home trusted certificate. Can be both a CA or a client one. |
| 606 | * |
| 607 | * @param[in] cert_path Path to a trusted certificate file in PEM format. |
| 608 | * @return 0 on success, -1 on error. |
| 609 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 610 | int nc_server_tls_ch_add_trusted_cert_path(const char *cert_path); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 611 | |
| 612 | /** |
| 613 | * @brief Set trusted Call Home Certificate Authority certificate locations. There |
| 614 | * can only be one file and one directory, they are replaced if already set. |
| 615 | * |
| 616 | * @param[in] cacert_file_path Path to a trusted CA cert store file in PEM format. |
| 617 | * Can be NULL. |
| 618 | * @param[in] cacert_dir_path Path to a trusted CA cert store hashed directory |
| 619 | * (c_rehash utility can be used to create hashes) with PEM files. Can be NULL. |
| 620 | * @return 0 on success, -1 on error. |
| 621 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 622 | int nc_server_tls_ch_set_trusted_cacert_locations(const char *cacert_file_path, const char *cacert_dir_path); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 623 | |
| 624 | /** |
| 625 | * @brief Destroy and clean all the set Call Home certificates and private keys. |
| 626 | * CRLs and CTN entries are not affected. |
| 627 | */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 628 | void nc_server_tls_ch_clear_certs(void); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 629 | |
| 630 | /** |
| 631 | * @brief Set Call Home Certificate Revocation List locations. There can only be |
| 632 | * one file and one directory, they are replaced if already set. |
| 633 | * |
| 634 | * @param[in] crl_file_path Path to a CRL store file in PEM format. Can be NULL. |
| 635 | * @param[in] crl_dir_path Path to a CRL store hashed directory (c_rehash utility |
| 636 | * can be used to create hashes) with PEM files. Can be NULL. |
| 637 | * @return 0 on success, -1 on error. |
| 638 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 639 | int nc_server_tls_ch_set_crl_locations(const char *crl_file_path, const char *crl_dir_path); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 640 | |
| 641 | /** |
| 642 | * @brief Destroy and clean Call Home CRLs. Call Home certificates, private keys, |
| 643 | * and CTN entries are not affected. |
| 644 | */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 645 | void nc_server_tls_ch_clear_crls(void); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 646 | |
| 647 | /** |
| 648 | * @brief Add a Call Home Cert-to-name entry. |
| 649 | * |
| 650 | * @param[in] id Priority of the entry. |
| 651 | * @param[in] fingerprint Matching certificate fingerprint. |
| 652 | * @param[in] map_type Type of username-certificate mapping. |
| 653 | * @param[in] name Specific username if \p map_type == NC_TLS_CTN_SPECIFED. Must be NULL otherwise. |
| 654 | * @return 0 on success, -1 on error. |
| 655 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 656 | int nc_server_tls_ch_add_ctn(uint32_t id, const char *fingerprint, NC_TLS_CTN_MAPTYPE map_type, const char *name); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 657 | |
| 658 | /** |
| 659 | * @brief Remove a Call Home Cert-to-name entry. |
| 660 | * |
| 661 | * @param[in] id Priority of the entry. -1 matches all the priorities. |
| 662 | * @param[in] fingerprint Fingerprint fo the entry. NULL matches all the fingerprints. |
| 663 | * @param[in] map_type Mapping type of the entry. 0 matches all the mapping types. |
| 664 | * @param[in] name Specific username for the entry. NULL matches all the usernames. |
| 665 | * @return 0 on success, -1 on not finding any match. |
| 666 | */ |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 667 | int nc_server_tls_ch_del_ctn(int64_t id, const char *fingerprint, NC_TLS_CTN_MAPTYPE map_type, const char *name); |
Michal Vasko | b05053d | 2016-01-22 16:12:06 +0100 | [diff] [blame] | 668 | |
Michal Vasko | 3031aae | 2016-01-27 16:07:18 +0100 | [diff] [blame] | 669 | /* TODO */ |
Michal Vasko | c6b9c7b | 2016-01-28 11:10:08 +0100 | [diff] [blame] | 670 | void nc_server_tls_ch_clear_opts(void); |
Michal Vasko | 086311b | 2016-01-08 09:53:11 +0100 | [diff] [blame] | 671 | |
| 672 | #endif /* ENABLE_TLS */ |
| 673 | |
| 674 | #endif /* NC_SESSION_SERVER_H_ */ |