/* * ***** BEGIN LICENSE BLOCK ***** Copyright (C) 2009-2019 Olof Hagsand Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate) This file is part of CLIXON. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Alternatively, the contents of this file may be used under the terms of the GNU General Public License Version 3 or later (the "GPL"), in which case the provisions of the GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL, and not to allow others to use your version of this file under the terms of Apache License version 2, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the Apache License version 2 or the GPL. ***** END LICENSE BLOCK ***** * libevhtp code */ /* XXX temp constant should go away, */ #undef _EVHTP_NYI #ifdef HAVE_CONFIG_H #include "clixon_config.h" /* generated by config & autoconf */ #endif /* compilation withotu threading support * XXX: could be disabled already in configure? */ //#define EVHTP_DISABLE_EVTHR #define EVHTP_DISABLE_REGEX #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* chmod */ /* evhtp */ #include #include /* cligen */ #include /* clicon */ #include /* restconf */ #include "restconf_lib.h" /* generic shared with plugins */ #include "restconf_api.h" /* generic not shared with plugins */ #include "restconf_root.h" /* Command line options to be passed to getopt(3) */ #define RESTCONF_OPTS "hD:f:l:p:d:y:a:u:o:P:c:k:" /* Need global variable to for signal handler XXX */ static clicon_handle _CLICON_HANDLE = NULL; /*! Signall terminates process */ static void restconf_sig_term(int arg) { static int i=0; if (i++ == 0) clicon_log(LOG_NOTICE, "%s: %s: pid: %u Signal %d", __PROGRAM__, __FUNCTION__, getpid(), arg); else exit(-1); if (_CLICON_HANDLE){ #ifdef _EVHTP_NYI stream_child_freeall(_CLICON_HANDLE); #endif restconf_terminate(_CLICON_HANDLE); } clicon_exit_set(); /* checked in clixon_event_loop() */ exit(-1); } static void restconf_sig_child(int arg) { int status; int pid; if ((pid = waitpid(-1, &status, 0)) != -1 && WIFEXITED(status)){ #ifdef _EVHTP_NYI ; #endif } } static char* evhtp_method2str(enum htp_method m) { switch (m){ case htp_method_GET: return "GET"; break; case htp_method_HEAD: return "HEAD"; break; case htp_method_POST: return "POST"; break; case htp_method_PUT: return "PUT"; break; case htp_method_DELETE: return "DELETE"; break; case htp_method_PATCH: return "PATCH"; break; default: return "XXX"; break; } } static int query_iterator(evhtp_header_t *hdr, void *arg) { cvec *qvec = (cvec *)arg; char *key; char *val; char *valu = NULL; /* unescaped value */ cg_var *cv; key = hdr->key; val = hdr->val; if (uri_percent_decode(val, &valu) < 0) return -1; if ((cv = cvec_add(qvec, CGV_STRING)) == NULL){ clicon_err(OE_UNIX, errno, "cvec_add"); return -1; } cv_name_set(cv, key); cv_string_set(cv, valu); if (valu) free(valu); return 0; } /*! Map from evhtp information to "fcgi" type parameters used in clixon code * * While all these params come via one call in fcgi, the information must be taken from * several different places in evhtp * @param[in] h Clicon handle * @param[in] req Evhtp request struct * @retval 0 OK * @retval -1 Error * The following parameters are set: * QUERY_STRING * REQUEST_METHOD * REQUEST_URI * HTTPS * HTTP_HOST * HTTP_ACCEPT * HTTP_CONTENT_TYPE * @note there may be more used by an application plugin */ static int evhtp_params_set(clicon_handle h, evhtp_request_t *req, cvec *qvec) { int retval = -1; htp_method meth; evhtp_uri_t *uri; evhtp_path_t *path; evhtp_header_t *hdr; if ((uri = req->uri) == NULL){ clicon_err(OE_DAEMON, EFAULT, "No uri"); goto done; } if ((path = uri->path) == NULL){ clicon_err(OE_DAEMON, EFAULT, "No path"); goto done; } meth = evhtp_request_get_method(req); /* QUERY_STRING */ if (qvec && uri->query) if (evhtp_kvs_for_each(uri->query, query_iterator, qvec) < 0){ clicon_err(OE_CFG, errno, "evhtp_kvs_for_each"); goto done; } if (clixon_restconf_param_set(h, "REQUEST_METHOD", evhtp_method2str(meth)) < 0) goto done; if (clixon_restconf_param_set(h, "REQUEST_URI", path->full) < 0) goto done; if (clixon_restconf_param_set(h, "HTTPS", "https") < 0) /* some string or NULL */ goto done; if ((hdr = evhtp_headers_find_header(req->headers_in, "Host")) != NULL){ if (clixon_restconf_param_set(h, "HTTP_HOST", hdr->val) < 0) goto done; } if ((hdr = evhtp_headers_find_header(req->headers_in, "Accept")) != NULL){ if (clixon_restconf_param_set(h, "HTTP_ACCEPT", hdr->val) < 0) goto done; } if ((hdr = evhtp_headers_find_header(req->headers_in, "Content-Type")) != NULL){ if (clixon_restconf_param_set(h, "HTTP_CONTENT_TYPE", hdr->val) < 0) goto done; } retval = 0; done: return retval; } static int evhtp_params_clear(clicon_handle h) { int retval = -1; char *params[] = {"QUERY_STRING", "REQUEST_METHOD", "REQUEST_URI", "HTTPS", "HTTP_HOST", "HTTP_ACCEPT", "HTTP_CONTENT_TYPE", NULL}; char *param; int i=0; while((param=params[i]) != NULL) if (clixon_restconf_param_del(h, param) < 0) goto done; retval = 0; done: return retval; } static int print_header(evhtp_header_t *header, void *arg) { // clicon_handle h = (clicon_handle)arg; clicon_debug(1, "%s %s %s", __FUNCTION__, header->key, header->val); return 0; } static evhtp_res cx_pre_accept(evhtp_connection_t *conn, void *arg) { // clicon_handle h = (clicon_handle)arg; clicon_debug(1, "%s", __FUNCTION__); return EVHTP_RES_OK; } static evhtp_res cx_post_accept(evhtp_connection_t *conn, void *arg) { // clicon_handle h = (clicon_handle)arg; clicon_debug(1, "%s", __FUNCTION__); return EVHTP_RES_OK; } /*! Generic callback called if no other callbacks are matched */ static void cx_gencb(evhtp_request_t *req, void *arg) { evhtp_connection_t *conn; // clicon_handle h = arg; clicon_debug(1, "%s", __FUNCTION__); if (req == NULL){ errno = EINVAL; return; } if ((conn = evhtp_request_get_connection(req)) == NULL) goto done; htp_sslutil_add_xheaders( req->headers_out, conn->ssl, HTP_SSLUTILS_XHDR_ALL); evhtp_send_reply(req, EVHTP_RES_NOTFOUND); done: return; /* void */ } /*! /.well-known callback * @see cx_genb */ static void cx_path_wellknown(evhtp_request_t *req, void *arg) { clicon_handle h = arg; /* input debug */ if (clicon_debug_get()) evhtp_headers_for_each(req->headers_in, print_header, h); /* get accepted connection */ /* set fcgi-like paramaters (ignore query vector) */ if (evhtp_params_set(h, req, NULL) < 0) goto done; /* call generic function */ if (api_well_known(h, req) < 0) goto done; /* Clear (fcgi) paramaters from this request */ if (evhtp_params_clear(h) < 0) goto done; done: return; /* void */ } /*! /restconf callback * @see cx_genb */ static void cx_path_restconf(evhtp_request_t *req, void *arg) { evhtp_connection_t *conn; clicon_handle h = arg; struct evbuffer *b = NULL; cvec *qvec = NULL; size_t len = 0; cbuf *cblen = NULL; clicon_debug(1, "%s", __FUNCTION__); if (req == NULL){ errno = EINVAL; goto done; } /* input debug */ if (clicon_debug_get()) evhtp_headers_for_each(req->headers_in, print_header, h); if ((cblen = cbuf_new()) == NULL){ clicon_err(OE_UNIX, errno, "cbuf_new"); goto done; } /* Query vector, ie the ?a=x&b=y stuff */ if ((qvec = cvec_new(0)) ==NULL){ clicon_err(OE_UNIX, errno, "cvec_new"); goto done; } /* get accepted connection */ if ((conn = evhtp_request_get_connection(req)) == NULL){ clicon_err(OE_DAEMON, EFAULT, "evhtp_request_get_connection"); goto done; } /* Get all parameters from this request (resembling fcgi) */ if (evhtp_params_set(h, req, qvec) < 0) goto done; /* 1. create body */ if ((b = evbuffer_new()) == NULL){ clicon_err(OE_DAEMON, errno, "evbuffer_new"); goto done; } cprintf(cblen, "%lu", len); /* 2. add headers (can mix with body) */ evhtp_headers_add_header(req->headers_out, evhtp_header_new("Cache-Control", "no-cache", 0, 0)); evhtp_headers_add_header(req->headers_out, evhtp_header_new("Content-Type", "application/xrd+xml", 0, 0)); evhtp_headers_add_header(req->headers_out, evhtp_header_new("Content-Length", cbuf_get(cblen), 0, 0)); /* Optional? */ htp_sslutil_add_xheaders(req->headers_out, conn->ssl, HTP_SSLUTILS_XHDR_ALL); /* 3. send reply */ evhtp_send_reply_start(req, EVHTP_RES_OK); evhtp_send_reply_body(req, b); evhtp_send_reply_end(req); /* Clear (fcgi)paramaters */ if (evhtp_params_clear(h) < 0) goto done; done: if (qvec) cvec_free(qvec); if (cblen) cbuf_free(cblen); if (b) evhtp_safe_free(b, evbuffer_free); return; /* void */ } /*! Usage help routine * @param[in] argv0 command line * @param[in] h Clicon handle */ static void usage(clicon_handle h, char *argv0) { fprintf(stderr, "usage:%s [options]\n" "where options are\n" "\t-h \t\t Help\n" "\t-D \t Debug level\n" "\t-f \t Configuration file (mandatory)\n" "\t-l > \t Log on (s)yslog, (f)ile (syslog is default)\n" "\t-p \t Yang directory path (see CLICON_YANG_DIR)\n" "\t-d \t Specify restconf plugin directory dir (default: %s)\n" "\t-y \t Load yang spec file (override yang main module)\n" "\t-a UNIX|IPv4|IPv6 Internal backend socket family\n" "\t-u \t Internal socket domain path or IP addr (see -a)\n" "\t-o \"