experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

all clixon event functions prepended with clixon_

Browse source 
Replaced fcgi getparam code with clixon-data parameters
This commit is contained in:
Olof hagsand 2020-06-05 16:19:03 +02:00
parent a455b15f03
commit 14b03f63a3
34 changed files with 567 additions and 877 deletions
Download patch file Download diff file Expand all files Collapse all files

11
CHANGELOG.md
View file

@ -25,6 +25,17 @@
## 4.6.0 ## 4.6.0
Expected: July 2020 Expected: July 2020
### C-API changes on existing features (For developers)
* Due to name collision with libevent, all clixon event functions prepended with `clixon_`. You need to rename your event functions as follows:
* event_reg_fd() -> clixon_event_reg_fd()
* event_unreg_fd() -> clixon_event_unreg_fd()
* event_reg_timeout() -> clixon_event_reg_timeout()
* event_unreg_timeout() -> clixon_event_unreg_timeout()
* event_poll() -> clixon_event_poll()
* event_loop() -> clixon_event_loop()
* event_exit() -> clixon_event_exit()
### Minor changes ### Minor changes
* Added new function `clicon_xml2str()` to complement xml_print and others that returns a malloced string. * Added new function `clicon_xml2str()` to complement xml_print and others that returns a malloced string.

2
apps/backend/backend_client.c
View file

