Skip to content

Commit

Permalink
build UPDATE file url protocol disabled by default
Browse files Browse the repository at this point in the history 
Refs #1537
  • Loading branch information
@michalvasko
michalvasko committed Feb 13, 2024
1 parent 0a7eb1c commit 0b566c8
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 78 deletions.
6 changes: 6 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ endif()
option(ENABLE_COVERAGE "Build code coverage report from tests" OFF)
option(BUILD_CLI "Build and install neotpeer2-cli" ON)
option(ENABLE_URL "Enable URL capability" ON)
option(ENABLE_URL_FILE "Enable the 'file' URL protocol (security advisory: allows authorized users to access local FS as the server user)" OFF)
set(SSH_AUTHORIZED_KEYS_FORMAT "%h/.ssh/authorized_keys" CACHE STRING "sshd-like pattern (with '%h', '%u', '%U') for determining path to users' SSH authorized_keys file.")
set(THREAD_COUNT 3 CACHE STRING "Number of threads accepting new sessions and handling requests")
set(POLL_IO_TIMEOUT 10 CACHE STRING "Timeout in milliseconds of polling sessions for new data. It is also used for synchronization of low level IO such as sending a reply while a notification is being sent")
Expand Down Expand Up @@ -267,6 +268,11 @@ if(ENABLE_URL)
target_link_libraries(netopeer2-server ${CURL_LIBRARIES})
endif()
set(NP2SRV_URL_CAPAB 1)
if(ENABLE_URL_FILE)
set(NP2SRV_URL_FILE_PROTO 1)
else()
unset(NP2SRV_URL_FILE_PROTO)
endif()
else()
message(STATUS "libcurl not found, url capability will not be supported")
unset(NP2SRV_URL_CAPAB)
Expand Down
144 changes: 73 additions & 71 deletions src/common.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -486,50 +486,42 @@ int
np2srv_url_setcap(void)
{
uint32_t i, j;
char *cpblt;
int first = 1, cur_prot, sup_prot = 0;
char *cpblt, *url_protocols = NULL;
int len = 0;
curl_version_info_data *curl_data;
const char *url_protocol_str[] = {"scp", "http", "https", "ftp", "sftp", "ftps", "file", NULL};
const char *main_cpblt = "urn:ietf:params:netconf:capability:url:1.0?scheme=";

# ifdef NP2SRV_URL_FILE_PROTO
const char *url_protocols_all[] = {"file", "ftp", "ftps", "http", "https", "scp", "sftp"};
# else
const char *url_protocols_all[] = {"ftp", "ftps", "http", "https", "scp", "sftp"};
# endif

assert(!np2srv.url_protocols);

curl_data = curl_version_info(CURLVERSION_NOW);
for (i = 0; curl_data->protocols[i]; ++i) {
for (j = 0; url_protocol_str[j]; ++j) {
if (!strcmp(curl_data->protocols[i], url_protocol_str[j])) {
sup_prot |= (1 << j);
for (j = 0; j < (sizeof url_protocols_all / sizeof *url_protocols_all); ++j) {
if (!strcmp(curl_data->protocols[i], url_protocols_all[j])) {
/* add supported protocol */
url_protocols = realloc(url_protocols, len + (len ? 1 : 0) + strlen(url_protocols_all[j]) + 1);
len += sprintf(url_protocols + len, "%s%s", len ? "," : "", url_protocols_all[j]);
break;
}
}
}
if (!sup_prot) {
if (!url_protocols) {
/* no protocols supported */
return 0;
}

/* get max capab string size and allocate it */
j = strlen(main_cpblt) + 1;
for (i = 0; url_protocol_str[i]; ++i) {
j += strlen(url_protocol_str[i]) + 1;
}
cpblt = malloc(j);
if (!cpblt) {
EMEM;
return -1;
}

/* main capability */
strcpy(cpblt, main_cpblt);

/* supported protocols */
for (i = 0, cur_prot = 1; i < (sizeof url_protocol_str / sizeof *url_protocol_str); ++i, cur_prot <<= 1) {
if (cur_prot & sup_prot) {
sprintf(cpblt + strlen(cpblt), "%s%s", first ? "" : ",", url_protocol_str[i]);
first = 0;
}
}

/* generate the capability string and set it */
asprintf(&cpblt, "%s%s", main_cpblt, url_protocols);
nc_server_set_capability(cpblt);
free(cpblt);

/* store the supported URL protocols for libcurl */
np2srv.url_protocols = url_protocols;
return 0;
}

Expand All @@ -541,16 +533,20 @@ struct np2srv_url_mem {
static size_t
url_writedata(char *ptr, size_t size, size_t nmemb, void *userdata)
{
int *fd = (int *)userdata;
struct np2srv_url_mem *data = userdata;

return write(*fd, ptr, size * nmemb);
data->memory = realloc(data->memory, data->size + (size * nmemb) + 1);
memcpy(data->memory + data->size, ptr, size * nmemb);
data->size += size * nmemb;

return size * nmemb;
}

static size_t
url_readdata(void *ptr, size_t size, size_t nmemb, void *userdata)
{
size_t copied = 0, aux_size = size * nmemb;
struct np2srv_url_mem *data = (struct np2srv_url_mem *)userdata;
struct np2srv_url_mem *data = userdata;

if ((aux_size < 1) || (data->size == 0)) {
/* no space or nothing left */
Expand All @@ -565,90 +561,89 @@ url_readdata(void *ptr, size_t size, size_t nmemb, void *userdata)
}

/**
* @brief Open specific URL using curl.
* @brief Get a specific URL using curl.
*
* @param[in] url URL to open.
* @return FD with the URL contents;
* @return -1 on error.
* @param[in] ev_sess Event session for errors.
* @return Data downloaded from the URL, NULL on error.
*/
static int
url_open(const char *url)
static char *
url_get(const char *url, sr_session_ctx_t *ev_sess)
{
CURL *curl;
CURLcode res;
char curl_buffer[CURL_ERROR_SIZE];
char url_tmp_name[(sizeof P_tmpdir / sizeof(char)) + 15] = P_tmpdir "/np2srv-XXXXXX";
int url_tmpfile;
struct np2srv_url_mem mem_data = {0};

/* prepare temporary file ... */
if ((url_tmpfile = mkstemp(url_tmp_name)) < 0) {
ERR("Failed to create a temporary file (%s).", strerror(errno));
return -1;
if (!np2srv.url_protocols) {
ERR("No URL protocols enabled.");
sr_session_set_error_message(ev_sess, "No URL protocols enabled.");
return NULL;
}

/* and hide it from the file system */
unlink(url_tmp_name);

DBG("Getting file from URL: %s (via curl)", url);

/* set up libcurl */
curl_global_init(URL_INIT_FLAGS);
curl = curl_easy_init();
curl_easy_setopt(curl, CURLOPT_PROTOCOLS_STR, np2srv.url_protocols);
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, url_writedata);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &url_tmpfile);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &mem_data);
curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_buffer);

/* download data */
res = curl_easy_perform(curl);
if (res != CURLE_OK) {
ERR("Failed to download data (curl: %s).", curl_buffer);
close(url_tmpfile);
url_tmpfile = -1;
} else {
/* move back to the beginning of the output file */
lseek(url_tmpfile, 0, SEEK_SET);
sr_session_set_error_message(ev_sess, curl_buffer);
goto cleanup;
}

if (mem_data.memory) {
/* add terminating zero */
mem_data.memory[mem_data.size] = '\0';
}

/* cleanup */
cleanup:
curl_easy_cleanup(curl);
curl_global_cleanup();

return url_tmpfile;
return mem_data.memory;
}

struct lyd_node *
op_parse_url(const char *url, int validate, int *rc, sr_session_ctx_t *sr_sess)
op_parse_url(const char *url, int validate, int *rc, sr_session_ctx_t *ev_sess)
{
struct lyd_node *config, *data = NULL;
struct ly_ctx *ly_ctx;
struct lyd_node_opaq *opaq;
int fd;
char *url_data = NULL;

ly_ctx = (struct ly_ctx *)sr_acquire_context(np2srv.sr_conn);

fd = url_open(url);
if (fd == -1) {
url_data = url_get(url, ev_sess);
if (!url_data) {
*rc = SR_ERR_INVAL_ARG;
sr_session_set_error_message(sr_sess, "Could not open URL.");
goto cleanup;
}

/* load the whole config element */
if (lyd_parse_data_fd(ly_ctx, fd, LYD_XML, LYD_PARSE_OPAQ | LYD_PARSE_ONLY | LYD_PARSE_NO_STATE, 0, &config)) {
if (lyd_parse_data_mem(ly_ctx, url_data, LYD_XML, LYD_PARSE_OPAQ | LYD_PARSE_ONLY | LYD_PARSE_NO_STATE, 0, &config)) {
*rc = SR_ERR_LY;
sr_session_set_error_message(sr_sess, ly_errmsg(ly_ctx));
sr_session_set_error_message(ev_sess, ly_errmsg(ly_ctx));
goto cleanup;
}

if (!config || config->schema) {
*rc = SR_ERR_UNSUPPORTED;
sr_session_set_error_message(sr_sess, "Missing top-level \"config\" element in URL data.");
sr_session_set_error_message(ev_sess, "Missing top-level \"config\" element in URL data.");
goto cleanup;
}

opaq = (struct lyd_node_opaq *)config;
if (strcmp(opaq->name.name, "config") || strcmp(opaq->name.module_ns, "urn:ietf:params:xml:ns:netconf:base:1.0")) {
*rc = SR_ERR_UNSUPPORTED;
sr_session_set_error_message(sr_sess, "Invalid top-level element in URL data, expected \"config\" with "
sr_session_set_error_message(ev_sess, "Invalid top-level element in URL data, expected \"config\" with "
"namespace \"urn:ietf:params:xml:ns:netconf:base:1.0\".");
goto cleanup;
}
Expand All @@ -661,18 +656,19 @@ op_parse_url(const char *url, int validate, int *rc, sr_session_ctx_t *sr_sess)
/* separate validation if requested */
if (lyd_validate_all(&data, NULL, LYD_VALIDATE_NO_STATE, NULL)) {
*rc = SR_ERR_LY;
sr_session_set_error_message(sr_sess, ly_errmsg(ly_ctx));
sr_session_set_error_message(ev_sess, ly_errmsg(ly_ctx));
goto cleanup;
}
}

cleanup:
sr_release_context(np2srv.sr_conn);
free(url_data);
return data;
}

int
op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, int *rc, sr_session_ctx_t *sr_sess)
op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, int *rc, sr_session_ctx_t *ev_sess)
{
CURL *curl;
CURLcode res;
Expand All @@ -682,12 +678,17 @@ op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, in
struct ly_ctx *ly_ctx;
int ret = 0;

if (!np2srv.url_protocols) {
ERR("No URL protocols enabled.");
return -1;
}

ly_ctx = (struct ly_ctx *)sr_acquire_context(np2srv.sr_conn);

/* print the config as expected by the other end */
if (lyd_new_opaq2(NULL, ly_ctx, "config", NULL, NULL, "urn:ietf:params:xml:ns:netconf:base:1.0", &config)) {
*rc = SR_ERR_LY;
sr_session_set_error_message(sr_sess, ly_errmsg(ly_ctx));
sr_session_set_error_message(ev_sess, ly_errmsg(ly_ctx));
ret = -1;
goto cleanup;
}
Expand All @@ -709,10 +710,11 @@ op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, in
/* set up libcurl */
curl_global_init(URL_INIT_FLAGS);
curl = curl_easy_init();
curl_easy_setopt(curl, CURLOPT_PROTOCOLS_STR, np2srv.url_protocols);
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
curl_easy_setopt(curl, CURLOPT_READDATA, &mem_data);
curl_easy_setopt(curl, CURLOPT_READFUNCTION, url_readdata);
curl_easy_setopt(curl, CURLOPT_READDATA, &mem_data);
curl_easy_setopt(curl, CURLOPT_INFILESIZE, (long)mem_data.size);
curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, curl_buffer);
res = curl_easy_perform(curl);
Expand All @@ -721,7 +723,7 @@ op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, in
if (res != CURLE_OK) {
ERR("Failed to upload data (curl: %s).", curl_buffer);
*rc = SR_ERR_SYS;
sr_session_set_error_message(sr_sess, curl_buffer);
sr_session_set_error_message(ev_sess, curl_buffer);
ret = -1;
goto curl_cleanup;
}
Expand All @@ -746,7 +748,7 @@ np2srv_url_setcap(void)
#endif

struct lyd_node *
op_parse_config(struct lyd_node_any *config, uint32_t parse_options, int *rc, sr_session_ctx_t *sr_sess)
op_parse_config(struct lyd_node_any *config, uint32_t parse_options, int *rc, sr_session_ctx_t *ev_sess)
{
const struct ly_ctx *ly_ctx;
struct lyd_node *root = NULL;
Expand Down Expand Up @@ -783,7 +785,7 @@ op_parse_config(struct lyd_node_any *config, uint32_t parse_options, int *rc, sr
}
if (lyrc) {
*rc = SR_ERR_LY;
sr_session_set_error_message(sr_sess, ly_errmsg(ly_ctx));
sr_session_set_error_message(ev_sess, ly_errmsg(ly_ctx));
}

return root;
Expand Down
15 changes: 8 additions & 7 deletions src/common.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ struct np2srv {
const char *ext_data_path; /**< path to the data file with data for LY ext data callback */

const char *server_dir; /**< path to server files (just confirmed commit for the moment) */
char *url_protocols; /**< list of supported URL protocols */

struct nc_pollsession *nc_ps; /**< libnetconf2 pollsession structure */
pthread_t workers[NP2SRV_THREAD_COUNT]; /**< worker threads handling sessions */
Expand Down Expand Up @@ -262,10 +263,10 @@ int np2srv_url_setcap(void);
* @param[in] url URL to access.
* @param[in] validate Whether to validate nested data.
* @param[out] rc SR error value.
* @param[in,out] sr_sess SR session to set error on.
* @param[in] ev_sess SR session for errors.
* @return Parsed data.
*/
struct lyd_node *op_parse_url(const char *url, int validate, int *rc, sr_session_ctx_t *sr_sess);
struct lyd_node *op_parse_url(const char *url, int validate, int *rc, sr_session_ctx_t *ev_sess);

/**
* @brief Upload YANG data to an URL (encapsulated in `config` element).
Expand All @@ -274,11 +275,11 @@ struct lyd_node *op_parse_url(const char *url, int validate, int *rc, sr_session
* @param[in] data Data to upload.
* @param[in] print_options Options for printing the data.
* @param[out] rc SR error value.
* @param[in,out] sr_sess SR session to set error on.
* @param[in] ev_sess SR session for errors.
* @return 0 on success;
* @return -1 on error.
*/
int op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, int *rc, sr_session_ctx_t *sr_sess);
int op_export_url(const char *url, struct lyd_node *data, uint32_t print_options, int *rc, sr_session_ctx_t *ev_sess);

#endif

Expand All @@ -288,10 +289,10 @@ int op_export_url(const char *url, struct lyd_node *data, uint32_t print_options
* @param[in] config Config node with the data.
* @param[in] parse_options Options for parsing the data.
* @param[out] rc SR error value.
* @param[in,out] sr_sess SR session to set error on.
* @param[in] ev_sess SR session for errors.
* @return Parsed data.
*/
struct lyd_node *op_parse_config(struct lyd_node_any *config, uint32_t parse_options, int *rc, sr_session_ctx_t *sr_sess);
struct lyd_node *op_parse_config(struct lyd_node_any *config, uint32_t parse_options, int *rc, sr_session_ctx_t *ev_sess);

/**
* @brief Get all data matching the NP2 filter.
Expand All @@ -300,7 +301,7 @@ struct lyd_node *op_parse_config(struct lyd_node_any *config, uint32_t parse_opt
* @param[in] max_depth Max depth fo the retrieved data.
* @param[in] get_opts SR get options to use.
* @param[in] xp_filter XPath filter to use.
* @param[in,out] ev_sess SR event session to set the error on.
* @param[in] ev_sess SR session for errors.
* @param[out] data Retrieved data.
* @return SR error value.
*/
Expand Down
4 changes: 4 additions & 0 deletions src/config.h.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@
*/
#cmakedefine NP2SRV_URL_CAPAB

/** @brief URL capability file: protocol support
*/
#cmakedefine NP2SRV_URL_FILE_PROTO

/** @brief Whether libsystemd is installed, decides general support for systemd
*/
#cmakedefine NP2SRV_HAVE_SYSTEMD
Expand Down
3 changes: 3 additions & 0 deletions src/main.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,9 @@ server_destroy(void)

/* disconnects and clears all the sessions */
sr_disconnect(np2srv.sr_conn);

/* free dynamic members */
free(np2srv.url_protocols);
}

static int
Expand Down
Loading

0 comments on commit 0b566c8

Please sign in to comment.