1 /* $OpenBSD: sendbug.c,v 1.42 2007/04/07 04:58:50 ray Exp $ */ 2 3 /* 4 * Written by Ray Lai <ray@cyth.net>. 5 * Public domain. 6 */ 7 8 #include <sys/types.h> 9 #include <sys/mman.h> 10 #include <sys/param.h> 11 #include <sys/stat.h> 12 #include <sys/sysctl.h> 13 #include <sys/wait.h> 14 15 #include <ctype.h> 16 #include <err.h> 17 #include <errno.h> 18 #include <fcntl.h> 19 #include <limits.h> 20 #include <paths.h> 21 #include <pwd.h> 22 #include <signal.h> 23 #include <stdio.h> 24 #include <stdlib.h> 25 #include <string.h> 26 #include <unistd.h> 27 28 #include "atomicio.h" 29 30 #define _PATH_DMESG "/var/run/dmesg.boot" 31 32 int checkfile(const char *); 33 void dmesg(FILE *); 34 int editit(const char *); 35 void init(void); 36 int matchline(const char *, const char *, size_t); 37 int prompt(void); 38 int send_file(const char *, int); 39 int sendmail(const char *); 40 void template(FILE *); 41 42 const char *categories = "system user library documentation ports kernel " 43 "alpha amd64 arm i386 m68k m88k mips ppc sgi sparc sparc64 vax"; 44 char *version = "4.2"; 45 46 struct passwd *pw; 47 char os[BUFSIZ], rel[BUFSIZ], mach[BUFSIZ], details[BUFSIZ]; 48 char *fullname, *tmppath; 49 int wantcleanup; 50 51 __dead void 52 usage(void) 53 { 54 extern char *__progname; 55 56 fprintf(stderr, "usage: %s [-DLPV]\n", __progname); 57 exit(1); 58 } 59 60 void 61 cleanup() 62 { 63 if (wantcleanup && tmppath && unlink(tmppath) == -1) 64 warn("unlink"); 65 } 66 67 68 int 69 main(int argc, char *argv[]) 70 { 71 int ch, c, Dflag = 0, fd, ret = 1; 72 const char *tmpdir; 73 struct stat sb; 74 char *pr_form; 75 time_t mtime; 76 FILE *fp; 77 78 while ((ch = getopt(argc, argv, "DLPV")) != -1) 79 switch (ch) { 80 case 'D': 81 Dflag = 1; 82 break; 83 case 'L': 84 printf("Known categories:\n"); 85 printf("%s\n\n", categories); 86 exit(0); 87 case 'P': 88 init(); 89 template(stdout); 90 exit(0); 91 case 'V': 92 printf("%s\n", version); 93 exit(0); 94 default: 95 usage(); 96 } 97 argc -= optind; 98 argv += optind; 99 100 if (argc > 0) 101 usage(); 102 103 if ((tmpdir = getenv("TMPDIR")) == NULL || tmpdir[0] == '\0') 104 tmpdir = _PATH_TMP; 105 if (asprintf(&tmppath, "%s%sp.XXXXXXXXXX", tmpdir, 106 tmpdir[strlen(tmpdir) - 1] == '/' ? "" : "/") == -1) 107 err(1, "asprintf"); 108 if ((fd = mkstemp(tmppath)) == -1) 109 err(1, "mkstemp"); 110 wantcleanup = 1; 111 atexit(cleanup); 112 if ((fp = fdopen(fd, "w+")) == NULL) 113 err(1, "fdopen"); 114 115 init(); 116 117 pr_form = getenv("PR_FORM"); 118 if (pr_form) { 119 char buf[BUFSIZ]; 120 size_t len; 121 FILE *frfp; 122 123 frfp = fopen(pr_form, "r"); 124 if (frfp == NULL) { 125 warn("can't seem to read your template file " 126 "(`%s'), ignoring PR_FORM", pr_form); 127 template(fp); 128 } else { 129 while (!feof(frfp)) { 130 len = fread(buf, 1, sizeof buf, frfp); 131 if (len == 0) 132 break; 133 if (fwrite(buf, 1, len, fp) != len) 134 break; 135 } 136 fclose(frfp); 137 } 138 } else { 139 template(fp); 140 if (!Dflag) 141 dmesg(fp); 142 } 143 144 if (fflush(fp) == EOF || fstat(fd, &sb) == -1 || fclose(fp) == EOF) 145 err(1, "error creating template"); 146 mtime = sb.st_mtime; 147 148 edit: 149 if (editit(tmppath) == -1 && errno != ECHILD) 150 err(1, "error running editor"); 151 152 if (stat(tmppath, &sb) == -1) 153 err(1, "stat"); 154 if (mtime == sb.st_mtime) 155 errx(1, "report unchanged, nothing sent"); 156 157 prompt: 158 if (!checkfile(tmppath)) 159 fprintf(stderr, "fields are blank, must be filled in\n"); 160 c = prompt(); 161 switch (c) { 162 case 'a': 163 case EOF: 164 wantcleanup = 0; 165 errx(1, "unsent report in %s", tmppath); 166 case 'e': 167 goto edit; 168 case 's': 169 if (sendmail(tmppath) == -1) 170 goto quit; 171 break; 172 default: 173 goto prompt; 174 } 175 176 ret = 0; 177 quit: 178 return (ret); 179 } 180 181 void 182 dmesg(FILE *fp) 183 { 184 char buf[BUFSIZ]; 185 FILE *dfp; 186 off_t offset = -1; 187 188 dfp = fopen(_PATH_DMESG, "r"); 189 if (dfp == NULL) { 190 warn("can't read dmesg"); 191 return; 192 } 193 194 fputs("\n" 195 "<dmesg is attached.>\n" 196 "<Feel free to delete or use the -D flag if it contains " 197 "sensitive information.>\n", fp); 198 /* Find last line starting with "OpenBSD". */ 199 for (;;) { 200 off_t o; 201 202 o = ftello(dfp); 203 if (fgets(buf, sizeof(buf), dfp) == NULL) 204 break; 205 if (!strncmp("OpenBSD ", buf, sizeof("OpenBSD ") - 1)) 206 offset = o; 207 } 208 if (offset != -1) { 209 size_t len; 210 211 clearerr(dfp); 212 fseeko(dfp, offset, SEEK_SET); 213 while (offset != -1 && !feof(dfp)) { 214 len = fread(buf, 1, sizeof buf, dfp); 215 if (len == 0) 216 break; 217 if (fwrite(buf, 1, len, fp) != len) 218 break; 219 } 220 } 221 fclose(dfp); 222 } 223 224 int 225 editit(const char *pathname) 226 { 227 char *argp[] = {"sh", "-c", NULL, NULL}, *ed, *p; 228 sig_t sighup, sigint, sigquit; 229 pid_t pid; 230 int st; 231 232 ed = getenv("VISUAL"); 233 if (ed == NULL || ed[0] == '\0') 234 ed = getenv("EDITOR"); 235 if (ed == NULL || ed[0] == '\0') 236 ed = _PATH_VI; 237 if (asprintf(&p, "%s %s", ed, pathname) == -1) 238 return (-1); 239 argp[2] = p; 240 241 top: 242 sighup = signal(SIGHUP, SIG_IGN); 243 sigint = signal(SIGINT, SIG_IGN); 244 sigquit = signal(SIGQUIT, SIG_IGN); 245 if ((pid = fork()) == -1) { 246 int saved_errno = errno; 247 248 (void)signal(SIGHUP, sighup); 249 (void)signal(SIGINT, sigint); 250 (void)signal(SIGQUIT, sigquit); 251 if (saved_errno == EAGAIN) { 252 sleep(1); 253 goto top; 254 } 255 free(p); 256 errno = saved_errno; 257 return (-1); 258 } 259 if (pid == 0) { 260 execv(_PATH_BSHELL, argp); 261 _exit(127); 262 } 263 free(p); 264 for (;;) { 265 if (waitpid(pid, &st, WUNTRACED) == -1) { 266 if (errno != EINTR) 267 return (-1); 268 } else if (WIFSTOPPED(st)) 269 raise(WSTOPSIG(st)); 270 else 271 break; 272 } 273 (void)signal(SIGHUP, sighup); 274 (void)signal(SIGINT, sigint); 275 (void)signal(SIGQUIT, sigquit); 276 if (!WIFEXITED(st) || WEXITSTATUS(st) != 0) { 277 errno = ECHILD; 278 return (-1); 279 } 280 return (0); 281 } 282 283 int 284 prompt(void) 285 { 286 int c, ret; 287 288 fpurge(stdin); 289 fprintf(stderr, "a)bort, e)dit, or s)end: "); 290 fflush(stderr); 291 ret = getchar(); 292 if (ret == EOF || ret == '\n') 293 return (ret); 294 do { 295 c = getchar(); 296 } while (c != EOF && c != '\n'); 297 return (ret); 298 } 299 300 int 301 sendmail(const char *pathname) 302 { 303 int filedes[2]; 304 305 if (pipe(filedes) == -1) { 306 warn("pipe: unsent report in %s", pathname); 307 return (-1); 308 } 309 switch (fork()) { 310 case -1: 311 warn("fork error: unsent report in %s", 312 pathname); 313 return (-1); 314 case 0: 315 close(filedes[1]); 316 if (dup2(filedes[0], STDIN_FILENO) == -1) { 317 warn("dup2 error: unsent report in %s", 318 pathname); 319 return (-1); 320 } 321 close(filedes[0]); 322 execl("/usr/sbin/sendmail", "sendmail", 323 "-oi", "-t", (void *)NULL); 324 warn("sendmail error: unsent report in %s", 325 pathname); 326 return (-1); 327 default: 328 close(filedes[0]); 329 /* Pipe into sendmail. */ 330 if (send_file(pathname, filedes[1]) == -1) { 331 warn("send_file error: unsent report in %s", 332 pathname); 333 return (-1); 334 } 335 close(filedes[1]); 336 wait(NULL); 337 break; 338 } 339 return (0); 340 } 341 342 void 343 init(void) 344 { 345 size_t amp, len, gecoslen, namelen; 346 int sysname[2]; 347 char ch, *cp; 348 349 if ((pw = getpwuid(getuid())) == NULL) 350 err(1, "getpwuid"); 351 namelen = strlen(pw->pw_name); 352 353 /* Count number of '&'. */ 354 for (amp = 0, cp = pw->pw_gecos; *cp && *cp != ','; ++cp) 355 if (*cp == '&') 356 ++amp; 357 358 /* Truncate gecos to full name. */ 359 gecoslen = cp - pw->pw_gecos; 360 pw->pw_gecos[gecoslen] = '\0'; 361 362 /* Expanded str = orig str - '&' chars + concatenated logins. */ 363 len = gecoslen - amp + (amp * namelen) + 1; 364 if ((fullname = malloc(len)) == NULL) 365 err(1, "malloc"); 366 367 /* Upper case first char of login. */ 368 ch = pw->pw_name[0]; 369 pw->pw_name[0] = toupper((unsigned char)pw->pw_name[0]); 370 371 cp = pw->pw_gecos; 372 fullname[0] = '\0'; 373 while (cp != NULL) { 374 char *token; 375 376 token = strsep(&cp, "&"); 377 if (token != pw->pw_gecos && 378 strlcat(fullname, pw->pw_name, len) >= len) 379 errx(1, "truncated string"); 380 if (strlcat(fullname, token, len) >= len) 381 errx(1, "truncated string"); 382 } 383 /* Restore case of first char of login. */ 384 pw->pw_name[0] = ch; 385 386 sysname[0] = CTL_KERN; 387 sysname[1] = KERN_OSTYPE; 388 len = sizeof(os) - 1; 389 if (sysctl(sysname, 2, &os, &len, NULL, 0) == -1) 390 err(1, "sysctl"); 391 392 sysname[0] = CTL_KERN; 393 sysname[1] = KERN_OSRELEASE; 394 len = sizeof(rel) - 1; 395 if (sysctl(sysname, 2, &rel, &len, NULL, 0) == -1) 396 err(1, "sysctl"); 397 398 sysname[0] = CTL_KERN; 399 sysname[1] = KERN_VERSION; 400 len = sizeof(details) - 1; 401 if (sysctl(sysname, 2, &details, &len, NULL, 0) == -1) 402 err(1, "sysctl"); 403 404 cp = strchr(details, '\n'); 405 if (cp) { 406 cp++; 407 if (*cp) 408 *cp++ = '\t'; 409 if (*cp) 410 *cp++ = '\t'; 411 if (*cp) 412 *cp++ = '\t'; 413 } 414 415 sysname[0] = CTL_HW; 416 sysname[1] = HW_MACHINE; 417 len = sizeof(mach) - 1; 418 if (sysctl(sysname, 2, &mach, &len, NULL, 0) == -1) 419 err(1, "sysctl"); 420 } 421 422 int 423 send_file(const char *file, int dst) 424 { 425 int blank = 0; 426 size_t len; 427 char *buf; 428 FILE *fp; 429 430 if ((fp = fopen(file, "r")) == NULL) 431 return (-1); 432 while ((buf = fgetln(fp, &len))) { 433 /* Skip lines starting with "SENDBUG". */ 434 if (len >= sizeof("SENDBUG") - 1 && 435 memcmp(buf, "SENDBUG", sizeof("SENDBUG") - 1) == 0) 436 continue; 437 if (len == 1 && buf[0] == '\n') 438 blank = 1; 439 /* Skip comments, but only if we encountered a blank line. */ 440 while (len) { 441 char *sp = NULL, *ep = NULL; 442 size_t copylen; 443 444 if (blank && (sp = memchr(buf, '<', len)) != NULL) 445 ep = memchr(sp, '>', len - (sp - buf + 1)); 446 /* Length of string before comment. */ 447 if (ep) 448 copylen = sp - buf; 449 else 450 copylen = len; 451 if (atomicio(vwrite, dst, buf, copylen) != copylen) { 452 int saved_errno = errno; 453 454 fclose(fp); 455 errno = saved_errno; 456 return (-1); 457 } 458 if (!ep) 459 break; 460 /* Skip comment. */ 461 len -= ep - buf + 1; 462 buf = ep + 1; 463 } 464 } 465 fclose(fp); 466 return (0); 467 } 468 469 /* 470 * Does line start with `s' and end with non-comment and non-whitespace? 471 * Note: Does not treat `line' as a C string. 472 */ 473 int 474 matchline(const char *s, const char *line, size_t linelen) 475 { 476 size_t slen; 477 int comment; 478 479 slen = strlen(s); 480 /* Is line shorter than string? */ 481 if (linelen <= slen) 482 return (0); 483 /* Does line start with string? */ 484 if (memcmp(line, s, slen) != 0) 485 return (0); 486 /* Does line contain anything but comments and whitespace? */ 487 line += slen; 488 linelen -= slen; 489 comment = 0; 490 while (linelen) { 491 if (comment) { 492 if (*line == '>') 493 comment = 0; 494 } else if (*line == '<') 495 comment = 1; 496 else if (!isspace((unsigned char)*line)) 497 return (1); 498 ++line; 499 --linelen; 500 } 501 return (0); 502 } 503 504 /* 505 * Are all required fields filled out? 506 */ 507 int 508 checkfile(const char *pathname) 509 { 510 FILE *fp; 511 size_t len; 512 int category, class, priority, release, severity, synopsis; 513 char *buf; 514 515 if ((fp = fopen(pathname, "r")) == NULL) { 516 warn("%s", pathname); 517 return (0); 518 } 519 category = class = priority = release = severity = synopsis = 0; 520 while ((buf = fgetln(fp, &len))) { 521 if (matchline(">Category:", buf, len)) 522 category = 1; 523 else if (matchline(">Class:", buf, len)) 524 class = 1; 525 else if (matchline(">Priority:", buf, len)) 526 priority = 1; 527 else if (matchline(">Release:", buf, len)) 528 release = 1; 529 else if (matchline(">Severity:", buf, len)) 530 severity = 1; 531 else if (matchline(">Synopsis:", buf, len)) 532 synopsis = 1; 533 } 534 fclose(fp); 535 return (category && class && priority && release && severity && 536 synopsis); 537 } 538 539 void 540 template(FILE *fp) 541 { 542 fprintf(fp, "SENDBUG: -*- sendbug -*-\n"); 543 fprintf(fp, "SENDBUG: Lines starting with `SENDBUG' will" 544 " be removed automatically, as\n"); 545 fprintf(fp, "SENDBUG: will all comments (text enclosed in `<' and `>').\n"); 546 fprintf(fp, "SENDBUG:\n"); 547 fprintf(fp, "SENDBUG: Choose from the following categories:\n"); 548 fprintf(fp, "SENDBUG:\n"); 549 fprintf(fp, "SENDBUG: %s\n", categories); 550 fprintf(fp, "SENDBUG:\n"); 551 fprintf(fp, "SENDBUG:\n"); 552 fprintf(fp, "To: %s\n", "gnats@openbsd.org"); 553 fprintf(fp, "Subject: \n"); 554 fprintf(fp, "From: %s\n", pw->pw_name); 555 fprintf(fp, "Cc: %s\n", pw->pw_name); 556 fprintf(fp, "Reply-To: %s\n", pw->pw_name); 557 fprintf(fp, "X-sendbug-version: %s\n", version); 558 fprintf(fp, "\n"); 559 fprintf(fp, "\n"); 560 fprintf(fp, ">Submitter-Id:\tnet\n"); 561 fprintf(fp, ">Originator:\t%s\n", fullname); 562 fprintf(fp, ">Organization:\n"); 563 fprintf(fp, "net\n"); 564 fprintf(fp, ">Synopsis:\t<synopsis of the problem (one line)>\n"); 565 fprintf(fp, ">Severity:\t" 566 "<[ non-critical | serious | critical ] (one line)>\n"); 567 fprintf(fp, ">Priority:\t<[ low | medium | high ] (one line)>\n"); 568 fprintf(fp, ">Category:\t<PR category (one line)>\n"); 569 fprintf(fp, ">Class:\t\t" 570 "<[ sw-bug | doc-bug | change-request | support ] (one line)>\n"); 571 fprintf(fp, ">Release:\t<release number or tag (one line)>\n"); 572 fprintf(fp, ">Environment:\n"); 573 fprintf(fp, "\t<machine, os, target, libraries (multiple lines)>\n"); 574 fprintf(fp, "\tSystem : %s %s\n", os, rel); 575 fprintf(fp, "\tDetails : %s\n", details); 576 fprintf(fp, "\tArchitecture: %s.%s\n", os, mach); 577 fprintf(fp, "\tMachine : %s\n", mach); 578 fprintf(fp, ">Description:\n"); 579 fprintf(fp, "\t<precise description of the problem (multiple lines)>\n"); 580 fprintf(fp, ">How-To-Repeat:\n"); 581 fprintf(fp, "\t<code/input/activities to reproduce the problem" 582 " (multiple lines)>\n"); 583 fprintf(fp, ">Fix:\n"); 584 fprintf(fp, "\t<how to correct or work around the problem," 585 " if known (multiple lines)>\n"); 586 } 587