diff --git a/CHANGELOG.md b/CHANGELOG.md index 01b923ac6..655d2e8c1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -76,6 +76,7 @@ Developers may need to change their code ### Corrected Bugs +* Fixed: [NACM paths don't work for mounted YANG models](https://github.com/clicon/clixon-controller/issues/62) * Fixed: [cl:creator attribute must be persistent](https://github.com/clicon/clixon-controller/issues/54) * Fixed: [Does clixon cli support autocompletion for leafrefs pointed to another module?](https://github.com/clicon/clixon/issues/455) * Fixed: [commit diff sometimes includes namespace in output](https://github.com/clicon/clixon-controller/issues/44) diff --git a/lib/clixon/clixon_yang_schema_mount.h b/lib/clixon/clixon_yang_schema_mount.h index 1cd519627..df288fff1 100644 --- a/lib/clixon/clixon_yang_schema_mount.h +++ b/lib/clixon/clixon_yang_schema_mount.h @@ -59,6 +59,7 @@ int yang_mount_get(yang_stmt *yu, char *xpath, yang_stmt **yspec); int yang_mount_set(yang_stmt *yu, char *xpath, yang_stmt *yspec); int xml_yang_mount_get(clicon_handle h, cxobj *x, validate_level *vl, yang_stmt **yspec); int xml_yang_mount_set(clicon_handle h, cxobj *x, yang_stmt *yspec); +int yang_mount_get_yspec_any(yang_stmt *y, yang_stmt **yspec); int xml_yang_mount_freeall(cvec *cvv); int yang_schema_mount_statedata(clicon_handle h, yang_stmt *yspec, char *xpath, cvec *nsc, cxobj **xret, cxobj **xerr); int yang_schema_mount_statistics(clicon_handle h, cxobj *xt, int modules, cbuf *cb); diff --git a/lib/src/clixon_path.c b/lib/src/clixon_path.c index 8c6bcd2b8..eb86ec068 100644 --- a/lib/src/clixon_path.c +++ b/lib/src/clixon_path.c @@ -667,6 +667,7 @@ api_path2xpath_cvv(cvec *api_path, char *name = NULL; cvec *cvk = NULL; /* vector of index keys */ yang_stmt *y = NULL; + yang_stmt *y1; yang_stmt *ymod = NULL; char *val; cg_var *cvi; @@ -807,12 +808,11 @@ api_path2xpath_cvv(cvec *api_path, cprintf(xpath, "%s:", xprefix); cprintf(xpath, "%s", name); } - /* If x/y is mountpoint, pass mount yspec to children */ if ((ret = yang_schema_mount_point(y)) < 0) goto done; if (ret == 1){ - yang_stmt *y1 = NULL; + y1 = NULL; if (xml_nsctx_yangspec(yspec, &nsc) < 0) goto done; /* cf xml_bind_yang0_opt/xml_yang_mount_get */ @@ -976,6 +976,7 @@ api_path2xml_vec(char **vec, int vi; cxobj *x = NULL; yang_stmt *y = NULL; + yang_stmt *y1; yang_stmt *ymod; yang_stmt *ykey; char *namespace = NULL; @@ -1155,7 +1156,7 @@ api_path2xml_vec(char **vec, if ((ret = yang_schema_mount_point(y)) < 0) goto done; if (ret == 1){ - yang_stmt *y1 = NULL; + y1 = NULL; if (xml_nsctx_yangspec(ys_spec(y), &nsc) < 0) goto done; if (xml2xpath(x, nsc, 0, 1, &xpath) < 0) // XXX should be canonical @@ -1472,6 +1473,7 @@ api_path_resolve(clixon_path *cplist, /*! Resolve instance-id prefix:names to yang statements * * @param[in] cplist Lisp of clixon-path + * @param[in] path Instance-id path original * @param[in] yt Yang statement of top symbol (can be yang-spec if top-level) * @retval 1 OK * @retval 0 Fail error in xerr @@ -1499,7 +1501,8 @@ instance_id_resolve(clixon_path *cplist, cg_var *cva; yang_stmt *yspec; char *kname; - + int ret; + yspec = ys_spec(yt); if ((cp = cplist) != NULL){ do { @@ -1513,6 +1516,16 @@ instance_id_resolve(clixon_path *cplist, goto fail; } } + if ((ret = yang_schema_mount_point(yt)) < 0) + goto done; + if (ret == 1){ + if (yang_mount_get_yspec_any(yt, &yspec) == 1){ + if ((yt = yang_find_module_by_prefix_yspec(yspec, cp->cp_prefix)) == NULL){ + clicon_err(OE_YANG, ENOENT, "Prefix \"%s\" does not correspond to any existing module", cp->cp_prefix); + goto fail; + } + } + } if ((yc = yang_find_datanode(yt, cp->cp_id)) == NULL){ clicon_err(OE_YANG, ENOENT, "Node %s used in path has no corresponding yang node", cp->cp_id); diff --git a/lib/src/clixon_yang_schema_mount.c b/lib/src/clixon_yang_schema_mount.c index 7e8d7a68d..fc4a05f5e 100644 --- a/lib/src/clixon_yang_schema_mount.c +++ b/lib/src/clixon_yang_schema_mount.c @@ -150,8 +150,8 @@ yang_mount_get(yang_stmt *y, char *xpath, yang_stmt **yspec) { - cvec *cvv = NULL; - cg_var *cv; + cvec *cvv; + cg_var *cv; clicon_debug(CLIXON_DBG_DEFAULT, "%s %s %p", __FUNCTION__, xpath, y); /* Special value in yang unknown node for mount-points: mapping from xpath->mounted yspec */ @@ -328,6 +328,34 @@ xml_yang_mount_set(clicon_handle h, return retval; } +/*! Get any yspec of a mount-point, special function + * + * Get (the first) mounted yspec. + * A more generic way would be to call plugin_mount to get the yanglib and from that get the + * yspec. But there is clixon code that cant call the plugin since h is not available + * @param[in] y Yang container/list containing unknown node + * @param[out] yspec YANG stmt spec + * @retval 1 yspec found and set + * @retval 0 Not found + */ +int +yang_mount_get_yspec_any(yang_stmt *y, + yang_stmt **yspec) +{ + cvec *cvv; + cg_var *cv; + void *p; + + /* Special value in yang unknown node for mount-points: mapping from xpath->mounted yspec */ + if ((cvv = yang_cvec_get(y)) != NULL && + (cv = cvec_i(cvv, 0)) != NULL && + (p = cv_void_get(cv)) != NULL){ + *yspec = p; + return 1; + } + return 0; +} + /*! Free all yspec yang-mounts * * @param[in] cvv Cligen-variable vector containing xpath -> yspec mapping @@ -663,7 +691,7 @@ yang_schema_yanglib_parse_mount(clicon_handle h, goto done; } -/*! Check if XML nod is mount-point and return matching YANG child +/*! Check if XML node is mount-point and return matching YANG child * * @param[in] h Clixon handle * @param[in] x1 XML node diff --git a/test/test_nacm_mount.sh b/test/test_nacm_mount.sh new file mode 100755 index 000000000..b91fbf845 --- /dev/null +++ b/test/test_nacm_mount.sh @@ -0,0 +1,281 @@ +#!/usr/bin/env bash +# Test for RFC8528 YANG Schema Mount + NACM RFC 8341 +# clixon-example is top-level, mounts clixon-mount1 +# The example extends the main example using -- -m -M for both backend and cli +# Extensive testing of mounted augment/uses: see fyang0 which includes fyang1+fyang2 + +# Magic line must be first in script (see README.md) +s="$_" ; . ./lib.sh || if [ "$s" = $0 ]; then exit 0; else return 0; fi + +APPNAME=example + +cfg=$dir/nacm_mount.xml +clispec=$dir/automode.cli +fyang=$dir/clixon-example.yang +fyang0=$dir/clixon-mount0.yang + +# Common NACM scripts +. ./nacm.sh + +CFD=$dir/conf.d +test -d $CFD || mkdir -p $CFD + +RESTCONFIG=$(restconf_config user false) + +cat < $cfg + + $cfg + $CFD + ${YANG_INSTALLDIR} + ${dir} + $fyang + true + $dir + /usr/local/lib/$APPNAME/restconf + /usr/local/lib/$APPNAME/cli + $APPNAME + /usr/local/var/run/$APPNAME.sock + /usr/local/lib/$APPNAME/backend + /usr/local/var/run/$APPNAME.pidfile + $dir + true + true + true + true + internal + none + true + +EOF + +cat < $CFD/autocli.xml + + + false + kw-nokey + true + + include clixon + enable + clixon-* + + + +EOF + +cat < $CFD/restconf.xml + + $RESTCONFIG + +EOF + +cat < $fyang +module clixon-example{ + yang-version 1.1; + namespace "urn:example:clixon"; + prefix ex; + import ietf-yang-schema-mount { + prefix yangmnt; + } + import ietf-netconf-acm { + prefix nacm; + } + container top{ + list mylist{ + key name; + leaf name{ + type string; + } + container mnt { + presence "Otherwise root is not visible"; + yangmnt:mount-point "mylabel"{ + description "Root for other yang models"; + } + } + } + } +} +EOF + +cat < $fyang0 +module clixon-mount0{ + yang-version 1.1; + namespace "urn:example:mount0"; + prefix m0; + container mymount0{ + list mylist0{ + key name0; + leaf name0{ + type string; + } + } + list mylist1{ + key name1; + leaf name1{ + type string; + } + } + } +} +EOF + +cat < $clispec +CLICON_MODE="example"; +CLICON_PROMPT="%U@%H %W> "; +CLICON_PLUGIN="example_cli"; + +# Autocli syntax tree operations +set @datamodel, cli_auto_set(); +merge @datamodel, cli_auto_merge(); +create @datamodel, cli_auto_create(); +delete("Delete a configuration item") @datamodel, cli_auto_del(); +validate("Validate changes"), cli_validate(); +commit("Commit the changes"), cli_commit(); +quit("Quit"), cli_quit(); +show("Show a particular state of the system"){ + configuration("Show configuration"), cli_show_auto_mode("candidate", "xml", true, false);{ + xml("Show configuration as XML"), cli_show_auto_mode("candidate", "xml", false, false); + cli("Show configuration as CLI commands"), cli_show_auto_mode("candidate", "cli", false, false, "report-all", "set "); + netconf("Show configuration as netconf edit-config operation"), cli_show_auto_mode("candidate", "netconf", false, false); + text("Show configuration as text"), cli_show_auto_mode("candidate", "text", false, false); + json("Show configuration as JSON"), cli_show_auto_mode("candidate", "json", false, false); + } + state("Show configuration and state"), cli_show_auto_mode("running", "xml", false, true); +} +EOF + +# The groups are slightly modified from RFC8341 A.1 ($USER added in admin group) +# The rule-list is from A.4 +# Note read-default is set to permit to ensure that deny-nacm is meaningful +RULES=$(cat < + false + deny + deny + deny + + $NGROUPS + + $NADMIN + + + limited permit + limited + + permit get + + /ex:top/ex:mylist/ex:mnt/m0:mymount0/m0:mylist0 + + * + permit + + Allow the 'limited' group full access to mylist0. + + + + permit exec + * + exec + permit + + Allow invocation of the supported server operations. + + + + + +EOF +) +// /ex:top/ex:mylist/ex:mnt/m0:mymount0/m0:mylist0 + +new "test params: -f $cfg" + +if [ $BE -ne 0 ]; then + new "kill old backend" + sudo clixon_backend -zf $cfg + if [ $? -ne 0 ]; then + err + fi + new "start backend -s init -f $cfg -- -m clixon-mount0 -M urn:example:mount0" + start_backend -s init -f $cfg -- -m clixon-mount0 -M urn:example:mount0 +fi + +new "wait backend" +wait_backend + +if [ $RC -ne 0 ]; then + new "kill old restconf daemon" + stop_restconf_pre + + new "start restconf daemon" + start_restconf -f $cfg -- -m clixon-mount0 -M urn:example:mount0 +fi + +new "wait restconf" +wait_restconf + +new "Add mountpoint: x" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "x" "" "" + +new "netconf commit" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "" "" "" + +new "auth set authentication config" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "$RULES" "" "" + +new "Add data to mounts" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "xx0x1" "" "" + +new "Enable nacm" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "true" "" "" + +new "netconf commit" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "" "" "" + +new "get netconf data" +expecteof_netconf "$clixon_netconf -qf $cfg" 0 "$DEFAULTHELLO" "" "xx0x1" + +new "restconf admin read mnt ok" +expectpart "$(curl -u andy:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt)" 0 "HTTP/$HVER 200" 'x0x1mylabelclixon-mount0urn:example:mount0' + +new "restconf limit read mnt ok" +expectpart "$(curl -u wilma:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt)" 0 "HTTP/$HVER 200" 'x0' + +new "restconf guest read mnt access denied" +expectpart "$(curl -u guest:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt)" 0 "HTTP/$HVER 403" 'applicationaccess-deniederrordefault deny' + +new "restconf admin read mnt mylist0 expect ok" +expectpart "$(curl -u andy:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt/clixon-mount0:mymount0/mylist0=x0)" 0 "HTTP/$HVER 200" 'x0' + +new "restconf admin read mnt mylist1 expect ok" +expectpart "$(curl -u andy:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt/clixon-mount0:mymount0/mylist1=x1)" 0 "HTTP/$HVER 200" 'x1' + +new "restconf limit read mnt mylist0 expect ok" +expectpart "$(curl -u wilma:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt/clixon-mount0:mymount0/mylist0=x0)" 0 "HTTP/$HVER 200" 'x0' + +new "restconf limit read mnt mylist0 expect fail" +expectpart "$(curl -u wilma:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt/clixon-mount0:mymount0/mylist1=x1)" 0 "HTTP/$HVER 404" 'applicationinvalid-valueerrorInstance does not exist' + +new "restconf guest read mnt mylist0 expect access denied" +expectpart "$(curl -u guest:bar $CURLOPTS -X GET -H "Accept: application/yang-data+xml" $RCPROTO://localhost/restconf/data/clixon-example:top/mylist=x/mnt/clixon-mount0:mymount0/mylist1=x1)" 0 "HTTP/$HVER 403" 'applicationaccess-deniederrordefault deny' + +if [ $RC -ne 0 ]; then + new "Kill restconf daemon" + stop_restconf +fi + +if [ $BE -ne 0 ]; then + new "Kill backend" + # Check if premature kill + pid=$(pgrep -u root -f clixon_backend) + if [ -z "$pid" ]; then + err "backend already dead" + fi + # kill backend + stop_backend -f $cfg +fi + +rm -rf $dir + +new "endtest" +endtest