1 /* $OpenBSD: control.c,v 1.112 2023/08/04 09:20:12 claudio Exp $ */ 2 3 /* 4 * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/types.h> 20 #include <sys/stat.h> 21 #include <sys/socket.h> 22 #include <sys/un.h> 23 #include <errno.h> 24 #include <stdlib.h> 25 #include <string.h> 26 #include <unistd.h> 27 28 #include "bgpd.h" 29 #include "session.h" 30 #include "log.h" 31 32 TAILQ_HEAD(ctl_conns, ctl_conn) ctl_conns = TAILQ_HEAD_INITIALIZER(ctl_conns); 33 34 #define CONTROL_BACKLOG 5 35 36 struct ctl_conn *control_connbyfd(int); 37 struct ctl_conn *control_connbypid(pid_t); 38 int control_close(struct ctl_conn *); 39 void control_result(struct ctl_conn *, u_int); 40 ssize_t imsg_read_nofd(struct imsgbuf *); 41 42 int 43 control_check(char *path) 44 { 45 struct sockaddr_un sa_un; 46 int fd; 47 48 memset(&sa_un, 0, sizeof(sa_un)); 49 sa_un.sun_family = AF_UNIX; 50 strlcpy(sa_un.sun_path, path, sizeof(sa_un.sun_path)); 51 52 if ((fd = socket(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0)) == -1) { 53 log_warn("%s: socket", __func__); 54 return (-1); 55 } 56 57 if (connect(fd, (struct sockaddr *)&sa_un, sizeof(sa_un)) == 0) { 58 log_warnx("control socket %s already in use", path); 59 close(fd); 60 return (-1); 61 } 62 63 close(fd); 64 65 return (0); 66 } 67 68 int 69 control_init(int restricted, char *path) 70 { 71 struct sockaddr_un sa_un; 72 int fd; 73 mode_t old_umask, mode; 74 75 if ((fd = socket(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 76 0)) == -1) { 77 log_warn("control_init: socket"); 78 return (-1); 79 } 80 81 memset(&sa_un, 0, sizeof(sa_un)); 82 sa_un.sun_family = AF_UNIX; 83 if (strlcpy(sa_un.sun_path, path, sizeof(sa_un.sun_path)) >= 84 sizeof(sa_un.sun_path)) { 85 log_warn("control_init: socket name too long"); 86 close(fd); 87 return (-1); 88 } 89 90 if (unlink(path) == -1) 91 if (errno != ENOENT) { 92 log_warn("control_init: unlink %s", path); 93 close(fd); 94 return (-1); 95 } 96 97 if (restricted) { 98 old_umask = umask(S_IXUSR|S_IXGRP|S_IXOTH); 99 mode = S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH; 100 } else { 101 old_umask = umask(S_IXUSR|S_IXGRP|S_IWOTH|S_IROTH|S_IXOTH); 102 mode = S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP; 103 } 104 105 if (bind(fd, (struct sockaddr *)&sa_un, sizeof(sa_un)) == -1) { 106 log_warn("control_init: bind: %s", path); 107 close(fd); 108 umask(old_umask); 109 return (-1); 110 } 111 112 umask(old_umask); 113 114 if (chmod(path, mode) == -1) { 115 log_warn("control_init: chmod: %s", path); 116 close(fd); 117 unlink(path); 118 return (-1); 119 } 120 121 return (fd); 122 } 123 124 int 125 control_listen(int fd) 126 { 127 if (fd != -1 && listen(fd, CONTROL_BACKLOG) == -1) { 128 log_warn("control_listen: listen"); 129 return (-1); 130 } 131 132 return (0); 133 } 134 135 void 136 control_shutdown(int fd) 137 { 138 close(fd); 139 } 140 141 size_t 142 control_fill_pfds(struct pollfd *pfd, size_t size) 143 { 144 struct ctl_conn *ctl_conn; 145 size_t i = 0; 146 147 TAILQ_FOREACH(ctl_conn, &ctl_conns, entry) { 148 pfd[i].fd = ctl_conn->ibuf.fd; 149 pfd[i].events = POLLIN; 150 if (ctl_conn->ibuf.w.queued > 0) 151 pfd[i].events |= POLLOUT; 152 i++; 153 } 154 return i; 155 } 156 157 unsigned int 158 control_accept(int listenfd, int restricted) 159 { 160 int connfd; 161 socklen_t len; 162 struct sockaddr_un sa_un; 163 struct ctl_conn *ctl_conn; 164 165 len = sizeof(sa_un); 166 if ((connfd = accept4(listenfd, 167 (struct sockaddr *)&sa_un, &len, 168 SOCK_NONBLOCK | SOCK_CLOEXEC)) == -1) { 169 if (errno == ENFILE || errno == EMFILE) { 170 pauseaccept = getmonotime(); 171 return (0); 172 } else if (errno != EWOULDBLOCK && errno != EINTR && 173 errno != ECONNABORTED) 174 log_warn("control_accept: accept"); 175 return (0); 176 } 177 178 if ((ctl_conn = calloc(1, sizeof(struct ctl_conn))) == NULL) { 179 log_warn("control_accept"); 180 close(connfd); 181 return (0); 182 } 183 184 imsg_init(&ctl_conn->ibuf, connfd); 185 ctl_conn->restricted = restricted; 186 187 TAILQ_INSERT_TAIL(&ctl_conns, ctl_conn, entry); 188 189 return (1); 190 } 191 192 struct ctl_conn * 193 control_connbyfd(int fd) 194 { 195 struct ctl_conn *c; 196 197 TAILQ_FOREACH(c, &ctl_conns, entry) { 198 if (c->ibuf.fd == fd) 199 break; 200 } 201 202 return (c); 203 } 204 205 struct ctl_conn * 206 control_connbypid(pid_t pid) 207 { 208 struct ctl_conn *c; 209 210 TAILQ_FOREACH(c, &ctl_conns, entry) { 211 if (c->ibuf.pid == pid) 212 break; 213 } 214 215 return (c); 216 } 217 218 int 219 control_close(struct ctl_conn *c) 220 { 221 if (c->terminate && c->ibuf.pid) 222 imsg_ctl_rde(IMSG_CTL_TERMINATE, 0, c->ibuf.pid, NULL, 0); 223 224 msgbuf_clear(&c->ibuf.w); 225 TAILQ_REMOVE(&ctl_conns, c, entry); 226 227 close(c->ibuf.fd); 228 free(c); 229 pauseaccept = 0; 230 return (1); 231 } 232 233 int 234 control_dispatch_msg(struct pollfd *pfd, struct peer_head *peers) 235 { 236 struct imsg imsg; 237 struct ctl_conn *c; 238 ssize_t n; 239 int verbose, matched; 240 struct peer *p; 241 struct ctl_neighbor *neighbor; 242 struct ctl_show_rib_request *ribreq; 243 244 if ((c = control_connbyfd(pfd->fd)) == NULL) { 245 log_warn("control_dispatch_msg: fd %d: not found", pfd->fd); 246 return (0); 247 } 248 249 if (pfd->revents & POLLOUT) { 250 if (msgbuf_write(&c->ibuf.w) <= 0 && errno != EAGAIN) 251 return control_close(c); 252 if (c->throttled && c->ibuf.w.queued < CTL_MSG_LOW_MARK) { 253 if (imsg_ctl_rde(IMSG_XON, 0, c->ibuf.pid, NULL, 0) != 254 -1) 255 c->throttled = 0; 256 } 257 } 258 259 if (!(pfd->revents & POLLIN)) 260 return (0); 261 262 if (((n = imsg_read_nofd(&c->ibuf)) == -1 && errno != EAGAIN) || 263 n == 0) 264 return control_close(c); 265 266 for (;;) { 267 if ((n = imsg_get(&c->ibuf, &imsg)) == -1) 268 return control_close(c); 269 270 if (n == 0) 271 break; 272 273 if (c->restricted) { 274 switch (imsg.hdr.type) { 275 case IMSG_CTL_SHOW_NEIGHBOR: 276 case IMSG_CTL_SHOW_NEXTHOP: 277 case IMSG_CTL_SHOW_INTERFACE: 278 case IMSG_CTL_SHOW_RIB_MEM: 279 case IMSG_CTL_SHOW_TERSE: 280 case IMSG_CTL_SHOW_TIMER: 281 case IMSG_CTL_SHOW_NETWORK: 282 case IMSG_CTL_SHOW_FLOWSPEC: 283 case IMSG_CTL_SHOW_RIB: 284 case IMSG_CTL_SHOW_RIB_PREFIX: 285 case IMSG_CTL_SHOW_SET: 286 case IMSG_CTL_SHOW_RTR: 287 break; 288 default: 289 /* clear imsg type to prevent processing */ 290 imsg.hdr.type = IMSG_NONE; 291 control_result(c, CTL_RES_DENIED); 292 break; 293 } 294 } 295 296 switch (imsg.hdr.type) { 297 case IMSG_NONE: 298 /* message was filtered out, nothing to do */ 299 break; 300 case IMSG_CTL_FIB_COUPLE: 301 case IMSG_CTL_FIB_DECOUPLE: 302 imsg_ctl_parent(imsg.hdr.type, imsg.hdr.peerid, 303 0, NULL, 0); 304 break; 305 case IMSG_CTL_SHOW_TERSE: 306 RB_FOREACH(p, peer_head, peers) 307 imsg_compose(&c->ibuf, IMSG_CTL_SHOW_NEIGHBOR, 308 0, 0, -1, p, sizeof(struct peer)); 309 imsg_compose(&c->ibuf, IMSG_CTL_END, 0, 0, -1, NULL, 0); 310 break; 311 case IMSG_CTL_SHOW_NEIGHBOR: 312 c->ibuf.pid = imsg.hdr.pid; 313 314 if (imsg.hdr.len == IMSG_HEADER_SIZE + 315 sizeof(struct ctl_neighbor)) { 316 neighbor = imsg.data; 317 } else { 318 neighbor = NULL; 319 } 320 matched = 0; 321 RB_FOREACH(p, peer_head, peers) { 322 if (!peer_matched(p, neighbor)) 323 continue; 324 325 matched = 1; 326 if (!neighbor || !neighbor->show_timers) { 327 imsg_ctl_rde(imsg.hdr.type, p->conf.id, 328 imsg.hdr.pid, NULL, 0); 329 } else { 330 u_int i; 331 time_t d; 332 struct ctl_timer ct; 333 334 imsg_compose(&c->ibuf, 335 IMSG_CTL_SHOW_NEIGHBOR, 336 0, 0, -1, p, sizeof(*p)); 337 for (i = 1; i < Timer_Max; i++) { 338 if (!timer_running(&p->timers, 339 i, &d)) 340 continue; 341 ct.type = i; 342 ct.val = d; 343 imsg_compose(&c->ibuf, 344 IMSG_CTL_SHOW_TIMER, 345 0, 0, -1, &ct, sizeof(ct)); 346 } 347 } 348 } 349 if (!matched && RB_EMPTY(peers)) { 350 control_result(c, CTL_RES_NOSUCHPEER); 351 } else if (!neighbor || !neighbor->show_timers) { 352 imsg_ctl_rde(IMSG_CTL_END, 0, imsg.hdr.pid, 353 NULL, 0); 354 } else { 355 imsg_compose(&c->ibuf, IMSG_CTL_END, 0, 0, -1, 356 NULL, 0); 357 } 358 break; 359 case IMSG_CTL_NEIGHBOR_UP: 360 case IMSG_CTL_NEIGHBOR_DOWN: 361 case IMSG_CTL_NEIGHBOR_CLEAR: 362 case IMSG_CTL_NEIGHBOR_RREFRESH: 363 case IMSG_CTL_NEIGHBOR_DESTROY: 364 if (imsg.hdr.len != IMSG_HEADER_SIZE + 365 sizeof(struct ctl_neighbor)) { 366 log_warnx("got IMSG_CTL_NEIGHBOR_ with " 367 "wrong length"); 368 break; 369 } 370 371 neighbor = imsg.data; 372 373 matched = 0; 374 RB_FOREACH(p, peer_head, peers) { 375 if (!peer_matched(p, neighbor)) 376 continue; 377 378 matched = 1; 379 380 switch (imsg.hdr.type) { 381 case IMSG_CTL_NEIGHBOR_UP: 382 bgp_fsm(p, EVNT_START); 383 p->conf.down = 0; 384 p->conf.reason[0] = '\0'; 385 p->IdleHoldTime = 386 INTERVAL_IDLE_HOLD_INITIAL; 387 p->errcnt = 0; 388 control_result(c, CTL_RES_OK); 389 break; 390 case IMSG_CTL_NEIGHBOR_DOWN: 391 p->conf.down = 1; 392 strlcpy(p->conf.reason, 393 neighbor->reason, 394 sizeof(p->conf.reason)); 395 session_stop(p, ERR_CEASE_ADMIN_DOWN); 396 control_result(c, CTL_RES_OK); 397 break; 398 case IMSG_CTL_NEIGHBOR_CLEAR: 399 strlcpy(p->conf.reason, 400 neighbor->reason, 401 sizeof(p->conf.reason)); 402 p->IdleHoldTime = 403 INTERVAL_IDLE_HOLD_INITIAL; 404 p->errcnt = 0; 405 if (!p->conf.down) { 406 session_stop(p, 407 ERR_CEASE_ADMIN_RESET); 408 timer_set(&p->timers, 409 Timer_IdleHold, 410 SESSION_CLEAR_DELAY); 411 } else { 412 session_stop(p, 413 ERR_CEASE_ADMIN_DOWN); 414 } 415 control_result(c, CTL_RES_OK); 416 break; 417 case IMSG_CTL_NEIGHBOR_RREFRESH: 418 if (session_neighbor_rrefresh(p)) 419 control_result(c, 420 CTL_RES_NOCAP); 421 else 422 control_result(c, CTL_RES_OK); 423 break; 424 case IMSG_CTL_NEIGHBOR_DESTROY: 425 if (!p->template) 426 control_result(c, 427 CTL_RES_BADPEER); 428 else if (p->state != STATE_IDLE) 429 control_result(c, 430 CTL_RES_BADSTATE); 431 else { 432 /* 433 * Mark as deleted, will be 434 * collected on next poll loop. 435 */ 436 p->reconf_action = 437 RECONF_DELETE; 438 control_result(c, CTL_RES_OK); 439 } 440 break; 441 default: 442 fatal("king bula wants more humppa"); 443 } 444 } 445 if (!matched) 446 control_result(c, CTL_RES_NOSUCHPEER); 447 break; 448 case IMSG_CTL_RELOAD: 449 case IMSG_CTL_SHOW_INTERFACE: 450 case IMSG_CTL_SHOW_FIB_TABLES: 451 case IMSG_CTL_SHOW_RTR: 452 c->ibuf.pid = imsg.hdr.pid; 453 imsg_ctl_parent(imsg.hdr.type, 0, imsg.hdr.pid, 454 imsg.data, imsg.hdr.len - IMSG_HEADER_SIZE); 455 break; 456 case IMSG_CTL_KROUTE: 457 case IMSG_CTL_KROUTE_ADDR: 458 case IMSG_CTL_SHOW_NEXTHOP: 459 c->ibuf.pid = imsg.hdr.pid; 460 imsg_ctl_parent(imsg.hdr.type, imsg.hdr.peerid, 461 imsg.hdr.pid, imsg.data, imsg.hdr.len - 462 IMSG_HEADER_SIZE); 463 break; 464 case IMSG_CTL_SHOW_RIB: 465 case IMSG_CTL_SHOW_RIB_PREFIX: 466 if (imsg.hdr.len != IMSG_HEADER_SIZE + 467 sizeof(struct ctl_show_rib_request)) { 468 log_warnx("got IMSG_CTL_SHOW_RIB with " 469 "wrong length"); 470 break; 471 } 472 473 ribreq = imsg.data; 474 neighbor = &ribreq->neighbor; 475 476 /* check if at least one neighbor exists */ 477 RB_FOREACH(p, peer_head, peers) 478 if (peer_matched(p, neighbor)) 479 break; 480 if (p == NULL && RB_EMPTY(peers)) { 481 control_result(c, CTL_RES_NOSUCHPEER); 482 break; 483 } 484 485 if ((imsg.hdr.type == IMSG_CTL_SHOW_RIB_PREFIX) 486 && (ribreq->prefix.aid == AID_UNSPEC)) { 487 /* malformed request, must specify af */ 488 control_result(c, CTL_RES_PARSE_ERROR); 489 break; 490 } 491 492 c->ibuf.pid = imsg.hdr.pid; 493 c->terminate = 1; 494 495 imsg_ctl_rde(imsg.hdr.type, 0, imsg.hdr.pid, 496 imsg.data, imsg.hdr.len - IMSG_HEADER_SIZE); 497 break; 498 case IMSG_CTL_SHOW_NETWORK: 499 case IMSG_CTL_SHOW_FLOWSPEC: 500 c->terminate = 1; 501 /* FALLTHROUGH */ 502 case IMSG_CTL_SHOW_RIB_MEM: 503 case IMSG_CTL_SHOW_SET: 504 c->ibuf.pid = imsg.hdr.pid; 505 imsg_ctl_rde(imsg.hdr.type, 0, imsg.hdr.pid, 506 imsg.data, imsg.hdr.len - IMSG_HEADER_SIZE); 507 break; 508 case IMSG_NETWORK_ADD: 509 case IMSG_NETWORK_ASPATH: 510 case IMSG_NETWORK_ATTR: 511 case IMSG_NETWORK_REMOVE: 512 case IMSG_NETWORK_FLUSH: 513 case IMSG_NETWORK_DONE: 514 case IMSG_FLOWSPEC_ADD: 515 case IMSG_FLOWSPEC_REMOVE: 516 case IMSG_FLOWSPEC_DONE: 517 case IMSG_FLOWSPEC_FLUSH: 518 case IMSG_FILTER_SET: 519 imsg_ctl_rde(imsg.hdr.type, 0, 0, 520 imsg.data, imsg.hdr.len - IMSG_HEADER_SIZE); 521 break; 522 case IMSG_CTL_LOG_VERBOSE: 523 if (imsg.hdr.len != IMSG_HEADER_SIZE + 524 sizeof(verbose)) 525 break; 526 527 /* forward to other processes */ 528 imsg_ctl_parent(imsg.hdr.type, 0, imsg.hdr.pid, 529 imsg.data, imsg.hdr.len - IMSG_HEADER_SIZE); 530 imsg_ctl_rde(imsg.hdr.type, 0, imsg.hdr.pid, 531 imsg.data, imsg.hdr.len - IMSG_HEADER_SIZE); 532 533 memcpy(&verbose, imsg.data, sizeof(verbose)); 534 log_setverbose(verbose); 535 break; 536 default: 537 break; 538 } 539 imsg_free(&imsg); 540 } 541 542 return (0); 543 } 544 545 int 546 control_imsg_relay(struct imsg *imsg, struct peer *p) 547 { 548 struct ctl_conn *c; 549 550 if ((c = control_connbypid(imsg->hdr.pid)) == NULL) 551 return (0); 552 553 /* special handling for peers since only the stats are sent from RDE */ 554 if (imsg->hdr.type == IMSG_CTL_SHOW_NEIGHBOR) { 555 struct rde_peer_stats stats; 556 557 if (imsg->hdr.len > IMSG_HEADER_SIZE + sizeof(stats)) { 558 log_warnx("wrong imsg len"); 559 return (0); 560 } 561 if (p == NULL) { 562 log_warnx("no such peer: id=%u", imsg->hdr.peerid); 563 return (0); 564 } 565 memcpy(&stats, imsg->data, sizeof(stats)); 566 p->stats.prefix_cnt = stats.prefix_cnt; 567 p->stats.prefix_out_cnt = stats.prefix_out_cnt; 568 p->stats.prefix_rcvd_update = stats.prefix_rcvd_update; 569 p->stats.prefix_rcvd_withdraw = stats.prefix_rcvd_withdraw; 570 p->stats.prefix_rcvd_eor = stats.prefix_rcvd_eor; 571 p->stats.prefix_sent_update = stats.prefix_sent_update; 572 p->stats.prefix_sent_withdraw = stats.prefix_sent_withdraw; 573 p->stats.prefix_sent_eor = stats.prefix_sent_eor; 574 p->stats.pending_update = stats.pending_update; 575 p->stats.pending_withdraw = stats.pending_withdraw; 576 577 return (imsg_compose(&c->ibuf, imsg->hdr.type, 0, 578 imsg->hdr.pid, -1, p, sizeof(*p))); 579 } 580 581 /* if command finished no need to send exit message */ 582 if (imsg->hdr.type == IMSG_CTL_END || imsg->hdr.type == IMSG_CTL_RESULT) 583 c->terminate = 0; 584 585 if (!c->throttled && c->ibuf.w.queued > CTL_MSG_HIGH_MARK) { 586 if (imsg_ctl_rde(IMSG_XOFF, 0, imsg->hdr.pid, NULL, 0) != -1) 587 c->throttled = 1; 588 } 589 590 return (imsg_compose(&c->ibuf, imsg->hdr.type, 0, imsg->hdr.pid, -1, 591 imsg->data, imsg->hdr.len - IMSG_HEADER_SIZE)); 592 } 593 594 void 595 control_result(struct ctl_conn *c, u_int code) 596 { 597 imsg_compose(&c->ibuf, IMSG_CTL_RESULT, 0, c->ibuf.pid, -1, 598 &code, sizeof(code)); 599 } 600 601 /* This should go into libutil, from smtpd/mproc.c */ 602 ssize_t 603 imsg_read_nofd(struct imsgbuf *ibuf) 604 { 605 ssize_t n; 606 char *buf; 607 size_t len; 608 609 buf = ibuf->r.buf + ibuf->r.wpos; 610 len = sizeof(ibuf->r.buf) - ibuf->r.wpos; 611 612 while ((n = recv(ibuf->fd, buf, len, 0)) == -1) { 613 if (errno != EINTR) 614 return (n); 615 } 616 617 ibuf->r.wpos += n; 618 return (n); 619 } 620