@ -144,7 +144,7 @@ backend_client_rm(clicon_handle h,
for (c = *ce_prev; c; c = c->ce_next){ for (c = *ce_prev; c; c = c->ce_next){
if (c == ce){ if (c == ce){
if (ce->ce_s){ if (ce->ce_s){
event_unreg_fd(ce->ce_s, from_client); clixon_event_unreg_fd(ce->ce_s, from_client);
close(ce->ce_s); close(ce->ce_s);
ce->ce_s = 0; ce->ce_s = 0;
} }

8
apps/backend/backend_main.c
View file

@ -134,7 +134,7 @@ backend_terminate(clicon_handle h)
if (sockfamily==AF_UNIX && lstat(sockpath, &st) == 0) if (sockfamily==AF_UNIX && lstat(sockpath, &st) == 0)
unlink(sockpath); unlink(sockpath);
backend_handle_exit(h); /* Also deletes streams. Cannot use h after this. */ backend_handle_exit(h); /* Also deletes streams. Cannot use h after this. */
event_exit(); clixon_event_exit();
clicon_debug(1, "%s done", __FUNCTION__); clicon_debug(1, "%s done", __FUNCTION__);
clicon_log_exit(); clicon_log_exit();
return 0; return 0;
@ -150,7 +150,7 @@ backend_sig_term(int arg)
if (i++ == 0) if (i++ == 0)
clicon_log(LOG_NOTICE, "%s: %s: pid: %u Signal %d", clicon_log(LOG_NOTICE, "%s: %s: pid: %u Signal %d",
__PROGRAM__, __FUNCTION__, getpid(), arg); __PROGRAM__, __FUNCTION__, getpid(), arg);
clicon_exit_set(); /* checked in event_loop() */ clicon_exit_set(); /* checked in clixon_event_loop() */
} }
/*! Create backend server socket and register callback /*! Create backend server socket and register callback
@ -168,7 +168,7 @@ backend_server_socket(clicon_handle h)
return -1; return -1;
/* ss is a server socket that the clients connect to. The callback /* ss is a server socket that the clients connect to. The callback
therefore accepts clients on ss */ therefore accepts clients on ss */
if (event_reg_fd(ss, backend_accept_client, h, "server socket") < 0) { if (clixon_event_reg_fd(ss, backend_accept_client, h, "server socket") < 0) {
close(ss); close(ss);
return -1; return -1;
} }
@ -923,7 +923,7 @@ main(int argc,
if (stream_timer_setup(0, h) < 0) if (stream_timer_setup(0, h) < 0)
goto done; goto done;
if (event_loop() < 0) if (clixon_event_loop() < 0)
goto done; goto done;
ok: ok:
retval = 0; retval = 0;

2
apps/backend/backend_socket.c
View file

@ -289,7 +289,7 @@ backend_accept_client(int fd,
/* /*
* Here we register callbacks for actual data socket * Here we register callbacks for actual data socket
*/ */
if (event_reg_fd(s, from_client, (void*)ce, "local netconf client socket") < 0) if (clixon_event_reg_fd(s, from_client, (void*)ce, "local netconf client socket") < 0)
goto done; goto done;
retval = 0; retval = 0;
done: done:

2
apps/cli/cli_common.c
View file

@ -987,7 +987,7 @@ cli_notification_cb(int s,
clicon_err(OE_PROTO, ESHUTDOWN, "Socket unexpected close"); clicon_err(OE_PROTO, ESHUTDOWN, "Socket unexpected close");
close(s); close(s);
errno = ESHUTDOWN; errno = ESHUTDOWN;
event_unreg_fd(s, cli_notification_cb); clixon_event_unreg_fd(s, cli_notification_cb);
goto done; goto done;
} }
/* XXX pass yang_spec and use xerr*/ /* XXX pass yang_spec and use xerr*/

10
apps/netconf/netconf_main.c
View file

@ -274,7 +274,7 @@ netconf_input_cb(int s,
} }
} }
/* poll==1 if more, poll==0 if none */ /* poll==1 if more, poll==0 if none */
if ((poll = event_poll(s)) < 0) if ((poll = clixon_event_poll(s)) < 0)
goto done; goto done;
if (poll == 0) if (poll == 0)
break; /* No data to read */ break; /* No data to read */
@ -338,7 +338,7 @@ netconf_terminate(clicon_handle h)
if ((x = clicon_conf_xml(h)) != NULL) if ((x = clicon_conf_xml(h)) != NULL)
xml_free(x); xml_free(x);
xpath_optimize_exit(); xpath_optimize_exit();
event_exit(); clixon_event_exit();
clicon_handle_exit(h); clicon_handle_exit(h);
clicon_log_exit(); clicon_log_exit();
return 0; return 0;
@ -590,7 +590,7 @@ main(int argc,
/* Send hello to northbound client */ /* Send hello to northbound client */
if (!quiet) if (!quiet)
send_hello(h, 1, id); send_hello(h, 1, id);
if (event_reg_fd(0, netconf_input_cb, h, "netconf socket") < 0) if (clixon_event_reg_fd(0, netconf_input_cb, h, "netconf socket") < 0)
goto done; goto done;
if (debug) if (debug)
clicon_option_dump(h, debug); clicon_option_dump(h, debug);
@ -598,10 +598,10 @@ main(int argc,
struct timeval t; struct timeval t;
gettimeofday(&t, NULL); gettimeofday(&t, NULL);
timeradd(&t, &tv, &t); timeradd(&t, &tv, &t);
if (event_reg_timeout(t, timeout_fn, NULL, "timeout") < 0) if (clixon_event_reg_timeout(t, timeout_fn, NULL, "timeout") < 0)
goto done; goto done;
} }
if (event_loop() < 0) if (clixon_event_loop() < 0)
goto done; goto done;
retval = 0; retval = 0;
done: done:

4
apps/netconf/netconf_rpc.c
View file

@ -437,7 +437,7 @@ netconf_notification_cb(int s,
clicon_err(OE_PROTO, ESHUTDOWN, "Socket unexpected close"); clicon_err(OE_PROTO, ESHUTDOWN, "Socket unexpected close");
close(s); close(s);
errno = ESHUTDOWN; errno = ESHUTDOWN;
event_unreg_fd(s, netconf_notification_cb); clixon_event_unreg_fd(s, netconf_notification_cb);
goto done; goto done;
} }
yspec = clicon_dbspec_yang(h); yspec = clicon_dbspec_yang(h);
@ -520,7 +520,7 @@ netconf_create_subscription(clicon_handle h,
goto done; goto done;
if (xpath_first(*xret, NULL, "rpc-reply/rpc-error") != NULL) if (xpath_first(*xret, NULL, "rpc-reply/rpc-error") != NULL)
goto ok; goto ok;
if (event_reg_fd(s, if (clixon_event_reg_fd(s,
netconf_notification_cb, netconf_notification_cb,
h, h,
"notification socket") < 0) "notification socket") < 0)

48
apps/restconf/Makefile.in
View file

@ -86,11 +86,11 @@ APPL = clixon_restconf_$(with_restconf)
endif endif
# Common source - not accessible from plugin - independent of restconf package (fcgi|evhtp) # Common source - not accessible from plugin - independent of restconf package (fcgi|evhtp)
APPSRC = restconf_lib.c #APPSRC = restconf_lib.c
# Fcgi-specific source including main # Fcgi-specific source including main
ifeq ($(with_restconf),fcgi) ifeq ($(with_restconf),fcgi)
APPSRC += restconf_fcgi_lib.c APPSRC = restconf_fcgi_lib.c
APPSRC += restconf_fcgi_main.c APPSRC += restconf_fcgi_main.c
APPSRC += restconf_methods.c # These should be moved ^ APPSRC += restconf_methods.c # These should be moved ^
APPSRC += restconf_methods_post.c APPSRC += restconf_methods_post.c
@ -100,19 +100,30 @@ endif
# Evhtp-specific source including main # Evhtp-specific source including main
ifeq ($(with_restconf),evhtp) ifeq ($(with_restconf),evhtp)
APPSRC += restconf_evhtp_main.c APPSRC = restconf_evhtp_main.c
endif endif
APPOBJ = $(APPSRC:.c=.o) APPOBJ = $(APPSRC:.c=.o)
all: $(APPL) # Accessible from plugin
LIBSRC = restconf_lib.c
LIBOBJ = $(LIBSRC:.c=.o)
# This lib is very small but used for clixon restconf applications to access clixon restconf lib
# functions. Mostly for future use
MYNAME = clixon_restconf
MYLIBLINK = lib$(MYNAME)$(SH_SUFFIX)
MYLIB = $(MYLIBLINK).$(CLIXON_MAJOR).$(CLIXON_MINOR)
MYLIBSO = $(MYLIBLINK).$(CLIXON_MAJOR)
all: $(MYLIB) $(APPL)
# Dependency of clixon library # Dependency of clixon library
$(top_srcdir)/lib/src/$(CLIXON_LIB): $(top_srcdir)/lib/src/$(CLIXON_LIB):
(cd $(top_srcdir)/lib/src && $(MAKE) $(MFLAGS) $(CLIXON_LIB)) (cd $(top_srcdir)/lib/src && $(MAKE) $(MFLAGS) $(CLIXON_LIB))
clean: clean:
rm -f *.core $(APPL) $(APPOBJ) *.o # extra .o to clean residue if with_restconf changes rm -f $(LIBOBJ) *.core $(APPL) $(APPOBJ) *.o $(MYLIB) $(MYLIBSO) $(MYLIBLINK) # extra .o to clean residue if with_restconf changes
distclean: clean distclean: clean
rm -f Makefile *~ .depend rm -f Makefile *~ .depend
@ -122,7 +133,7 @@ distclean: clean
# Also create a libexec/ directory for writeable/temporary files. # Also create a libexec/ directory for writeable/temporary files.
# Put config file in etc/ # Put config file in etc/
# Also a rule for letting www-dir be owned by www-data, which only works for sudo # Also a rule for letting www-dir be owned by www-data, which only works for sudo
install: $(APPL) install: install-lib $(APPL)
ifeq ($(shell whoami),root) ifeq ($(shell whoami),root)
install -d -m 0755 -o $(wwwuser) -g $(wwwuser) $(DESTDIR)$(wwwdir) install -d -m 0755 -o $(wwwuser) -g $(wwwuser) $(DESTDIR)$(wwwdir)
else else
@ -130,10 +141,19 @@ else
endif endif
install -m 0755 $(INSTALLFLAGS) $(APPL) $(DESTDIR)$(wwwdir) install -m 0755 $(INSTALLFLAGS) $(APPL) $(DESTDIR)$(wwwdir)
install-include: install-lib: $(MYLIB)
install -d -m 0755 $(DESTDIR)$(libdir)
install -m 0644 $(INSTALLFLAGS) $(MYLIB) $(DESTDIR)$(libdir)
ln -sf $(MYLIB) $(DESTDIR)$(libdir)/$(MYLIBSO) # -l:libclixon_restconf.so.2
ln -sf $(MYLIBSO) $(DESTDIR)$(libdir)/$(MYLIBLINK) # -l:libclixon_restconf.so
install-include: clixon_restconf.h
install -d -m 0755 $(DESTDIR)$(includedir)/clixon
install -m 0644 $^ $(DESTDIR)$(includedir)/clixon
uninstall: uninstall:
rm -f $(DESTDIR)$(wwwdir)/$(APPL) rm -f $(DESTDIR)$(wwwdir)/$(APPL)
rm -f $(DESTDIR)$(libdir)/$(MYLIBLINK)*
.SUFFIXES: .SUFFIXES:
.SUFFIXES: .c .o .SUFFIXES: .c .o
@ -141,8 +161,18 @@ uninstall:
.c.o: .c.o:
$(CC) $(INCLUDES) -D__PROGRAM__=\"clixon_restconf\" $(CPPFLAGS) $(CFLAGS) -c $< $(CC) $(INCLUDES) -D__PROGRAM__=\"clixon_restconf\" $(CPPFLAGS) $(CFLAGS) -c $<
$(APPL) : $(APPOBJ) $(APPL) : $(APPOBJ) $(MYLIBLINK) $(LIBDEPS)
$(CC) $(LDFLAGS) $(APPOBJ) $(LIBS) -o $@ $(CC) $(LDFLAGS) $(APPOBJ) -L. $(MYLIB) $(LIBS) -o $@
$(MYLIB) : $(LIBOBJ) $(LIBDEPS)
ifeq ($(HOST_VENDOR),apple)
$(CC) $(LDFLAGS) -shared -undefined dynamic_lookup -o $@ $(LIBOBJ) $(LIBS)
else
$(CC) $(LDFLAGS) -shared -Wl,-soname,$(MYLIBSO) -o $@ $(LIBOBJ) $(LIBS) -Wl,-soname=$(MYLIBSO)
endif
# link-name is needed for application linking, eg for clixon_cli and clixon_config
$(MYLIBLINK) : $(MYLIB)
TAGS: TAGS:
find . -name '*.[chyl]' -print | etags - find . -name '*.[chyl]' -print | etags -

66
apps/restconf/clixon_restconf.h Normal file
View file

@ -0,0 +1,66 @@
/*
*
***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand
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 *****
* The exported interface to plugins. External apps (eg frontend restconf plugins)
* should only include this file (not the restconf_*.h)
*/
#ifndef _CLIXON_RESTCONF_H_
#define _CLIXON_RESTCONF_H_
/*
* Types (also in restconf_lib.h)
*/
enum restconf_media{
YANG_DATA_JSON, /* "application/yang-data+json" */
YANG_DATA_XML, /* "application/yang-data+xml" */
YANG_PATCH_JSON, /* "application/yang-patch+json" */
YANG_PATCH_XML /* "application/yang-patch+xml" */
};
typedef enum restconf_media restconf_media;
/*
* Prototypes (also in restconf_lib.h)
*/
int restconf_err2code(char *tag);
const char *restconf_code2reason(int code);
const restconf_media restconf_media_str2int(char *media);
const char *restconf_media_int2str(restconf_media media);
int get_user_cookie(char *cookiestr, char *attribute, char **val);
int restconf_terminate(clicon_handle h);
int restconf_insert_attributes(cxobj *xdata, cvec *qvec);
int restconf_main_extension_cb(clicon_handle h, yang_stmt *yext, yang_stmt *ys);
char *clixon_restconf_param_get(clicon_handle h, char *param);
int clixon_restconf_param_set(clicon_handle h, char *param, char *val);
#endif /* _CLIXON_RESTCONF_H_ */

4
apps/restconf/restconf_evhtp_main.c
View file

@ -105,7 +105,7 @@ restconf_sig_term(int arg)
#endif #endif
restconf_terminate(_CLICON_HANDLE); restconf_terminate(_CLICON_HANDLE);
} }
clicon_exit_set(); /* checked in event_loop() */ clicon_exit_set(); /* checked in clixon_event_loop() */
exit(-1); exit(-1);
} }
@ -240,7 +240,7 @@ usage(clicon_handle h,
exit(0); exit(0);
} }
/*! Main routine for libhttp restconf /*! Main routine for libevhtp restconf
*/ */
int int
main(int argc, main(int argc,

190
apps/restconf/restconf_fcgi_lib.c
View file

@ -64,36 +64,16 @@
#include "restconf_lib.h" #include "restconf_lib.h"
#include "restconf_fcgi_lib.h" #include "restconf_fcgi_lib.h"
/*! Return media_in from Content-Type, -1 if not found or unrecognized
* @note media-type syntax does not support parameters
* @see RFC7231 Sec 3.1.1.1 for media-type syntax type:
* media-type = type "/" subtype *( OWS ";" OWS parameter )
* type = token
* subtype = token
*
*/
restconf_media
restconf_content_type(FCGX_Request *r)
{
char *str;
restconf_media m;
if ((str = FCGX_GetParam("HTTP_CONTENT_TYPE", r->envp)) == NULL)
return -1;
if ((int)(m = restconf_media_str2int(str)) == -1)
return -1;
return m;
}
/*! HTTP error 400 /*! HTTP error 400
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
int int
restconf_badrequest(FCGX_Request *r) restconf_badrequest(clicon_handle h,
FCGX_Request *r)
{ {
char *path; char *path;
path = FCGX_GetParam("REQUEST_URI", r->envp); path = clixon_restconf_param_get(h, "REQUEST_URI");
FCGX_SetExitStatus(400, r->out); FCGX_SetExitStatus(400, r->out);
FCGX_FPrintF(r->out, "Status: 400 Bad Request\r\n"); /* 400 bad request */ FCGX_FPrintF(r->out, "Status: 400 Bad Request\r\n"); /* 400 bad request */
FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n"); FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n");
@ -107,11 +87,12 @@ restconf_badrequest(FCGX_Request *r)
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
int int
restconf_unauthorized(FCGX_Request *r) restconf_unauthorized(clicon_handle h,
FCGX_Request *r)
{ {
char *path; char *path;
path = FCGX_GetParam("REQUEST_URI", r->envp); path = clixon_restconf_param_get(h, "REQUEST_URI");
FCGX_SetExitStatus(401, r->out); FCGX_SetExitStatus(401, r->out);
FCGX_FPrintF(r->out, "Status: 401 Unauthorized\r\n"); /* 401 unauthorized */ FCGX_FPrintF(r->out, "Status: 401 Unauthorized\r\n"); /* 401 unauthorized */
FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n"); FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n");
@ -124,11 +105,12 @@ restconf_unauthorized(FCGX_Request *r)
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
int int
restconf_forbidden(FCGX_Request *r) restconf_forbidden(clicon_handle h,
FCGX_Request *r)
{ {
char *path; char *path;
path = FCGX_GetParam("REQUEST_URI", r->envp); path = clixon_restconf_param_get(h, "REQUEST_URI");
FCGX_SetExitStatus(403, r->out); FCGX_SetExitStatus(403, r->out);
FCGX_FPrintF(r->out, "Status: 403 Forbidden\r\n"); /* 403 forbidden */ FCGX_FPrintF(r->out, "Status: 403 Forbidden\r\n"); /* 403 forbidden */
FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n"); FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n");
@ -141,11 +123,12 @@ restconf_forbidden(FCGX_Request *r)
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
int int
restconf_notfound(FCGX_Request *r) restconf_notfound(clicon_handle h,
FCGX_Request *r)
{ {
char *path; char *path;
path = FCGX_GetParam("REQUEST_URI", r->envp); path = clixon_restconf_param_get(h, "REQUEST_URI");
FCGX_SetExitStatus(404, r->out); FCGX_SetExitStatus(404, r->out);
FCGX_FPrintF(r->out, "Status: 404 Not Found\r\n"); /* 404 not found */ FCGX_FPrintF(r->out, "Status: 404 Not Found\r\n"); /* 404 not found */
FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n"); FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n");
@ -160,11 +143,12 @@ restconf_notfound(FCGX_Request *r)
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
int int
restconf_notacceptable(FCGX_Request *r) restconf_notacceptable(clicon_handle h,
FCGX_Request *r)
{ {
char *path; char *path;
path = FCGX_GetParam("REQUEST_URI", r->envp); path = clixon_restconf_param_get(h, "REQUEST_URI");
FCGX_SetExitStatus(406, r->out); FCGX_SetExitStatus(406, r->out);
FCGX_FPrintF(r->out, "Status: 406 Not Acceptable\r\n"); /* 406 not acceptible */ FCGX_FPrintF(r->out, "Status: 406 Not Acceptable\r\n"); /* 406 not acceptible */
@ -206,12 +190,13 @@ restconf_unsupported_media(FCGX_Request *r)
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
int int
restconf_internal_server_error(FCGX_Request *r) restconf_internal_server_error(clicon_handle h,
FCGX_Request *r)
{ {
char *path; char *path;
clicon_debug(1, "%s", __FUNCTION__); clicon_debug(1, "%s", __FUNCTION__);
path = FCGX_GetParam("REQUEST_URI", r->envp); path = clixon_restconf_param_get(h, "REQUEST_URI");
FCGX_FPrintF(r->out, "Status: 500 Internal Server Error\r\n"); /* 500 internal server error */ FCGX_FPrintF(r->out, "Status: 500 Internal Server Error\r\n"); /* 500 internal server error */
FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n"); FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n");
FCGX_FPrintF(r->out, "<h1>Internal server error when accessing %s</h1>\n", path); FCGX_FPrintF(r->out, "<h1>Internal server error when accessing %s</h1>\n", path);
@ -231,23 +216,6 @@ restconf_notimplemented(FCGX_Request *r)
return 0; return 0;
} }
/*!
* @param[in] r Fastcgi request handle
*/
static int
printparam(FCGX_Request *r,
char *e,
int dbgp)
{
char *p = FCGX_GetParam(e, r->envp);
if (dbgp)
clicon_debug(1, "%s = '%s'", e, p?p:"");
else
FCGX_FPrintF(r->out, "%s = '%s'\n", e, p?p:"");
return 0;
}
/*! Print all FCGI headers /*! Print all FCGI headers
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
* @see https://nginx.org/en/docs/http/ngx_http_core_module.html#var_https * @see https://nginx.org/en/docs/http/ngx_http_core_module.html#var_https
@ -256,43 +224,73 @@ int
restconf_test(FCGX_Request *r, restconf_test(FCGX_Request *r,
int dbg) int dbg)
{ {
printparam(r, "QUERY_STRING", dbg); char **environ = r->envp;
printparam(r, "REQUEST_METHOD", dbg); int i;
printparam(r, "CONTENT_TYPE", dbg);
printparam(r, "CONTENT_LENGTH", dbg);
printparam(r, "SCRIPT_FILENAME", dbg);
printparam(r, "SCRIPT_NAME", dbg);
printparam(r, "REQUEST_URI", dbg);
printparam(r, "DOCUMENT_URI", dbg);
printparam(r, "DOCUMENT_ROOT", dbg);
printparam(r, "SERVER_PROTOCOL", dbg);
printparam(r, "GATEWAY_INTERFACE", dbg);
printparam(r, "SERVER_SOFTWARE", dbg);
printparam(r, "REMOTE_ADDR", dbg);
printparam(r, "REMOTE_PORT", dbg);
printparam(r, "SERVER_ADDR", dbg);
printparam(r, "SERVER_PORT", dbg);
printparam(r, "SERVER_NAME", dbg);
printparam(r, "HTTP_COOKIE", dbg);
printparam(r, "HTTPS", dbg);
printparam(r, "HTTP_HOST", dbg);
printparam(r, "HTTP_ACCEPT", dbg);
printparam(r, "HTTP_CONTENT_TYPE", dbg);
printparam(r, "HTTP_AUTHORIZATION", dbg);
#if 0 /* For debug */
clicon_debug(1, "All environment vars:"); clicon_debug(1, "All environment vars:");
{ for (i = 0; environ[i] != NULL; i++){
extern char **environ; clicon_debug(1, "%s", environ[i]);
int i;
for (i = 0; environ[i] != NULL; i++){
clicon_debug(1, "%s", environ[i]);
}
} }
clicon_debug(1, "End environment vars:"); clicon_debug(1, "End environment vars");
#endif
return 0; return 0;
} }
/*! Convert FCGI parameters to clixon runtime data
* @param[in] h Clixon handle
* @param[in] envp Fastcgi request handle parameter array on the format "<param>=<value>"
* @see https://nginx.org/en/docs/http/ngx_http_core_module.html#var_https
*/
int
clixon_restconf_params_set(clicon_handle h,
char **envp)
{
int retval = -1;
int i;
char *param;
char *val;
clicon_debug(1, "%s", __FUNCTION__);
for (i = 0; envp[i] != NULL; i++){ /* on the form <param>=<value> */
if (clixon_strsplit(envp[i], '=', &param, &val) < 0)
goto done;
clicon_debug(1, "%s param:%s val:%s", __FUNCTION__, param, val);
if (clixon_restconf_param_set(h, param, val) < 0)
goto done;
}
retval = 0;
done:
clicon_debug(1, "%s %d", __FUNCTION__, retval);
return retval;
}
/*! Clear all FCGI parameters in an environment
* @param[in] h Clixon handle
* @param[in] envp Fastcgi request handle parameter array on the format "<param>=<value>"
* @see https://nginx.org/en/docs/http/ngx_http_core_module.html#var_https
*/
int
clixon_restconf_params_clear(clicon_handle h,
char **envp)
{
int retval = -1;
int i;
char *param;
char *val;
clicon_debug(1, "%s", __FUNCTION__);
for (i = 0; envp[i] != NULL; i++){ /* on the form <param>=<value> */
if (clixon_strsplit(envp[i], '=', &param, &val) < 0)
goto done;
clicon_debug(1, "%s param:%s val:%s", __FUNCTION__, param, val);
if (clixon_restconf_param_del(h, param) < 0)
goto done;
}
retval = 0;
done:
clicon_debug(1, "%s %d", __FUNCTION__, retval);
return retval;
}
/*! /*!
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
*/ */
@ -431,7 +429,8 @@ api_return_err(clicon_handle h,
* @note ports are ignored * @note ports are ignored
*/ */
int int
http_location(FCGX_Request *r, http_location(clicon_handle h,
FCGX_Request *r,
cxobj *xobj) cxobj *xobj)
{ {
int retval = -1; int retval = -1;
@ -440,9 +439,9 @@ http_location(FCGX_Request *r,
char *request_uri; char *request_uri;
cbuf *cb = NULL; cbuf *cb = NULL;
https = FCGX_GetParam("HTTPS", r->envp); https = clixon_restconf_param_get(h, "HTTPS");
host = FCGX_GetParam("HTTP_HOST", r->envp); host = clixon_restconf_param_get(h, "HTTP_HOST");
request_uri = FCGX_GetParam("REQUEST_URI", r->envp); request_uri = clixon_restconf_param_get(h, "REQUEST_URI");
if (xobj != NULL){ if (xobj != NULL){
if ((cb = cbuf_new()) == NULL){ if ((cb = cbuf_new()) == NULL){
clicon_err(OE_UNIX, 0, "cbuf_new"); clicon_err(OE_UNIX, 0, "cbuf_new");
@ -468,23 +467,4 @@ http_location(FCGX_Request *r,
return retval; return retval;
} }
/*! Extract uri-encoded uri-path from fastcgi parameters
* Use REQUEST_URI parameter and strip ?args
* REQUEST_URI have args and is encoded
* eg /interface=eth%2f0%2f0?insert=first
* DOCUMENT_URI dont have args and is not encoded
* eg /interface=eth/0/0
* causes problems with eg /interface=eth%2f0%2f0
*/
char *
restconf_uripath(FCGX_Request *r)
{
char *path;
char *q;
path = FCGX_GetParam("REQUEST_URI", r->envp);
if ((q = index(path, '?')) != NULL)
*q = '\0';
return path;
}

18
apps/restconf/restconf_fcgi_lib.h
View file

@ -40,21 +40,21 @@
/* /*
* Prototypes * Prototypes
*/ */
restconf_media restconf_content_type(FCGX_Request *r); int restconf_badrequest(clicon_handle h, FCGX_Request *r);
int restconf_badrequest(FCGX_Request *r); int restconf_unauthorized(clicon_handle h, FCGX_Request *r);
int restconf_unauthorized(FCGX_Request *r); int restconf_forbidden(clicon_handle h, FCGX_Request *r);
int restconf_forbidden(FCGX_Request *r); int restconf_notfound(clicon_handle h, FCGX_Request *r);
int restconf_notfound(FCGX_Request *r); int restconf_notacceptable(clicon_handle h, FCGX_Request *r);
int restconf_notacceptable(FCGX_Request *r);
int restconf_conflict(FCGX_Request *r); int restconf_conflict(FCGX_Request *r);
int restconf_unsupported_media(FCGX_Request *r); int restconf_unsupported_media(FCGX_Request *r);
int restconf_internal_server_error(FCGX_Request *r); int restconf_internal_server_error(clicon_handle h, FCGX_Request *r);
int restconf_notimplemented(FCGX_Request *r); int restconf_notimplemented(FCGX_Request *r);
int restconf_test(FCGX_Request *r, int dbg); int restconf_test(FCGX_Request *r, int dbg);
int clixon_restconf_params_set(clicon_handle h, char **envp);
int clixon_restconf_params_clear(clicon_handle h, char **envp);
cbuf *readdata(FCGX_Request *r); cbuf *readdata(FCGX_Request *r);
int api_return_err(clicon_handle h, FCGX_Request *r, cxobj *xerr, int api_return_err(clicon_handle h, FCGX_Request *r, cxobj *xerr,
int pretty, enum restconf_media media, int code); int pretty, enum restconf_media media, int code);
int http_location(FCGX_Request *r, cxobj *xobj); int http_location(clicon_handle h, FCGX_Request *r, cxobj *xobj);
char *restconf_uripath(FCGX_Request *r);
#endif /* _RESTCONF_FCGI_LIB_H_ */ #endif /* _RESTCONF_FCGI_LIB_H_ */

41
apps/restconf/restconf_fcgi_main.c
View file

@ -114,7 +114,7 @@ api_data(clicon_handle h,
char *request_method; char *request_method;
clicon_debug(1, "%s", __FUNCTION__); clicon_debug(1, "%s", __FUNCTION__);
request_method = FCGX_GetParam("REQUEST_METHOD", r->envp); request_method = clixon_restconf_param_get(h, "REQUEST_METHOD");
clicon_debug(1, "%s method:%s", __FUNCTION__, request_method); clicon_debug(1, "%s method:%s", __FUNCTION__, request_method);
if (strcmp(request_method, "OPTIONS")==0) if (strcmp(request_method, "OPTIONS")==0)
retval = api_data_options(h, r); retval = api_data_options(h, r);
@ -131,7 +131,7 @@ api_data(clicon_handle h,
else if (strcmp(request_method, "DELETE")==0) else if (strcmp(request_method, "DELETE")==0)
retval = api_data_delete(h, r, api_path, pi, pretty, media_out); retval = api_data_delete(h, r, api_path, pi, pretty, media_out);
else else
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
clicon_debug(1, "%s retval:%d", __FUNCTION__, retval); clicon_debug(1, "%s retval:%d", __FUNCTION__, retval);
return retval; return retval;
} }
@ -161,7 +161,7 @@ api_operations(clicon_handle h,
char *request_method; char *request_method;
clicon_debug(1, "%s", __FUNCTION__); clicon_debug(1, "%s", __FUNCTION__);
request_method = FCGX_GetParam("REQUEST_METHOD", r->envp); request_method = clixon_restconf_param_get(h, "REQUEST_METHOD");
clicon_debug(1, "%s method:%s", __FUNCTION__, request_method); clicon_debug(1, "%s method:%s", __FUNCTION__, request_method);
if (strcmp(request_method, "GET")==0) if (strcmp(request_method, "GET")==0)
retval = api_operations_get(h, r, path, pi, qvec, data, pretty, media_out); retval = api_operations_get(h, r, path, pi, qvec, data, pretty, media_out);
@ -169,7 +169,7 @@ api_operations(clicon_handle h,
retval = api_operations_post(h, r, path, pi, qvec, data, retval = api_operations_post(h, r, path, pi, qvec, data,
pretty, media_out); pretty, media_out);
else else
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
return retval; return retval;
} }
@ -340,8 +340,8 @@ api_restconf(clicon_handle h,
cxobj *xerr; cxobj *xerr;
clicon_debug(1, "%s", __FUNCTION__); clicon_debug(1, "%s", __FUNCTION__);
path = restconf_uripath(r); path = restconf_uripath(h);
query = FCGX_GetParam("QUERY_STRING", r->envp); query = clixon_restconf_param_get(h, "QUERY_STRING");
pretty = clicon_option_bool(h, "CLICON_RESTCONF_PRETTY"); pretty = clicon_option_bool(h, "CLICON_RESTCONF_PRETTY");
/* Get media for output (proactive negotiation) RFC7231 by using /* Get media for output (proactive negotiation) RFC7231 by using
@ -349,7 +349,7 @@ api_restconf(clicon_handle h,
* operation POST, etc * operation POST, etc
* If accept is * default is yang-json * If accept is * default is yang-json
*/ */
if ((media_str = FCGX_GetParam("HTTP_ACCEPT", r->envp)) == NULL){ if ((media_str = clixon_restconf_param_get(h, "HTTP_ACCEPT")) == NULL){
// retval = restconf_unsupported_media(r); // retval = restconf_unsupported_media(r);
// goto done; // goto done;
} }
@ -367,15 +367,15 @@ api_restconf(clicon_handle h,
goto done; goto done;
/* Sanity check of path. Should be /restconf/ */ /* Sanity check of path. Should be /restconf/ */
if (pn < 2){ if (pn < 2){
restconf_notfound(r); restconf_notfound(h, r);
goto ok; goto ok;
} }
if (strlen(pvec[0]) != 0){ if (strlen(pvec[0]) != 0){
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
goto done; goto done;
} }
if (strcmp(pvec[1], RESTCONF_API)){ if (strcmp(pvec[1], RESTCONF_API)){
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
goto done; goto done;
} }
restconf_test(r, 1); restconf_test(r, 1);
@ -385,7 +385,7 @@ api_restconf(clicon_handle h,
goto done; goto done;
} }
if ((method = pvec[2]) == NULL){ if ((method = pvec[2]) == NULL){
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
goto done; goto done;
} }
clicon_debug(1, "%s: method=%s", __FUNCTION__, method); clicon_debug(1, "%s: method=%s", __FUNCTION__, method);
@ -441,7 +441,7 @@ api_restconf(clicon_handle h,
else if (strcmp(method, "test") == 0) else if (strcmp(method, "test") == 0)
restconf_test(r, 0); restconf_test(r, 0);
else else
restconf_notfound(r); restconf_notfound(h, r);
ok: ok:
retval = 0; retval = 0;
done: done:
@ -483,7 +483,7 @@ restconf_sig_term(int arg)
stream_child_freeall(_CLICON_HANDLE); stream_child_freeall(_CLICON_HANDLE);
restconf_terminate(_CLICON_HANDLE); restconf_terminate(_CLICON_HANDLE);
} }
clicon_exit_set(); /* checked in event_loop() */ clicon_exit_set(); /* checked in clixon_event_loop() */
exit(-1); exit(-1);
} }
@ -790,8 +790,12 @@ main(int argc,
clicon_session_id_set(h, id); clicon_session_id_set(h, id);
start++; start++;
} }
/* Translate from FCGI parameter form to Clixon runtime data
if ((path = FCGX_GetParam("REQUEST_URI", r->envp)) != NULL){ * XXX: potential name collision?
*/
if (clixon_restconf_params_set(h, r->envp) < 0)
goto done;
if ((path = clixon_restconf_param_get(h, "REQUEST_URI")) != NULL){
clicon_debug(1, "path: %s", path); clicon_debug(1, "path: %s", path);
if (strncmp(path, "/" RESTCONF_API, strlen("/" RESTCONF_API)) == 0) if (strncmp(path, "/" RESTCONF_API, strlen("/" RESTCONF_API)) == 0)
api_restconf(h, r); /* This is the function */ api_restconf(h, r); /* This is the function */
@ -803,11 +807,13 @@ main(int argc,
} }
else{ else{
clicon_debug(1, "top-level %s not found", path); clicon_debug(1, "top-level %s not found", path);
restconf_notfound(r); restconf_notfound(h, r);
} }
} }
else else
clicon_debug(1, "NULL URI"); clicon_debug(1, "NULL URI");
if (clixon_restconf_params_clear(h, r->envp) < 0)
goto done;
if (finish) if (finish)
FCGX_Finish_r(r); FCGX_Finish_r(r);
else{ /* A handler is forked so we initiate a new request after instead else{ /* A handler is forked so we initiate a new request after instead
@ -817,7 +823,8 @@ main(int argc,
goto done; goto done;
} }
} }
}
} /* while */
retval = 0; retval = 0;
done: done:
stream_child_freeall(h); stream_child_freeall(h);

80
apps/restconf/restconf_lib.c
View file

@ -176,6 +176,27 @@ restconf_media_int2str(restconf_media media)
return clicon_int2str(http_media_map, media); return clicon_int2str(http_media_map, media);
} }
/*! Return media_in from Content-Type, -1 if not found or unrecognized
* @note media-type syntax does not support parameters
* @see RFC7231 Sec 3.1.1.1 for media-type syntax type:
* media-type = type "/" subtype *( OWS ";" OWS parameter )
* type = token
* subtype = token
*
*/
restconf_media
restconf_content_type(clicon_handle h)
{
char *str;
restconf_media m;
if ((str = clixon_restconf_param_get(h, "HTTP_CONTENT_TYPE")) == NULL)
return -1;
if ((int)(m = restconf_media_str2int(str)) == -1)
return -1;
return m;
}
/*! Parse a cookie string and return value of cookie attribute /*! Parse a cookie string and return value of cookie attribute
* @param[in] cookiestr cookie string according to rfc6265 (modified) * @param[in] cookiestr cookie string according to rfc6265 (modified)
* @param[in] attribute cookie attribute * @param[in] attribute cookie attribute
@ -389,3 +410,62 @@ restconf_main_extension_cb(clicon_handle h,
done: done:
return retval; return retval;
} }
/*! Get restconf http parameter
* @param[in] h Clicon handle
* @param[in] name Data name
* @retval val Data value as string
* Currently using clixon runtime data but there is risk for colliding names
*/
char *
clixon_restconf_param_get(clicon_handle h,
char *param)
{
char *val;
if (clicon_data_get(h, param, &val) < 0)
return NULL;
return val;
}
/*! Set restconf http parameter
* @param[in] h Clicon handle
* @param[in] name Data name
* @param[in] val Data value as null-terminated string
* @retval 0 OK
* @retval -1 Error
* Currently using clixon runtime data but there is risk for colliding names
*/
int
clixon_restconf_param_set(clicon_handle h,
char *param,
char *val)
{
return clicon_data_set(h, param, val);
}
int
clixon_restconf_param_del(clicon_handle h,
char *param)
{
return clicon_data_del(h, param);
}
/*! Extract uri-encoded uri-path from fastcgi parameters
* Use REQUEST_URI parameter and strip ?args
* REQUEST_URI have args and is encoded
* eg /interface=eth%2f0%2f0?insert=first
* DOCUMENT_URI dont have args and is not encoded
* eg /interface=eth/0/0
* causes problems with eg /interface=eth%2f0%2f0
*/
char *
restconf_uripath(clicon_handle h)
{
char *path;
char *q;
path = clixon_restconf_param_get(h, "REQUEST_URI");
if ((q = index(path, '?')) != NULL)
*q = '\0';
return path;
}

13
apps/restconf/restconf_lib.h
View file

@ -72,9 +72,14 @@ int restconf_err2code(char *tag);
const char *restconf_code2reason(int code); const char *restconf_code2reason(int code);
const restconf_media restconf_media_str2int(char *media); const restconf_media restconf_media_str2int(char *media);
const char *restconf_media_int2str(restconf_media media); const char *restconf_media_int2str(restconf_media media);
int get_user_cookie(char *cookiestr, char *attribute, char **val); restconf_media restconf_content_type(clicon_handle h);
int restconf_terminate(clicon_handle h); int get_user_cookie(char *cookiestr, char *attribute, char **val);
int restconf_insert_attributes(cxobj *xdata, cvec *qvec); int restconf_terminate(clicon_handle h);
int restconf_main_extension_cb(clicon_handle h, yang_stmt *yext, yang_stmt *ys); int restconf_insert_attributes(cxobj *xdata, cvec *qvec);
int restconf_main_extension_cb(clicon_handle h, yang_stmt *yext, yang_stmt *ys);
char *clixon_restconf_param_get(clicon_handle h, char *param);
int clixon_restconf_param_set(clicon_handle h, char *param, char *val);
int clixon_restconf_param_del(clicon_handle h, char *param);
char *restconf_uripath(clicon_handle h);
#endif /* _RESTCONF_LIB_H_ */ #endif /* _RESTCONF_LIB_H_ */

605
apps/restconf/restconf_libhttp_main.c
View file

@ -1,605 +0,0 @@
/*
*
***** 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 *****
*/
/* XXX temp constant should go away, */
#undef _LIBHTTP_NYI
#ifdef HAVE_CONFIG_H
#include "clixon_config.h" /* generated by config & autoconf */
#endif
#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 <limits.h>
#include <signal.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <libgen.h>
#include <sys/stat.h> /* chmod */
/* libhttp */
#include <libhttp/libhttp.h>
/* cligen */
#include <cligen/cligen.h>
/* clicon */
#include <clixon/clixon.h>
/* restconf */
#include "restconf_lib.h"
#if 0 /* These are all dependent on FCGX */
#include "restconf_methods.h"
#include "restconf_methods_get.h"
#include "restconf_methods_post.h"
#include "restconf_stream.h"
#endif
/* Command line options to be passed to getopt(3) */
#define RESTCONF_OPTS "hD:f:l:p:d:y:a:u:o:P:"
/* 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 _LIBHTTP_NYI
stream_child_freeall(_CLICON_HANDLE);
#endif
restconf_terminate(_CLICON_HANDLE);
}
clicon_exit_set(); /* checked in 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 _LIBHTTP_NYI
stream_child_free(_CLICON_HANDLE, pid);
#else
;
#endif
}
/*! 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 <level>\t Debug level\n"
"\t-f <file>\t Configuration file (mandatory)\n"
"\t-l <s|f<file>> \t Log on (s)yslog, (f)ile (syslog is default)\n"
"\t-p <dir>\t Yang directory path (see CLICON_YANG_DIR)\n"
"\t-d <dir>\t Specify restconf plugin directory dir (default: %s)\n"
"\t-y <file>\t Load yang spec file (override yang main module)\n"
"\t-a UNIX|IPv4|IPv6 Internal backend socket family\n"
"\t-u <path|addr>\t Internal socket domain path or IP addr (see -a)\n"
"\t-o \"<option>=<value>\" Give configuration option overriding config file (see clixon-config.yang)\n"
"\t-P <port>\t HTTP port (default 80)\n"
,
argv0,
clicon_restconf_dir(h)
);
exit(0);
}
/*! Create and append a libhttp option.
*/
static int
lh_opts_append(struct lh_opt_t **options,
int *len,
char *name,
char *value)
{
int retval = -1;
struct lh_opt_t *opt = NULL;
(*len)++;
if ((*options = realloc(*options, *len*sizeof(*opt))) == NULL){
clicon_err(OE_FATAL, errno, "realloc");
goto done;
}
opt = &(*options)[*len-1];
memset(opt, 0, sizeof(*opt));
if (name && (opt->name = strdup(name)) == NULL){
clicon_err(OE_FATAL, errno, "strdup");
goto done;
}
if (value && (opt->value = strdup(value)) == NULL){
clicon_err(OE_FATAL, errno, "strdup");
goto done;
}
retval = 0;
done:
return retval;
}
/*! Free a libhttp options list
*/
static int
lh_opts_free(struct lh_opt_t *options,
int len)
{
struct lh_opt_t *opt = NULL;
int i;
for (i=0; i<len; i++){
opt = &options[i];
if (opt->name)
free((char*)opt->name);
if (opt->value)
free((char*)opt->value);
}
if (options)
free(options);
return 0;
}
/*! Libhttp icoming request
*/
static int
cx_begin_request(struct lh_ctx_t *ctx,
struct lh_con_t *conn)
{
const struct lh_rqi_t *request_info = httplib_get_request_info(conn);
char content[100];
// Prepare the message we're going to send
int content_length = snprintf(content, sizeof(content),
"Hello from Clixon FOO! Remote port: %d",
request_info->remote_port);
fprintf(stderr, "%s\n", __FUNCTION__);
httplib_printf(ctx, conn,
"HTTP/1.1 200 OK\r\n"
"Content-Type: text/plain\r\n"
"Content-Length: %d\r\n" // Always set Content-Length
"\r\n"
"%s",
content_length, content);
return 0;
}
static void
cx_end_request(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
int reply_status_code )
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static int
cx_log_message(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
const char *message)
{
fprintf(stderr, "ERROR: %s\n", message);
return 0;
}
static int
cx_log_access(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
const char *message)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return 0;
}
static int
cx_init_ssl(struct lh_ctx_t *ctx,
void *ssl_context,
void *user_data)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return 0;
}
static void
cx_connection_close(struct lh_ctx_t *ctx,
const struct lh_con_t *conn)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static const char *
cx_open_file(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
const char *path,
size_t *data_len)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return NULL;
}
static void
cx_init_lua(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
void *lua_context)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static int
cx_http_error(struct lh_ctx_t *ctx,
struct lh_con_t *conn,
int status)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return 0;
}
static void
cx_init_context(struct lh_ctx_t *ctx)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static void
cx_init_thread(struct lh_ctx_t *ctx,
int thread_type)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static void
cx_exit_context(struct lh_ctx_t *ctx)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
/*! Main routine for libhttp restconf
*/
int
main(int argc,
char **argv)
{
int retval = -1;
char *argv0 = argv[0];
int c;
clicon_handle h;
char *dir;
int logdst = CLICON_LOG_SYSLOG;
yang_stmt *yspec = NULL;
int finish = 0;
int start = 1;
char *str;
clixon_plugin *cp = NULL;
uint32_t id = 0;
cvec *nsctx_global = NULL; /* Global namespace context */
size_t cligen_buflen;
size_t cligen_bufthreshold;
char *portstr = "80";
#ifdef _LIBHTTP_NYI
char *stream_path;
#endif
struct lh_ctx_t *ctx = NULL;
/* See XX_httplib_free_config_options, XX_httplib_init_options */
struct lh_opt_t *lh_opts = NULL;
int lh_opts_len = 0;
const struct lh_clb_t lh_callbacks = {cx_begin_request, cx_end_request, cx_log_message, cx_log_access, cx_init_ssl,
cx_connection_close, cx_open_file, cx_init_lua, cx_http_error,
cx_init_context, cx_init_thread, cx_exit_context};
/* In the startup, logs to stderr & debug flag set later */
clicon_log_init(__PROGRAM__, LOG_INFO, logdst);
/* 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 */
if (sscanf(optarg, "%d", &debug) != 1)
usage(h, argv[0]);
break;
case 'f': /* override config file */
if (!strlen(optarg))
usage(h, argv[0]);
clicon_option_str_set(h, "CLICON_CONFIGFILE", optarg);
break;
case 'l': /* Log destination: s|e|o */
if ((logdst = clicon_log_opt(optarg[0])) < 0)
usage(h, argv[0]);
if (logdst == CLICON_LOG_FILE &&
strlen(optarg)>1 &&
clicon_log_file(optarg+1) < 0)
goto done;
break;
} /* switch getopt */
/*
* Logs, error and debug to stderr or syslog, set debug level
*/
clicon_log_init(__PROGRAM__, debug?LOG_DEBUG:LOG_INFO, logdst);
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_DAEMON, errno, "Setting signal");
goto done;
}
if (set_signal(SIGINT, restconf_sig_term, NULL) < 0){
clicon_err(OE_DAEMON, errno, "Setting signal");
goto done;
}
if (set_signal(SIGCHLD, restconf_sig_child, NULL) < 0){
clicon_err(OE_DAEMON, errno, "Setting signal");
goto done;
}
/* Find and read configfile */
if (clicon_options_main(h) < 0)
goto done;
#ifdef _LIBHTTP_NYI
stream_path = clicon_option_str(h, "CLICON_STREAM_PATH");
#endif
/* Now rest of options, some overwrite option file */
optind = 1;
opterr = 0;
while ((c = getopt(argc, argv, RESTCONF_OPTS)) != -1)
switch (c) {
case 'h' : /* help */
case 'D' : /* debug */
case 'f': /* config file */
case 'l': /* log */
break; /* see above */
case 'p' : /* yang dir path */
if (clicon_option_add(h, "CLICON_YANG_DIR", optarg) < 0)
goto done;
break;
case 'd': /* Plugin directory */
if (!strlen(optarg))
usage(h, argv[0]);
clicon_option_str_set(h, "CLICON_RESTCONF_DIR", optarg);
break;
case 'y' : /* Load yang spec file (override yang main module) */
clicon_option_str_set(h, "CLICON_YANG_MAIN_FILE", optarg);
break;
case 'a': /* internal backend socket address family */
clicon_option_str_set(h, "CLICON_SOCK_FAMILY", optarg);
break;
case 'u': /* internal backend socket unix domain path or ip host */
if (!strlen(optarg))
usage(h, argv[0]);
clicon_option_str_set(h, "CLICON_SOCK", optarg);
break;
case 'o':{ /* Configuration option */
char *val;
if ((val = index(optarg, '=')) == NULL)
usage(h, argv0);
*val++ = '\0';
if (clicon_option_add(h, optarg, val) < 0)
goto done;
break;
}
case 'P': /* http port */
if (!strlen(optarg))
usage(h, argv[0]);
portstr=optarg;
break;
default:
usage(h, argv[0]);
break;
}
argc -= optind;
argv += optind;
/* See here for libhttp options XX_httplib_process_options
* - https://github.com/lammertb/libhttp/blob/master/doc/UserManual.md
* some options seem documented here: https://github.com/civetweb/civetweb/blob/master/docs/UserManual.md
*/
if (lh_opts_append(&lh_opts, &lh_opts_len, "listening_ports", portstr) < 0)
goto done;
if (lh_opts_append(&lh_opts, &lh_opts_len, "num_threads", "5") < 0)
goto done;
/* Access the remaining argv/argc options (after --) w clicon-argv_get() */
clicon_argv_set(h, argv0, argc, argv);
/* Init cligen buffers */
cligen_buflen = clicon_option_int(h, "CLICON_CLI_BUF_START");
cligen_bufthreshold = clicon_option_int(h, "CLICON_CLI_BUF_THRESHOLD");
cbuf_alloc_set(cligen_buflen, cligen_bufthreshold);
/* Add (hardcoded) netconf features in case ietf-netconf loaded here
* Otherwise it is loaded in netconf_module_load below
*/
if (netconf_module_features(h) < 0)
goto done;
/* Create top-level yang spec and store as option */
if ((yspec = yspec_new()) == NULL)
goto done;
clicon_dbspec_yang_set(h, yspec);
/* Treat unknown XML as anydata */
if (clicon_option_bool(h, "CLICON_YANG_UNKNOWN_ANYDATA") == 1)
xml_bind_yang_unknown_anydata(1);
/* Load restconf plugins before yangs are loaded (eg extension callbacks) */
if ((dir = clicon_restconf_dir(h)) != NULL)
if (clixon_plugins_load(h, CLIXON_PLUGIN_INIT, dir, NULL) < 0)
return -1;
/* Create a pseudo-plugin to create extension callback to set the ietf-routing
* yang-data extension for api-root top-level restconf function.
*/
if (clixon_pseudo_plugin(h, "pseudo restconf", &cp) < 0)
goto done;
cp->cp_api.ca_extension = restconf_main_extension_cb;
/* Load Yang modules
* 1. Load a yang module as a specific absolute filename */
if ((str = clicon_yang_main_file(h)) != NULL){
if (yang_spec_parse_file(h, str, yspec) < 0)
goto done;
}
/* 2. Load a (single) main module */
if ((str = clicon_yang_module_main(h)) != NULL){
if (yang_spec_parse_module(h, str, clicon_yang_module_revision(h),
yspec) < 0)
goto done;
}
/* 3. Load all modules in a directory */
if ((str = clicon_yang_main_dir(h)) != NULL){
if (yang_spec_load_dir(h, str, yspec) < 0)
goto done;
}
/* Load clixon lib yang module */
if (yang_spec_parse_module(h, "clixon-lib", NULL, yspec) < 0)
goto done;
/* Load yang module library, RFC7895 */
if (yang_modules_init(h) < 0)
goto done;
/* Load yang restconf module */
if (yang_spec_parse_module(h, "ietf-restconf", NULL, yspec)< 0)
goto done;
/* Add netconf yang spec, used as internal protocol */
if (netconf_module_load(h) < 0)
goto done;
/* Add system modules */
if (clicon_option_bool(h, "CLICON_STREAM_DISCOVERY_RFC8040") &&
yang_spec_parse_module(h, "ietf-restconf-monitoring", NULL, yspec)< 0)
goto done;
if (clicon_option_bool(h, "CLICON_STREAM_DISCOVERY_RFC5277") &&
yang_spec_parse_module(h, "clixon-rfc5277", NULL, yspec)< 0)
goto done;
/* Here all modules are loaded
* Compute and set canonical namespace context
*/
if (xml_nsctx_yangspec(yspec, &nsctx_global) < 0)
goto done;
if (clicon_nsctx_global_set(h, nsctx_global) < 0)
goto done;
/* Dump configuration options on debug */
if (debug)
clicon_option_dump(h, debug);
/* Call start function in all plugins before we go interactive
*/
if (clixon_plugin_start_all(h) < 0)
goto done;
/* Find and read configfile */
if (clicon_options_main(h) < 0)
goto done;
/* Terminate options list with NULL (must be the last) */
if (lh_opts_append(&lh_opts, &lh_opts_len, NULL, NULL) < 0)
goto done;
/* Start the web server. */
if ((ctx = httplib_start(&lh_callbacks, /* callbacks */
h, /* userdata - clixon handle*/
lh_opts /* options */
)) == NULL)
goto done;
while (finish == 0) {
finish = 1; /* If zero, dont finish request, initiate new */
clicon_debug(1, "------------");
if (start == 0){
/* Send hello request to backend to get session-id back
* This is done once at the beginning of the session and then this is
* used by the client, even though new TCP sessions are created for
* each message sent to the backend.
*/
if (clicon_hello_req(h, &id) < 0)
goto done;
clicon_session_id_set(h, id);
start++;
}
break; /* XXX */
}
pthread_exit(NULL);
/* Use options to select the port and document root among other things.
* Use callbacks to add your own hooks.
*/
retval = 0;
done:
if (ctx)
httplib_stop(ctx); /* to stop the server. */
#ifdef _LIBHTTP_NYI
stream_child_freeall(h);
#endif
lh_opts_free(lh_opts, lh_opts_len);
restconf_terminate(h);
return retval;
}

