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>
48 #include "trans_lsock.h"
52 static const struct asn_oid
53 oid_begemotSnmpdLocalPortTable = OIDX_begemotSnmpdLocalPortTable;
55 static int lsock_start(void);
56 static int lsock_stop(int);
57 static void lsock_close_port(struct tport *);
58 static int lsock_init_port(struct tport *);
59 static ssize_t lsock_send(struct tport *, const u_char *, size_t,
60 const struct sockaddr *, size_t);
63 const struct transport_def lsock_trans = {
65 OIDX_begemotSnmpdTransLsock,
72 static struct transport *my_trans;
75 lsock_remove(struct tport *tp, intptr_t arg __unused)
77 struct lsock_port *port = (struct lsock_port *)tp;
79 (void)remove(port->name);
88 if (my_trans != NULL) {
89 if (!force && trans_first_port(my_trans) != NULL)
90 return (SNMP_ERR_GENERR);
91 trans_iter_port(my_trans, lsock_remove, 0);
92 return (trans_unregister(my_trans));
94 return (SNMP_ERR_NOERROR);
100 return (trans_register(&lsock_trans, &my_trans));
104 * Open a local port. If this is a datagram socket create also the
108 lsock_open_port(u_char *name, size_t namelen, struct lsock_port **pp,
111 struct lsock_port *port;
112 struct lsock_peer *peer = NULL;
113 int is_stream, need_cred;
116 struct sockaddr_un sa;
118 if (namelen == 0 || namelen + 1 > sizeof(sa.sun_path))
119 return (SNMP_ERR_BADVALUE);
122 case LOCP_DGRAM_UNPRIV:
127 case LOCP_DGRAM_PRIV:
132 case LOCP_STREAM_UNPRIV:
137 case LOCP_STREAM_PRIV:
143 return (SNMP_ERR_BADVALUE);
146 if ((port = malloc(sizeof(*port))) == NULL)
147 return (SNMP_ERR_GENERR);
149 memset(port, 0, sizeof(*port));
151 if ((peer = malloc(sizeof(*peer))) == NULL) {
153 return (SNMP_ERR_GENERR);
155 memset(peer, 0, sizeof(*peer));
157 if ((port->name = malloc(namelen + 1)) == NULL) {
161 return (SNMP_ERR_GENERR);
163 strncpy(port->name, name, namelen);
164 port->name[namelen] = '\0';
168 LIST_INIT(&port->peers);
170 port->tport.index.len = namelen + 1;
171 port->tport.index.subs[0] = namelen;
172 for (u = 0; u < namelen; u++)
173 port->tport.index.subs[u + 1] = name[u];
176 LIST_INSERT_HEAD(&port->peers, peer, link);
181 peer->input.id = NULL;
182 peer->input.stream = is_stream;
183 peer->input.cred = need_cred;
184 peer->input.peer = (struct sockaddr *)&peer->peer;
187 trans_insert_port(my_trans, &port->tport);
189 if (community != COMM_INITIALIZE &&
190 (err = lsock_init_port(&port->tport)) != SNMP_ERR_NOERROR) {
191 lsock_close_port(&port->tport);
197 return (SNMP_ERR_NOERROR);
201 * Close a local domain peer
204 lsock_peer_close(struct lsock_peer *peer)
207 LIST_REMOVE(peer, link);
208 snmpd_input_close(&peer->input);
216 lsock_close_port(struct tport *tp)
218 struct lsock_port *port = (struct lsock_port *)tp;
219 struct lsock_peer *peer;
221 if (port->str_id != NULL)
222 fd_deselect(port->str_id);
223 if (port->str_sock >= 0)
224 (void)close(port->str_sock);
225 (void)remove(port->name);
227 trans_remove_port(tp);
229 while ((peer = LIST_FIRST(&port->peers)) != NULL)
230 lsock_peer_close(peer);
237 * Input on a local socket (either datagram or stream)
240 lsock_input(int fd __unused, void *udata)
242 struct lsock_peer *peer = udata;
243 struct lsock_port *p = peer->port;
245 peer->input.peerlen = sizeof(peer->peer);
246 if (snmpd_input(&peer->input, &p->tport) == -1 && peer->input.stream)
247 /* framing or other input error */
248 lsock_peer_close(peer);
252 * A UNIX domain listening socket is ready. This means we have a peer
253 * that we need to accept
256 lsock_listen_input(int fd, void *udata)
258 struct lsock_port *p = udata;
259 struct lsock_peer *peer;
261 if ((peer = malloc(sizeof(*peer))) == NULL) {
262 syslog(LOG_WARNING, "%s: peer malloc failed", p->name);
263 (void)close(accept(fd, NULL, NULL));
266 memset(peer, 0, sizeof(*peer));
270 peer->input.stream = 1;
271 peer->input.cred = (p->type == LOCP_DGRAM_PRIV ||
272 p->type == LOCP_STREAM_PRIV);
273 peer->input.peerlen = sizeof(peer->peer);
274 peer->input.peer = (struct sockaddr *)&peer->peer;
276 peer->input.fd = accept(fd, peer->input.peer, &peer->input.peerlen);
277 if (peer->input.fd == -1) {
278 syslog(LOG_WARNING, "%s: accept failed: %m", p->name);
283 if ((peer->input.id = fd_select(peer->input.fd, lsock_input,
284 peer, NULL)) == NULL) {
285 close(peer->input.fd);
290 LIST_INSERT_HEAD(&p->peers, peer, link);
294 * Create a local socket
297 lsock_init_port(struct tport *tp)
299 struct lsock_port *p = (struct lsock_port *)tp;
300 struct sockaddr_un sa;
302 if (p->type == LOCP_STREAM_PRIV || p->type == LOCP_STREAM_UNPRIV) {
303 if ((p->str_sock = socket(PF_LOCAL, SOCK_STREAM, 0)) < 0) {
304 syslog(LOG_ERR, "creating local socket: %m");
305 return (SNMP_ERR_RES_UNAVAIL);
308 strcpy(sa.sun_path, p->name);
309 sa.sun_family = AF_LOCAL;
310 sa.sun_len = strlen(p->name) +
311 offsetof(struct sockaddr_un, sun_path);
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 strcpy(sa.sun_path, p->name);
364 sa.sun_family = AF_LOCAL;
365 sa.sun_len = strlen(p->name) +
366 offsetof(struct sockaddr_un, sun_path);
368 (void)remove(p->name);
370 if (bind(peer->input.fd, (struct sockaddr *)&sa, sizeof(sa))) {
371 if (errno == EADDRNOTAVAIL) {
372 close(peer->input.fd);
374 return (SNMP_ERR_INCONS_NAME);
376 syslog(LOG_ERR, "bind: %s %m", p->name);
377 close(peer->input.fd);
379 return (SNMP_ERR_GENERR);
381 if (chmod(p->name, 0666) == -1)
382 syslog(LOG_WARNING, "chmod(%s,0666): %m", p->name);
384 peer->input.id = fd_select(peer->input.fd, lsock_input,
386 if (peer->input.id == NULL) {
387 (void)remove(p->name);
388 close(peer->input.fd);
390 return (SNMP_ERR_GENERR);
393 return (SNMP_ERR_NOERROR);
400 lsock_send(struct tport *tp, const u_char *buf, size_t len,
401 const struct sockaddr *addr, size_t addrlen)
403 struct lsock_port *p = (struct lsock_port *)tp;
404 struct lsock_peer *peer;
406 if (p->type == LOCP_DGRAM_PRIV || p->type == LOCP_DGRAM_UNPRIV) {
407 peer = LIST_FIRST(&p->peers);
410 /* search for the peer */
411 LIST_FOREACH(peer, &p->peers, link)
412 if (peer->input.peerlen == addrlen &&
413 memcmp(peer->input.peer, addr, addrlen) == 0)
421 return (sendto(peer->input.fd, buf, len, 0, addr, addrlen));
425 * Dependency to create a lsock port
428 struct snmp_dependency dep;
430 /* index (path name) */
435 struct lsock_port *port;
437 /* which of the fields are set */
440 /* type of the port */
447 #define LD_STATUS 0x02
448 #define LD_CREATE 0x04 /* rollback create */
449 #define LD_DELETE 0x08 /* rollback delete */
452 * dependency handler for lsock ports
455 lsock_func(struct snmp_context *ctx, struct snmp_dependency *dep,
458 struct lsock_dep *ld = (struct lsock_dep *)(void *)dep;
459 int err = SNMP_ERR_NOERROR;
463 case SNMP_DEPOP_COMMIT:
464 if (!(ld->set & LD_STATUS))
465 err = SNMP_ERR_BADVALUE;
466 else if (ld->port == NULL) {
468 err = SNMP_ERR_BADVALUE;
472 err = lsock_open_port(ld->path, ld->pathlen,
473 &ld->port, ld->type);
474 if (err == SNMP_ERR_NOERROR)
475 ld->set |= LD_CREATE;
477 } else if (!ld->status) {
478 /* delete - hard to roll back so defer to finalizer */
479 ld->set |= LD_DELETE;
481 /* modify - read-only */
482 err = SNMP_ERR_READONLY;
486 case SNMP_DEPOP_ROLLBACK:
487 if (ld->set & LD_CREATE) {
489 lsock_close_port(&ld->port->tport);
491 return (SNMP_ERR_NOERROR);
493 case SNMP_DEPOP_FINISH:
494 if ((ld->set & LD_DELETE) && ctx->code == SNMP_RET_OK)
495 lsock_close_port(&ld->port->tport);
497 return (SNMP_ERR_NOERROR);
506 op_lsock_port(struct snmp_context *ctx, struct snmp_value *value,
507 u_int sub, u_int iidx, enum snmp_op op)
509 asn_subid_t which = value->var.subs[sub-1];
510 struct lsock_port *p;
513 struct lsock_dep *ld;
518 case SNMP_OP_GETNEXT:
519 if ((p = (struct lsock_port *)trans_next_port(my_trans,
520 &value->var, sub)) == NULL)
521 return (SNMP_ERR_NOSUCHNAME);
522 index_append(&value->var, sub, &p->tport.index);
526 if ((p = (struct lsock_port *)trans_find_port(my_trans,
527 &value->var, sub)) == NULL)
528 return (SNMP_ERR_NOSUCHNAME);
532 p = (struct lsock_port *)trans_find_port(my_trans,
535 if (index_decode(&value->var, sub, iidx, &name, &namelen))
536 return (SNMP_ERR_NO_CREATION);
538 asn_slice_oid(&didx, &value->var, sub, value->var.len);
539 if ((ld = (struct lsock_dep *)(void *)snmp_dep_lookup(ctx,
540 &oid_begemotSnmpdLocalPortTable, &didx, sizeof(*ld),
541 lsock_func)) == NULL) {
543 return (SNMP_ERR_GENERR);
546 if (ld->path == NULL) {
548 ld->pathlen = namelen;
556 case LEAF_begemotSnmpdLocalPortStatus:
557 if (ld->set & LD_STATUS)
558 return (SNMP_ERR_INCONS_VALUE);
559 if (!TRUTH_OK(value->v.integer))
560 return (SNMP_ERR_WRONG_VALUE);
562 ld->status = TRUTH_GET(value->v.integer);
563 ld->set |= LD_STATUS;
566 case LEAF_begemotSnmpdLocalPortType:
567 if (ld->set & LD_TYPE)
568 return (SNMP_ERR_INCONS_VALUE);
569 if (value->v.integer < 1 || value->v.integer > 4)
570 return (SNMP_ERR_WRONG_VALUE);
572 ld->type = value->v.integer;
576 return (SNMP_ERR_NOERROR);
578 case SNMP_OP_ROLLBACK:
580 return (SNMP_ERR_NOERROR);
587 * Come here to fetch the value
591 case LEAF_begemotSnmpdLocalPortStatus:
592 value->v.integer = 1;
595 case LEAF_begemotSnmpdLocalPortType:
596 value->v.integer = p->type;
603 return (SNMP_ERR_NOERROR);