3 * inc.c -- incorporate messages from a maildrop into a folder
5 * This code is Copyright (c) 2002, by the authors of nmh. See the
6 * COPYRIGHT file in the root directory of the nmh distribution for
7 * complete copyright information.
11 /* Revised: Sat Apr 14 17:08:17 PDT 1990 (marvit@hplabs)
12 * Added hpux hacks to set and reset gid to be "mail" as needed. The reset
13 * is necessary so inc'ed mail is the group of the inc'er, rather than
14 * "mail". We setgid to egid only when [un]locking the mail file. This
15 * is also a major security precaution which will not be explained here.
17 * Fri Feb 7 16:04:57 PST 1992 John Romine <bug-mh@ics.uci.edu>
18 * NB: I'm not 100% sure that this setgid stuff is secure even now.
20 * See the *GROUPPRIVS() macros later. I'm reasonably happy with the setgid
21 * attribute. Running setuid root is probably not a terribly good idea, though.
22 * -- Peter Maydell <pmaydell@chiark.greenend.org.uk>, 04/1998
24 * Peter Maydell's patch slightly modified for nmh 0.28-pre2.
25 * Ruud de Rooij <ruud@debian.org> Wed, 22 Jul 1998 13:24:22 +0200
34 # include <h/dropsbr.h>
35 # include <h/popsbr.h>
42 #include <h/fmt_scan.h>
43 #include <h/scansbr.h>
44 #include <h/signals.h>
51 # define POPminc(a) (a)
57 # define RPOPminc(a) (a)
59 # define RPOPminc(a) 0
63 # define APOPminc(a) (a)
65 # define APOPminc(a) 0
69 # define KPOPminc(a) (a)
71 # define KPOPminc(a) 0
75 # define SASLminc(a) (a)
77 # define SASLminc(a) 0
80 static struct swit switches[] = {
82 { "audit audit-file", 0 },
92 { "form formatfile", 0 },
94 { "format string", 5 },
96 { "host hostname", POPminc (-4) },
98 { "user username", POPminc (-4) },
100 { "pack file", POPminc (-4) },
102 { "nopack", POPminc (-6) },
104 { "apop", APOPminc (-4) },
106 { "noapop", APOPminc (-6) },
108 { "rpop", RPOPminc (-4) },
110 { "norpop", RPOPminc (-6) },
120 { "width columns", 0 },
128 { "kpop", KPOPminc (-4) },
130 { "sasl", SASLminc(-4) },
131 #define SASLMECHSW 25
132 { "saslmech", SASLminc(-8) },
134 { "proxy command", POPminc(-5) },
139 * flags for the mail source
145 static int snoop = 0;
148 extern char response[];
150 static char *packfile = NULL;
156 static int mbx_style = MMDF_FORMAT;
157 static int pd = NOTOK;
158 static FILE *pf = NULL;
161 /* This is an attempt to simplify things by putting all the
162 * privilege ops into macros.
163 * *GROUPPRIVS() is related to handling the setgid MAIL property,
164 * and only applies if MAILGROUP is defined.
165 * *USERPRIVS() is related to handling the setuid root property,
166 * and only applies if POP is defined [why does POP => setuid root?]
167 * Basically, SAVEGROUPPRIVS() is called right at the top of main()
168 * to initialise things, and then DROPGROUPPRIVS() and GETGROUPPRIVS()
169 * do the obvious thing. TRYDROPGROUPPRIVS() has to be safe to call
170 * before DROPUSERPRIVS() is called [this is needed because setgid()
171 * sets both effective and real uids if euid is root.]
173 * There's probably a better implementation if we're allowed to use
174 * BSD-style setreuid() rather than using POSIX saved-ids.
175 * Anyway, if you're euid root it's a bit pointless to drop the group
178 * I'm pretty happy that the security is good provided we aren't setuid root.
179 * The only things we trust with group=mail privilege are lkfopen()
184 * For setting and returning to "mail" gid
187 static int return_gid;
189 /* easy case; we're not setuid root, so can drop group privs
192 #define TRYDROPGROUPPRIVS() DROPGROUPPRIVS()
193 #else /* POP ie we are setuid root */
194 #define TRYDROPGROUPPRIVS() \
195 if (geteuid() != 0) DROPGROUPPRIVS()
197 #define DROPGROUPPRIVS() setgid(getgid())
198 #define GETGROUPPRIVS() setgid(return_gid)
199 #define SAVEGROUPPRIVS() return_gid = getegid()
201 /* define *GROUPPRIVS() as null; this avoids having lots of "#ifdef MAILGROUP"s */
202 #define TRYDROPGROUPPRIVS()
203 #define DROPGROUPPRIVS()
204 #define GETGROUPPRIVS()
205 #define SAVEGROUPPRIVS()
206 #endif /* not MAILGROUP */
209 #define DROPUSERPRIVS() setuid(getuid())
211 #define DROPUSERPRIVS()
214 /* these variables have to be globals so that done() can correctly clean up the lockfile */
215 static int locked = 0;
216 static char *newmail;
222 char *map_name(char *);
224 static void inc_done(int) NORETURN;
226 static int pop_action(char *);
227 static int pop_pack(char *);
228 static int map_count(void);
233 main (int argc, char **argv)
235 int chgflag = 1, trnflag = 1;
236 int noisy = 1, width = 0;
237 int rpop, i, hghnum = 0, msgnum = 0;
238 int kpop = 0, sasl = 0;
239 char *cp, *maildir = NULL, *folder = NULL;
240 char *format = NULL, *form = NULL;
241 char *host = NULL, *user = NULL, *proxy = NULL;
242 char *audfile = NULL, *from = NULL, *saslmech = NULL;
243 char buf[BUFSIZ], **argp, *nfs, **arguments;
244 struct msgs *mp = NULL;
247 char b[MAXPATHLEN + 1];
248 char *maildir_copy = NULL; /* copy of mail directory because the static gets overwritten */
251 int nmsgs, nbytes, p = 0;
253 char *MAILHOST_env_variable;
261 struct hes_postoffice *po;
266 /* absolutely the first thing we do is save our privileges,
267 * and drop them if we can.
273 setlocale(LC_ALL, "");
275 invo_name = r1bindex (argv[0], '/');
277 /* read user profile/context */
280 mts_init (invo_name);
281 arguments = getarguments (invo_name, argc, argv, 1);
287 * use MAILHOST environment variable if present,
289 * If that fails, use the default (if any)
290 * provided by mts.conf in mts_init()
292 if ((MAILHOST_env_variable = getenv("MAILHOST")) != NULL)
293 pophost = MAILHOST_env_variable;
295 else if ((po = hes_getmailhost(getusername())) != NULL &&
296 strcmp(po->po_type, "POP") == 0)
297 pophost = po->po_host;
300 * If there is a valid "pophost" entry in mts.conf,
301 * then use it as the default host.
303 if (pophost && *pophost)
306 if ((cp = getenv ("MHPOPDEBUG")) && *cp)
312 while ((cp = *argp++)) {
314 switch (smatch (++cp, switches)) {
316 ambigsw (cp, switches);
319 adios (NULL, "-%s unknown", cp);
322 snprintf (buf, sizeof(buf), "%s [+folder] [switches]", invo_name);
323 print_help (buf, switches, 1);
326 print_version(invo_name);
330 if (!(cp = *argp++) || *cp == '-')
331 adios (NULL, "missing argument to %s", argp[-2]);
332 audfile = getcpy (m_maildir (cp));
346 * The flag `trnflag' has the value:
348 * 2 if -truncate is given
349 * 1 by default (truncating is default)
350 * 0 if -notruncate is given
360 if (!(cp = *argp++) || *cp == '-')
361 adios (NULL, "missing argument to %s", argp[-2]);
362 from = path (cp, TFILE);
365 * If the truncate file is in default state,
366 * change to not truncate.
380 if (!(form = *argp++) || *form == '-')
381 adios (NULL, "missing argument to %s", argp[-2]);
385 if (!(format = *argp++) || *format == '-')
386 adios (NULL, "missing argument to %s", argp[-2]);
391 if (!(cp = *argp++) || *cp == '-')
392 adios (NULL, "missing argument to %s", argp[-2]);
397 if (!(host = *argp++) || *host == '-')
398 adios (NULL, "missing argument to %s", argp[-2]);
401 if (!(user = *argp++) || *user == '-')
402 adios (NULL, "missing argument to %s", argp[-2]);
407 if (!(cp = *argp++) || *cp == '-')
408 adios (NULL, "missing argument to %s", argp[-2]);
410 if (!(packfile = *argp++) || *packfile == '-')
411 adios (NULL, "missing argument to %s", argp[-2]);
447 if (!(saslmech = *argp++) || *saslmech == '-')
448 adios (NULL, "missing argument to %s", argp[-2]);
451 if (!(proxy = *argp++) || *proxy == '-')
452 adios (NULL, "missing argument to %s", argp[-2]);
456 if (*cp == '+' || *cp == '@') {
458 adios (NULL, "only one folder at a time!");
460 folder = pluspath (cp);
462 adios (NULL, "usage: %s [+folder] [switches]", invo_name);
466 /* NOTE: above this point you should use TRYDROPGROUPPRIVS(),
467 * not DROPGROUPPRIVS().
472 if (from || !host || rpop <= 0)
476 /* guarantee dropping group priveleges; we might not have done so earlier */
480 * Where are we getting the new mail?
493 * Are we getting the mail from
496 if (inc_type == INC_POP) {
498 user = getusername ();
499 if ( strcmp( POPSERVICE, "kpop" ) == 0 ) {
502 if (kpop || sasl || ( rpop > 0))
503 pass = getusername ();
505 ruserpass (host, &user, &pass);
508 * initialize POP connection
510 if (pop_init (host, user, pass, proxy, snoop, kpop ? 1 : rpop, kpop,
511 sasl, saslmech) == NOTOK)
512 adios (NULL, "%s", response);
514 /* Check if there are any messages */
515 if (pop_stat (&nmsgs, &nbytes) == NOTOK)
516 adios (NULL, "%s", response);
522 adios (NULL, "no mail to incorporate");
528 * We will get the mail from a file
529 * (typically the standard maildrop)
532 if (inc_type == INC_FILE) {
535 else if ((newmail = getenv ("MAILDROP")) && *newmail)
536 newmail = m_mailpath (newmail);
537 else if ((newmail = context_find ("maildrop")) && *newmail)
538 newmail = m_mailpath (newmail);
540 newmail = concat (MAILDIR, "/", MAILFIL, NULL);
542 if (stat (newmail, &s1) == NOTOK || s1.st_size == 0)
543 adios (NULL, "no mail to incorporate");
545 if ((cp = strdup(newmail)) == (char *)0)
546 adios (NULL, "error allocating memory to copy newmail");
552 /* skip the folder setup */
553 if ((inc_type == INC_POP) && packfile)
557 if (!context_find ("path"))
558 free (path ("./", TFOLDER));
560 folder = getfolder (0);
561 maildir = m_maildir (folder);
563 if ((maildir_copy = strdup(maildir)) == (char *)0)
564 adios (maildir, "error allocating memory to copy maildir");
566 if (!folder_exists(maildir)) {
567 /* If the folder doesn't exist, and we're given the -silent flag,
571 create_folder(maildir, 0, done);
576 if (chdir (maildir) == NOTOK)
577 adios (maildir, "unable to change directory to");
579 /* read folder and create message structure */
580 if (!(mp = folder_read (folder)))
581 adios (NULL, "unable to read folder %s", folder);
587 if (inc_type == INC_FILE) {
588 if (access (newmail, W_OK) != NOTOK) {
591 SIGNAL (SIGHUP, SIG_IGN);
592 SIGNAL (SIGINT, SIG_IGN);
593 SIGNAL (SIGQUIT, SIG_IGN);
594 SIGNAL (SIGTERM, SIG_IGN);
597 GETGROUPPRIVS(); /* Reset gid to lock mail file */
598 in = lkfopen (newmail, "r");
601 adios (NULL, "unable to lock and fopen %s", newmail);
602 fstat (fileno(in), &s1);
605 if ((in = fopen (newmail, "r")) == NULL)
606 adios (newmail, "unable to read");
610 /* This shouldn't be necessary but it can't hurt. */
614 if ((i = stat (audfile, &st)) == NOTOK)
615 advise (NULL, "Creating Receive-Audit: %s", audfile);
616 if ((aud = fopen (audfile, "a")) == NULL)
617 adios (audfile, "unable to append to");
619 chmod (audfile, m_gmprot ());
622 fprintf (aud, from ? "<<inc>> %s -ms %s\n"
623 : host ? "<<inc>> %s -host %s -user %s%s\n"
625 dtimenow (0), from ? from : host, user,
626 rpop < 0 ? " -apop" : rpop > 0 ? " -rpop" : "");
628 fprintf (aud, from ? "<<inc>> %s -ms %s\n" : "<<inc>> %s\n",
634 if (context_find ("mhe")) {
635 cp = concat (maildir, "/++", NULL);
637 if ((mhe = fopen (cp, "a")) == NULL)
638 admonish (cp, "unable to append to");
641 chmod (cp, m_gmprot ());
646 /* Get new format string */
647 nfs = new_fs (form, format, FORMAT);
650 printf ("Incorporating new mail into %s...\n\n", folder);
656 * Get the mail from a POP server
658 if (inc_type == INC_POP) {
660 packfile = path (packfile, TFILE);
661 if (stat (packfile, &st) == NOTOK) {
663 adios (packfile, "error on file");
664 cp = concat ("Create file \"", packfile, "\"? ", NULL);
665 if (noisy && !getanswer (cp))
669 msgnum = map_count ();
670 if ((pd = mbx_open (packfile, mbx_style, getuid(), getgid(), m_gmprot()))
672 adios (packfile, "unable to open");
673 if ((pf = fdopen (pd, "w+")) == NULL)
674 adios (NULL, "unable to fdopen %s", packfile);
676 hghnum = msgnum = mp->hghmsg;
678 * Check if we have enough message space for all the new
679 * messages. If not, then realloc the folder and add enough
680 * space for all new messages plus 10 additional slots.
682 if (mp->hghmsg + nmsgs >= mp->hghoff
683 && !(mp = folder_realloc (mp, mp->lowoff, mp->hghmsg + nmsgs + 10)))
684 adios (NULL, "unable to allocate folder storage");
687 for (i = 1; i <= nmsgs; i++) {
690 fseek (pf, 0L, SEEK_CUR);
693 fwrite (mmdlm1, 1, strlen (mmdlm1), pf);
696 if (pop_retr (i, pop_pack) == NOTOK)
697 adios (NULL, "%s", response);
699 fseek (pf, 0L, SEEK_CUR);
702 adios (packfile, "write error on");
703 fseek (pf, start, SEEK_SET);
705 cp = getcpy (m_name (msgnum));
706 if ((pf = fopen (cp, "w+")) == NULL)
707 adios (cp, "unable to write");
708 chmod (cp, m_gmprot ());
711 if (pop_retr (i, pop_action) == NOTOK)
712 adios (NULL, "%s", response);
715 adios (cp, "write error on");
716 fseek (pf, 0L, SEEK_SET);
718 switch (p = scan (pf, msgnum, 0, nfs, width,
719 packfile ? 0 : msgnum == mp->hghmsg + 1 && chgflag,
720 1, NULL, stop - start, noisy)) {
722 printf ("%*d empty\n", DMAXFOLDER, msgnum);
728 /* advise (cp, "unable to read"); already advised */
747 clear_msg_flags (mp, msgnum);
748 set_exists (mp, msgnum);
749 set_unseen (mp, msgnum);
750 mp->msgflags |= SEQMOD;
755 fseek (pf, stop, SEEK_SET);
756 fwrite (mmdlm2, 1, strlen (mmdlm2), pf);
757 if (fflush (pf) || ferror (pf)) {
761 adios (packfile, "write error on");
763 map_write (packfile, pd, 0, 0L, start, stop, pos, size, noisy);
765 if (ferror(pf) || fclose (pf)) {
770 adios (cp, "write error on");
775 if (trnflag && pop_dele (i) == NOTOK)
776 adios (NULL, "%s", response);
779 if (pop_quit () == NOTOK)
780 adios (NULL, "%s", response);
782 mbx_close (packfile, pd);
789 * Get the mail from file (usually mail spool)
791 if (inc_type == INC_FILE) {
792 m_unknown (in); /* the MAGIC invocation... */
793 hghnum = msgnum = mp->hghmsg;
796 * Check if we need to allocate more space for message status.
797 * If so, then add space for an additional 100 messages.
799 if (msgnum >= mp->hghoff
800 && !(mp = folder_realloc (mp, mp->lowoff, mp->hghoff + 100))) {
801 advise (NULL, "unable to allocate folder storage");
807 /* copy file from spool to tmp file */
808 tmpfilenam = m_scratch ("", invo_name);
809 if ((fd = creat (tmpfilenam, m_gmprot ())) == NOTOK)
810 adios (tmpfilenam, "unable to create");
811 chmod (tmpfilenam, m_gmprot ());
812 if (!(in2 = fdopen (fd, "r+")))
813 adios (tmpfilenam, "unable to access");
816 /* link message into folder */
817 newmsg = folder_addmsg(mp, tmpfilenam);
819 /* create scanline for new message */
820 switch (i = scan (in, msgnum + 1, msgnum + 1, nfs, width,
821 msgnum == hghnum && chgflag, 1, NULL, 0L, noisy)) {
828 fputs ("inc aborted!\n", aud);
829 advise (NULL, "aborted!"); /* doesn't clean up locks! */
833 advise (NULL, "BUG in %s, number out of range", invo_name);
837 advise (NULL, "BUG in %s, scan() botch (%d)", invo_name, i);
843 * Run the external program hook on the message.
846 (void)snprintf(b, sizeof (b), "%s/%d", maildir_copy, msgnum + 1);
847 (void)ext_hook("add-hook", b, (char *)0);
861 if (mp->lowmsg == 0) mp->lowmsg = 1;
863 clear_msg_flags (mp, msgnum);
864 set_exists (mp, msgnum);
865 set_unseen (mp, msgnum);
866 mp->msgflags |= SEQMOD;
874 if (p < 0) { /* error */
876 if (i < 0) { /* error */
879 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
880 (void) lkfclose (in, newmail); in = NULL;
881 DROPGROUPPRIVS(); /* And then return us to normal privileges */
883 fclose (in); in = NULL;
885 adios (NULL, "failed");
900 if ((inc_type == INC_POP) && packfile)
905 * truncate file we are incorporating from
907 if (inc_type == INC_FILE) {
909 if (stat (newmail, &st) != NOTOK && s1.st_mtime != st.st_mtime)
910 advise (NULL, "new messages have arrived!\007");
912 if ((i = creat (newmail, 0600)) != NOTOK)
915 admonish (newmail, "error zero'ing");
916 unlink(map_name(newmail));
920 printf ("%s not zero'd\n", newmail);
924 if (msgnum == hghnum) {
925 admonish (NULL, "no messages incorporated");
927 context_replace (pfolder, folder); /* update current folder */
929 mp->curmsg = hghnum + 1;
933 if (chgflag) /* sigh... */
934 seq_setcur (mp, mp->curmsg);
938 * unlock the mail spool
940 if (inc_type == INC_FILE) {
942 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
943 (void) lkfclose (in, newmail); in = NULL;
944 DROPGROUPPRIVS(); /* And then return us to normal privileges */
946 fclose (in); in = NULL;
950 seq_setunseen (mp, 0); /* set the Unseen-Sequence */
951 seq_save (mp); /* synchronize sequences */
952 context_save (); /* save the context file */
961 * Copy message message from spool into
962 * temporary file. Massage the "From " line
966 cpymsg (FILE *in, FILE *out)
969 char *tmpbuf, name[NAMESZ];
972 state = m_getfld (state, name, tmpbuf, rlwidth, in);
992 inc_done (int status)
995 if (packfile && pd != NOTOK)
996 mbx_close (packfile, pd);
1001 lkfclose(in, newmail);
1009 pop_action (char *s)
1011 fprintf (pf, "%s\n", s);
1012 stop += strlen (s) + 1;
1013 return 0; /* Is return value used? This was missing before 1999-07-15. */
1020 char buffer[BUFSIZ];
1022 snprintf (buffer, sizeof(buffer), "%s\n", s);
1023 for (j = 0; (j = stringdex (mmdlm1, buffer)) >= 0; buffer[j]++)
1025 for (j = 0; (j = stringdex (mmdlm2, buffer)) >= 0; buffer[j]++)
1028 size += strlen (buffer) + 1;
1029 return 0; /* Is return value used? This was missing before 1999-07-15. */
1040 if (stat (packfile, &st) == NOTOK)
1042 if ((md = open (cp = map_name (packfile), O_RDONLY)) == NOTOK
1043 || map_chk (cp, md, &d, (long) st.st_size, 1)) {