6
apps/restconf/restconf_methods.c
View file

@ -311,7 +311,7 @@ api_data_write(clicon_handle h,
#endif #endif
if (xml_child_nr(xret) == 0){ /* Object does not exist */ if (xml_child_nr(xret) == 0){ /* Object does not exist */
if (plain_patch){ /* If the target resource instance does not exist, the server MUST NOT create it. */ if (plain_patch){ /* If the target resource instance does not exist, the server MUST NOT create it. */
restconf_badrequest(r); restconf_badrequest(h, r);
goto ok; goto ok;
} }
else else
@ -740,7 +740,7 @@ api_data_put(clicon_handle h,
{ {
restconf_media media_in; restconf_media media_in;
media_in = restconf_content_type(r); media_in = restconf_content_type(h);
return api_data_write(h, r, api_path0, pcvec, pi, qvec, data, pretty, return api_data_write(h, r, api_path0, pcvec, pi, qvec, data, pretty,
media_in, media_out, 0); media_in, media_out, 0);
} }
@ -776,7 +776,7 @@ api_data_patch(clicon_handle h,
restconf_media media_in; restconf_media media_in;
int ret; int ret;
media_in = restconf_content_type(r); media_in = restconf_content_type(h);
switch (media_in){ switch (media_in){
case YANG_DATA_XML: case YANG_DATA_XML:
case YANG_DATA_JSON: /* plain patch */ case YANG_DATA_JSON: /* plain patch */

7
apps/restconf/restconf_methods_post.c
View file

@ -188,7 +188,7 @@ api_data_post(clicon_handle h,
* If xbot is top-level (api_path=null) it does not have a spec therefore look for * If xbot is top-level (api_path=null) it does not have a spec therefore look for
* top-level (yspec) otherwise assume parent (xbot) is populated. * top-level (yspec) otherwise assume parent (xbot) is populated.
*/ */
media_in = restconf_content_type(r); media_in = restconf_content_type(h);
switch (media_in){ switch (media_in){
case YANG_DATA_XML: case YANG_DATA_XML:
if ((ret = clixon_xml_parse_string(data, yb, yspec, &xbot, &xerr)) < 0){ if ((ret = clixon_xml_parse_string(data, yb, yspec, &xbot, &xerr)) < 0){
@ -382,8 +382,7 @@ api_data_post(clicon_handle h,
} }
FCGX_SetExitStatus(201, r->out); FCGX_SetExitStatus(201, r->out);
FCGX_FPrintF(r->out, "Status: 201 Created\r\n"); FCGX_FPrintF(r->out, "Status: 201 Created\r\n");
http_location(r, xdata); http_location(h, r, xdata);
FCGX_GetParam("HTTP_ACCEPT", r->envp);
FCGX_FPrintF(r->out, "\r\n"); FCGX_FPrintF(r->out, "\r\n");
ok: ok:
retval = 0; retval = 0;
@ -451,7 +450,7 @@ api_operations_post_input(clicon_handle h,
goto done; goto done;
} }
/* Parse input data as json or xml into xml */ /* Parse input data as json or xml into xml */
media_in = restconf_content_type(r); media_in = restconf_content_type(h);
switch (media_in){ switch (media_in){
case YANG_DATA_XML: case YANG_DATA_XML:
/* XXX: Here data is on the form: <input xmlns="urn:example:clixon"/> and has no proper yang binding /* XXX: Here data is on the form: <input xmlns="urn:example:clixon"/> and has no proper yang binding

26
apps/restconf/restconf_stream.c
View file

@ -336,7 +336,7 @@ stream_timeout(int s,
gettimeofday(&t, NULL); gettimeofday(&t, NULL);
t1.tv_sec = 1; t1.tv_usec = 0; t1.tv_sec = 1; t1.tv_usec = 0;
timeradd(&t, &t1, &t); timeradd(&t, &t1, &t);
event_reg_timeout(t, stream_timeout, arg, "Stream timeout"); clixon_event_reg_timeout(t, stream_timeout, arg, "Stream timeout");
} }
return 0; return 0;
} }
@ -374,28 +374,28 @@ api_stream(clicon_handle h,
#endif #endif
clicon_debug(1, "%s", __FUNCTION__); clicon_debug(1, "%s", __FUNCTION__);
path = restconf_uripath(r); path = restconf_uripath(h);
query = FCGX_GetParam("QUERY_STRING", r->envp); query = clixon_restconf_param_get(h, "QUERY_STRING");
pretty = clicon_option_bool(h, "CLICON_RESTCONF_PRETTY"); pretty = clicon_option_bool(h, "CLICON_RESTCONF_PRETTY");
restconf_test(r, 1); restconf_test(r, 1);
if ((pvec = clicon_strsep(path, "/", &pn)) == NULL) if ((pvec = clicon_strsep(path, "/", &pn)) == NULL)
goto done; goto done;
/* Sanity check of path. Should be /stream/<name> */ /* Sanity check of path. Should be /stream/<name> */
if (pn != 3){ if (pn != 3){
restconf_notfound(r); restconf_notfound(h, r);
goto ok; goto ok;
} }
if (strlen(pvec[0]) != 0){ if (strlen(pvec[0]) != 0){
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
goto done; goto done;
} }
if (strcmp(pvec[1], streampath)){ if (strcmp(pvec[1], streampath)){
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
goto done; goto done;
} }
if ((method = pvec[2]) == NULL){ if ((method = pvec[2]) == NULL){
retval = restconf_notfound(r); retval = restconf_notfound(h, r);
goto done; goto done;
} }
clicon_debug(1, "%s: method=%s", __FUNCTION__, method); clicon_debug(1, "%s: method=%s", __FUNCTION__, method);
@ -454,12 +454,12 @@ api_stream(clicon_handle h,
xml_free(xret); xml_free(xret);
#endif /* STREAM_FORK */ #endif /* STREAM_FORK */
/* Listen to backend socket */ /* Listen to backend socket */
if (event_reg_fd(s, if (clixon_event_reg_fd(s,
restconf_stream_cb, restconf_stream_cb,
(void*)r, (void*)r,
"stream socket") < 0) "stream socket") < 0)
goto done; goto done;
if (event_reg_fd(r->listen_sock, if (clixon_event_reg_fd(r->listen_sock,
stream_checkuplink, stream_checkuplink,
(void*)r, (void*)r,
"stream socket") < 0) "stream socket") < 0)
@ -467,11 +467,11 @@ api_stream(clicon_handle h,
/* Poll upstream errors */ /* Poll upstream errors */
stream_timeout(0, (void*)r); stream_timeout(0, (void*)r);
/* Start loop */ /* Start loop */
event_loop(); clixon_event_loop();
close(s); close(s);
event_unreg_fd(s, restconf_stream_cb); clixon_event_unreg_fd(s, restconf_stream_cb);
event_unreg_fd(r->listen_sock, restconf_stream_cb); clixon_event_unreg_fd(r->listen_sock, restconf_stream_cb);
event_unreg_timeout(stream_timeout, (void*)r); clixon_event_unreg_timeout(stream_timeout, (void*)r);
clicon_exit_reset(); clicon_exit_reset();
#ifdef STREAM_FORK #ifdef STREAM_FORK
FCGX_Finish_r(r); FCGX_Finish_r(r);

8
example/main/Makefile.in
View file

@ -1,7 +1,9 @@
# #
# ***** BEGIN LICENSE BLOCK ***** # ***** BEGIN LICENSE BLOCK *****
# #
# Copyright (C) 2009-2019 Olof Hagsand and Benny Holmgren # Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
# Copyright (C) 2017-2019 Olof Hagsand
# Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgat)e
# #
# This file is part of CLIXON # This file is part of CLIXON
# #
@ -63,7 +65,7 @@ NETCONF_PLUGIN = $(APPNAME)_netconf.so
RESTCONF_PLUGIN = $(APPNAME)_restconf.so RESTCONF_PLUGIN = $(APPNAME)_restconf.so
PLUGINS = $(BE_PLUGIN) $(BE2_PLUGIN) $(CLI_PLUGIN) $(NETCONF_PLUGIN) PLUGINS = $(BE_PLUGIN) $(BE2_PLUGIN) $(CLI_PLUGIN) $(NETCONF_PLUGIN)
ifeq ($(with_restconf),yes) ifdef with_restconf
PLUGINS += $(RESTCONF_PLUGIN) PLUGINS += $(RESTCONF_PLUGIN)
endif endif
@ -138,7 +140,7 @@ install: $(YANGSPECS) $(CLISPECS) $(PLUGINS) $(APPNAME).xml
install -m 0644 $(INSTALLFLAGS) $(BE_PLUGIN) $(BE2_PLUGIN) $(DESTDIR)$(libdir)/$(APPNAME)/backend install -m 0644 $(INSTALLFLAGS) $(BE_PLUGIN) $(BE2_PLUGIN) $(DESTDIR)$(libdir)/$(APPNAME)/backend
install -d -m 0755 $(DESTDIR)$(libdir)/$(APPNAME)/netconf install -d -m 0755 $(DESTDIR)$(libdir)/$(APPNAME)/netconf
install -m 0644 $(INSTALLFLAGS) $(NETCONF_PLUGIN) $(DESTDIR)$(libdir)/$(APPNAME)/netconf install -m 0644 $(INSTALLFLAGS) $(NETCONF_PLUGIN) $(DESTDIR)$(libdir)/$(APPNAME)/netconf
ifeq ($(with_restconf),yes) ifdef with_restconf
install -d -m 0755 $(DESTDIR)$(libdir)/$(APPNAME)/restconf install -d -m 0755 $(DESTDIR)$(libdir)/$(APPNAME)/restconf
install -m 0644 $(INSTALLFLAGS) $(RESTCONF_PLUGIN) $(DESTDIR)$(libdir)/$(APPNAME)/restconf install -m 0644 $(INSTALLFLAGS) $(RESTCONF_PLUGIN) $(DESTDIR)$(libdir)/$(APPNAME)/restconf
endif endif

2
example/main/example_backend.c
View file

@ -235,7 +235,7 @@ example_stream_timer_setup(clicon_handle h)
gettimeofday(&t, NULL); gettimeofday(&t, NULL);
t1.tv_sec = 5; t1.tv_usec = 0; t1.tv_sec = 5; t1.tv_usec = 0;
timeradd(&t, &t1, &t); timeradd(&t, &t1, &t);
return event_reg_timeout(t, example_stream_timer, h, "example stream timer"); return clixon_event_reg_timeout(t, example_stream_timer, h, "example stream timer");
} }
/*! Smallest possible RPC declaration for test /*! Smallest possible RPC declaration for test

17
example/main/example_restconf.c
View file

@ -2,7 +2,9 @@
* *
***** BEGIN LICENSE BLOCK ***** ***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand and Benny Holmgren Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
Copyright (C) 2017-2019 Olof Hagsand
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgat)e
This file is part of CLIXON. This file is part of CLIXON.
@ -31,6 +33,8 @@
***** END LICENSE BLOCK ***** ***** END LICENSE BLOCK *****
* *
* This code uses WITH_RESTCONF_FCGI to identify its run with fcgi intreface for ca_auth
* This should be changed.
*/ */
#include <stdlib.h> #include <stdlib.h>
@ -39,13 +43,13 @@
#include <errno.h> #include <errno.h>
#include <ctype.h> #include <ctype.h>
#include <signal.h> #include <signal.h>
#include <fcgiapp.h>
/* cligen */ /* cligen */
#include <cligen/cligen.h> #include <cligen/cligen.h>
/* clicon */ /* clicon */
#include <clixon/clixon.h> #include <clixon/clixon.h>
#include <clixon/clixon_restconf.h> /* minor use */
static const char Base64[] = static const char Base64[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
@ -197,23 +201,22 @@ example_restconf_credentials(clicon_handle h,
void *arg) void *arg)
{ {
int retval = -1; int retval = -1;
FCGX_Request *r = (FCGX_Request *)arg;
cxobj *xt = NULL; cxobj *xt = NULL;
char *auth;
char *user = NULL; char *user = NULL;
cbuf *cb = NULL;
char *auth;
char *passwd; char *passwd;
char *passwd2 = ""; char *passwd2 = "";
size_t authlen; size_t authlen;
cbuf *cb = NULL;
int ret; int ret;
/* HTTP basic authentication not enabled, pass with user "none" */ /* HTTP basic authentication not enabled, pass with user "none" */
if (basic_auth==0) if (basic_auth==0)
goto ok; goto ok;
/* At this point in the code we must use HTTP basic authentication */ /* At this point in the code we must use HTTP basic authentication */
if ((auth = FCGX_GetParam("HTTP_AUTHORIZATION", r->envp)) == NULL) if ((auth = clixon_restconf_param_get(h, "HTTP_AUTHORIZATION")) == NULL)
goto fail; goto fail;
if (strlen(auth) < strlen("Basic ")) if (strlen(auth) < strlen("Basic "))
goto fail; goto fail;
if (strncmp("Basic ", auth, strlen("Basic "))) if (strncmp("Basic ", auth, strlen("Basic ")))
goto fail; goto fail;

9
lib/clixon/clixon_data.h
View file

@ -2,7 +2,9 @@
* *
***** BEGIN LICENSE BLOCK ***** ***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand and Benny Holmgren Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
Copyright (C) 2017-2019 Olof Hagsand
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate)
This file is part of CLIXON. This file is part of CLIXON.
@ -35,6 +37,7 @@
* Access functions for clixon data. * Access functions for clixon data.
* Free-typed values for runtime getting and setting. * Free-typed values for runtime getting and setting.
* Accessed with clicon_data(h). * Accessed with clicon_data(h).
* @see clixon_option.[ch] for clixon options
*/ */
#ifndef _CLIXON_DATA_H_ #ifndef _CLIXON_DATA_H_
@ -52,6 +55,10 @@ typedef struct {
/* /*
* Prototypes * Prototypes
*/ */
int clicon_data_get(clicon_handle h, char *id, char **val);
int clicon_data_set(clicon_handle h, char *id, char *val);
int clicon_data_del(clicon_handle h, char *name);
yang_stmt * clicon_dbspec_yang(clicon_handle h); yang_stmt * clicon_dbspec_yang(clicon_handle h);
int clicon_dbspec_yang_set(clicon_handle h, yang_stmt *ys); int clicon_dbspec_yang_set(clicon_handle h, yang_stmt *ys);

20
lib/clixon/clixon_event.h
View file

@ -2,7 +2,9 @@
* *
***** BEGIN LICENSE BLOCK ***** ***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand and Benny Holmgren Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
Copyright (C) 2017-2019 Olof Hagsand
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate)
This file is part of CLIXON. This file is part of CLIXON.
@ -47,19 +49,19 @@ int clicon_exit_reset(void);
int clicon_exit_get(void); int clicon_exit_get(void);
int event_reg_fd(int fd, int (*fn)(int, void*), void *arg, char *str); int clixon_event_reg_fd(int fd, int (*fn)(int, void*), void *arg, char *str);
int event_unreg_fd(int s, int (*fn)(int, void*)); int clixon_event_unreg_fd(int s, int (*fn)(int, void*));
int event_reg_timeout(struct timeval t, int (*fn)(int, void*), int clixon_event_reg_timeout(struct timeval t, int (*fn)(int, void*),
void *arg, char *str); void *arg, char *str);
int event_unreg_timeout(int (*fn)(int, void*), void *arg); int clixon_event_unreg_timeout(int (*fn)(int, void*), void *arg);
int event_poll(int fd); int clixon_event_poll(int fd);
int event_loop(void); int clixon_event_loop(void);
int event_exit(void); int clixon_event_exit(void);
#endif /* _CLIXON_EVENT_H_ */ #endif /* _CLIXON_EVENT_H_ */

6
lib/clixon/clixon_options.h
View file

@ -33,8 +33,10 @@
***** END LICENSE BLOCK ***** ***** END LICENSE BLOCK *****
* * This file contains access functions for two types of clixon vars:
* Configuration file and Options. * - options, ie string based variables from Clixon configuration files.
* Accessed with clicon_options(h).
* @see clixon_data.[ch] for free-type runtime get/set *
*/ */
#ifndef _CLIXON_OPTIONS_H_ #ifndef _CLIXON_OPTIONS_H_

1
lib/clixon/clixon_string.h
View file

@ -89,6 +89,7 @@ static inline char * strdup4(char *str)
*/ */
char **clicon_strsep(char *string, char *delim, int *nvec0); char **clicon_strsep(char *string, char *delim, int *nvec0);
char *clicon_strjoin (int argc, char **argv, char *delim); char *clicon_strjoin (int argc, char **argv, char *delim);
int clixon_strsplit(char *nodeid, const int delim, char **prefix, char **id);
int str2cvec(char *string, char delim1, char delim2, cvec **cvp); int str2cvec(char *string, char delim1, char delim2, cvec **cvp);
#if defined(__GNUC__) && __GNUC__ >= 3 #if defined(__GNUC__) && __GNUC__ >= 3
int uri_percent_encode(char **encp, char *fmt, ...) __attribute__ ((format (printf, 2, 3))); int uri_percent_encode(char **encp, char *fmt, ...) __attribute__ ((format (printf, 2, 3)));

68
lib/src/clixon_data.c
View file

@ -2,7 +2,9 @@
* *
***** BEGIN LICENSE BLOCK ***** ***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand and Benny Holmgren Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
Copyright (C) 2017-2019 Olof Hagsand
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate)
This file is part of CLIXON. This file is part of CLIXON.
@ -35,6 +37,7 @@
* Access functions for clixon data. * Access functions for clixon data.
* Free-typed values for runtime getting and setting. * Free-typed values for runtime getting and setting.
* Accessed with clicon_data(h). * Accessed with clicon_data(h).
* @see clixon_option.[ch] for clixon options
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "clixon_config.h" /* generated by config & autoconf */ #include "clixon_config.h" /* generated by config & autoconf */
@ -75,8 +78,66 @@
#include "clixon_xpath.h" #include "clixon_xpath.h"
#include "clixon_data.h" #include "clixon_data.h"
/*! Get YANG specification for application specs /*! Get generic clixon data on the form <name>=<val> where <val> is string
* Must use hash functions directly since they are not strings. * @param[in] h Clicon handle
* @param[in] name Data name
* @param[out] val Data value as string
* @retval 0 OK
* @retval -1 Not found
* @see clicon_option_str
*/
int
clicon_data_get(clicon_handle h,
char *name,
char **val)
{
clicon_hash_t *cdat = clicon_data(h);
if (val == NULL){
clicon_err(OE_CFG, EINVAL, "%s val is NULL", __FUNCTION__);
return -1;
}
if (clicon_hash_lookup(cdat, (char*)name) == NULL)
return -1;
*val = clicon_hash_value(cdat, (char*)name, NULL);
return 0;
}
/*! Set generic clixon data on the form <name>=<val> where <val> is string
* @param[in] h Clicon handle
* @param[in] name Data name
* @param[in] val Data value as null-terminated string
* @retval 0 OK
* @retval -1 Error
* @see clicon_option_str_set
*/
int
clicon_data_set(clicon_handle h,
char *name,
char *val)
{
clicon_hash_t *cdat = clicon_data(h);
return clicon_hash_add(cdat, (char*)name, val, strlen(val)+1)==NULL?-1:0;
}
/*! Delete generic clixon data
* @param[in] h Clicon handle
* @param[in] name Data name
* @retval 0 OK
* @retval -1 Error
* @see clicon_option_del
*/
int
clicon_data_del(clicon_handle h,
char *name)
{
clicon_hash_t *cdat = clicon_data(h);
return clicon_hash_del(cdat, (char*)name);
}
/*!
* @param[in] h Clicon handle * @param[in] h Clicon handle
* @retval yspec Yang spec * @retval yspec Yang spec
* @see clicon_config_yang for the configuration yang * @see clicon_config_yang for the configuration yang
@ -655,3 +716,4 @@ clicon_session_id_set(clicon_handle h,
clicon_hash_add(cdat, "session-id", &id, sizeof(uint32_t)); clicon_hash_add(cdat, "session-id", &id, sizeof(uint32_t));
return 0; return 0;
} }

58
lib/src/clixon_event.c
View file

@ -2,7 +2,9 @@
* *
***** BEGIN LICENSE BLOCK ***** ***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand and Benny Holmgren Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
Copyright (C) 2017-2019 Olof Hagsand
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgat)e
This file is part of CLIXON. This file is part of CLIXON.
@ -80,7 +82,7 @@ struct event_data{
static struct event_data *ee = NULL; static struct event_data *ee = NULL;
static struct event_data *ee_timers = NULL; static struct event_data *ee_timers = NULL;
/* Set if element in ee is deleted (event_unreg_fd). Check in ee loops */ /* Set if element in ee is deleted (clixon_event_unreg_fd). Check in ee loops */
static int _ee_unreg = 0; static int _ee_unreg = 0;
static int _clicon_exit = 0; static int _clicon_exit = 0;
@ -123,14 +125,14 @@ clicon_exit_get(void)
* @code * @code
* int fn(int fd, void *arg){ * int fn(int fd, void *arg){
* } * }
* event_reg_fd(fd, fn, (void*)42, "call fn on input on fd"); * clixon_event_reg_fd(fd, fn, (void*)42, "call fn on input on fd");
* @endcode * @endcode
*/ */
int int
event_reg_fd(int fd, clixon_event_reg_fd(int fd,
int (*fn)(int, void*), int (*fn)(int, void*),
void *arg, void *arg,
char *str) char *str)
{ {
struct event_data *e; struct event_data *e;
@ -154,12 +156,12 @@ event_reg_fd(int fd,
* @param[in] s File descriptor * @param[in] s File descriptor
* @param[in] fn Function to call when input available on fd * @param[in] fn Function to call when input available on fd
* Note: deregister when exactly function and socket match, not argument * Note: deregister when exactly function and socket match, not argument
* @see event_reg_fd * @see clixon_event_reg_fd
* @see event_unreg_timeout * @see clixon_event_unreg_timeout
*/ */
int int
event_unreg_fd(int s, clixon_event_unreg_fd(int s,
int (*fn)(int, void*)) int (*fn)(int, void*))
{ {
struct event_data *e, **e_prev; struct event_data *e, **e_prev;
int found = 0; int found = 0;
@ -189,7 +191,7 @@ event_unreg_fd(int s,
* gettimeofday(&t, NULL); * gettimeofday(&t, NULL);
* t1.tv_sec = 1; t1.tv_usec = 0; * t1.tv_sec = 1; t1.tv_usec = 0;
* timeradd(&t, &t1, &t); * timeradd(&t, &t1, &t);
* event_reg_timeout(t, fn, NULL, "call every second"); * clixon_event_reg_timeout(t, fn, NULL, "call every second");
* } * }
* @endcode * @endcode
* *
@ -198,14 +200,14 @@ event_unreg_fd(int s,
* registration for each period, see example above. * registration for each period, see example above.
* Note also that the first argument to fn is a dummy, just to get the same * Note also that the first argument to fn is a dummy, just to get the same
* signatute as for file-descriptor callbacks. * signatute as for file-descriptor callbacks.
* @see event_reg_fd * @see clixon_event_reg_fd
* @see event_unreg_timeout * @see clixon_event_unreg_timeout
*/ */
int int
event_reg_timeout(struct timeval t, clixon_event_reg_timeout(struct timeval t,
int (*fn)(int, void*), int (*fn)(int, void*),
void *arg, void *arg,
char *str) char *str)
{ {
struct event_data *e, *e1, **e_prev; struct event_data *e, *e1, **e_prev;
@ -228,22 +230,22 @@ event_reg_timeout(struct timeval t,
} }
e->e_next = e1; e->e_next = e1;
*e_prev = e; *e_prev = e;
clicon_debug(2, "event_reg_timeout: %s", str); clicon_debug(2, "%s: %s", __FUNCTION__, str);
return 0; return 0;
} }
/*! Deregister a timeout callback as previosly registered by event_reg_timeout() /*! Deregister a timeout callback as previosly registered by clixon_event_reg_timeout()
* Note: deregister when exactly function and function arguments match, not time. So you * Note: deregister when exactly function and function arguments match, not time. So you
* cannot have same function and argument callback on different timeouts. This is a little * cannot have same function and argument callback on different timeouts. This is a little
* different from event_unreg_fd. * different from clixon_event_unreg_fd.
* @param[in] fn Function to call at time t * @param[in] fn Function to call at time t
* @param[in] arg Argument to function fn * @param[in] arg Argument to function fn
* @see event_reg_timeout * @see clixon_event_reg_timeout
* @see event_unreg_fd * @see clixon_event_unreg_fd
*/ */
int int
event_unreg_timeout(int (*fn)(int, void*), clixon_event_unreg_timeout(int (*fn)(int, void*),
void *arg) void *arg)
{ {
struct event_data *e, **e_prev; struct event_data *e, **e_prev;
int found = 0; int found = 0;
@ -268,7 +270,7 @@ event_unreg_timeout(int (*fn)(int, void*),
* @retval 1 Something to read on fd * @retval 1 Something to read on fd
*/ */
int int
event_poll(int fd) clixon_event_poll(int fd)
{ {
int retval = -1; int retval = -1;
fd_set fdset; fd_set fdset;
@ -288,7 +290,7 @@ event_poll(int fd)
* @retval -1 Error: eg select, callback, timer, * @retval -1 Error: eg select, callback, timer,
*/ */
int int
event_loop(void) clixon_event_loop(void)
{ {
struct event_data *e; struct event_data *e;
struct event_data *e_next; struct event_data *e_next;
@ -363,7 +365,7 @@ event_loop(void)
} }
int int
event_exit(void) clixon_event_exit(void)
{ {
struct event_data *e, *e_next; struct event_data *e, *e_next;

4
lib/src/clixon_options.c
View file

@ -37,9 +37,7 @@
* This file contains access functions for two types of clixon vars: * This file contains access functions for two types of clixon vars:
* - options, ie string based variables from Clixon configuration files. * - options, ie string based variables from Clixon configuration files.
* Accessed with clicon_options(h). * Accessed with clicon_options(h).
* - data. Free-typed values for runtime getting and setting. * @see clixon_data.[ch] for free-type runtime get/set
* Accessed with clicon_data(h).
* Consider splitting?
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "clixon_config.h" /* generated by config & autoconf */ #include "clixon_config.h" /* generated by config & autoconf */

6
lib/src/clixon_stream.c
View file

@ -230,7 +230,7 @@ stream_get_xml(clicon_handle h,
/*! Check all stream subscription stop timers, set up new timer /*! Check all stream subscription stop timers, set up new timer
* @param[in] fd No-op * @param[in] fd No-op
* @param[in] arg Clicon handle * @param[in] arg Clicon handle
* @note format is given by event_reg_timeout callback function (fd not needed) * @note format is given by clixon_event_reg_timeout callback function (fd not needed)
*/ */
int int
stream_timer_setup(int fd, stream_timer_setup(int fd,
@ -295,7 +295,7 @@ stream_timer_setup(int fd,
} }
/* Initiate new timer */ /* Initiate new timer */
timeradd(&now, &t1, &t); timeradd(&now, &t1, &t);
if (event_reg_timeout(t, if (clixon_event_reg_timeout(t,
stream_timer_setup, /* this function */ stream_timer_setup, /* this function */
h, /* clicon handle */ h, /* clicon handle */
"stream timer setup") < 0) "stream timer setup") < 0)
@ -841,7 +841,7 @@ stream_replay_trigger(clicon_handle h,
ra->ra_fn = fn; ra->ra_fn = fn;
ra->ra_arg = arg; ra->ra_arg = arg;
gettimeofday(&now, NULL); gettimeofday(&now, NULL);
if (event_reg_timeout(now, stream_replay_cb, ra, if (clixon_event_reg_timeout(now, stream_replay_cb, ra,
"create-subscribtion stream replay") < 0) "create-subscribtion stream replay") < 0)
goto done; goto done;
retval = 0; retval = 0;

81
lib/src/clixon_string.c
View file

@ -148,6 +148,59 @@ clicon_strjoin(int argc,
return str; return str;
} }
/*! Split a string once into two parts: prefix and suffix
* @param[in] string
* @param[in] delim
* @param[out] prefix If non-NULL, return malloced string, or NULL.
* @param[out] suffix If non-NULL, return malloced identifier.
* @retval 0 OK
* @retval -1 Error
* @code
* char *a = NULL;
* char *b = NULL;
* if (clixon_strsplit(nodeid, ':', &a, &b) < 0)
* goto done;
* if (a)
* free(a);
* if (b)
* free(b);
* @note caller need to free prefix and suffix after use
* @see clicon_strsep not just single split
*/
int
clixon_strsplit(char *string,
const int delim,
char **prefix,
char **suffix)
{
int retval = -1;
char *str;
if ((str = strchr(string, delim)) == NULL){
if (suffix && (*suffix = strdup(string)) == NULL){
clicon_err(OE_YANG, errno, "strdup");
goto done;
}
}
else {
if (prefix){
if ((*prefix = strdup(string)) == NULL){
clicon_err(OE_YANG, errno, "strdup");
goto done;
}
(*prefix)[str-string] = '\0';
}
str++;
if (suffix && (*suffix = strdup(str)) == NULL){
clicon_err(OE_YANG, errno, "strdup");
goto done;
}
}
retval = 0;
done:
return retval;
}
static int static int
uri_unreserved(unsigned char in) uri_unreserved(unsigned char in)
{ {
@ -676,6 +729,7 @@ clicon_str2int_search(const map_str2int *mstab,
return -1; /* not found */ return -1; /* not found */
} }
/*! Split colon-separated node identifier into prefix and name /*! Split colon-separated node identifier into prefix and name
* @param[in] node-id * @param[in] node-id
* @param[out] prefix If non-NULL, return malloced string, or NULL. * @param[out] prefix If non-NULL, return malloced string, or NULL.
@ -698,32 +752,7 @@ nodeid_split(char *nodeid,
char **prefix, char **prefix,
char **id) char **id)
{ {
int retval = -1; return clixon_strsplit(nodeid, ':', prefix, id);
char *str;
if ((str = strchr(nodeid, ':')) == NULL){
if (id && (*id = strdup(nodeid)) == NULL){
clicon_err(OE_YANG, errno, "strdup");
goto done;
}
}
else {
if (prefix){
if ((*prefix = strdup(nodeid)) == NULL){
clicon_err(OE_YANG, errno, "strdup");
goto done;
}
(*prefix)[str-nodeid] = '\0';
}
str++;
if (id && (*id = strdup(str)) == NULL){
clicon_err(OE_YANG, errno, "strdup");
goto done;
}
}
retval = 0;
done:
return retval;
} }
/*! Trim blanks from front and end of a string, return new string /*! Trim blanks from front and end of a string, return new string

13
test/lib.sh
View file

@ -87,6 +87,15 @@ else
: ${RCWAIT:=2} : ${RCWAIT:=2}
fi fi
# RESTCONF protocol, eg http or https
: ${RCPROTO:=http}
# RESTCONF port
: ${RCPORT:=80}
# RESTCONF error message (if not up)
: ${RCERROR:="HTTP/1.1 502 Bad Gateway"}
# www user (on linux typically www-data, freebsd www) # www user (on linux typically www-data, freebsd www)
# could be taken from configure # could be taken from configure
: ${wwwuser:=www-data} : ${wwwuser:=www-data}
@ -238,9 +247,9 @@ stop_restconf(){
# Wait for restconf to stop sending 502 Bad Gateway # Wait for restconf to stop sending 502 Bad Gateway
wait_restconf(){ wait_restconf(){
hdr=$(curl --head -sS http://localhost/restconf) hdr=$(curl --head -sS $RCPROTO://localhost:$RCPORT/restconf)
let i=0; let i=0;
while [[ $hdr == "HTTP/1.1 502 Bad Gateway"* ]]; do while [[ $hdr == "$RCERROR"* ]]; do
sleep 1 sleep 1
hdr=$(curl --head -sS http://localhost/restconf) hdr=$(curl --head -sS http://localhost/restconf)
let i++; let i++;

4
util/clixon_util_grpc.c
View file

@ -539,9 +539,9 @@ main(int argc,
clicon_err(OE_XML, errno, "nghttp2_session_send"); clicon_err(OE_XML, errno, "nghttp2_session_send");
goto done; goto done;
} }
if (event_reg_fd(ss, ssl_input_cb, sd, "ssl socket") < 0) if (clixon_event_reg_fd(ss, ssl_input_cb, sd, "ssl socket") < 0)
goto done; goto done;
if (event_loop() < 0) if (clixon_event_loop() < 0)
goto done; goto done;
retval = 0; retval = 0;
done: done:

4
util/clixon_util_ssl.c
View file

@ -531,9 +531,9 @@ main(int argc,
clicon_err(OE_XML, errno, "nghttp2_session_send"); clicon_err(OE_XML, errno, "nghttp2_session_send");
goto done; goto done;
} }
if (event_reg_fd(ss, ssl_input_cb, sd, "ssl socket") < 0) if (clixon_event_reg_fd(ss, ssl_input_cb, sd, "ssl socket") < 0)
goto done; goto done;
if (event_loop() < 0) if (clixon_event_loop() < 0)
goto done; goto done;
retval = 0; retval = 0;
done: done: