1091 lines
36 KiB
C
1091 lines
36 KiB
C
/*
|
|
*
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren
|
|
Copyright (C) 2017-2019 Olof Hagsand
|
|
Copyright (C) 2020-2022 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 *****
|
|
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "clixon_config.h" /* generated by config & autoconf */
|
|
#endif
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <unistd.h>
|
|
#include <stdarg.h>
|
|
#include <errno.h>
|
|
#include <signal.h>
|
|
#include <fcntl.h>
|
|
#include <time.h>
|
|
#include <syslog.h>
|
|
#include <ifaddrs.h>
|
|
#include <sys/wait.h>
|
|
#include <sys/time.h>
|
|
#include <sys/socket.h>
|
|
#include <sys/stat.h>
|
|
#include <sys/param.h>
|
|
#include <sys/types.h>
|
|
#include <grp.h>
|
|
#include <netinet/in.h>
|
|
#include <arpa/inet.h>
|
|
#include <netinet/in.h>
|
|
#include <libgen.h>
|
|
|
|
/* cligen */
|
|
#include <cligen/cligen.h>
|
|
|
|
/* clicon */
|
|
#include <clixon/clixon.h>
|
|
|
|
#include "clixon_backend_transaction.h"
|
|
#include "backend_socket.h"
|
|
#include "clixon_backend_client.h"
|
|
#include "backend_client.h"
|
|
#include "clixon_backend_plugin.h"
|
|
#include "clixon_backend_commit.h"
|
|
#include "backend_handle.h"
|
|
#include "backend_startup.h"
|
|
#include "backend_plugin_restconf.h"
|
|
|
|
/* Command line options to be passed to getopt(3) */
|
|
#define BACKEND_OPTS "hD:f:E:l:d:p:b:Fza:u:P:1qs:c:U:g:y:o:"
|
|
|
|
#define BACKEND_LOGFILE "/usr/local/var/clixon_backend.log"
|
|
|
|
/*! Clean and close all state of backend (but dont exit).
|
|
* Cannot use h after this
|
|
* @param[in] h Clixon handle
|
|
*/
|
|
static int
|
|
backend_terminate(clicon_handle h)
|
|
{
|
|
yang_stmt *yspec;
|
|
char *pidfile = clicon_backend_pidfile(h);
|
|
int sockfamily = clicon_sock_family(h);
|
|
char *sockpath = clicon_sock_str(h);
|
|
cxobj *x;
|
|
struct stat st;
|
|
int ss;
|
|
cvec *nsctx;
|
|
|
|
clicon_debug(1, "%s", __FUNCTION__);
|
|
if ((ss = clicon_socket_get(h)) != -1)
|
|
close(ss);
|
|
/* Disconnect datastore */
|
|
xmldb_disconnect(h);
|
|
/* Clear module state caches */
|
|
if ((x = clicon_modst_cache_get(h, 0)) != NULL)
|
|
xml_free(x);
|
|
if ((x = clicon_modst_cache_get(h, 1)) != NULL)
|
|
xml_free(x);
|
|
/* Free changelog */
|
|
if ((x = clicon_xml_changelog_get(h)) != NULL)
|
|
xml_free(x);
|
|
if ((yspec = clicon_dbspec_yang(h)) != NULL){
|
|
ys_free(yspec);
|
|
}
|
|
if ((yspec = clicon_config_yang(h)) != NULL)
|
|
ys_free(yspec);
|
|
if ((yspec = clicon_nacm_ext_yang(h)) != NULL)
|
|
ys_free(yspec);
|
|
if ((nsctx = clicon_nsctx_global_get(h)) != NULL)
|
|
cvec_free(nsctx);
|
|
clicon_data_cvec_del(h, "netconf-statistics");
|
|
if ((x = clicon_nacm_ext(h)) != NULL)
|
|
xml_free(x);
|
|
if ((x = clicon_conf_xml(h)) != NULL)
|
|
xml_free(x);
|
|
confirmed_commit_free(h);
|
|
stream_publish_exit();
|
|
/* Delete all plugins, RPC callbacks, and upgrade callbacks */
|
|
clixon_plugin_module_exit(h);
|
|
/* Delete all process-control entries */
|
|
clixon_process_delete_all(h);
|
|
|
|
xpath_optimize_exit();
|
|
clixon_pagination_free(h);
|
|
|
|
if (pidfile)
|
|
unlink(pidfile);
|
|
if (sockfamily==AF_UNIX && lstat(sockpath, &st) == 0)
|
|
unlink(sockpath);
|
|
backend_handle_exit(h); /* Also deletes streams. Cannot use h after this. */
|
|
clixon_event_exit();
|
|
clicon_debug(1, "%s done", __FUNCTION__);
|
|
clixon_err_exit();
|
|
clicon_log_exit();
|
|
return 0;
|
|
}
|
|
|
|
/*! Unlink pidfile and quit
|
|
*/
|
|
static void
|
|
backend_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);
|
|
clixon_exit_set(1); /* checked in clixon_event_loop() */
|
|
}
|
|
|
|
/*! wait for killed child
|
|
* primary use in case restconf daemon forked using process-control API
|
|
* This may cause EINTR in eg select() in clixon_event_loop() which will be ignored
|
|
*/
|
|
static void
|
|
backend_sig_child(int arg)
|
|
{
|
|
clicon_debug(1, "%s", __FUNCTION__);
|
|
clicon_sig_child_set(1);
|
|
}
|
|
|
|
/*! Create backend server socket and register callback
|
|
* @param[in] h Clicon handle
|
|
* @retval s Server socket file descriptor (see socket(2))
|
|
* @retval -1 Error
|
|
*/
|
|
static int
|
|
backend_server_socket(clicon_handle h)
|
|
{
|
|
int ss;
|
|
|
|
/* Open control socket */
|
|
if ((ss = backend_socket_init(h)) < 0)
|
|
return -1;
|
|
/* ss is a server socket that the clients connect to. The callback
|
|
therefore accepts clients on ss */
|
|
if (clixon_event_reg_fd(ss, backend_accept_client, h, "server socket") < 0) {
|
|
close(ss);
|
|
return -1;
|
|
}
|
|
return ss;
|
|
}
|
|
|
|
/*! Load external NACM file
|
|
*/
|
|
static int
|
|
nacm_load_external(clicon_handle h)
|
|
{
|
|
int retval = -1;
|
|
char *filename; /* NACM config file */
|
|
yang_stmt *yspec = NULL;
|
|
cxobj *xt = NULL;
|
|
struct stat st;
|
|
FILE *f = NULL;
|
|
|
|
filename = clicon_option_str(h, "CLICON_NACM_FILE");
|
|
if (filename == NULL || strlen(filename)==0){
|
|
clicon_err(OE_UNIX, errno, "CLICON_NACM_FILE not set in NACM external mode");
|
|
goto done;
|
|
}
|
|
if (stat(filename, &st) < 0){
|
|
clicon_err(OE_UNIX, errno, "%s", filename);
|
|
goto done;
|
|
}
|
|
if (!S_ISREG(st.st_mode)){
|
|
clicon_err(OE_UNIX, 0, "%s is not a regular file", filename);
|
|
goto done;
|
|
}
|
|
if ((f = fopen(filename, "r")) == NULL) {
|
|
clicon_err(OE_UNIX, errno, "configure file: %s", filename);
|
|
return -1;
|
|
}
|
|
if ((yspec = yspec_new()) == NULL)
|
|
goto done;
|
|
if (yang_spec_parse_module(h, "ietf-netconf-acm", NULL, yspec) < 0)
|
|
goto done;
|
|
/* Read configfile */
|
|
if (clixon_xml_parse_file(f, YB_MODULE, yspec, &xt, NULL) < 0)
|
|
goto done;
|
|
if (xt == NULL){
|
|
clicon_err(OE_XML, 0, "No xml tree in %s", filename);
|
|
goto done;
|
|
}
|
|
if (clicon_nacm_ext_yang_set(h, yspec) < 0)
|
|
goto done;
|
|
if (clicon_nacm_ext_set(h, xt) < 0)
|
|
goto done;
|
|
|
|
retval = 0;
|
|
done:
|
|
if (f)
|
|
fclose(f);
|
|
return retval;
|
|
}
|
|
|
|
static int
|
|
xmldb_drop_priv(clicon_handle h,
|
|
const char *db,
|
|
uid_t uid,
|
|
gid_t gid)
|
|
{
|
|
int retval = -1;
|
|
char *filename = NULL;
|
|
|
|
if (xmldb_db2file(h, db, &filename) < 0)
|
|
goto done;
|
|
if (chown(filename, uid, gid) < 0){
|
|
clicon_err(OE_UNIX, errno, "chown");
|
|
goto done;
|
|
}
|
|
retval = 0;
|
|
done:
|
|
if (filename)
|
|
free(filename);
|
|
return retval;
|
|
}
|
|
|
|
/*! Drop root privileges uid and gid to Clixon user/group and
|
|
*
|
|
* If config options are right, drop process uid/guid privileges and change some
|
|
* file ownerships.
|
|
* "Right" means:
|
|
* - uid is currently 0 (started as root)
|
|
* - CLICON_BACKEND_USER is set
|
|
* - CLICON_BACKEND_PRIVILEGES is not "none"
|
|
* @param[in] h Clicon handle
|
|
* @param[in] gid Group id (assume already known)
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
*/
|
|
static int
|
|
check_drop_priv(clicon_handle h,
|
|
gid_t gid,
|
|
yang_stmt *yspec)
|
|
{
|
|
int retval = -1;
|
|
uid_t uid;
|
|
uid_t newuid = -1;
|
|
enum priv_mode_t priv_mode = PM_NONE;
|
|
char *backend_user = NULL;
|
|
|
|
/* Get privileges mode (for dropping privileges) */
|
|
if ((priv_mode = clicon_backend_privileges_mode(h)) == PM_NONE)
|
|
goto ok;
|
|
|
|
/* From here, drop privileges */
|
|
/* Check backend user exists */
|
|
if ((backend_user = clicon_backend_user(h)) == NULL){
|
|
clicon_err(OE_DAEMON, EPERM, "Privileges cannot be dropped without specifying CLICON_BACKEND_USER\n");
|
|
goto done;
|
|
}
|
|
/* Get (wanted) new backend user id */
|
|
if (name2uid(backend_user, &newuid) < 0){
|
|
clicon_err(OE_DAEMON, errno, "'%s' is not a valid user .\n", backend_user);
|
|
goto done;
|
|
}
|
|
/* get current backend userid, if already at this level OK */
|
|
if ((uid = getuid()) == newuid)
|
|
goto ok;
|
|
if (uid != 0){
|
|
clicon_err(OE_DAEMON, EPERM, "Privileges can only be dropped from root user (uid is %u)\n", uid);
|
|
goto done;
|
|
}
|
|
/* When dropping privileges, datastores are created if they do not exist.
|
|
* But when drops are not made, datastores are created on demand.
|
|
* XXX: move the creation to top-level so they are always created at init?
|
|
*/
|
|
if (xmldb_exists(h, "running") != 1)
|
|
if (xmldb_create(h, "running") < 0)
|
|
goto done;
|
|
if (xmldb_drop_priv(h, "running", newuid, gid) < 0)
|
|
goto done;
|
|
if (xmldb_exists(h, "candidate") != 1)
|
|
if (xmldb_create(h, "candidate") < 0)
|
|
goto done;
|
|
if (xmldb_drop_priv(h, "candidate", newuid, gid) < 0)
|
|
goto done;
|
|
if (if_feature(yspec, "ietf-netconf", "startup")) {
|
|
if (xmldb_exists(h, "startup") != 1)
|
|
if (xmldb_create(h, "startup") < 0)
|
|
goto done;
|
|
if (xmldb_drop_priv(h, "startup", newuid, gid) < 0)
|
|
goto done;
|
|
}
|
|
if (if_feature(yspec, "ietf-netconf", "confirmed-commit")) {
|
|
if (xmldb_exists(h, "rollback") != 1)
|
|
if (xmldb_create(h, "rollback") < 0)
|
|
goto done;
|
|
if (xmldb_drop_priv(h, "rollback", newuid, gid) < 0)
|
|
goto done;
|
|
}
|
|
if (setgid(gid) == -1) {
|
|
clicon_err(OE_DAEMON, errno, "setgid %d", gid);
|
|
goto done;
|
|
}
|
|
switch (priv_mode){
|
|
case PM_DROP_PERM:
|
|
if (drop_priv_perm(newuid) < 0)
|
|
goto done;
|
|
/* Verify you cannot regain root privileges */
|
|
if (setuid(0) != -1){
|
|
clicon_err(OE_DAEMON, EPERM, "Could regain root privilieges");
|
|
goto done;
|
|
}
|
|
break;
|
|
case PM_DROP_TEMP:
|
|
if (drop_priv_temp(newuid) < 0)
|
|
goto done;
|
|
break;
|
|
case PM_NONE:
|
|
break; /* catched above */
|
|
}
|
|
ok:
|
|
retval = 0;
|
|
done:
|
|
return retval;
|
|
}
|
|
|
|
/*! Given a retval, transform to status or fatal error
|
|
*
|
|
* @param[in] ret Return value from xml validation function
|
|
* @param[out] status Transform status according to rules below
|
|
* @retval 0 OK, status set
|
|
* @retval -1 Fatal error outside scope of startup_status
|
|
* Transformation rules:
|
|
* 1) retval -1 assume clicon_errno/suberrno set. Special case from xml parser
|
|
* is clicon_suberrno = XMLPARSE_ERRNO which assumes an XML (non-fatal) parse
|
|
* error which translates to -> STARTUP_ERR
|
|
* All other error cases translates to fatal error
|
|
* 2) retval 0 is xml validation fails -> STARTUP_INVALID
|
|
* 3) retval 1 is OK -> STARTUP_OK
|
|
* 4) any other retval translates to fatal error
|
|
*/
|
|
static int
|
|
ret2status(int ret,
|
|
enum startup_status *status)
|
|
{
|
|
int retval = -1;
|
|
|
|
switch (ret){
|
|
case -1:
|
|
if (clicon_suberrno != XMLPARSE_ERRNO)
|
|
goto done;
|
|
clicon_err_reset();
|
|
*status = STARTUP_ERR;
|
|
break;
|
|
case 0:
|
|
*status = STARTUP_INVALID;
|
|
break;
|
|
case 1:
|
|
*status = STARTUP_OK;
|
|
break;
|
|
default:
|
|
clicon_err(OE_CFG, EINVAL, "No such retval %d", retval);
|
|
} /* switch */
|
|
retval = 0;
|
|
done:
|
|
return retval;
|
|
}
|
|
|
|
#if 0 /* DEBUG */
|
|
/* Debug timer */
|
|
int
|
|
backend_timer_setup(int fd,
|
|
void *arg)
|
|
{
|
|
int retval = -1;
|
|
clicon_handle h = (clicon_handle)arg;
|
|
struct timeval now;
|
|
struct timeval t;
|
|
struct timeval t1 = {10, 0};
|
|
|
|
clicon_debug(1, "%s", __FUNCTION__);
|
|
gettimeofday(&now, NULL);
|
|
|
|
backend_client_print(h, stderr);
|
|
xmldb_print(h, stderr);
|
|
fprintf(stderr, "\n");
|
|
|
|
/* Initiate new timer */
|
|
timeradd(&now, &t1, &t);
|
|
if (clixon_event_reg_timeout(t,
|
|
backend_timer_setup, /* this function */
|
|
h, /* clicon handle */
|
|
"backend timer setup") < 0)
|
|
goto done;
|
|
retval = 0;
|
|
done:
|
|
return retval;
|
|
}
|
|
#endif /* DEBUG */
|
|
|
|
/*! usage
|
|
*/
|
|
static void
|
|
usage(clicon_handle h,
|
|
char *argv0)
|
|
{
|
|
char *plgdir = clicon_backend_dir(h);
|
|
char *confsock = clicon_sock_str(h);
|
|
char *confpid = clicon_backend_pidfile(h);
|
|
char *group = clicon_sock_group(h);
|
|
|
|
fprintf(stderr, "usage:%s <options>*\n"
|
|
"where options are\n"
|
|
"\t-h\t\tHelp\n"
|
|
"\t-D <level>\tDebug level\n"
|
|
"\t-f <file>\tClixon config file\n"
|
|
"\t-E <dir> \tExtra configuration file directory\n"
|
|
"\t-l <s|e|o|n|f<file>> \tLog on (s)yslog, std(e)rr, std(o)ut, (n)one or (f)ile (syslog is default)\n"
|
|
"\t-d <dir>\tSpecify backend plugin directory (default: %s)\n"
|
|
"\t-p <dir>\tAdd Yang directory path (see CLICON_YANG_DIR)\n"
|
|
"\t-b <dir>\tSpecify datastore directory\n"
|
|
"\t-F\t\tRun in foreground, do not run as daemon\n"
|
|
"\t-z\t\tKill other backend daemon and exit\n"
|
|
"\t-a UNIX|IPv4|IPv6 Internal backend socket family\n"
|
|
"\t-u <path|addr>\tInternal socket domain path or IP addr (see -a)(default: %s)\n"
|
|
"\t-P <file>\tPid filename (default: %s)\n"
|
|
"\t-1\t\tRun once and then quit (dont wait for events)\n"
|
|
"\t-s <mode>\tSpecify backend startup mode: none|startup|running|init)\n"
|
|
"\t-c <file>\tLoad extra XML configuration file, but do not commit.\n"
|
|
"\t-q \t\tQuit startup directly after upgrading and print result on stdout\n"
|
|
"\t-U <user>\tRun backend daemon as this user AND drop privileges permanently\n"
|
|
"\t-g <group>\tClient membership required to this group (default: %s)\n"
|
|
|
|
"\t-y <file>\tLoad yang spec file (override yang main module)\n"
|
|
"\t-o \"<option>=<value>\"\tGive configuration option overriding config file (see clixon-config.yang)\n",
|
|
argv0,
|
|
plgdir ? plgdir : "none",
|
|
confsock ? confsock : "none",
|
|
confpid ? confpid : "none",
|
|
group ? group : "none"
|
|
);
|
|
exit(-1);
|
|
}
|
|
|
|
int
|
|
main(int argc,
|
|
char **argv)
|
|
{
|
|
int retval = -1;
|
|
int c;
|
|
int zap;
|
|
int foreground;
|
|
int once;
|
|
enum startup_mode_t startup_mode;
|
|
char *extraxml_file;
|
|
char *backend_group = NULL;
|
|
char *argv0 = argv[0];
|
|
struct stat st;
|
|
clicon_handle h;
|
|
int help = 0;
|
|
int pid;
|
|
char *pidfile;
|
|
char *sock;
|
|
int sockfamily;
|
|
char *nacm_mode;
|
|
int logdst = CLICON_LOG_SYSLOG|CLICON_LOG_STDERR;
|
|
yang_stmt *yspec = NULL;
|
|
char *str;
|
|
int ss = -1; /* server socket */
|
|
cbuf *cbret = NULL; /* startup cbuf if invalid */
|
|
enum startup_status status = STARTUP_ERR; /* Startup status */
|
|
int ret;
|
|
char *dir;
|
|
gid_t gid = -1;
|
|
cvec *nsctx_global = NULL; /* Global namespace context */
|
|
size_t cligen_buflen;
|
|
size_t cligen_bufthreshold;
|
|
int dbg;
|
|
size_t sz;
|
|
|
|
/* In the startup, logs to stderr & syslog and debug flag set later */
|
|
clicon_log_init(__PROGRAM__, LOG_INFO, logdst);
|
|
/* Initiate CLICON handle */
|
|
if ((h = backend_handle_init()) == NULL)
|
|
return -1;
|
|
foreground = 0;
|
|
once = 0;
|
|
zap = 0;
|
|
extraxml_file = NULL;
|
|
dbg = 0;
|
|
|
|
/*
|
|
* Command-line options for help, debug, and config-file
|
|
*/
|
|
opterr = 0;
|
|
optind = 1;
|
|
while ((c = getopt(argc, argv, BACKEND_OPTS)) != -1)
|
|
switch (c) {
|
|
case 'h':
|
|
/* Defer the call to usage() to later. Reason is that for helpful
|
|
text messages, default dirs, etc, are not set until later.
|
|
But this measn that we need to check if 'help' is set before
|
|
exiting, and then call usage() before exit.
|
|
*/
|
|
help = 1;
|
|
break;
|
|
case 'D' : /* debug */
|
|
if (sscanf(optarg, "%d", &dbg) != 1)
|
|
usage(h, argv[0]);
|
|
break;
|
|
case 'f': /* config file */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
clicon_option_str_set(h, "CLICON_CONFIGFILE", optarg);
|
|
break;
|
|
case 'E': /* extra config directory */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
clicon_option_str_set(h, "CLICON_CONFIGDIR", 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;
|
|
}
|
|
/*
|
|
* Here we have the debug flag settings, use that.
|
|
* Syslogs also to stderr, but later turn stderr off in daemon mode.
|
|
* error only to syslog. debug to syslog
|
|
* XXX: if started in a start-daemon script, there will be irritating
|
|
* double syslogs until fork below.
|
|
*/
|
|
clicon_log_init(__PROGRAM__, dbg?LOG_DEBUG:LOG_INFO, logdst);
|
|
clicon_debug_init(dbg, NULL);
|
|
yang_init(h);
|
|
|
|
/* Find and read configfile */
|
|
if (clicon_options_main(h) < 0){
|
|
if (help)
|
|
usage(h, argv[0]);
|
|
goto done;
|
|
}
|
|
|
|
/* Initialize plugin module by creating a handle holding plugin and callback lists */
|
|
if (clixon_plugin_module_init(h) < 0)
|
|
goto done;
|
|
|
|
/* Now run through the operational args */
|
|
opterr = 1;
|
|
optind = 1;
|
|
while ((c = getopt(argc, argv, BACKEND_OPTS)) != -1)
|
|
switch (c) {
|
|
case 'h' : /* help */
|
|
case 'D' : /* debug */
|
|
case 'f': /* config file */
|
|
case 'E': /* extra config dir */
|
|
case 'l' :
|
|
break; /* see above */
|
|
case 'd': /* Plugin directory */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
if (clicon_option_add(h, "CLICON_BACKEND_DIR", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case 'b': /* XMLDB database directory */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
if (clicon_option_add(h, "CLICON_XMLDB_DIR", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case 'p' : /* Add yang dir path */
|
|
if (clicon_option_add(h, "CLICON_YANG_DIR", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case 'F' : /* foreground */
|
|
foreground = 1;
|
|
break;
|
|
case 'z': /* Zap other process */
|
|
zap++;
|
|
break;
|
|
case 'a': /* internal backend socket address family */
|
|
if (clicon_option_add(h, "CLICON_SOCK_FAMILY", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case 'u': /* config unix domain path / ip address */
|
|
if (!strlen(optarg))
|
|
usage(h, argv[0]);
|
|
if (clicon_option_add(h, "CLICON_SOCK", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case 'P': /* pidfile */
|
|
if (clicon_option_add(h, "CLICON_BACKEND_PIDFILE", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case '1' : /* Quit after reading database once - dont wait for events */
|
|
once = 1;
|
|
break;
|
|
case 'q': /* Quit directly after startup upgrading and print result on stdout */
|
|
if (clicon_quit_upgrade_set(h, 1) < 0)
|
|
goto done;
|
|
break;
|
|
case 's' : /* startup mode */
|
|
if (clicon_option_add(h, "CLICON_STARTUP_MODE", optarg) < 0)
|
|
goto done;
|
|
if (clicon_startup_mode(h) < 0){
|
|
fprintf(stderr, "Invalid startup mode: %s\n", optarg);
|
|
usage(h, argv[0]);
|
|
}
|
|
break;
|
|
case 'c': /* Load application config */
|
|
extraxml_file = optarg;
|
|
break;
|
|
case 'U': /* config user (for socket and drop privileges) */
|
|
if (clicon_username_set(h, optarg) < 0)
|
|
goto done;
|
|
if (clicon_option_add(h, "CLICON_BACKEND_PRIVILEGES", "drop_permanent") < 0)
|
|
goto done;
|
|
break;
|
|
case 'g': /* config socket group */
|
|
if (clicon_option_add(h, "CLICON_SOCK_GROUP", optarg) < 0)
|
|
goto done;
|
|
break;
|
|
case 'y' : /* Load yang absolute filename */
|
|
if (clicon_option_add(h, "CLICON_YANG_MAIN_FILE", optarg) < 0)
|
|
goto done;
|
|
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;
|
|
}
|
|
default:
|
|
usage(h, argv[0]);
|
|
break;
|
|
}
|
|
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
/* Access the remaining argv/argc options (after --) w clicon-argv_get() */
|
|
clicon_argv_set(h, argv0, argc, argv);
|
|
|
|
clicon_log_init(__PROGRAM__, dbg?LOG_DEBUG:LOG_INFO, logdst);
|
|
|
|
/* Defer: Wait to the last minute to print help message */
|
|
if (help)
|
|
usage(h, argv[0]);
|
|
|
|
/* 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);
|
|
|
|
if ((sz = clicon_option_int(h, "CLICON_LOG_STRING_LIMIT")) != 0)
|
|
clicon_log_string_limit_set(sz);
|
|
|
|
#ifndef HAVE_LIBXML2
|
|
if (clicon_yang_regexp(h) == REGEXP_LIBXML2){
|
|
clicon_err(OE_FATAL, 0, "CLICON_YANG_REGEXP set to libxml2, but HAVE_LIBXML2 not set (Either change CLICON_YANG_REGEXP to posix, or run: configure --with-libxml2))");
|
|
goto done;
|
|
}
|
|
#endif
|
|
/* Check pid-file, if zap kil the old daemon, else return here */
|
|
if ((pidfile = clicon_backend_pidfile(h)) == NULL){
|
|
clicon_err(OE_FATAL, 0, "pidfile not set");
|
|
goto done;
|
|
}
|
|
sockfamily = clicon_sock_family(h);
|
|
if ((sock = clicon_sock_str(h)) == NULL){
|
|
clicon_err(OE_FATAL, 0, "sock not set");
|
|
goto done;
|
|
}
|
|
if (pidfile_get(pidfile, &pid) < 0)
|
|
return -1;
|
|
if (zap){
|
|
if (pid && pidfile_zapold(pid) < 0)
|
|
return -1;
|
|
if (lstat(pidfile, &st) == 0)
|
|
unlink(pidfile);
|
|
if (sockfamily==AF_UNIX && lstat(sock, &st) == 0)
|
|
unlink(sock);
|
|
backend_terminate(h);
|
|
exit(0); /* OK */
|
|
}
|
|
else
|
|
if (pid){
|
|
clicon_err(OE_DAEMON, 0, "Daemon already running with pid %d\n(Try killing it with %s -z)",
|
|
pid, argv0);
|
|
return -1; /* goto done deletes pidfile */
|
|
}
|
|
|
|
/* After this point we can goto done on error
|
|
* Here there is either no old process or we have killed it,..
|
|
*/
|
|
if (lstat(pidfile, &st) == 0)
|
|
unlink(pidfile);
|
|
if (sockfamily==AF_UNIX && lstat(sock, &st) == 0)
|
|
unlink(sock);
|
|
|
|
/* Sanity check: backend group exists */
|
|
if ((backend_group = clicon_sock_group(h)) == NULL){
|
|
clicon_err(OE_FATAL, 0, "clicon_sock_group option not set");
|
|
return -1;
|
|
}
|
|
if (group_name2gid(backend_group, &gid) < 0){
|
|
clicon_log(LOG_ERR, "'%s' does not seem to be a valid user group.\n" /* \n required here due to multi-line log */
|
|
"The config daemon requires a valid group to create a server UNIX socket\n"
|
|
"Define a valid CLICON_SOCK_GROUP in %s or via the -g option\n"
|
|
"or create the group and add the user to it. Check documentation for how to do this on your platform",
|
|
backend_group,
|
|
clicon_configfile(h));
|
|
goto done;
|
|
}
|
|
/* Publish stream on pubsub channels.
|
|
* CLICON_STREAM_PUB should be set to URL to where streams are published
|
|
* and configure should be run with --enable-publish
|
|
*/
|
|
if (clicon_option_exists(h, "CLICON_STREAM_PUB") &&
|
|
stream_publish_init() < 0)
|
|
goto done;
|
|
/* Connect to plugin to get a handle */
|
|
if (xmldb_connect(h) < 0)
|
|
goto done;
|
|
|
|
/* Set default namespace according to CLICON_NAMESPACE_NETCONF_DEFAULT */
|
|
xml_nsctx_namespace_netconf_default(h);
|
|
|
|
/* 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;
|
|
|
|
/* In case ietf-yang-metadata is loaded by application, handle annotation extension */
|
|
if (yang_metadata_init(h) < 0)
|
|
goto done;
|
|
/* External NACM file?
|
|
* Note, loads yang -> extensions -> plugins
|
|
*/
|
|
nacm_mode = clicon_option_str(h, "CLICON_NACM_MODE");
|
|
if (nacm_mode && strcmp(nacm_mode, "external") == 0)
|
|
if (nacm_load_external(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);
|
|
|
|
/* Load backend plugins before yangs are loaded (eg extension callbacks) */
|
|
if ((dir = clicon_backend_dir(h)) != NULL &&
|
|
clixon_plugins_load(h, CLIXON_PLUGIN_INIT, dir,
|
|
clicon_option_str(h, "CLICON_BACKEND_REGEXP")) < 0)
|
|
goto done;
|
|
|
|
/* 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 (will not overwrite file loaded ^) */
|
|
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;
|
|
/* Add generic yang specs, used by netconf client and as internal protocol
|
|
*/
|
|
if (netconf_module_load(h) < 0)
|
|
goto done;
|
|
/* Load yang restconf module */
|
|
if (yang_spec_parse_module(h, "ietf-restconf", NULL, yspec)< 0)
|
|
goto done;
|
|
/* Load yang YANG module state */
|
|
if (clicon_option_bool(h, "CLICON_XMLDB_MODSTATE") &&
|
|
yang_spec_parse_module(h, "ietf-yang-library", NULL, yspec)< 0)
|
|
goto done;
|
|
/* Check restconf start/stop from backend */
|
|
if (clicon_option_bool(h, "CLICON_BACKEND_RESTCONF_PROCESS")){
|
|
if (backend_plugin_restconf_register(h, 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;
|
|
|
|
/* Initialize server socket and save it to handle */
|
|
if (backend_rpc_init(h) < 0)
|
|
goto done;
|
|
|
|
/* Must be after netconf_module_load, but before startup code */
|
|
if (clicon_option_bool(h, "CLICON_XML_CHANGELOG"))
|
|
if (clixon_xml_changelog_init(h) < 0)
|
|
goto done;
|
|
/* Init commit confirmed */
|
|
if (if_feature(yspec, "ietf-netconf", "confirmed-commit")) {
|
|
if (confirmed_commit_init(h) < 0)
|
|
goto done;
|
|
}
|
|
/* Save modules state of the backend (server). Compare with startup XML */
|
|
if (startup_module_state(h, yspec) < 0)
|
|
goto done;
|
|
/* Startup mode needs to be defined, */
|
|
startup_mode = clicon_startup_mode(h);
|
|
if ((int)startup_mode == -1){
|
|
clicon_log(LOG_ERR, "Startup mode undefined. Specify option CLICON_STARTUP_MODE or specify -s option to clicon_backend.");
|
|
goto done;
|
|
}
|
|
/* Check that netconf :startup is enabled */
|
|
if ((startup_mode == SM_STARTUP || startup_mode == SM_RUNNING_STARTUP) &&
|
|
!if_feature(yspec, "ietf-netconf", "startup")){
|
|
clicon_log(LOG_ERR, "Startup mode selected but Netconf :startup feature is not enabled. Enable with option: <CLICON_FEATURE>ietf-netconf:startup</CLICON_FEATURE>");
|
|
goto done;
|
|
}
|
|
|
|
/* Init running db if it is not there
|
|
* change running_startup -> running or startup depending on if running exists or not
|
|
*/
|
|
if (xmldb_exists(h, "running") != 1){
|
|
if (startup_mode == SM_RUNNING_STARTUP)
|
|
startup_mode = SM_STARTUP;
|
|
if (xmldb_create(h, "running") < 0)
|
|
return -1;
|
|
}
|
|
else
|
|
if (startup_mode == SM_RUNNING_STARTUP)
|
|
startup_mode = SM_RUNNING;
|
|
xmldb_delete(h, "candidate");
|
|
/* If startup fails, lib functions report invalidation info in a cbuf */
|
|
if ((cbret = cbuf_new()) == NULL){
|
|
clicon_err(OE_XML, errno, "cbuf_new");
|
|
goto done;
|
|
}
|
|
switch (startup_mode){
|
|
case SM_INIT: /* Scratch running and start from empty */
|
|
/* Delete any rollback database, if it exists */
|
|
xmldb_delete(h, "rollback");
|
|
/* [Delete and] create running db */
|
|
if (xmldb_db_reset(h, "running") < 0)
|
|
goto done;
|
|
/* FALLTHRU */
|
|
case SM_NONE: /* Load plugins and call plugin_init() */
|
|
if ((ret = startup_extraxml(h, NULL, cbret)) < 0)
|
|
goto done;
|
|
status = STARTUP_OK;
|
|
break;
|
|
case SM_RUNNING: /* Use running as startup */
|
|
/* Copy original running to tmp as backup (restore if error) */
|
|
if (xmldb_copy(h, "running", "tmp") < 0)
|
|
goto done;
|
|
ret = startup_mode_startup(h, "tmp", cbret);
|
|
/* If ret fails, copy tmp back to running */
|
|
if (ret != 1)
|
|
if (xmldb_copy(h, "tmp", "running") < 0)
|
|
goto done;
|
|
xmldb_delete(h, "tmp");
|
|
if (ret2status(ret, &status) < 0)
|
|
goto done;
|
|
break;
|
|
case SM_STARTUP:
|
|
/* Copy original running to tmp as backup (restore if error) */
|
|
if (xmldb_copy(h, "running", "tmp") < 0)
|
|
goto done;
|
|
/* Load and commit from startup */
|
|
ret = startup_mode_startup(h, "startup", cbret);
|
|
/* If ret fails, copy tmp back to running */
|
|
if (ret != 1)
|
|
if (xmldb_copy(h, "tmp", "running") < 0)
|
|
goto done;
|
|
/* clear startup dbcache */
|
|
xmldb_clear(h, "startup");
|
|
if (ret2status(ret, &status) < 0)
|
|
goto done;
|
|
/* if status = STARTUP_INVALID, cbret contains info */
|
|
break;
|
|
case SM_DUMP_XML:
|
|
/* dump the tree */
|
|
cxobj *xc = clicon_conf_xml(h);
|
|
ret = clixon_xml2file(stdout, xc, 0, 1, "", &fprintf, 0, 1);
|
|
goto ok;
|
|
default:
|
|
break;
|
|
}
|
|
/* Quit after upgrade catch-all, running/startup quits in upgrade code */
|
|
if (clicon_quit_upgrade_get(h) == 1)
|
|
goto done;
|
|
|
|
/*
|
|
* Disable unknown to anydata auto-creation after startup
|
|
*/
|
|
if (clicon_option_bool(h, "CLICON_YANG_UNKNOWN_ANYDATA") == 1){
|
|
clicon_option_bool_set(h, "CLICON_YANG_UNKNOWN_ANYDATA", 0);
|
|
xml_bind_yang_unknown_anydata(0);
|
|
}
|
|
/* Merge extra XML from file and reset function to running
|
|
*/
|
|
if (status == STARTUP_OK){
|
|
if (startup_mode == SM_NONE){
|
|
/* Special case for mode none: no commits are made therefore need to go through all processes
|
|
* registered in plugins (specifically the restconf pseudo plugin)
|
|
*/
|
|
if (clixon_process_start_all(h) < 0)
|
|
goto done;
|
|
}
|
|
else {
|
|
if ((ret = startup_extraxml(h, extraxml_file, cbret)) < 0)
|
|
goto done;
|
|
if (ret2status(ret, &status) < 0)
|
|
goto done;
|
|
/* if status = STARTUP_INVALID, cbret contains info */
|
|
}
|
|
}
|
|
|
|
if (status != STARTUP_OK){
|
|
if (cbuf_len(cbret))
|
|
clicon_log(LOG_NOTICE, "%s: %u %s", __PROGRAM__, getpid(), cbuf_get(cbret));
|
|
if (load_failsafe(h, "Startup") < 0){
|
|
goto done;
|
|
}
|
|
status = STARTUP_OK;
|
|
cbuf_reset(cbret); /* cbret contains error info */
|
|
}
|
|
|
|
/* Initiate the shared candidate. */
|
|
if (xmldb_copy(h, "running", "candidate") < 0)
|
|
goto done;
|
|
if (xmldb_modified_set(h, "candidate", 0) <0)
|
|
goto done;
|
|
|
|
/* Set startup status */
|
|
if (clicon_startup_status_set(h, status) < 0)
|
|
goto done;
|
|
|
|
if (status == STARTUP_INVALID && cbuf_len(cbret))
|
|
clicon_log(LOG_NOTICE, "%s: %u %s", __PROGRAM__, getpid(), cbuf_get(cbret));
|
|
|
|
/* Call backend plugin_start with user -- options */
|
|
if (clixon_plugin_start_all(h) < 0)
|
|
goto done;
|
|
/* -1 option to run only once */
|
|
if (once)
|
|
goto ok;
|
|
|
|
/* Daemonize and initiate logging. Note error is initiated here to make
|
|
daemonized errors OK. Before this stage, errors are logged on stderr
|
|
also */
|
|
if (foreground==0){
|
|
/* Call plugin callbacks just before fork/daemonization */
|
|
if (clixon_plugin_pre_daemon_all(h) < 0)
|
|
goto done;
|
|
clicon_log_init(__PROGRAM__, dbg?LOG_DEBUG:LOG_INFO,
|
|
logdst==CLICON_LOG_FILE?CLICON_LOG_FILE:CLICON_LOG_SYSLOG);
|
|
if (daemon(0, 0) < 0){
|
|
fprintf(stderr, "config: daemon");
|
|
exit(-1);
|
|
}
|
|
}
|
|
/* Call plugin callbacks when in background and before dropped privileges
|
|
* Possibly this should be within the foreground==0 clause after daemon?
|
|
*/
|
|
if (clixon_plugin_daemon_all(h) < 0)
|
|
goto done;
|
|
|
|
/* Write pid-file */
|
|
if (pidfile_write(pidfile) < 0)
|
|
goto done;
|
|
|
|
if (set_signal(SIGTERM, backend_sig_term, NULL) < 0){
|
|
clicon_err(OE_DAEMON, errno, "Setting signal");
|
|
goto done;
|
|
}
|
|
if (set_signal(SIGINT, backend_sig_term, NULL) < 0){
|
|
clicon_err(OE_DAEMON, errno, "Setting signal");
|
|
goto done;
|
|
}
|
|
/* This is in case restconf daemon forked using process-control API */
|
|
if (set_signal(SIGCHLD, backend_sig_child, NULL) < 0){
|
|
clicon_err(OE_DAEMON, errno, "Setting signal");
|
|
goto done;
|
|
}
|
|
/* Client exit in the middle of a transaction, handled in clicon_msg_send */
|
|
if (set_signal(SIGPIPE, SIG_IGN, NULL) < 0){
|
|
clicon_err(OE_DAEMON, errno, "Setting signal");
|
|
goto done;
|
|
}
|
|
/* Initialize server socket and save it to handle */
|
|
if ((ss = backend_server_socket(h)) < 0)
|
|
goto done;
|
|
if (clicon_socket_set(h, ss) < 0)
|
|
goto done;
|
|
clicon_option_dump(h, 1);
|
|
|
|
/* Depending on configure setting, privileges may be dropped here after
|
|
* initializations */
|
|
if (check_drop_priv(h, gid, yspec) < 0)
|
|
goto done;
|
|
|
|
/* Start session-id for clients */
|
|
clicon_session_id_set(h, 1);
|
|
#if 0 /* debug */
|
|
/* Enable this to get prints of datastore and session status */
|
|
if (0 && clicon_debug_get() &&
|
|
backend_timer_setup(0, h) < 0)
|
|
goto done;
|
|
#endif
|
|
if (stream_timer_setup(0, h) < 0)
|
|
goto done;
|
|
/* Just before event-loop, after socket bind/listen */
|
|
if (netconf_monitoring_statistics_init(h) < 0)
|
|
goto done;
|
|
clicon_log(LOG_NOTICE, "%s: %u Started", __PROGRAM__, getpid());
|
|
if (clixon_event_loop(h) < 0)
|
|
goto done;
|
|
ok:
|
|
retval = 0;
|
|
done:
|
|
if (cbret)
|
|
cbuf_free(cbret);
|
|
clicon_log(LOG_NOTICE, "%s: %u Terminated retval:%d", __PROGRAM__, getpid(), retval);
|
|
backend_terminate(h); /* Cannot use h after this */
|
|
|
|
return retval;
|
|
}
|