3 * Fraunhofer Institute for Open Communication Systems (FhG Fokus).
6 * Author: Harti Brandt <harti@freebsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $Begemot: bsnmp/snmpd/trans_lsock.c,v 1.6 2005/02/25 11:50:25 brandt_h Exp $
31 * Local domain socket transport
33 #include <sys/types.h>
34 #include <sys/queue.h>
36 #include <sys/ucred.h>
49 #include "trans_lsock.h"
53 static const struct asn_oid
54 oid_begemotSnmpdLocalPortTable = OIDX_begemotSnmpdLocalPortTable;
56 static int lsock_start(void);
57 static int lsock_stop(int);
58 static void lsock_close_port(struct tport *);
59 static int lsock_init_port(struct tport *);
60 static ssize_t lsock_send(struct tport *, const u_char *, size_t,
61 const struct sockaddr *, size_t);
62 static ssize_t lsock_recv(struct tport *, struct port_input *);
65 const struct transport_def lsock_trans = {
67 OIDX_begemotSnmpdTransLsock,
76 static struct transport *my_trans;
79 lsock_remove(struct tport *tp, intptr_t arg __unused)
81 struct lsock_port *port = (struct lsock_port *)tp;
83 (void)remove(port->name);
92 if (my_trans != NULL) {
93 if (!force && trans_first_port(my_trans) != NULL)
94 return (SNMP_ERR_GENERR);
95 trans_iter_port(my_trans, lsock_remove, 0);
96 return (trans_unregister(my_trans));
98 return (SNMP_ERR_NOERROR);
104 return (trans_register(&lsock_trans, &my_trans));
108 * Open a local port. If this is a datagram socket create also the
112 lsock_open_port(u_char *name, size_t namelen, struct lsock_port **pp,
115 struct lsock_port *port;
116 struct lsock_peer *peer = NULL;
117 int is_stream, need_cred;
120 struct sockaddr_un sa;
122 if (namelen == 0 || namelen + 1 > sizeof(sa.sun_path))
123 return (SNMP_ERR_BADVALUE);
126 case LOCP_DGRAM_UNPRIV:
131 case LOCP_DGRAM_PRIV:
136 case LOCP_STREAM_UNPRIV:
141 case LOCP_STREAM_PRIV:
147 return (SNMP_ERR_BADVALUE);
150 if ((port = calloc(1, sizeof(*port))) == NULL)
151 return (SNMP_ERR_GENERR);
154 if ((peer = calloc(1, sizeof(*peer))) == NULL) {
156 return (SNMP_ERR_GENERR);
159 if ((port->name = malloc(namelen + 1)) == NULL) {
163 return (SNMP_ERR_GENERR);
165 strncpy(port->name, name, namelen);
166 port->name[namelen] = '\0';
170 LIST_INIT(&port->peers);
172 port->tport.index.len = namelen + 1;
173 port->tport.index.subs[0] = namelen;
174 for (u = 0; u < namelen; u++)
175 port->tport.index.subs[u + 1] = name[u];
178 LIST_INSERT_HEAD(&port->peers, peer, link);
183 peer->input.id = NULL;
184 peer->input.stream = is_stream;
185 peer->input.cred = need_cred;
186 peer->input.peer = (struct sockaddr *)&peer->peer;
189 trans_insert_port(my_trans, &port->tport);
191 if (community != COMM_INITIALIZE &&
192 (err = lsock_init_port(&port->tport)) != SNMP_ERR_NOERROR) {
193 lsock_close_port(&port->tport);
199 return (SNMP_ERR_NOERROR);
203 * Close a local domain peer
206 lsock_peer_close(struct lsock_peer *peer)
209 LIST_REMOVE(peer, link);
210 snmpd_input_close(&peer->input);
218 lsock_close_port(struct tport *tp)
220 struct lsock_port *port = (struct lsock_port *)tp;
221 struct lsock_peer *peer;
223 if (port->str_id != NULL)
224 fd_deselect(port->str_id);
225 if (port->str_sock >= 0)
226 (void)close(port->str_sock);
227 (void)remove(port->name);
229 trans_remove_port(tp);
231 while ((peer = LIST_FIRST(&port->peers)) != NULL)
232 lsock_peer_close(peer);
239 * Input on a local socket (either datagram or stream)
242 lsock_input(int fd __unused, void *udata)
244 struct lsock_peer *peer = udata;
245 struct lsock_port *p = peer->port;
247 peer->input.peerlen = sizeof(peer->peer);
248 if (snmpd_input(&peer->input, &p->tport) == -1 && peer->input.stream)
249 /* framing or other input error */
250 lsock_peer_close(peer);
254 * A UNIX domain listening socket is ready. This means we have a peer
255 * that we need to accept
258 lsock_listen_input(int fd, void *udata)
260 struct lsock_port *p = udata;
261 struct lsock_peer *peer;
263 if ((peer = calloc(1, sizeof(*peer))) == NULL) {
264 syslog(LOG_WARNING, "%s: peer malloc failed", p->name);
265 (void)close(accept(fd, NULL, NULL));
271 peer->input.stream = 1;
272 peer->input.cred = (p->type == LOCP_DGRAM_PRIV ||
273 p->type == LOCP_STREAM_PRIV);
274 peer->input.peerlen = sizeof(peer->peer);
275 peer->input.peer = (struct sockaddr *)&peer->peer;
277 peer->input.fd = accept(fd, peer->input.peer, &peer->input.peerlen);
278 if (peer->input.fd == -1) {
279 syslog(LOG_WARNING, "%s: accept failed: %m", p->name);
284 if ((peer->input.id = fd_select(peer->input.fd, lsock_input,
285 peer, NULL)) == NULL) {
286 close(peer->input.fd);
291 LIST_INSERT_HEAD(&p->peers, peer, link);
295 * Create a local socket
298 lsock_init_port(struct tport *tp)
300 struct lsock_port *p = (struct lsock_port *)tp;
301 struct sockaddr_un sa;
303 if (p->type == LOCP_STREAM_PRIV || p->type == LOCP_STREAM_UNPRIV) {
304 if ((p->str_sock = socket(PF_LOCAL, SOCK_STREAM, 0)) < 0) {
305 syslog(LOG_ERR, "creating local socket: %m");
306 return (SNMP_ERR_RES_UNAVAIL);
309 strlcpy(sa.sun_path, p->name, sizeof(sa.sun_path));
310 sa.sun_family = AF_LOCAL;
311 sa.sun_len = SUN_LEN(&sa);
313 (void)remove(p->name);
315 if (bind(p->str_sock, (struct sockaddr *)&sa, sizeof(sa))) {
316 if (errno == EADDRNOTAVAIL) {
319 return (SNMP_ERR_INCONS_NAME);
321 syslog(LOG_ERR, "bind: %s %m", p->name);
324 return (SNMP_ERR_GENERR);
326 if (chmod(p->name, 0666) == -1)
327 syslog(LOG_WARNING, "chmod(%s,0666): %m", p->name);
329 if (listen(p->str_sock, 10) == -1) {
330 syslog(LOG_ERR, "listen: %s %m", p->name);
331 (void)remove(p->name);
334 return (SNMP_ERR_GENERR);
337 p->str_id = fd_select(p->str_sock, lsock_listen_input, p, NULL);
338 if (p->str_id == NULL) {
339 (void)remove(p->name);
342 return (SNMP_ERR_GENERR);
345 struct lsock_peer *peer;
348 peer = LIST_FIRST(&p->peers);
350 if ((peer->input.fd = socket(PF_LOCAL, SOCK_DGRAM, 0)) < 0) {
351 syslog(LOG_ERR, "creating local socket: %m");
352 return (SNMP_ERR_RES_UNAVAIL);
355 if (setsockopt(peer->input.fd, 0, LOCAL_CREDS, &on,
357 syslog(LOG_ERR, "setsockopt(LOCAL_CREDS): %m");
358 close(peer->input.fd);
360 return (SNMP_ERR_GENERR);
363 strlcpy(sa.sun_path, p->name, sizeof(sa.sun_path));
364 sa.sun_family = AF_LOCAL;
365 sa.sun_len = SUN_LEN(&sa);
367 (void)remove(p->name);
369 if (bind(peer->input.fd, (struct sockaddr *)&sa, sizeof(sa))) {
370 if (errno == EADDRNOTAVAIL) {
371 close(peer->input.fd);
373 return (SNMP_ERR_INCONS_NAME);
375 syslog(LOG_ERR, "bind: %s %m", p->name);
376 close(peer->input.fd);
378 return (SNMP_ERR_GENERR);
380 if (chmod(p->name, 0666) == -1)
381 syslog(LOG_WARNING, "chmod(%s,0666): %m", p->name);
383 peer->input.id = fd_select(peer->input.fd, lsock_input,
385 if (peer->input.id == NULL) {
386 (void)remove(p->name);
387 close(peer->input.fd);
389 return (SNMP_ERR_GENERR);
392 return (SNMP_ERR_NOERROR);
399 lsock_send(struct tport *tp, const u_char *buf, size_t len,
400 const struct sockaddr *addr, size_t addrlen)
402 struct lsock_port *p = (struct lsock_port *)tp;
403 struct lsock_peer *peer;
405 if (p->type == LOCP_DGRAM_PRIV || p->type == LOCP_DGRAM_UNPRIV) {
406 peer = LIST_FIRST(&p->peers);
409 /* search for the peer */
410 LIST_FOREACH(peer, &p->peers, link)
411 if (peer->input.peerlen == addrlen &&
412 memcmp(peer->input.peer, addr, addrlen) == 0)
420 return (sendto(peer->input.fd, buf, len, 0, addr, addrlen));
424 check_priv_stream(struct port_input *pi)
429 /* obtain the accept time credentials */
430 ucredlen = sizeof(ucred);
432 if (getsockopt(pi->fd, 0, LOCAL_PEERCRED, &ucred, &ucredlen) == 0 &&
433 ucredlen >= sizeof(ucred) && ucred.cr_version == XUCRED_VERSION)
434 pi->priv = (ucred.cr_uid == 0);
443 lsock_recv(struct tport *tp __unused, struct port_input *pi)
449 msg.msg_control = NULL;
450 msg.msg_controllen = 0;
452 if (pi->buf == NULL) {
453 /* no buffer yet - allocate one */
454 if ((pi->buf = buf_alloc(0)) == NULL) {
455 /* ups - could not get buffer. Return an error
456 * the caller must close the transport. */
459 pi->buflen = buf_size(0);
464 /* try to get a message */
465 msg.msg_name = pi->peer;
466 msg.msg_namelen = pi->peerlen;
469 msg.msg_control = NULL;
470 msg.msg_controllen = 0;
473 iov[0].iov_base = pi->buf + pi->length;
474 iov[0].iov_len = pi->buflen - pi->length;
476 len = recvmsg(pi->fd, &msg, 0);
478 if (len == -1 || len == 0)
485 check_priv_stream(pi);
491 * Dependency to create a lsock port
494 struct snmp_dependency dep;
496 /* index (path name) */
501 struct lsock_port *port;
503 /* which of the fields are set */
506 /* type of the port */
513 #define LD_STATUS 0x02
514 #define LD_CREATE 0x04 /* rollback create */
515 #define LD_DELETE 0x08 /* rollback delete */
518 * dependency handler for lsock ports
521 lsock_func(struct snmp_context *ctx, struct snmp_dependency *dep,
524 struct lsock_dep *ld = (struct lsock_dep *)(void *)dep;
525 int err = SNMP_ERR_NOERROR;
529 case SNMP_DEPOP_COMMIT:
530 if (!(ld->set & LD_STATUS))
531 err = SNMP_ERR_BADVALUE;
532 else if (ld->port == NULL) {
534 err = SNMP_ERR_BADVALUE;
538 err = lsock_open_port(ld->path, ld->pathlen,
539 &ld->port, ld->type);
540 if (err == SNMP_ERR_NOERROR)
541 ld->set |= LD_CREATE;
543 } else if (!ld->status) {
544 /* delete - hard to roll back so defer to finalizer */
545 ld->set |= LD_DELETE;
547 /* modify - read-only */
548 err = SNMP_ERR_READONLY;
552 case SNMP_DEPOP_ROLLBACK:
553 if (ld->set & LD_CREATE) {
555 lsock_close_port(&ld->port->tport);
557 return (SNMP_ERR_NOERROR);
559 case SNMP_DEPOP_FINISH:
560 if ((ld->set & LD_DELETE) && ctx->code == SNMP_RET_OK)
561 lsock_close_port(&ld->port->tport);
563 return (SNMP_ERR_NOERROR);
572 op_lsock_port(struct snmp_context *ctx, struct snmp_value *value,
573 u_int sub, u_int iidx, enum snmp_op op)
575 asn_subid_t which = value->var.subs[sub-1];
576 struct lsock_port *p;
579 struct lsock_dep *ld;
584 case SNMP_OP_GETNEXT:
585 if ((p = (struct lsock_port *)trans_next_port(my_trans,
586 &value->var, sub)) == NULL)
587 return (SNMP_ERR_NOSUCHNAME);
588 index_append(&value->var, sub, &p->tport.index);
592 if ((p = (struct lsock_port *)trans_find_port(my_trans,
593 &value->var, sub)) == NULL)
594 return (SNMP_ERR_NOSUCHNAME);
598 p = (struct lsock_port *)trans_find_port(my_trans,
601 if (index_decode(&value->var, sub, iidx, &name, &namelen))
602 return (SNMP_ERR_NO_CREATION);
604 asn_slice_oid(&didx, &value->var, sub, value->var.len);
605 if ((ld = (struct lsock_dep *)(void *)snmp_dep_lookup(ctx,
606 &oid_begemotSnmpdLocalPortTable, &didx, sizeof(*ld),
607 lsock_func)) == NULL) {
609 return (SNMP_ERR_GENERR);
612 if (ld->path == NULL) {
614 ld->pathlen = namelen;
622 case LEAF_begemotSnmpdLocalPortStatus:
623 if (ld->set & LD_STATUS)
624 return (SNMP_ERR_INCONS_VALUE);
625 if (!TRUTH_OK(value->v.integer))
626 return (SNMP_ERR_WRONG_VALUE);
628 ld->status = TRUTH_GET(value->v.integer);
629 ld->set |= LD_STATUS;
632 case LEAF_begemotSnmpdLocalPortType:
633 if (ld->set & LD_TYPE)
634 return (SNMP_ERR_INCONS_VALUE);
635 if (value->v.integer < 1 || value->v.integer > 4)
636 return (SNMP_ERR_WRONG_VALUE);
638 ld->type = value->v.integer;
642 return (SNMP_ERR_NOERROR);
644 case SNMP_OP_ROLLBACK:
646 return (SNMP_ERR_NOERROR);
653 * Come here to fetch the value
657 case LEAF_begemotSnmpdLocalPortStatus:
658 value->v.integer = 1;
661 case LEAF_begemotSnmpdLocalPortType:
662 value->v.integer = p->type;
669 return (SNMP_ERR_NOERROR);