| /** |
| * @file server_config.h |
| * @author Roman Janota <janota@cesnet.cz> |
| * @brief libnetconf2 server configuration |
| * |
| * @copyright |
| * Copyright (c) 2023 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. |
| * You may obtain a copy of the License at |
| * |
| * https://opensource.org/licenses/BSD-3-Clause |
| */ |
| |
| #ifndef NC_CONFIG_SERVER_H_ |
| #define NC_CONFIG_SERVER_H_ |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #include <stdarg.h> |
| #include <stdint.h> |
| |
| #include <libyang/libyang.h> |
| |
| #include "session.h" |
| |
| /** |
| * @brief Configure server based on the given diff data. |
| * |
| * Expected data are a validated instance of a ietf-netconf-server YANG data. |
| * The data must be in the diff format and supported operations are: create, replace, |
| * delete and none. Context must already have implemented the required modules, see |
| * ::nc_config_load_modules(). |
| * |
| * @param[in] diff ietf-netconf-server YANG diff data. |
| * @return 0 on success, 1 on error. |
| */ |
| int nc_server_config_setup_diff(const struct lyd_node *diff); |
| |
| /** |
| * @brief Configure server based on the given data. |
| * |
| * Expected data is a validated instance of a ietf-netconf-server YANG data. |
| * Behaves as if all the nodes in data had the replace operation. That means that the current configuration will be deleted |
| * and just the given data will all be applied. |
| * The data must not contain any operation attribute, see ::nc_config_setup_diff() which works with diff. |
| * Context must already have implemented the required modules, see * ::nc_config_load_modules(). |
| * |
| * @param[in] data ietf-netconf-server YANG data. |
| * @return 0 on success, 1 on error. |
| */ |
| int nc_server_config_setup_data(const struct lyd_node *data); |
| |
| /** |
| * @brief Configure server based on the given ietf-netconf-server YANG data. |
| * Wrapper around ::nc_config_setup_server_data() hiding work with parsing the data. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] path Path to the file with YANG data in XML format. |
| * @return 0 on success, 1 on error. |
| */ |
| int nc_server_config_setup_path(const struct ly_ctx *ctx, const char *path); |
| |
| /** |
| * @brief Implements all the required modules and their features in the context. |
| * Needs to be called before any other configuration functions. |
| * |
| * If ctx is : |
| * - NULL: a new context will be created and if the call is successful you have to free it, |
| * - non NULL: modules will simply be implemented. |
| * |
| * Implemented modules: ietf-netconf-server, ietf-x509-cert-to-name, ietf-crypto-types, |
| * ietf-tcp-common, ietf-ssh-common, iana-ssh-encryption-algs, iana-ssh-key-exchange-algs, |
| * iana-ssh-mac-algs, iana-ssh-public-key-algs, ietf-keystore, ietf-ssh-server, ietf-truststore, |
| * ietf-tls-server and libnetconf2-netconf-server. |
| * |
| * @param[in, out] ctx Optional context in which the modules will be implemented. Created if ctx is null. |
| * @return 0 on success, 1 on error. |
| */ |
| int nc_server_config_load_modules(struct ly_ctx **ctx); |
| |
| #ifdef NC_ENABLED_SSH_TLS |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a local-address and local-port. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * @param[in] transport Either SSH or TLS transport for the given endpoint. |
| * @param[in] address New listening address. |
| * @param[in] port New listening port. |
| * If an endpoint with this identifier already exists, it's address and port will be overriden. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_address_port(const struct ly_ctx *ctx, const char *endpt_name, NC_TRANSPORT_IMPL transport, |
| const char *address, const char *port, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a hostkey. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's hostkey might be changed. |
| * @param[in] hostkey_name Arbitrary identifier of the hostkey. |
| * If a hostkey with this identifier already exists, it's contents will be changed. |
| * @param[in] privkey_path Path to a file containing a private key. |
| * The private key has to be in a PEM format. Only RSA and ECDSA keys are supported. |
| * @param[in] pubkey_path Path to a file containing a public key. If NULL, public key will be |
| * generated from the private key. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_hostkey(const struct ly_ctx *ctx, |
| const char *endpt_name, const char *hostkey_name, const char *privkey_path, const char *pubkey_path, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for host-key algorithms replacing any previous ones. |
| * |
| * Supported algorithms are: ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, |
| * rsa-sha2-512, rsa-sha2-256, ssh-rsa and ssh-dss. |
| * |
| * @param[in] ctx libyang context |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's host-key algorithms will be replaced. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @param[in] alg_count Number of following algorithms. |
| * @param[in] ... String literals of host-key algorithms in a decreasing order of preference. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_host_key_algs(const struct ly_ctx *ctx, const char *endpt_name, |
| struct lyd_node **config, int alg_count, ...); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for key exchange algorithms replacing any previous ones. |
| * |
| * Supported algorithms are: diffie-hellman-group-exchange-sha1, curve25519-sha256, ecdh-sha2-nistp256, |
| * ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group18-sha512, diffie-hellman-group16-sha512, |
| * diffie-hellman-group-exchange-sha256 and diffie-hellman-group14-sha256. |
| * |
| * @param[in] ctx libyang context |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's key exchange algorithms will be replaced. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @param[in] alg_count Number of following algorithms. |
| * @param[in] ... String literals of key exchange algorithms in a decreasing order of preference. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_key_exchange_algs(const struct ly_ctx *ctx, const char *endpt_name, struct lyd_node **config, |
| int alg_count, ...); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for encryption algorithms replacing any previous ones. |
| * |
| * Supported algorithms are: aes256-ctr, aes192-ctr, aes128-ctr, aes256-cbc, aes192-cbc, aes128-cbc, blowfish-cbc |
| * triple-des-cbc and none. |
| * |
| * @param[in] ctx libyang context |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's encryption algorithms will be replaced. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @param[in] alg_count Number of following algorithms. |
| * @param[in] ... String literals of encryption algorithms in a decreasing order of preference. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_encryption_algs(const struct ly_ctx *ctx, const char *endpt_name, struct lyd_node **config, |
| int alg_count, ...); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for mac algorithms replacing any previous ones. |
| * |
| * Supported algorithms are: hmac-sha2-256, hmac-sha2-512 and hmac-sha1. |
| * |
| * @param[in] ctx libyang context |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's mac algorithms will be replaced. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @param[in] alg_count Number of following algorithms. |
| * @param[in] ... String literals of mac algorithms in a decreasing order of preference. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_mac_algs(const struct ly_ctx *ctx, const char *endpt_name, struct lyd_node **config, |
| int alg_count, ...); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a client, which supports the public key authentication method. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's user might be changed. |
| * @param[in] user_name Arbitrary identifier of the user. |
| * If an user with this identifier already exists, it's contents will be changed. |
| * @param[in] pubkey_name Arbitrary identifier of the user's public key. |
| * If a public key with this identifier already exists for this user, it's contents will be changed. |
| * @param[in] pubkey_path Path to a file containing the user's public key. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_client_auth_pubkey(const struct ly_ctx *ctx, const char *endpt_name, |
| const char *user_name, const char *pubkey_name, const char *pubkey_path, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a client, which supports the password authentication method. |
| * |
| * This function sets the password for the given user. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's user might be changed. |
| * @param[in] user_name Arbitrary identifier of the user. |
| * If an user with this identifier already exists, it's contents will be changed. |
| * @param[in] password Cleartext user's password. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_client_auth_password(const struct ly_ctx *ctx, const char *endpt_name, |
| const char *user_name, const char *password, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a client, which supports the none authentication method. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's user might be changed. |
| * @param[in] user_name Arbitrary identifier of the user. |
| * If an user with this identifier already exists, it's contents will be changed. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_client_auth_none(const struct ly_ctx *ctx, const char *endpt_name, |
| const char *user_name, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a client, which supports the interactive authentication method. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's user might be changed. |
| * @param[in] user_name Arbitrary identifier of the user. |
| * If an user with this identifier already exists, it's contents will be changed. |
| * @param[in] pam_config_name Name of the PAM configuration file. |
| * @param[in] pam_config_name Optional. The absolute path to the directory in which the configuration file |
| * with the name conf_name is located. A newer version (>= 1.4) of PAM library is required to be able to specify |
| * the path. If NULL is passed, then the PAM's system directories will be searched (usually /etc/pam.d/). |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_ssh_client_auth_interactive(const struct ly_ctx *ctx, const char *endpt_name, |
| const char *user_name, const char *pam_config_name, const char *pam_config_dir, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a server's certificate. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's server certificate will be changed. |
| * @param[in] pubkey_path Optional path to the server's public key file. If not provided, |
| * it will be generated from the private key. |
| * @param[in] privkey_path Path to the server's private key file. |
| * @param[in] certificate_path Path to the server's certificate file. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_server_certificate(const struct ly_ctx *ctx, const char *endpt_name, const char *pubkey_path, |
| const char *privkey_path, const char *certificate_path, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a client's (end-entity) certificate. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in] cert_name Arbitrary identifier of the client's certificate. |
| * If a client certificate with this indetifier already exists, it will be changed. |
| * @param[in] cert_path Path to the client's certificate file. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_client_certificate(const struct ly_ctx *ctx, const char *endpt_name, const char *cert_name, |
| const char *cert_path, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a client certificate authority (trust-anchor) certificate. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in] cert_name Arbitrary identifier of the certificate authority certificate. |
| * If a CA with this indetifier already exists, it will be changed. |
| * @param[in] cert_path Path to the CA certificate file. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_client_ca(const struct ly_ctx *ctx, const char *endpt_name, const char *cert_name, |
| const char *cert_path, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a cert-to-name entry. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in] id ID of the entry. The lower the ID, the higher the priority of the entry (it will be checked earlier). |
| * @param[in] fingerprint Optional fingerprint of the entry. The fingerprint should always be set, however if it is |
| * not set, it will match any certificate. Entry with no fingerprint should therefore be placed only as the last entry. |
| * @param[in] map_type Mapping username to the certificate option. |
| * @param[in] name Username for this cert-to-name entry. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_ctn(const struct ly_ctx *ctx, const char *endpt_name, uint32_t id, const char *fingerprint, |
| NC_TLS_CTN_MAPTYPE map_type, const char *name, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a TLS version. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in] tls_version TLS version to be used. Call this multiple times to set |
| * the accepted versions of the TLS protocol and let the client and server negotiate |
| * the given version. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_version(const struct ly_ctx *ctx, const char *endpt_name, |
| NC_TLS_VERSION tls_version, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a TLS cipher. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @param[in] cipher_count Number of ciphers. |
| * @param[in] ... TLS ciphers. These ciphers MUST be in the format as listed in the |
| * iana-tls-cipher-suite-algs YANG model (lowercase and separated by dashes). Regardless |
| * of the TLS protocol version used, all of these ciphers will be tried and some of them |
| * might not be set (TLS handshake might fail then). For the list of supported ciphers see |
| * the OpenSSL documentation. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_ciphers(const struct ly_ctx *ctx, const char *endpt_name, struct lyd_node **config, |
| int cipher_count, ...); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a Certificate Revocation List via a local file. |
| * |
| * Beware that you can choose up to one function between the three CRL alternatives on a given endpoint and calling |
| * this function will remove any CRL YANG nodes created by the other two functions. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in] path Path to a DER/PEM encoded CRL file. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_crl_path(const struct ly_ctx *ctx, const char *endpt_name, const char *path, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a Certificate Revocation List via an URL. |
| * |
| * Beware that you can choose up to one function between the three CRL alternatives on a given endpoint and calling |
| * this function will remove any CRL YANG nodes created by the other two functions. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in] url URL from which the CRL file will be downloaded. The file has to be in the DER or PEM format. |
| * The allowed protocols are all the protocols supported by CURL. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_crl_url(const struct ly_ctx *ctx, const char *endpt_name, const char *url, struct lyd_node **config); |
| |
| /** |
| * @brief Creates new YANG configuration data nodes for a Certificate Revocation List via certificate extensions. |
| * |
| * The chain of configured Certificate Authorities will be examined. For each certificate in this chain all the |
| * CRLs from the URLs specified in their extension fields CRL Distribution Points will be downloaded and used. |
| * Beware that you can choose up to one function between the three CRL alternatives on a given endpoint and calling |
| * this function will remove any CRL YANG nodes created by the other two functions. |
| * |
| * @param[in] ctx libyang context. |
| * @param[in] endpt_name Arbitrary identifier of the endpoint. |
| * If an endpoint with this identifier already exists, it's contents will be changed. |
| * @param[in,out] config Configuration YANG data tree. If *config is NULL, it will be created. |
| * Otherwise the new YANG data will be added to the previous data and may override it. |
| * @return 0 on success, non-zero otherwise. |
| */ |
| int nc_server_config_new_tls_crl_cert_ext(const struct ly_ctx *ctx, const char *endpt_name, struct lyd_node **config); |
| |
| #endif /* NC_ENABLED_SSH_TLS */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* NC_SESSION_SERVER_H_ */ |