381 lines
10 KiB
C
381 lines
10 KiB
C
/*
|
|
*
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
Copyright (C) 2009-2017 Olof Hagsand and Benny Holmgren
|
|
|
|
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 *****
|
|
|
|
*/
|
|
|
|
/*
|
|
* See draft-ietf-netconf-restconf-13.txt [draft]
|
|
|
|
* sudo apt-get install libfcgi-dev
|
|
* gcc -o fastcgi fastcgi.c -lfcgi
|
|
|
|
* sudo su -c "/www-data/clixon_restconf -Df /usr/local/etc/routing.conf " -s /bin/sh www-data
|
|
|
|
* This is the interface:
|
|
* api/data/profile=<name>/metric=<name> PUT data:enable=<flag>
|
|
* api/test
|
|
*/
|
|
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
#include <errno.h>
|
|
#include <signal.h>
|
|
#include <syslog.h>
|
|
#include <fcntl.h>
|
|
#include <time.h>
|
|
#include <fcgi_stdio.h>
|
|
#include <signal.h>
|
|
#include <sys/time.h>
|
|
#include <sys/wait.h>
|
|
#include <curl/curl.h>
|
|
#include <libgen.h>
|
|
|
|
/* cligen */
|
|
#include <cligen/cligen.h>
|
|
|
|
/* clicon */
|
|
#include <clixon/clixon.h>
|
|
|
|
/* restconf */
|
|
#include "restconf_lib.h"
|
|
#include "restconf_methods.h"
|
|
|
|
/* Command line options to be passed to getopt(3) */
|
|
#define RESTCONF_OPTS "hDf:p:y:"
|
|
|
|
/* Should be discovered via "/.well-known/host-meta"
|
|
resource ([RFC6415]) */
|
|
#define RESTCONF_API_ROOT "/restconf/"
|
|
|
|
/*! Generic REST method, GET, PUT, DELETE
|
|
* @param[in] h CLIXON handle
|
|
* @param[in] r Fastcgi request handle
|
|
* @param[in] api_path According to restconf (Sec 3.5.1.1 in [draft])
|
|
* @param[in] pcvec Vector of path ie DOCUMENT_URI element
|
|
* @param[in] pi Offset, where to start pcvec
|
|
* @param[in] qvec Vector of query string (QUERY_STRING)
|
|
* @param[in] dvec Stream input data
|
|
*/
|
|
static int
|
|
api_data(clicon_handle h,
|
|
FCGX_Request *r,
|
|
char *api_path,
|
|
cvec *pcvec,
|
|
int pi,
|
|
cvec *qvec,
|
|
char *data)
|
|
{
|
|
int retval = -1;
|
|
char *request_method;
|
|
|
|
clicon_debug(1, "%s", __FUNCTION__);
|
|
request_method = FCGX_GetParam("REQUEST_METHOD", r->envp);
|
|
clicon_debug(1, "%s method:%s", __FUNCTION__, request_method);
|
|
if (strcmp(request_method, "OPTIONS")==0)
|
|
retval = api_data_options(h, r);
|
|
else if (strcmp(request_method, "HEAD")==0)
|
|
retval = api_data_head(h, r, pcvec, pi, qvec);
|
|
else if (strcmp(request_method, "GET")==0)
|
|
retval = api_data_get(h, r, pcvec, pi, qvec);
|
|
else if (strcmp(request_method, "POST")==0)
|
|
retval = api_data_post(h, r, api_path, pcvec, pi, qvec, data);
|
|
else if (strcmp(request_method, "PUT")==0)
|
|
retval = api_data_put(h, r, api_path, pcvec, pi, qvec, data);
|
|
else if (strcmp(request_method, "PATCH")==0)
|
|
retval = api_data_patch(h, r, api_path, pcvec, pi, qvec, data);
|
|
else if (strcmp(request_method, "DELETE")==0)
|
|
retval = api_data_delete(h, r, api_path, pi);
|
|
else
|
|
retval = notfound(r);
|
|
return retval;
|
|
}
|
|
|
|
/*! Process a FastCGI request
|
|
* @param[in] r Fastcgi request handle
|
|
*/
|
|
static int
|
|
request_process(clicon_handle h,
|
|
FCGX_Request *r)
|
|
{
|
|
int retval = -1;
|
|
char *path;
|
|
char *query;
|
|
char *method;
|
|
char **pvec = NULL;
|
|
int pn;
|
|
cvec *qvec = NULL;
|
|
cvec *dvec = NULL;
|
|
cvec *pcvec = NULL; /* for rest api */
|
|
cbuf *cb = NULL;
|
|
char *data;
|
|
int auth = 0;
|
|
|
|
clicon_debug(1, "%s", __FUNCTION__);
|
|
path = FCGX_GetParam("DOCUMENT_URI", r->envp);
|
|
query = FCGX_GetParam("QUERY_STRING", r->envp);
|
|
if ((pvec = clicon_strsep(path, "/", &pn)) == NULL)
|
|
goto done;
|
|
|
|
if (str2cvec(query, '&', '=', &qvec) < 0)
|
|
goto done;
|
|
if (str2cvec(path, '/', '=', &pcvec) < 0) /* rest url eg /album=ricky/foo */
|
|
goto done;
|
|
/* data */
|
|
if ((cb = readdata(r)) == NULL)
|
|
goto done;
|
|
data = cbuf_get(cb);
|
|
clicon_debug(1, "DATA=%s", data);
|
|
if (str2cvec(data, '&', '=', &dvec) < 0)
|
|
goto done;
|
|
|
|
if ((method = pvec[2]) == NULL){
|
|
retval = notfound(r);
|
|
goto done;
|
|
}
|
|
|
|
retval = 0;
|
|
test(r, 1);
|
|
/* If present, check credentials */
|
|
if (plugin_credentials(h, r, &auth) < 0)
|
|
goto done;
|
|
clicon_debug(1, "%s credentials ok auth:%d (should be 1)",
|
|
__FUNCTION__, auth);
|
|
if (auth == 0)
|
|
goto done;
|
|
clicon_debug(1, "%s credentials ok 2", __FUNCTION__);
|
|
|
|
if (strcmp(method, "data") == 0) /* restconf, skip /api/data */
|
|
retval = api_data(h, r, path, pcvec, 2, qvec, data);
|
|
else if (strcmp(method, "test") == 0)
|
|
retval = test(r, 0);
|
|
else
|
|
retval = notfound(r);
|
|
done:
|
|
clicon_debug(1, "%s retval:%d", __FUNCTION__, retval);
|
|
if (pvec)
|
|
free(pvec);
|
|
if (dvec)
|
|
cvec_free(dvec);
|
|
if (qvec)
|
|
cvec_free(qvec);
|
|
if (pcvec)
|
|
cvec_free(pcvec);
|
|
if (cb)
|
|
cbuf_free(cb);
|
|
return retval;
|
|
}
|
|
|
|
static int
|
|
restconf_terminate(clicon_handle h)
|
|
{
|
|
yang_spec *yspec;
|
|
|
|
clicon_debug(0, "%s", __FUNCTION__);
|
|
clicon_rpc_close_session(h);
|
|
if ((yspec = clicon_dbspec_yang(h)) != NULL)
|
|
yspec_free(yspec);
|
|
clicon_handle_exit(h);
|
|
return 0;
|
|
}
|
|
|
|
/* Need global variable to for signal handler */
|
|
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)
|
|
restconf_terminate(_CLICON_HANDLE);
|
|
clicon_exit_set(); /* checked in event_loop() */
|
|
exit(-1);
|
|
}
|
|
|
|
/*! Usage help routine
|
|
* @param[in] argv0 command line
|
|
* @param[in] h Clicon handle
|
|
*/
|
|
static void
|
|
usage(clicon_handle h,
|
|
char *argv0)
|
|
|
|
{
|
|
char *restconfdir = clicon_restconf_dir(h);
|
|
|
|
fprintf(stderr, "usage:%s [options]\n"
|
|
"where options are\n"
|
|
"\t-h \t\tHelp\n"
|
|
"\t-D \t\tDebug. Log to syslog\n"
|
|
"\t-f <file>\tConfiguration file (mandatory)\n"
|
|
"\t-d <dir>\tSpecify restconf plugin directory dir (default: %s)\n"
|
|
"\t-y <file>\tOverride yang spec file (dont include .yang suffix)\n",
|
|
argv0,
|
|
restconfdir
|
|
);
|
|
exit(0);
|
|
}
|
|
|
|
/*! Main routine for grideye fastcgi API
|
|
*/
|
|
int
|
|
main(int argc,
|
|
char **argv)
|
|
{
|
|
int retval = -1;
|
|
int sock;
|
|
FCGX_Request request;
|
|
FCGX_Request *r = &request;
|
|
char c;
|
|
char *sockpath;
|
|
char *path;
|
|
clicon_handle h;
|
|
char *yangspec=NULL;
|
|
|
|
/* In the startup, logs to stderr & debug flag set later */
|
|
clicon_log_init(__PROGRAM__, LOG_INFO, CLICON_LOG_SYSLOG);
|
|
/* Create handle */
|
|
if ((h = clicon_handle_init()) == NULL)
|
|
goto done;
|
|
_CLICON_HANDLE = h; /* for termination handling */
|
|
while ((c = getopt(argc, argv, RESTCONF_OPTS)) != -1)
|
|
switch (c) {
|
|
case 'h':
|
|
usage(h, argv[0]);
|
|
break;
|
|
case 'D' : /* debug */
|
|
debug = 1;
|
|
break;
|
|
case 'f': /* override config file */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
clicon_option_str_set(h, "CLICON_CONFIGFILE", optarg);
|
|
break;
|
|
case 'd': /* Plugin directory */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
clicon_option_str_set(h, "CLICON_RESTCONF_DIR", optarg);
|
|
break;
|
|
case 'y' : /* yang module */
|
|
yangspec = optarg;
|
|
break;
|
|
default:
|
|
usage(h, argv[0]);
|
|
break;
|
|
}
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
clicon_log_init(__PROGRAM__, debug?LOG_DEBUG:LOG_INFO, CLICON_LOG_SYSLOG);
|
|
clicon_debug_init(debug, NULL);
|
|
clicon_log(LOG_NOTICE, "%s: %u Started", __PROGRAM__, getpid());
|
|
if (set_signal(SIGTERM, restconf_sig_term, NULL) < 0){
|
|
clicon_err(OE_DEMON, errno, "Setting signal");
|
|
goto done;
|
|
}
|
|
if (set_signal(SIGINT, restconf_sig_term, NULL) < 0){
|
|
clicon_err(OE_DEMON, errno, "Setting signal");
|
|
goto done;
|
|
}
|
|
|
|
/* Find and read configfile */
|
|
if (clicon_options_main(h) < 0)
|
|
goto done;
|
|
|
|
/* Overwrite yang module with -y option */
|
|
if (yangspec){
|
|
/* Set revision to NULL, extract dir and module */
|
|
char *str = strdup(yangspec);
|
|
char *dir = dirname(str);
|
|
hash_del(clicon_options(h), (char*)"CLICON_YANG_MODULE_REVISION");
|
|
clicon_option_str_set(h, "CLICON_YANG_MODULE_MAIN", basename(yangspec));
|
|
clicon_option_str_set(h, "CLICON_YANG_DIR", strdup(dir));
|
|
}
|
|
/* Initialize plugins group */
|
|
if (restconf_plugin_load(h) < 0)
|
|
return -1;
|
|
|
|
/* Parse yang database spec file */
|
|
if (yang_spec_main(h, NULL, 0) < 0)
|
|
goto done;
|
|
|
|
if ((sockpath = clicon_option_str(h, "CLICON_RESTCONF_PATH")) == NULL){
|
|
clicon_err(OE_CFG, errno, "No CLICON_RESTCONF_PATH in clixon configure file");
|
|
goto done;
|
|
}
|
|
if (FCGX_Init() != 0){
|
|
clicon_err(OE_CFG, errno, "FCGX_Init");
|
|
goto done;
|
|
}
|
|
if ((sock = FCGX_OpenSocket(sockpath, 10)) < 0){
|
|
clicon_err(OE_CFG, errno, "FCGX_OpenSocket");
|
|
goto done;
|
|
}
|
|
|
|
if (FCGX_InitRequest(r, sock, 0) != 0){
|
|
clicon_err(OE_CFG, errno, "FCGX_InitRequest");
|
|
goto done;
|
|
}
|
|
while (1) {
|
|
if (FCGX_Accept_r(r) < 0) {
|
|
clicon_err(OE_CFG, errno, "FCGX_Accept_r");
|
|
goto done;
|
|
}
|
|
clicon_debug(1, "------------");
|
|
if ((path = FCGX_GetParam("DOCUMENT_URI", r->envp)) != NULL){
|
|
if (strncmp(path, RESTCONF_API_ROOT, strlen(RESTCONF_API_ROOT)) == 0 ||
|
|
strncmp(path, RESTCONF_API_ROOT, strlen(RESTCONF_API_ROOT)-1) == 0)
|
|
request_process(h, r);
|
|
else{
|
|
clicon_debug(1, "top-level not found");
|
|
notfound(r);
|
|
}
|
|
}
|
|
else
|
|
clicon_debug(1, "NULL URI");
|
|
FCGX_Finish_r(r);
|
|
}
|
|
retval = 0;
|
|
done:
|
|
restconf_plugin_unload(h);
|
|
restconf_terminate(h);
|
|
return retval;
|
|
}
|