/* * ***** BEGIN LICENSE BLOCK ***** Copyright (C) 2009-2017 Olof Hagsand and Benny Holmgren This file is part of CLIXON. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Alternatively, the contents of this file may be used under the terms of the GNU General Public License Version 3 or later (the "GPL"), in which case the provisions of the GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL, and not to allow others to use your version of this file under the terms of Apache License version 2, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the Apache License version 2 or the GPL. ***** END LICENSE BLOCK ***** */ #ifdef HAVE_CONFIG_H #include "clixon_config.h" /* generated by config & autoconf */ #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* cligen */ #include /* clicon */ #include #include "clixon_backend_handle.h" #include "backend_commit.h" #include "backend_plugin.h" #include "backend_client.h" #include "backend_handle.h" /*! Add client notification subscription. Ie send notify to this client when event occurs * @param[in] ce Client entry struct * @param[in] stream Notification stream name * @param[in] format How to display event (see enum format_enum) * @param[in] filter Filter, what to display, eg xpath for format=xml, fnmatch * * @see backend_notify - where subscription is made and notify call is made */ static struct client_subscription * client_subscription_add(struct client_entry *ce, char *stream, enum format_enum format, char *filter) { struct client_subscription *su = NULL; if ((su = malloc(sizeof(*su))) == NULL){ clicon_err(OE_PLUGIN, errno, "malloc"); goto done; } memset(su, 0, sizeof(*su)); su->su_stream = strdup(stream); su->su_format = format; su->su_filter = filter?strdup(filter):strdup(""); su->su_next = ce->ce_subscription; ce->ce_subscription = su; done: return su; } static struct client_entry * ce_find_bypid(struct client_entry *ce_list, int pid) { struct client_entry *ce; for (ce = ce_list; ce; ce = ce->ce_next) if (ce->ce_pid == pid) return ce; return NULL; } static int client_subscription_delete(struct client_entry *ce, struct client_subscription *su0) { struct client_subscription *su; struct client_subscription **su_prev; su_prev = &ce->ce_subscription; /* this points to stack and is not real backpointer */ for (su = *su_prev; su; su = su->su_next){ if (su == su0){ *su_prev = su->su_next; free(su->su_stream); if (su->su_filter) free(su->su_filter); free(su); break; } su_prev = &su->su_next; } return 0; } #ifdef notused /* xxx */ static struct client_subscription * client_subscription_find(struct client_entry *ce, char *stream) { struct client_subscription *su = NULL; for (su = ce->ce_subscription; su; su = su->su_next) if (strcmp(su->su_stream, stream) == 0) break; return su; } #endif /*! Remove client entry state * Close down everything wrt clients (eg sockets, subscriptions) * Finally actually remove client struct in handle * @param[in] h Clicon handle * @param[in] ce Client hadnle * @see backend_client_delete for actual deallocation of client entry struct */ int backend_client_rm(clicon_handle h, struct client_entry *ce) { struct client_entry *c; struct client_entry *c0; struct client_entry **ce_prev; struct client_subscription *su; c0 = backend_client_list(h); ce_prev = &c0; /* this points to stack and is not real backpointer */ for (c = *ce_prev; c; c = c->ce_next){ if (c == ce){ if (ce->ce_s){ event_unreg_fd(ce->ce_s, from_client); close(ce->ce_s); ce->ce_s = 0; } while ((su = ce->ce_subscription) != NULL) client_subscription_delete(ce, su); break; } ce_prev = &c->ce_next; } return backend_client_delete(h, ce); /* actually purge it */ } /*! FInd target/source in netconf request. Assume sanity made so not finding is error */ static char* netconf_db_find(cxobj *xn, char *name) { cxobj *xs; /* source */ cxobj *xi; char *db = NULL; if ((xs = xml_find(xn, name)) == NULL) goto done; if ((xi = xml_child_i(xs, 0)) == NULL) goto done; db = xml_name(xi); done: return db; } /*! Internal message: get-config * * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[out] cbret Return xml value cligen buffer */ static int from_client_get_config(clicon_handle h, cxobj *xe, cbuf *cbret) { int retval = -1; char *db; cxobj *xfilter; char *selector = "/"; cxobj *xret = NULL; if ((db = netconf_db_find(xe, "source")) == NULL){ clicon_err(OE_XML, 0, "db not found"); goto done; } if ((xfilter = xml_find(xe, "filter")) != NULL) if ((selector = xml_find_value(xfilter, "select"))==NULL) selector="/"; if (xmldb_get(h, db, selector, &xret, NULL, NULL) < 0){ cprintf(cbret, "" "operation-failed" "application" "error" "read-registry" ""); goto ok; } cprintf(cbret, ""); /* if empty only , if any data then .. */ if (xret!=NULL){ if (xml_child_nr(xret)){ if (xml_name_set(xret, "config") < 0) goto done; if (clicon_xml2cbuf(cbret, xret, 0, 0) < 0) goto done; } } cprintf(cbret, ""); ok: retval = 0; done: if (xret) xml_free(xret); return retval; } /*! Internal message: edit-config * * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[in] mypid Process/session id of calling client * @param[out] cbret Return xml value cligen buffer */ static int from_client_edit_config(clicon_handle h, cxobj *xn, int mypid, cbuf *cbret) { int retval = -1; char *target; cbuf *cb = NULL; cxobj *xret = NULL; cxobj *xc; cxobj *x; enum operation_type operation = OP_MERGE; int piddb; if ((target = netconf_db_find(xn, "target")) == NULL){ clicon_err(OE_XML, 0, "db not found"); goto done; } /* Check if target locked by other client */ piddb = xmldb_islocked(h, target); if (piddb && mypid != piddb){ cprintf(cbret, "" "lock-denied" "protocol" "error" "Operation failed, lock is already held" "%d" "", piddb); goto ok; } if ((x = xpath_first(xn, "default-operation")) != NULL){ if (xml_operation(xml_body(x), &operation) < 0){ cprintf(cbret, "" "invalid-value" "protocol" "error" ""); goto ok; } } if ((xc = xpath_first(xn, "config")) != NULL){ if (xmldb_put(h, target, operation, xc) < 0){ cprintf(cbret, "" "operation-failed" "protocol" "error" "%s" "", clicon_err_reason); goto ok; } } else{ cprintf(cbret, "" "missing-element" "protocol" "error" "config" ""); goto ok; } cprintf(cbret, ""); ok: retval = 0; done: if (xret) xml_free(xret); if (cb) cbuf_free(cb); return retval; } /*! Internal message: Lock database * * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[in] pid Unix process id * @param[out] cbret Return xml value cligen buffer */ static int from_client_lock(clicon_handle h, cxobj *xe, int pid, cbuf *cbret) { int retval = -1; char *db; int piddb; if ((db = netconf_db_find(xe, "target")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "target" ""); goto ok; } /* * A lock MUST not be granted if either of the following conditions is true: * 1) A lock is already held by any NETCONF session or another entity. * 2) The target configuration is , it has already been modified, and * these changes have not been committed or rolled back. */ piddb = xmldb_islocked(h, db); if (piddb){ cprintf(cbret, "" "lock-denied" "protocol" "error" "Lock failed, lock is already held" "%d" "", piddb); goto ok; } else{ xmldb_lock(h, db, pid); cprintf(cbret, ""); } ok: retval = 0; // done: return retval; } /*! Internal message: Unlock database * * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[in] pid Unix process id * @param[out] cbret Return xml value cligen buffer */ static int from_client_unlock(clicon_handle h, cxobj *xe, int pid, cbuf *cbret) { int retval = -1; char *db; int piddb; if ((db = netconf_db_find(xe, "target")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "target" ""); goto ok; } piddb = xmldb_islocked(h, db); /* * An unlock operation will not succeed if any of the following * conditions are true: * 1) the specified lock is not currently active * 2) the session issuing the operation is not the same * session that obtained the lock */ if (piddb==0 || piddb != pid){ cprintf(cbret, "" "lock-denied" "protocol" "error" "Unlock failed, lock is already held" "pid=%d piddb=%d" "", pid, piddb); goto ok; } else{ xmldb_unlock(h, db); if (cprintf(cbret, "") < 0) goto done; } ok: retval = 0; done: return retval; } /*! Internal message: Kill session (Kill the process) * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[out] cbret Return xml value cligen buffer * @retval 0 OK * @retval -1 Error. Send error message back to client. */ static int from_client_kill_session(clicon_handle h, cxobj *xe, cbuf *cbret) { int retval = -1; uint32_t pid; /* other pid */ char *str; struct client_entry *ce; char *db = "running"; /* XXX */ cxobj *x; if ((x = xml_find(xe, "session-id")) == NULL || (str = xml_find_value(x, "body")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "session-id" ""); goto ok; } pid = atoi(str); /* may or may not be in active client list, probably not */ if ((ce = ce_find_bypid(backend_client_list(h), pid)) != NULL){ xmldb_unlock_all(h, pid); backend_client_rm(h, ce); } if (kill (pid, 0) != 0 && errno == ESRCH) /* Nothing there */ ; else{ killpg(pid, SIGTERM); kill(pid, SIGTERM); #if 0 /* Hate sleeps we assume it died, see also 0 in next if.. */ sleep(1); #endif } if (1 || (kill (pid, 0) != 0 && errno == ESRCH)){ /* Nothing there */ /* clear from locks */ if (xmldb_islocked(h, db) == pid) xmldb_unlock(h, db); } else{ /* failed to kill client */ cprintf(cbret, "" "operation-failed" "application" "error" "Faile to kill session" ""); goto ok; } cprintf(cbret, ""); ok: retval = 0; // done: return retval; } /*! Internal message: Copy database from db1 to db2 * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[in] mypid Process/session id of calling client * @param[out] cbret Return xml value cligen buffer * @retval 0 OK * @retval -1 Error. Send error message back to client. */ static int from_client_copy_config(clicon_handle h, cxobj *xe, int mypid, cbuf *cbret) { char *source; char *target; int retval = -1; int piddb; if ((source = netconf_db_find(xe, "source")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "source" ""); goto ok; } if ((target = netconf_db_find(xe, "target")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "target" ""); goto ok; } /* Check if target locked by other client */ piddb = xmldb_islocked(h, target); if (piddb && mypid != piddb){ cprintf(cbret, "" "lock-denied" "protocol" "error" "Operation failed, lock is already held" "%d" "", piddb); goto ok; } if (xmldb_copy(h, source, target) < 0){ cprintf(cbret, "" "operation-failed" "application" "error" "read-registry" ""); goto ok; } cprintf(cbret, ""); ok: retval = 0; // done: return retval; } /*! Internal message: Delete database * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[in] mypid Process/session id of calling client * @param[out] cbret Return xml value cligen buffer * @retval 0 OK * @retval -1 Error. Send error message back to client. */ static int from_client_delete_config(clicon_handle h, cxobj *xe, int mypid, cbuf *cbret) { int retval = -1; char *target; int piddb; if ((target = netconf_db_find(xe, "target")) == NULL|| strcmp(target, "running")==0){ cprintf(cbret, "" "missing-element" "protocol" "error" "target" ""); goto ok; } /* Check if target locked by other client */ piddb = xmldb_islocked(h, target); if (piddb && mypid != piddb){ cprintf(cbret, "" "lock-denied" "protocol" "error" "Operation failed, lock is already held" "%d" "", piddb); goto ok; } if (xmldb_delete(h, target) < 0){ cprintf(cbret, "" "operation-failed" "protocol" "error" "Internal error" "%s" "", clicon_err_reason); goto ok; } if (xmldb_create(h, target) < 0){ cprintf(cbret, "" "operation-failed" "protocol" "error" "Internal error" "%s" "", clicon_err_reason); goto ok; } cprintf(cbret, ""); ok: retval = 0; // done: return retval; } /*! Internal message: Create subscription for notifications see RFC 5277 * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[in] ce Client entry * @param[out] cbret Return xml value cligen buffer * @retval 0 OK * @retval -1 Error. Send error message back to client. * @example: * * RESULT # If not present, events in the default NETCONF stream will be sent. * XPATH-EXPR<(filter> * # only for replay (NYI) * # only for replay (NYI) * */ static int from_client_create_subscription(clicon_handle h, cxobj *xe, struct client_entry *ce, cbuf *cbret) { char *stream = "NETCONF"; char *filter = NULL; int retval = -1; cxobj *x; /* Genereic xml tree */ char *ftype; if ((x = xpath_first(xe, "//stream")) != NULL) stream = xml_find_value(x, "body"); if ((x = xpath_first(xe, "//filter")) != NULL){ if ((ftype = xml_find_value(x, "type")) != NULL){ /* Only accept xpath as filter type */ if (strcmp(ftype, "xpath") != 0){ cprintf(cbret, "" "operation-failed" "application" "error" "only xpath filter type supported" "type" ""); goto ok; } } } if (client_subscription_add(ce, stream, FORMAT_XML, filter) == NULL) goto done; cprintf(cbret, ""); ok: retval = 0; done: return retval; } /*! Internal message: Set debug level. This is global, not just for the session. * @param[in] h Clicon handle * @param[in] xe Netconf request xml tree * @param[out] cbret Return xml value cligen buffer * @retval 0 OK * @retval -1 Error. Send error message back to client. */ static int from_client_debug(clicon_handle h, cxobj *xe, cbuf *cbret) { int retval = -1; uint32_t level; char *valstr; if ((valstr = xml_find_body(xe, "level")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "level" ""); goto ok; } level = atoi(valstr); clicon_debug_init(level, NULL); /* 0: dont debug, 1:debug */ setlogmask(LOG_UPTO(level?LOG_DEBUG:LOG_INFO)); /* for syslog */ clicon_log(LOG_NOTICE, "%s debug:%d", __FUNCTION__, debug); cprintf(cbret, ""); ok: retval = 0; //done: return retval; } /*! An internal clicon message has arrived from a client. Receive and dispatch. * @param[in] s Socket where message arrived. read from this. * @param[in] arg Client entry (from). * @retval 0 OK * @retval -1 Error Terminates backend and is never called). Instead errors are * propagated back to client. */ static int from_client_msg(clicon_handle h, struct client_entry *ce, struct clicon_msg *msg) { int retval = -1; cxobj *xt = NULL; cxobj *x; cxobj *xe; char *name; char *db; cbuf *cbret = NULL; /* return message */ int pid; int ret; pid = ce->ce_pid; /* Return netconf message. Should be filled in by the dispatch(sub) functions * as wither rpc-error or by positive response. */ if ((cbret = cbuf_new()) == NULL){ clicon_err(OE_XML, errno, "cbuf_new"); goto done; } if (clicon_msg_decode(msg, &xt) < 0){ cprintf(cbret, "" "operation-failed" "rpc" "error" "rpc expected" "Not recognized" ""); goto reply; } if ((x = xpath_first(xt, "/rpc")) == NULL){ cprintf(cbret, "" "operation-failed" "rpc" "error" "rpc expected" "Not recognized" ""); goto reply; } xe = NULL; while ((xe = xml_child_each(x, xe, CX_ELMNT)) != NULL) { name = xml_name(xe); if (strcmp(name, "get-config") == 0){ if (from_client_get_config(h, xe, cbret) <0) goto done; } else if (strcmp(name, "edit-config") == 0){ if (from_client_edit_config(h, xe, pid, cbret) <0) goto done; } else if (strcmp(name, "copy-config") == 0){ if (from_client_copy_config(h, xe, pid, cbret) <0) goto done; } else if (strcmp(name, "delete-config") == 0){ if (from_client_delete_config(h, xe, pid, cbret) <0) goto done; } else if (strcmp(name, "lock") == 0){ if (from_client_lock(h, xe, pid, cbret) < 0) goto done; } else if (strcmp(name, "unlock") == 0){ if (from_client_unlock(h, xe, pid, cbret) < 0) goto done; } else if (strcmp(name, "close-session") == 0){ xmldb_unlock_all(h, pid); cprintf(cbret, ""); } else if (strcmp(name, "kill-session") == 0){ if (from_client_kill_session(h, xe, cbret) < 0) goto done; } else if (strcmp(name, "validate") == 0){ if ((db = netconf_db_find(xe, "source")) == NULL){ cprintf(cbret, "" "missing-element" "protocol" "error" "source" ""); goto reply; } if (from_client_validate(h, db, cbret) < 0) goto done; } else if (strcmp(name, "commit") == 0){ if (from_client_commit(h, pid, cbret) < 0) goto done; } else if (strcmp(name, "discard-changes") == 0){ if (from_client_discard_changes(h, pid, cbret) < 0) goto done; } else if (strcmp(name, "create-subscription") == 0){ if (from_client_create_subscription(h, xe, ce, cbret) < 0) goto done; } else if (strcmp(name, "debug") == 0){ if (from_client_debug(h, xe, cbret) < 0) goto done; } else{ if ((ret = backend_netconf_plugin_callbacks(h, xe, ce, cbret)) < 0) goto done; if (ret == 0) /* not handled by callback */ cprintf(cbret, "" "operation-failed" "rpc" "error" "%s" "Not recognized" "", name); } } reply: assert(cbuf_len(cbret)); clicon_debug(1, "%s %s", __FUNCTION__, cbuf_get(cbret)); if (send_msg_reply(ce->ce_s, cbuf_get(cbret), cbuf_len(cbret)+1) < 0){ switch (errno){ case EPIPE: /* man (2) write: * EPIPE fd is connected to a pipe or socket whose reading end is * closed. When this happens the writing process will also receive * a SIGPIPE signal. * In Clixon this means a client, eg restconf, netconf or cli closes * the (UNIX domain) socket. */ case ECONNRESET: clicon_log(LOG_WARNING, "client rpc reset"); break; default: goto done; } } // ok: retval = 0; done: if (xt) xml_free(xt); if (cbret) cbuf_free(cbret); return retval;// -1 here terminates backend } /*! An internal clicon message has arrived from a client. Receive and dispatch. * @param[in] s Socket where message arrived. read from this. * @param[in] arg Client entry (from). * @retval 0 OK * @retval -1 Error Terminates backend and is never called). Instead errors are * propagated back to client. */ int from_client(int s, void* arg) { int retval = -1; struct clicon_msg *msg = NULL; struct client_entry *ce = (struct client_entry *)arg; clicon_handle h = ce->ce_handle; int eof; // assert(s == ce->ce_s); if (clicon_msg_rcv(ce->ce_s, &msg, &eof) < 0) goto done; if (eof) backend_client_rm(h, ce); else if (from_client_msg(h, ce, msg) < 0) goto done; retval = 0; done: if (msg) free(msg); return retval; }