experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
clixon/lib/src/clixon_proto.c
Olof hagsand aba5c68fe2 Move format code to options and cleanup
2024-04-16 12:06:46 +02:00

772 lines
23 KiB
C
Raw Blame History

/*
*
***** 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 *****
*
* Protocol to communicate between clients (eg clixon_cli, clixon_netconf)
* and server (clicon_backend)
*/
#ifdef HAVE_CONFIG_H
#include "clixon_config.h" /* generated by config & autoconf */
#endif
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <syslog.h>
#include <signal.h>
#include <ctype.h>
#include <sys/types.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/param.h>
#include <netinet/in.h>
#include <sys/un.h>
#include <arpa/inet.h>
/* cligen */
#include <cligen/cligen.h>
/* clixon */
#include "clixon_queue.h"
#include "clixon_hash.h"
#include "clixon_handle.h"
#include "clixon_string.h"
#include "clixon_event.h"
#include "clixon_yang.h"
#include "clixon_xml.h"
#include "clixon_err.h"
#include "clixon_log.h"
#include "clixon_debug.h"
#include "clixon_sig.h"
#include "clixon_netconf_lib.h"
#include "clixon_xml_io.h"
#include "clixon_netconf_input.h"
#include "clixon_options.h"
#include "clixon_proto.h"
static int _atomicio_sig = 0;
/*! Given family, addr str, port, return sockaddr and length
*
* @param[in] addrtype Address family: inet:ipv4-address or inet:ipv6-address
* @param[in] addrstr IP address as string
* @param[in] port TCP port host byte order
* @param[out] sa sockaddr, should be allocated
* @param[out] salen length of sockaddr data
* @code
* struct sockaddr_in6 sin6 = {0,}; // because its larger than sin and sa
* struct sockaddr *sa = &sin6;
* size_t sa_len;
* if (clixon_inet2sin(inet:ipv4-address, "0.0.0.0", 80, sa, &sa_len) < 0)
* err;
* @endcode
* Probably misplaced, need a clixon_network file?
*/
int
clixon_inet2sin(const char *addrtype,
const char *addrstr,
uint16_t port,
struct sockaddr *sa,
size_t *sa_len)
{
struct sockaddr_in6 *sin6;
struct sockaddr_in *sin;
if (strcmp(addrtype, "inet:ipv6-address") == 0) {
sin6 = (struct sockaddr_in6 *)sa;
*sa_len = sizeof(struct sockaddr_in6);
sin6->sin6_port = htons(port);
sin6->sin6_family = AF_INET6;
inet_pton(AF_INET6, addrstr, &sin6->sin6_addr);
}
else if (strcmp(addrtype, "inet:ipv4-address") == 0) {
sin = (struct sockaddr_in *)sa;
*sa_len = sizeof(struct sockaddr_in);
sin->sin_family = AF_INET;
sin->sin_port = htons(port);
sin->sin_addr.s_addr = inet_addr(addrstr);
}
else{
clixon_err(OE_XML, EINVAL, "Unexpected addrtype: %s", addrtype);
return -1;
}
return 0;
}
/*! Encode a clicon netconf message using variable argument lists
*
* @param[in] id Session id of client
* @param[in] format Variable agrument list format an XML netconf string
* @retval msg Clicon message to send to eg clicon_msg_send()
* @retval NULL Error
* @note if format includes %, they will be expanded according to printf rules.
* if this is a problem, use ("%s", xml) instaead of (xml)
* Notaly this may an issue of RFC 3896 encoded strings
*/
struct clicon_msg *
clicon_msg_encode(uint32_t id,
const char *format, ...)
{
va_list args;
uint32_t xmllen;
uint32_t len;
struct clicon_msg *msg = NULL;
int hdrlen = sizeof(*msg);
va_start(args, format);
xmllen = vsnprintf(NULL, 0, format, args) + 1;
va_end(args);
len = hdrlen + xmllen;
if ((msg = (struct clicon_msg *)malloc(len)) == NULL){
clixon_err(OE_PROTO, errno, "malloc");
return NULL;
}
memset(msg, 0, len);
/* hdr */
msg->op_len = htonl(len);
msg->op_id = htonl(id);
/* body */
va_start(args, format);
vsnprintf(msg->op_body, xmllen, format, args);
va_end(args);
return msg;
}
/*! Open local connection using unix domain sockets
*
* @param[in] h Clixon handle
* @param[in] sockpath Unix domain file path
* @retval s Socket
* @retval -1 Error
*/
int
clicon_connect_unix(clixon_handle h,
char *sockpath)
{
struct sockaddr_un addr;
int retval = -1;
int s;
if ((s = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
clixon_err(OE_CFG, errno, "socket");
return -1;
}
memset(&addr, 0, sizeof(addr));
addr.sun_family = AF_UNIX;
strncpy(addr.sun_path, sockpath, sizeof(addr.sun_path)-1);
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "connecting to %s", addr.sun_path);
if (connect(s, (struct sockaddr *)&addr, SUN_LEN(&addr)) < 0){
if (errno == EACCES)
clixon_err(OE_CFG, errno, "connecting unix socket: %s. "
"Is user not member of group: \"%s\"?",
sockpath, clicon_sock_group(h));
else
clixon_err(OE_CFG, errno, "connecting unix socket: %s", sockpath);
close(s);
goto done;
}
retval = s;
done:
return retval;
}
/*! Connect to server using unix socket
*
* @param[in] h Clixon handle
* @param[in] msg Internal msg data structure. It has fixed header and variable body.
* @param[in] sockpath Unix domain file path
* @param[out] retdata Returned data as string netconf xml tree.
* @param[out] sock0 Return socket in case of asynchronous notify
* @retval 0 OK
* @retval -1 Error
* @see clicon_rpc But this is one-shot rpc: open, send, get reply and close.
*/
int
clicon_rpc_connect_unix(clixon_handle h,
char *sockpath,
int *sock0)
{
int retval = -1;
int s = -1;
struct stat sb = {0,};
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "Send msg on %s", sockpath);
if (sock0 == NULL){
clixon_err(OE_NETCONF, EINVAL, "sock0 expected");
goto done;
}
/* special error handling to get understandable messages (otherwise ENOENT) */
if (stat(sockpath, &sb) < 0){
clixon_err(OE_PROTO, errno, "%s: config daemon not running?", sockpath);
goto done;
}
if (!S_ISSOCK(sb.st_mode)){
clixon_err(OE_PROTO, EIO, "%s: Not unix socket", sockpath);
goto done;
}
if ((s = clicon_connect_unix(h, sockpath)) < 0)
goto done;
*sock0 = s;
retval = 0;
done:
return retval;
}
/*! Connect to server, send a clicon_msg message and wait for result using an inet socket
*
* @param[in] h Clixon handle (not used)
* @param[in] dst IPv4 address
* @param[in] port TCP port
* @param[out] retdata Returned data as string netconf xml tree.
* @param[out] sock0 Return socket in case of asynchronous notify
* @retval 0 OK
* @retval -1 Error
* @see clicon_rpc But this is one-shot rpc: open, send, get reply and close.
*/
int
clicon_rpc_connect_inet(clixon_handle h,
char *dst,
uint16_t port,
int *sock0)
{
int retval = -1;
int s = -1;
struct sockaddr_in addr;
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "Send msg to %s:%hu", dst, port);
if (sock0 == NULL){
clixon_err(OE_NETCONF, EINVAL, "sock0 expected");
goto done;
}
memset(&addr, 0, sizeof(addr));
addr.sin_family = AF_INET;
addr.sin_port = htons(port);
if (inet_pton(addr.sin_family, dst, &addr.sin_addr) != 1)
goto done; /* Could check getaddrinfo */
/* special error handling to get understandable messages (otherwise ENOENT) */
if ((s = socket(addr.sin_family, SOCK_STREAM, 0)) < 0) {
clixon_err(OE_CFG, errno, "socket");
return -1;
}
if (connect(s, (struct sockaddr*)&addr, sizeof(addr)) < 0){
clixon_err(OE_CFG, errno, "connecting socket inet4");
close(s);
goto done;
}
*sock0 = s;
retval = 0;
done:
return retval;
}
/*! Ensure all of data on socket comes through. fn is either read or write
*
* @param[in] fn I/O function, ie read/write
* @param[in] fd File descriptor, eg socket
* @param[in] s0 Buffer to read to or write from
* @param[in] n Number of bytes to read/write, loop until done
*/
static ssize_t
atomicio(ssize_t (*fn) (int, void *, size_t),
int fd,
void *s0,
size_t n)
{
char *s = s0;
ssize_t res, pos = 0;
while (n > pos) {
_atomicio_sig = 0;
res = (fn)(fd, s + pos, n - pos);
switch (res) {
case -1:
if (errno == EINTR){
if (_atomicio_sig == 0)
continue;
}
else if (errno == EAGAIN)
continue;
else if (errno == ECONNRESET)/* Connection reset by peer */
res = 0;
else if (errno == EPIPE) /* Client shutdown */
res = 0;
else if (errno == EBADF) /* client shutdown - freebsd */
res = 0;
case 0: /* fall thru */
return (res);
default:
pos += res;
}
}
return (pos);
}
static int
clixon_msg_send(int s,
const char *descr,
cbuf *cb)
{
int retval = -1;
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "send msg len=%lu", cbuf_len(cb));
if (descr)
clixon_debug(CLIXON_DBG_MSG, "Send [%s]: %s", descr, cbuf_get(cb));
else
clixon_debug(CLIXON_DBG_MSG, "Send: %s", cbuf_get(cb));
if (atomicio((ssize_t (*)(int, void *, size_t))write,
s, cbuf_get(cb), cbuf_len(cb)) < 0){
clixon_err(OE_CFG, errno, "atomicio");
clixon_log(NULL, LOG_WARNING, "%s: write: %s", __FUNCTION__, strerror(errno));
goto done;
}
retval = 0;
done:
return retval;
}
/*================= NETCONF 1.0 EOM framing ================*/
/*! Receive a message using NETCONF 1.0 end-of-message encoding
*
* @param[in] s socket (unix or inet) to communicate with backend
* @param[in] descr Description of peer for logging
* @param[out] cb cligen buf struct containing the incoming message
* @param[out] eof Set if eof encountered
* @retval 0 OK
* @retval -1 Error
* @see clixon_msg_rcv11 Chunked framing
* @see netconf_input_msg2
*/
int
clixon_msg_rcv10(int s,
const char *descr,
cbuf *cb,
int *eof)
{
int retval = -1;
unsigned char buf[BUFSIZ];
int i;
int len;
int xml_state = 0;
int poll;
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "");
*eof = 0;
memset(buf, 0, sizeof(buf));
while (1){
#if 1
if ((len = netconf_input_read2(s, buf, sizeof(buf), eof)) < 0)
goto done;
#else
if ((len = read(s, buf, sizeof(buf))) < 0){
if (errno == ECONNRESET)
len = 0; /* emulate EOF */
else{
clixon_log(NULL, LOG_ERR, "%s: read: %s errno:%d", __FUNCTION__, strerror(errno), errno);
goto done;
}
} /* read */
if (len == 0){ /* EOF */
*eof = 1;
close(s);
goto ok;
}
#endif
for (i=0; i<len; i++){
if (buf[i] == 0)
continue; /* Skip NULL chars (eg from terminals) */
cprintf(cb, "%c", buf[i]);
if (detect_endtag("]]>]]>",
buf[i],
&xml_state)) {
/* OK, we have an xml string from a client */
/* Remove trailer */
*(((char*)cbuf_get(cb)) + cbuf_len(cb) - strlen("]]>]]>")) = '\0';
goto ok;
}
}
/* poll==1 if more, poll==0 if none */
if ((poll = clixon_event_poll(s)) < 0)
goto done;
if (poll == 0)
break; /* No data to read */
} /* while */
ok:
if (descr)
clixon_debug(CLIXON_DBG_MSG, "Recv [%s]: %s", descr, cbuf_get(cb));
else
clixon_debug(CLIXON_DBG_MSG, "Recv: %s", cbuf_get(cb));
retval = 0;
done:
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "done");
return retval;
}
/*! Send a message using NETCONF 1.0 end-of-message encoding
*
* @param[in] s socket (unix or inet) to communicate with backend
* @param[in] descr Description of peer for logging
* @param[in] cb data buffer including NETCONF (and EOM)
* @retval 0 OK
* @retval -1 Error
* @see clixon_msg_send11 version 1.1 - chunked
*/
int
clixon_msg_send10(int s,
const char *descr,
cbuf *cb)
{
return clixon_msg_send(s, descr, cb);
}
/*! Send a netconf message and recieve result using NETCONF 1.0 EOM encoding
*
* This is mainly used by the client API.
* @param[in] sock Socket / file descriptor
* @param[in] descr Description of peer for logging
* @param[in] msgin Clixon msg data structure. It has fixed header and variable body.
* @param[out] msgret Returned data as netconf xml tree.
* @param[out] eof Set if eof encountered
* @retval 0 OK
* @retval -1 Error
* @see clicon_rpc using clicon_msg protocol header
*/
int
clixon_rpc10(int sock,
const char *descr,
cbuf *msg,
cbuf *msgret,
int *eof)
{
int retval = -1;
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "");
if (netconf_framing_preamble(NETCONF_SSH_EOM, msg) < 0)
goto done;
if (netconf_framing_postamble(NETCONF_SSH_EOM, msg) < 0)
goto done;
if (clixon_msg_send10(sock, descr, msg) < 0)
goto done;
if (clixon_msg_rcv10(sock, descr, msgret, eof) < 0)
goto done;
retval = 0;
done:
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "retval:%d", retval);
return retval;
}
/*================= NETCONF 1.1 Chunked framing ================*/
/*! Send a message using NETCONF 1.1 w chunked framing
*
* @param[in] s socket (unix or inet) to communicate with backend
* @param[in] descr Description of peer for logging
* @param[out] msg CLICON msg data reply structure. Free with free()
* @see clixon_msg_send10 1.0 EOM
*/
static int
clixon_msg_send11(int s,
const char *descr,
cbuf *cb)
{
int retval = -1;
if (netconf_output_encap(NETCONF_SSH_CHUNKED, cb) < 0)
goto done;
if (clixon_msg_send(s, descr, cb) < 0)
goto done;
retval = 0;
done:
return retval;
}
static void
atomicio_sig_handler(int arg)
{
_atomicio_sig++;
}
/*! Receive a message using unified NETCONF w chunked framing
*
* @param[in] s socket (unix or inet) to communicate with backend
* @param[in] descr Description of peer for logging
* @param[in] intr If set, make a ^C cause an error (OBSOLETE?)
* @param[out] cb cligen buf struct containing the incoming message
* @param[out] eof Set if eof encountered
* @retval 0 OK (check eof)
* @retval -1 Error
* @see netconf_input_cb()
* @note only NETCONF version 1.0 EOM framing
*/
int
clixon_msg_rcv11(int s,
const char *descr,
int intr,
cbuf **cb,
int *eof)
{
int retval = -1;
unsigned char buf[BUFSIZ];
ssize_t buflen = sizeof(buf);
int frame_state = 0;
size_t frame_size = 0;
unsigned char *p = buf;
size_t plen;
cbuf *cbmsg=NULL;
ssize_t len;
int eom = 0;
cxobj *xtop = NULL;
cxobj *xerr = NULL;
sigset_t oldsigset = {0,};
struct sigaction oldsigaction[32] = {{{0,},},};
if ((cbmsg = cbuf_new()) == NULL){
clixon_err(OE_XML, errno, "cbuf_new");
goto done;
}
eom = 0;
*eof = 0;
if (intr){
if (clixon_signal_save(&oldsigset, oldsigaction) < 0)
goto done;
set_signal(SIGINT, SIG_IGN, NULL);
clicon_signal_unblock(SIGINT);
set_signal_flags(SIGINT, 0, atomicio_sig_handler, NULL);
}
while (*eof == 0 && eom == 0) {
/* Read input data from socket and append to cbbuf */
if ((len = netconf_input_read2(s, buf, buflen, eof)) < 0)
goto done;
p = buf;
plen = len;
while (!(*eof) && plen > 0){
if (netconf_input_msg2(&p, &plen,
cbmsg,
NETCONF_SSH_CHUNKED,
&frame_state,
&frame_size,
&eom) < 0){
/* Errors from input are only framing errors, non-fatal, return eof */
*eof = 1;
cbuf_reset(cbmsg);
break;
}
if (eom == 0)
continue;
}
}
clixon_debug(CLIXON_DBG_MSG, "Recv: %s", cbuf_get(cbmsg));
if (cb){
*cb = cbmsg;
cbmsg = NULL;
}
retval = 0;
done:
clixon_debug(CLIXON_DBG_MSG|CLIXON_DBG_DETAIL, "%s done", __FUNCTION__);
if (intr){
if (clixon_signal_restore(&oldsigset, oldsigaction) < 0)
goto done;
}
if (cbmsg)
cbuf_free(cbmsg);
if (xtop)
xml_free(xtop);
if (xerr)
xml_free(xerr);
return retval;
}
/*! Send a NETCONF message and wait for result.
*
* TBD: timeout, interrupt?
* retval may be -1 and
* errno set to ENOTCONN/ESHUTDOWN which means that socket is now closed probably
* due to remote peer disconnecting. The caller may have to do something,...
* @param[in] sock Socket / file descriptor
* @param[in] descr Description of peer for logging
* @param[in] msg Clixon msg data structure. It has fixed header and variable body.
* @param[out] xret Returned data as netconf xml tree.
* @param[out] eof Set if eof encountered
* @retval 0 OK (check eof)
* @retval -1 Error
* @see clixon_rpc10 using NETCONF 1.0 EOM
*/
int
clicon_rpc(int sock,
const char *descr,
struct clicon_msg *msg,
char **ret,
int *eof)
{
int retval = -1;
struct clicon_msg *reply = NULL;
cbuf *cbsend = cbuf_new();
cbuf *cbrcv = NULL;
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "");
cprintf(cbsend, "%s", msg->op_body);
if (clixon_msg_send11(sock, descr, cbsend) < 0)
goto done;
if (cbsend)
cbuf_free(cbsend);
if (clixon_msg_rcv11(sock, descr, 0, &cbrcv, eof) < 0)
goto done;
if (*eof)
goto ok;
if (cbrcv){
if ((*ret = strdup(cbuf_get(cbrcv))) == NULL){
clixon_err(OE_UNIX, errno, "strdup");
goto done;
}
cbuf_free(cbrcv);
}
ok:
retval = 0;
done:
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "retval:%d", retval);
if (reply)
free(reply);
return retval;
}
/*! Send a clicon_msg message as reply to a clicon rpc request
*
* @param[in] s Socket to communicate with client
* @param[in] descr Description of peer for logging
* @param[in] data Returned data as byte-string.
* @param[in] datalen Length of returned data XXX may be unecessary if always string?
* @retval 0 OK
* @retval -1 Error
*/
int
send_msg_reply(int s,
const char *descr,
char *data,
uint32_t datalen)
{
int retval = -1;
cbuf *cb = NULL;
if ((cb = cbuf_new()) == NULL){
clixon_err(OE_UNIX, errno, "cbuf_new");
goto done;
}
if (cbuf_append_buf(cb, data, datalen) < 0){
clixon_err(OE_UNIX, errno, "cbuf_append_buf");
goto done;
}
if (clixon_msg_send11(s, descr, cb) < 0)
goto done;
retval = 0;
done:
if (cb)
cbuf_free(cb);
return retval;
}
/*! Send a clicon_msg NOTIFY message asynchronously to client
*
* @param[in] s Socket to communicate with client
* @param[in] descr Description of peer for logging
* @param[in] msg Data string to send
* @retval 0 OK
* @retval -1 Error
* @see send_msg_notify_xml
*/
static int
send_msg_notify(int s,
const char *descr,
char *msg)
{
int retval = -1;
cbuf *cb = NULL;
if ((cb = cbuf_new()) == NULL){
clixon_err(OE_UNIX, errno, "cbuf_new");
goto done;
}
cprintf(cb, "%s", msg);
if (clixon_msg_send11(s, descr, cb) < 0)
goto done;
retval = 0;
done:
if (cb)
cbuf_free(cb);
return retval;
}
/*! Send a clicon_msg NOTIFY message asynchronously to client
*
* @param[in] h Clixon handle
* @param[in] s Socket to communicate with client
* @param[in] descr Description of peer for logging
* @param[in] xev Event as XML
* @retval 0 OK
* @retval -1 Error
* @see send_msg_notify
*/
int
send_msg_notify_xml(clixon_handle h,
int s,
const char *descr,
cxobj *xev)
{
int retval = -1;
cbuf *cb = NULL;
if ((cb = cbuf_new()) == NULL){
clixon_err(OE_PLUGIN, errno, "cbuf_new");
goto done;
}
if (clixon_xml2cbuf(cb, xev, 0, 0, NULL, -1, 0) < 0)
goto done;
if (send_msg_notify(s, descr, cbuf_get(cb)) < 0)
goto done;
retval = 0;
done:
clixon_debug(CLIXON_DBG_MSG | CLIXON_DBG_DETAIL, "retval:%d", retval);
if (cb)
cbuf_free(cb);
return retval;
}
Reference in a new issue View git blame Copy permalink