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