509 lines
16 KiB
C
509 lines
16 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 *****
|
|
*
|
|
* The example have the following optional arguments that you can pass as
|
|
* argc/argv after -- in clixon_cli:
|
|
* -m <yang> Mount this yang on mountpoint
|
|
* -M <namespace> Namespace of mountpoint, note both -m and -M must exist
|
|
* Note module-set hard-coded to "mylabel"
|
|
*/
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
#include <syslog.h>
|
|
#include <unistd.h>
|
|
#include <signal.h>
|
|
#include <pwd.h>
|
|
#include <sys/types.h>
|
|
#include <sys/stat.h>
|
|
#include <sys/time.h>
|
|
#include <sys/param.h>
|
|
#include <netinet/in.h>
|
|
|
|
/* clixon */
|
|
#include <cligen/cligen.h>
|
|
#include <clixon/clixon.h>
|
|
#include <clixon/clixon_cli.h>
|
|
#include <clixon/cli_generate.h>
|
|
|
|
/*! Error/log message callback
|
|
*
|
|
* Start cli with -- -e
|
|
* make errmsg/logmsg callback
|
|
*/
|
|
static errmsg_t *_errmsg_callback_fn = NULL;
|
|
|
|
/*! Yang schema mount
|
|
*
|
|
* Start cli with -- -m <yang> -M <namespace>
|
|
* Mount this yang on mountpoint
|
|
*/
|
|
static char *_mount_yang = NULL;
|
|
static char *_mount_namespace = NULL;
|
|
|
|
#ifndef CLIXON_STATIC_PLUGINS
|
|
static clixon_plugin_api api;
|
|
#endif
|
|
|
|
/*! Example cli function
|
|
*/
|
|
int
|
|
mycallback(clixon_handle h,
|
|
cvec *cvv,
|
|
cvec *argv)
|
|
{
|
|
int retval = -1;
|
|
cxobj *xret = NULL;
|
|
cg_var *myvar;
|
|
cvec *nsc = NULL;
|
|
|
|
/* Access cligen callback variables */
|
|
myvar = cvec_find(cvv, "var"); /* get a cligen variable from vector */
|
|
fprintf(stderr, "%s: %d\n", __FUNCTION__, cv_int32_get(myvar)); /* get int value */
|
|
fprintf(stderr, "arg = %s\n", cv_string_get(cvec_i(argv,0))); /* get string value */
|
|
|
|
if ((nsc = xml_nsctx_init(NULL, "urn:example:clixon")) == NULL)
|
|
goto done;
|
|
/* Show eth0 interfaces config using XPath */
|
|
if (clicon_rpc_get_config(h, NULL, "running",
|
|
"/interfaces/interface[name='eth0']",
|
|
nsc, NULL,
|
|
&xret) < 0)
|
|
goto done;
|
|
if (clixon_xml2file(stdout, xret, 0, 1, NULL, cligen_output, 0, 1) < 0)
|
|
goto done;
|
|
retval = 0;
|
|
done:
|
|
if (nsc)
|
|
xml_nsctx_free(nsc);
|
|
if (xret)
|
|
xml_free(xret);
|
|
return retval;
|
|
}
|
|
|
|
/*! Start bash from cli callback
|
|
*
|
|
* Typical usage: shell("System Bash") <source:rest>, cli_start_shell();
|
|
* @param[in] h Clixon handle
|
|
* @param[in] cvv Vector of command variables
|
|
* @param[in] argv [<shell>], defaults to "sh"
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
* @note Code potentially unsafe
|
|
*/
|
|
int
|
|
cli_start_shell(clixon_handle h,
|
|
cvec *cvv,
|
|
cvec *argv)
|
|
{
|
|
int retval = -1;
|
|
char *cmd;
|
|
char *shcmd = "sh";
|
|
struct passwd *pw;
|
|
char bcmd[128];
|
|
cg_var *cv1 = cvec_i(cvv, 1);
|
|
sigset_t oldsigset;
|
|
struct sigaction oldsigaction[32] = {{{0,},},};
|
|
|
|
if (cvec_len(argv) > 1){
|
|
clixon_err(OE_PLUGIN, EINVAL, "Received %d arguments. Expected: [<shell>]",
|
|
cvec_len(argv));
|
|
goto done;
|
|
}
|
|
if (cvec_len(argv) == 1){
|
|
shcmd = cv_string_get(cvec_i(argv, 0));
|
|
}
|
|
cmd = (cvec_len(cvv)>1 ? cv_string_get(cv1) : NULL);
|
|
if ((pw = getpwuid(getuid())) == NULL){
|
|
clixon_err(OE_UNIX, errno, "getpwuid");
|
|
goto done;
|
|
}
|
|
if (chdir(pw->pw_dir) < 0){
|
|
clixon_err(OE_UNIX, errno, "chdir");
|
|
endpwent();
|
|
goto done;
|
|
}
|
|
endpwent();
|
|
|
|
if (clixon_signal_save(&oldsigset, oldsigaction) < 0)
|
|
goto done;
|
|
cli_signal_flush(h);
|
|
cli_signal_unblock(h);
|
|
if (cmd){
|
|
snprintf(bcmd, 128, "%s -c \"%s\"", shcmd, cmd);
|
|
if (system(bcmd) < 0){
|
|
cli_signal_block(h);
|
|
clixon_err(OE_UNIX, errno, "system(bash -c)");
|
|
goto done;
|
|
}
|
|
}
|
|
else{
|
|
snprintf(bcmd, 128, "%s ", shcmd); /* -l (login shell) but is applicable to bash only */
|
|
if (system(bcmd) < 0){
|
|
cli_signal_block(h);
|
|
clixon_err(OE_UNIX, errno, "system(bash)");
|
|
goto done;
|
|
}
|
|
}
|
|
cli_signal_block(h);
|
|
#if 0 /* Allow errcodes from bash */
|
|
if (retval != 0){
|
|
clixon_err(OE_UNIX, errno, "system(%s) %d", cmd, retval);
|
|
goto done;
|
|
}
|
|
#endif
|
|
if (clixon_signal_restore(&oldsigset, oldsigaction) < 0)
|
|
goto done;
|
|
retval = 0;
|
|
done:
|
|
return retval;
|
|
}
|
|
|
|
/*! Example "downcall", ie initiate an RPC to the backend
|
|
*/
|
|
int
|
|
example_client_rpc(clixon_handle h,
|
|
cvec *cvv,
|
|
cvec *argv)
|
|
{
|
|
int retval = -1;
|
|
cg_var *cva;
|
|
cxobj *xtop = NULL;
|
|
cxobj *xrpc;
|
|
cxobj *xret = NULL;
|
|
cxobj *xerr;
|
|
|
|
/* User supplied variable in CLI command */
|
|
cva = cvec_find(cvv, "a"); /* get a cligen variable from vector */
|
|
/* Create XML for example netconf RPC */
|
|
if (clixon_xml_parse_va(YB_NONE, NULL, &xtop, NULL,
|
|
"<rpc xmlns=\"%s\" username=\"%s\" %s>"
|
|
"<example xmlns=\"urn:example:clixon\"><x>%s</x></example></rpc>",
|
|
NETCONF_BASE_NAMESPACE,
|
|
clicon_username_get(h),
|
|
NETCONF_MESSAGE_ID_ATTR,
|
|
cv_string_get(cva)) < 0)
|
|
goto done;
|
|
/* Skip top-level */
|
|
xrpc = xml_child_i(xtop, 0);
|
|
/* Send to backend */
|
|
if (clicon_rpc_netconf_xml(h, xrpc, &xret, NULL) < 0)
|
|
goto done;
|
|
if ((xerr = xpath_first(xret, NULL, "//rpc-error")) != NULL){
|
|
clixon_err_netconf(h, OE_NETCONF, 0, xerr, "Get configuration");
|
|
goto done;
|
|
}
|
|
/* Print result */
|
|
if (clixon_xml2file(stdout, xml_child_i(xret, 0), 0, 0, NULL, cligen_output, 0, 1) < 0)
|
|
goto done;
|
|
fprintf(stdout,"\n");
|
|
|
|
/* pretty-print:
|
|
clixon_text2file(stdout, xml_child_i(xret, 0), 0, cligen_output, 0);
|
|
*/
|
|
retval = 0;
|
|
done:
|
|
if (xret)
|
|
xml_free(xret);
|
|
if (xtop)
|
|
xml_free(xtop);
|
|
return retval;
|
|
}
|
|
|
|
/*! Translate function from an original value to a new.
|
|
*
|
|
* In this case, assume string and increment characters, eg HAL->IBM
|
|
* @param[in] h Clixon handle
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
*/
|
|
int
|
|
cli_incstr(cligen_handle h,
|
|
cg_var *cv)
|
|
{
|
|
char *str;
|
|
int i;
|
|
|
|
/* Filter out other than strings
|
|
* this is specific to this example, one can do translation */
|
|
if (cv == NULL || cv_type_get(cv) != CGV_STRING)
|
|
return 0;
|
|
if ((str = cv_string_get(cv)) == NULL){
|
|
clixon_err(OE_PLUGIN, EINVAL, "cv string is NULL");
|
|
return -1;
|
|
}
|
|
for (i=0; i<strlen(str); i++)
|
|
str[i]++;
|
|
return 0;
|
|
}
|
|
|
|
/*! Example YANG schema mount
|
|
*
|
|
* Given an XML mount-point xt, return XML yang-lib modules-set
|
|
* @param[in] h Clixon handle
|
|
* @param[in] xt XML mount-point in XML tree
|
|
* @param[out] config If '0' all data nodes in the mounted schema are read-only
|
|
* @param[out] validate Do or dont do full RFC 7950 validation
|
|
* @param[out] yanglib XML yang-lib module-set tree
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
* XXX hardcoded to clixon-example@2022-11-01.yang regardless of xt
|
|
* @see RFC 8528
|
|
*/
|
|
int
|
|
example_cli_yang_mount(clixon_handle h,
|
|
cxobj *xt,
|
|
int *config,
|
|
validate_level *vl,
|
|
cxobj **yanglib)
|
|
{
|
|
int retval = -1;
|
|
cbuf *cb = NULL;
|
|
|
|
if (config)
|
|
*config = 1;
|
|
if (vl)
|
|
*vl = VL_FULL;
|
|
if (yanglib && _mount_yang){
|
|
if ((cb = cbuf_new()) == NULL){
|
|
clixon_err(OE_UNIX, errno, "cbuf_new");
|
|
goto done;
|
|
}
|
|
cprintf(cb, "<yang-library xmlns=\"urn:ietf:params:xml:ns:yang:ietf-yang-library\">");
|
|
cprintf(cb, "<module-set>");
|
|
cprintf(cb, "<name>mylabel</name>");
|
|
cprintf(cb, "<module>");
|
|
/* In yang name+namespace is mandatory, but not revision */
|
|
cprintf(cb, "<name>%s</name>", _mount_yang); // mandatory
|
|
cprintf(cb, "<namespace>%s</namespace>", _mount_namespace); // mandatory
|
|
// cprintf(cb, "<revision>2022-11-01</revision>");
|
|
cprintf(cb, "</module>");
|
|
cprintf(cb, "</module-set>");
|
|
cprintf(cb, "</yang-library>");
|
|
if (clixon_xml_parse_string(cbuf_get(cb), YB_NONE, NULL, yanglib, NULL) < 0)
|
|
goto done;
|
|
if (xml_rootchild(*yanglib, 0, yanglib) < 0)
|
|
goto done;
|
|
}
|
|
retval = 0;
|
|
done:
|
|
if (cb)
|
|
cbuf_free(cb);
|
|
return retval;
|
|
}
|
|
|
|
/*! Callback to customize log, error, or debug message
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @param[in] fn Inline function name (when called from clixon_err() macro)
|
|
* @param[in] line Inline file line number (when called from clixon_err() macro)
|
|
* @param[in] type Log message type
|
|
* @param[in,out] category Clixon error category, See enum clixon_err
|
|
* @param[in,out] suberr Error number, typically errno
|
|
* @param[in] xerr Netconf error xml tree on the form: <rpc-error>
|
|
* @param[in] format Format string
|
|
* @param[in] ap Variable argument list
|
|
* @param[out] cbmsg Log string as cbuf, if set bypass ordinary logging
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
* When cbmsg is set by a plugin, no other plugins are called. category and suberr
|
|
* can be rewritten by any plugin.
|
|
*/
|
|
int
|
|
myerrmsg(clixon_handle h,
|
|
const char *fn,
|
|
const int line,
|
|
enum clixon_log_type type,
|
|
int *category,
|
|
int *suberr,
|
|
cxobj *xerr,
|
|
const char *format,
|
|
va_list ap,
|
|
cbuf **cbmsg)
|
|
{
|
|
int retval = -1;
|
|
cbuf *cb = NULL;
|
|
|
|
if ((cb = cbuf_new()) == NULL){
|
|
fprintf(stderr, "cbuf_new: %s\n", strerror(errno)); /* dont use clixon_err here due to recursion */
|
|
goto done;
|
|
}
|
|
// XXX Number of args in ap (eg %:s) must be known
|
|
// vcprintf(cb, "My new err-string %s : %s", ap);
|
|
cprintf(cb, "My new err-string");
|
|
if (category)
|
|
*category = -1;
|
|
if (suberr)
|
|
*suberr = 0;
|
|
*cbmsg = cb;
|
|
retval = 0;
|
|
done:
|
|
return retval;
|
|
}
|
|
|
|
/*! Example cli function which redirects customized error to myerrmsg above
|
|
*/
|
|
int
|
|
myerror(clixon_handle h,
|
|
cvec *cvv,
|
|
cvec *argv)
|
|
{
|
|
int retval = -1;
|
|
cxobj *xret = NULL;
|
|
errmsg_t *oldfn = NULL;
|
|
|
|
_errmsg_callback_fn = myerrmsg;
|
|
#ifdef DYNAMICLINKAGE
|
|
/* This does not link statically */
|
|
if (cli_remove(h, cvv, argv) < 0)
|
|
goto done;
|
|
#endif
|
|
retval = 0;
|
|
#ifdef DYNAMICLINKAGE
|
|
done:
|
|
#endif
|
|
_errmsg_callback_fn = oldfn;
|
|
if (xret)
|
|
xml_free(xret);
|
|
return retval;
|
|
}
|
|
|
|
/*! Callback to customize log, error, or debug message
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @param[in] fn Inline function name (when called from clixon_err() macro)
|
|
* @param[in] line Inline file line number (when called from clixon_err() macro)
|
|
* @param[in] type Log message type
|
|
* @param[in,out] category Clixon error category, See enum clixon_err
|
|
* @param[in,out] suberr Error number, typically errno
|
|
* @param[in] xerr Netconf error xml tree on the form: <rpc-error>
|
|
* @param[in] format Format string
|
|
* @param[in] ap Variable argument list
|
|
* @param[out] cbmsg Log string as cbuf, if set bypass ordinary logging
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
* When cbmsg is set by a plugin, no other plugins are called. category and suberr
|
|
* can be rewritten by any plugin.
|
|
*/
|
|
int
|
|
example_cli_errmsg(clixon_handle h,
|
|
const char *fn,
|
|
const int line,
|
|
enum clixon_log_type type,
|
|
int *category,
|
|
int *suberr,
|
|
cxobj *xerr,
|
|
const char *format,
|
|
va_list ap,
|
|
cbuf **cbmsg)
|
|
{
|
|
if (_errmsg_callback_fn != NULL){
|
|
return (_errmsg_callback_fn)(h, fn, line, type, category, suberr, xerr, format, ap, cbmsg);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/*! Callback for printing version output and exit
|
|
*
|
|
* A plugin can customize a version (or banner) output on stdout.
|
|
* Several version strings can be printed if there are multiple callbacks.
|
|
* If no registered plugins exist, clixon prints CLIXON_VERSION
|
|
* Typically invoked by command-line option -V
|
|
* @param[in] h Clixon handle
|
|
* @param[in] f Output file
|
|
* @retval 0 OK
|
|
* @retval -1 Error
|
|
*/
|
|
int
|
|
example_version(clixon_handle h,
|
|
FILE *f)
|
|
{
|
|
cligen_output(f, "Clixon main example version 0\n");
|
|
return 0;
|
|
}
|
|
|
|
#ifndef CLIXON_STATIC_PLUGINS
|
|
static clixon_plugin_api api = {
|
|
"example", /* name */
|
|
clixon_plugin_init, /* init */
|
|
NULL, /* start */
|
|
NULL, /* exit */
|
|
.ca_yang_mount= example_cli_yang_mount, /* RFC 8528 schema mount */
|
|
.ca_errmsg = example_cli_errmsg, /* customize log, error, debug message */
|
|
.ca_version = example_version /* Customized version string */
|
|
};
|
|
|
|
/*! CLI plugin initialization
|
|
*
|
|
* @param[in] h Clixon handle
|
|
* @retval NULL Error
|
|
* @retval api Pointer to API struct
|
|
*/
|
|
clixon_plugin_api *
|
|
clixon_plugin_init(clixon_handle h)
|
|
{
|
|
struct timeval tv;
|
|
int c;
|
|
int argc; /* command-line options (after --) */
|
|
char **argv;
|
|
|
|
gettimeofday(&tv, NULL);
|
|
srandom(tv.tv_usec);
|
|
/* Get user command-line options (after --) */
|
|
if (clicon_argv_get(h, &argc, &argv) < 0)
|
|
goto done;
|
|
opterr = 0;
|
|
optind = 1;
|
|
while ((c = getopt(argc, argv, "m:M:")) != -1)
|
|
switch (c) {
|
|
case 'm':
|
|
_mount_yang = optarg;
|
|
break;
|
|
case 'M':
|
|
_mount_namespace = optarg;
|
|
break;
|
|
}
|
|
if ((_mount_yang && !_mount_namespace) || (!_mount_yang && _mount_namespace)){
|
|
clixon_err(OE_PLUGIN, EINVAL, "Both -m and -M must be given for mounts");
|
|
goto done;
|
|
}
|
|
/* XXX Not implemented: CLI completion for mountpoints, see clixon-controller
|
|
*/
|
|
return &api;
|
|
done:
|
|
return NULL;
|
|
}
|
|
#endif /* CLIXON_STATIC_PLUGINS */
|