3 * inc.c -- incorporate messages from a maildrop into a folder
7 * This code is Copyright (c) 2002, by the authors of nmh. See the
8 * COPYRIGHT file in the root directory of the nmh distribution for
9 * complete copyright information.
13 /* Revised: Sat Apr 14 17:08:17 PDT 1990 (marvit@hplabs)
14 * Added hpux hacks to set and reset gid to be "mail" as needed. The reset
15 * is necessary so inc'ed mail is the group of the inc'er, rather than
16 * "mail". We setgid to egid only when [un]locking the mail file. This
17 * is also a major security precaution which will not be explained here.
19 * Fri Feb 7 16:04:57 PST 1992 John Romine <bug-mh@ics.uci.edu>
20 * NB: I'm not 100% sure that this setgid stuff is secure even now.
22 * See the *GROUPPRIVS() macros later. I'm reasonably happy with the setgid
23 * attribute. Running setuid root is probably not a terribly good idea, though.
24 * -- Peter Maydell <pmaydell@chiark.greenend.org.uk>, 04/1998
26 * Peter Maydell's patch slightly modified for nmh 0.28-pre2.
27 * Ruud de Rooij <ruud@debian.org> Wed, 22 Jul 1998 13:24:22 +0200
35 # include <h/dropsbr.h>
36 # include <h/popsbr.h>
43 #include <h/fmt_scan.h>
44 #include <h/scansbr.h>
45 #include <h/signals.h>
52 # define POPminc(a) (a)
58 # define RPOPminc(a) (a)
60 # define RPOPminc(a) 0
64 # define APOPminc(a) (a)
66 # define APOPminc(a) 0
70 # define KPOPminc(a) (a)
72 # define KPOPminc(a) 0
76 # define SASLminc(a) (a)
78 # define SASLminc(a) 0
81 static struct swit switches[] = {
83 { "audit audit-file", 0 },
93 { "form formatfile", 0 },
95 { "format string", 5 },
97 { "host hostname", POPminc (-4) },
99 { "user username", POPminc (-4) },
101 { "pack file", POPminc (-4) },
103 { "nopack", POPminc (-6) },
105 { "apop", APOPminc (-4) },
107 { "noapop", APOPminc (-6) },
109 { "rpop", RPOPminc (-4) },
111 { "norpop", RPOPminc (-6) },
121 { "width columns", 0 },
129 { "kpop", KPOPminc (-4) },
131 { "sasl", SASLminc(-4) },
132 #define SASLMECHSW 25
133 { "saslmech", SASLminc(-8) },
135 { "proxy command", POPminc(-5) },
140 * flags for the mail source
146 static int snoop = 0;
149 extern char response[];
151 static char *packfile = NULL;
157 static int mbx_style = MMDF_FORMAT;
158 static int pd = NOTOK;
159 static FILE *pf = NULL;
162 /* This is an attempt to simplify things by putting all the
163 * privilege ops into macros.
164 * *GROUPPRIVS() is related to handling the setgid MAIL property,
165 * and only applies if MAILGROUP is defined.
166 * *USERPRIVS() is related to handling the setuid root property,
167 * and only applies if POP is defined [why does POP => setuid root?]
168 * Basically, SAVEGROUPPRIVS() is called right at the top of main()
169 * to initialise things, and then DROPGROUPPRIVS() and GETGROUPPRIVS()
170 * do the obvious thing. TRYDROPGROUPPRIVS() has to be safe to call
171 * before DROPUSERPRIVS() is called [this is needed because setgid()
172 * sets both effective and real uids if euid is root.]
174 * There's probably a better implementation if we're allowed to use
175 * BSD-style setreuid() rather than using POSIX saved-ids.
176 * Anyway, if you're euid root it's a bit pointless to drop the group
179 * I'm pretty happy that the security is good provided we aren't setuid root.
180 * The only things we trust with group=mail privilege are lkfopen()
185 * For setting and returning to "mail" gid
188 static int return_gid;
190 /* easy case; we're not setuid root, so can drop group privs
193 #define TRYDROPGROUPPRIVS() DROPGROUPPRIVS()
194 #else /* POP ie we are setuid root */
195 #define TRYDROPGROUPPRIVS() \
196 if (geteuid() != 0) DROPGROUPPRIVS()
198 #define DROPGROUPPRIVS() setgid(getgid())
199 #define GETGROUPPRIVS() setgid(return_gid)
200 #define SAVEGROUPPRIVS() return_gid = getegid()
202 /* define *GROUPPRIVS() as null; this avoids having lots of "#ifdef MAILGROUP"s */
203 #define TRYDROPGROUPPRIVS()
204 #define DROPGROUPPRIVS()
205 #define GETGROUPPRIVS()
206 #define SAVEGROUPPRIVS()
207 #endif /* not MAILGROUP */
210 #define DROPUSERPRIVS() setuid(getuid())
212 #define DROPUSERPRIVS()
215 /* these variables have to be globals so that done() can correctly clean up the lockfile */
216 static int locked = 0;
217 static char *newmail;
223 char *map_name(char *);
227 static int pop_action(char *);
228 static int pop_pack(char *);
229 static int map_count(void);
234 main (int argc, char **argv)
236 int chgflag = 1, trnflag = 1;
237 int noisy = 1, width = 0;
238 int rpop, i, hghnum, msgnum;
239 int kpop = 0, sasl = 0;
240 char *cp, *maildir, *folder = NULL;
241 char *format = NULL, *form = NULL;
242 char *host = NULL, *user = NULL, *proxy = NULL;
243 char *audfile = NULL, *from = NULL, *saslmech = NULL;
244 char buf[BUFSIZ], **argp, *nfs, **arguments;
248 char b[MAXPATHLEN + 1];
249 char *maildir_copy; /* copy of mail directory because the static gets overwritten */
252 int nmsgs, nbytes, p = 0;
254 char *MAILHOST_env_variable;
262 struct hes_postoffice *po;
265 /* absolutely the first thing we do is save our privileges,
266 * and drop them if we can.
272 setlocale(LC_ALL, "");
274 invo_name = r1bindex (argv[0], '/');
276 /* read user profile/context */
279 mts_init (invo_name);
280 arguments = getarguments (invo_name, argc, argv, 1);
286 * use MAILHOST environment variable if present,
288 * If that fails, use the default (if any)
289 * provided by mts.conf in mts_init()
291 if ((MAILHOST_env_variable = getenv("MAILHOST")) != NULL)
292 pophost = MAILHOST_env_variable;
294 else if ((po = hes_getmailhost(getusername())) != NULL &&
295 strcmp(po->po_type, "POP") == 0)
296 pophost = po->po_host;
299 * If there is a valid "pophost" entry in mts.conf,
300 * then use it as the default host.
302 if (pophost && *pophost)
305 if ((cp = getenv ("MHPOPDEBUG")) && *cp)
311 while ((cp = *argp++)) {
313 switch (smatch (++cp, switches)) {
315 ambigsw (cp, switches);
318 adios (NULL, "-%s unknown", cp);
321 snprintf (buf, sizeof(buf), "%s [+folder] [switches]", invo_name);
322 print_help (buf, switches, 1);
325 print_version(invo_name);
329 if (!(cp = *argp++) || *cp == '-')
330 adios (NULL, "missing argument to %s", argp[-2]);
331 audfile = getcpy (m_maildir (cp));
345 * The flag `trnflag' has the value:
347 * 2 if -truncate is given
348 * 1 by default (truncating is default)
349 * 0 if -notruncate is given
359 if (!(cp = *argp++) || *cp == '-')
360 adios (NULL, "missing argument to %s", argp[-2]);
361 from = path (cp, TFILE);
364 * If the truncate file is in default state,
365 * change to not truncate.
379 if (!(form = *argp++) || *form == '-')
380 adios (NULL, "missing argument to %s", argp[-2]);
384 if (!(format = *argp++) || *format == '-')
385 adios (NULL, "missing argument to %s", argp[-2]);
390 if (!(cp = *argp++) || *cp == '-')
391 adios (NULL, "missing argument to %s", argp[-2]);
396 if (!(host = *argp++) || *host == '-')
397 adios (NULL, "missing argument to %s", argp[-2]);
400 if (!(user = *argp++) || *user == '-')
401 adios (NULL, "missing argument to %s", argp[-2]);
406 if (!(cp = *argp++) || *cp == '-')
407 adios (NULL, "missing argument to %s", argp[-2]);
409 if (!(packfile = *argp++) || *packfile == '-')
410 adios (NULL, "missing argument to %s", argp[-2]);
446 if (!(saslmech = *argp++) || *saslmech == '-')
447 adios (NULL, "missing argument to %s", argp[-2]);
450 if (!(proxy = *argp++) || *proxy == '-')
451 adios (NULL, "missing argument to %s", argp[-2]);
455 if (*cp == '+' || *cp == '@') {
457 adios (NULL, "only one folder at a time!");
459 folder = path (cp + 1, *cp == '+' ? TFOLDER : TSUBCWF);
461 adios (NULL, "usage: %s [+folder] [switches]", invo_name);
465 /* NOTE: above this point you should use TRYDROPGROUPPRIVS(),
466 * not DROPGROUPPRIVS().
471 if (from || !host || rpop <= 0)
475 /* guarantee dropping group priveleges; we might not have done so earlier */
479 * Where are we getting the new mail?
492 * Are we getting the mail from
495 if (inc_type == INC_POP) {
497 user = getusername ();
498 if ( strcmp( POPSERVICE, "kpop" ) == 0 ) {
501 if (kpop || sasl || ( rpop > 0))
502 pass = getusername ();
504 ruserpass (host, &user, &pass);
507 * initialize POP connection
509 if (pop_init (host, user, pass, proxy, snoop, kpop ? 1 : rpop, kpop,
510 sasl, saslmech) == NOTOK)
511 adios (NULL, "%s", response);
513 /* Check if there are any messages */
514 if (pop_stat (&nmsgs, &nbytes) == NOTOK)
515 adios (NULL, "%s", response);
521 adios (NULL, "no mail to incorporate");
527 * We will get the mail from a file
528 * (typically the standard maildrop)
531 if (inc_type == INC_FILE) {
534 else if ((newmail = getenv ("MAILDROP")) && *newmail)
535 newmail = m_mailpath (newmail);
536 else if ((newmail = context_find ("maildrop")) && *newmail)
537 newmail = m_mailpath (newmail);
539 newmail = concat (MAILDIR, "/", MAILFIL, NULL);
541 if (stat (newmail, &s1) == NOTOK || s1.st_size == 0)
542 adios (NULL, "no mail to incorporate");
544 if ((cp = strdup(newmail)) == (char *)0)
545 adios (maildir, "error allocating memory to copy newmail");
551 /* skip the folder setup */
552 if ((inc_type == INC_POP) && packfile)
556 if (!context_find ("path"))
557 free (path ("./", TFOLDER));
559 folder = getfolder (0);
560 maildir = m_maildir (folder);
562 if ((maildir_copy = strdup(maildir)) == (char *)0)
563 adios (maildir, "error allocating memory to copy maildir");
566 create_folder(maildir, 0, done);
570 if (chdir (maildir) == NOTOK)
571 adios (maildir, "unable to change directory to");
573 /* read folder and create message structure */
574 if (!(mp = folder_read (folder)))
575 adios (NULL, "unable to read folder %s", folder);
581 if (inc_type == INC_FILE) {
582 if (access (newmail, W_OK) != NOTOK) {
585 SIGNAL (SIGHUP, SIG_IGN);
586 SIGNAL (SIGINT, SIG_IGN);
587 SIGNAL (SIGQUIT, SIG_IGN);
588 SIGNAL (SIGTERM, SIG_IGN);
591 GETGROUPPRIVS(); /* Reset gid to lock mail file */
592 in = lkfopen (newmail, "r");
595 adios (NULL, "unable to lock and fopen %s", newmail);
596 fstat (fileno(in), &s1);
599 if ((in = fopen (newmail, "r")) == NULL)
600 adios (newmail, "unable to read");
604 /* This shouldn't be necessary but it can't hurt. */
608 if ((i = stat (audfile, &st)) == NOTOK)
609 advise (NULL, "Creating Receive-Audit: %s", audfile);
610 if ((aud = fopen (audfile, "a")) == NULL)
611 adios (audfile, "unable to append to");
613 chmod (audfile, m_gmprot ());
616 fprintf (aud, from ? "<<inc>> %s -ms %s\n"
617 : host ? "<<inc>> %s -host %s -user %s%s\n"
619 dtimenow (0), from ? from : host, user,
620 rpop < 0 ? " -apop" : rpop > 0 ? " -rpop" : "");
622 fprintf (aud, from ? "<<inc>> %s -ms %s\n" : "<<inc>> %s\n",
628 if (context_find ("mhe")) {
629 cp = concat (maildir, "/++", NULL);
631 if ((mhe = fopen (cp, "a")) == NULL)
632 admonish (cp, "unable to append to");
635 chmod (cp, m_gmprot ());
640 /* Get new format string */
641 nfs = new_fs (form, format, FORMAT);
644 printf ("Incorporating new mail into %s...\n\n", folder);
650 * Get the mail from a POP server
652 if (inc_type == INC_POP) {
654 packfile = path (packfile, TFILE);
655 if (stat (packfile, &st) == NOTOK) {
657 adios (packfile, "error on file");
658 cp = concat ("Create file \"", packfile, "\"? ", NULL);
659 if (noisy && !getanswer (cp))
663 msgnum = map_count ();
664 if ((pd = mbx_open (packfile, mbx_style, getuid(), getgid(), m_gmprot()))
666 adios (packfile, "unable to open");
667 if ((pf = fdopen (pd, "w+")) == NULL)
668 adios (NULL, "unable to fdopen %s", packfile);
670 hghnum = msgnum = mp->hghmsg;
672 * Check if we have enough message space for all the new
673 * messages. If not, then realloc the folder and add enough
674 * space for all new messages plus 10 additional slots.
676 if (mp->hghmsg + nmsgs >= mp->hghoff
677 && !(mp = folder_realloc (mp, mp->lowoff, mp->hghmsg + nmsgs + 10)))
678 adios (NULL, "unable to allocate folder storage");
681 for (i = 1; i <= nmsgs; i++) {
684 fseek (pf, 0L, SEEK_CUR);
687 fwrite (mmdlm1, 1, strlen (mmdlm1), pf);
690 if (pop_retr (i, pop_pack) == NOTOK)
691 adios (NULL, "%s", response);
693 fseek (pf, 0L, SEEK_CUR);
696 adios (packfile, "write error on");
697 fseek (pf, start, SEEK_SET);
699 cp = getcpy (m_name (msgnum));
700 if ((pf = fopen (cp, "w+")) == NULL)
701 adios (cp, "unable to write");
702 chmod (cp, m_gmprot ());
705 if (pop_retr (i, pop_action) == NOTOK)
706 adios (NULL, "%s", response);
709 adios (cp, "write error on");
710 fseek (pf, 0L, SEEK_SET);
712 switch (p = scan (pf, msgnum, 0, nfs, width,
713 packfile ? 0 : msgnum == mp->hghmsg + 1 && chgflag,
714 1, NULL, stop - start, noisy)) {
716 printf ("%*d empty\n", DMAXFOLDER, msgnum);
722 /* advise (cp, "unable to read"); already advised */
741 clear_msg_flags (mp, msgnum);
742 set_exists (mp, msgnum);
743 set_unseen (mp, msgnum);
744 mp->msgflags |= SEQMOD;
749 fseek (pf, stop, SEEK_SET);
750 fwrite (mmdlm2, 1, strlen (mmdlm2), pf);
751 if (fflush (pf) || ferror (pf)) {
755 adios (packfile, "write error on");
757 map_write (packfile, pd, 0, 0L, start, stop, pos, size, noisy);
759 if (ferror(pf) || fclose (pf)) {
764 adios (cp, "write error on");
769 if (trnflag && pop_dele (i) == NOTOK)
770 adios (NULL, "%s", response);
773 if (pop_quit () == NOTOK)
774 adios (NULL, "%s", response);
776 mbx_close (packfile, pd);
783 * Get the mail from file (usually mail spool)
785 if (inc_type == INC_FILE) {
786 m_unknown (in); /* the MAGIC invocation... */
787 hghnum = msgnum = mp->hghmsg;
790 * Check if we need to allocate more space for message status.
791 * If so, then add space for an additional 100 messages.
793 if (msgnum >= mp->hghoff
794 && !(mp = folder_realloc (mp, mp->lowoff, mp->hghoff + 100))) {
795 advise (NULL, "unable to allocate folder storage");
801 /* copy file from spool to tmp file */
802 tmpfilenam = m_scratch ("", invo_name);
803 if ((fd = creat (tmpfilenam, m_gmprot ())) == NOTOK)
804 adios (tmpfilenam, "unable to create");
805 chmod (tmpfilenam, m_gmprot ());
806 if (!(in2 = fdopen (fd, "r+")))
807 adios (tmpfilenam, "unable to access");
810 /* link message into folder */
811 newmsg = folder_addmsg(mp, tmpfilenam);
813 /* create scanline for new message */
814 switch (i = scan (in, msgnum + 1, msgnum + 1, nfs, width,
815 msgnum == hghnum && chgflag, 1, NULL, 0L, noisy)) {
822 fputs ("inc aborted!\n", aud);
823 advise (NULL, "aborted!"); /* doesn't clean up locks! */
827 advise (NULL, "BUG in %s, number out of range", invo_name);
831 advise (NULL, "BUG in %s, scan() botch (%d)", invo_name, i);
837 * Run the external program hook on the message.
840 (void)snprintf(b, sizeof (b), "%s/%d", maildir_copy, msgnum + 1);
841 (void)ext_hook("add-hook", b, (char *)0);
855 if (mp->lowmsg == 0) mp->lowmsg = 1;
857 clear_msg_flags (mp, msgnum);
858 set_exists (mp, msgnum);
859 set_unseen (mp, msgnum);
860 mp->msgflags |= SEQMOD;
868 if (p < 0) { /* error */
870 if (i < 0) { /* error */
873 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
874 (void) lkfclose (in, newmail); in = NULL;
875 DROPGROUPPRIVS(); /* And then return us to normal privileges */
877 fclose (in); in = NULL;
879 adios (NULL, "failed");
894 if ((inc_type == INC_POP) && packfile)
899 * truncate file we are incorporating from
901 if (inc_type == INC_FILE) {
903 if (stat (newmail, &st) != NOTOK && s1.st_mtime != st.st_mtime)
904 advise (NULL, "new messages have arrived!\007");
906 if ((i = creat (newmail, 0600)) != NOTOK)
909 admonish (newmail, "error zero'ing");
910 unlink(map_name(newmail));
914 printf ("%s not zero'd\n", newmail);
918 if (msgnum == hghnum) {
919 admonish (NULL, "no messages incorporated");
921 context_replace (pfolder, folder); /* update current folder */
923 mp->curmsg = hghnum + 1;
927 if (chgflag) /* sigh... */
928 seq_setcur (mp, mp->curmsg);
932 * unlock the mail spool
934 if (inc_type == INC_FILE) {
936 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
937 (void) lkfclose (in, newmail); in = NULL;
938 DROPGROUPPRIVS(); /* And then return us to normal privileges */
940 fclose (in); in = NULL;
944 seq_setunseen (mp, 0); /* set the Unseen-Sequence */
945 seq_save (mp); /* synchronize sequences */
946 context_save (); /* save the context file */
954 * Copy message message from spool into
955 * temporary file. Massage the "From " line
959 cpymsg (FILE *in, FILE *out)
962 char *tmpbuf, name[NAMESZ];
965 state = m_getfld (state, name, tmpbuf, rlwidth, in);
988 if (packfile && pd != NOTOK)
989 mbx_close (packfile, pd);
994 lkfclose(in, newmail);
998 return 1; /* dead code to satisfy the compiler */
1003 pop_action (char *s)
1005 fprintf (pf, "%s\n", s);
1006 stop += strlen (s) + 1;
1007 return 0; /* Is return value used? This was missing before 1999-07-15. */
1014 char buffer[BUFSIZ];
1016 snprintf (buffer, sizeof(buffer), "%s\n", s);
1017 for (j = 0; (j = stringdex (mmdlm1, buffer)) >= 0; buffer[j]++)
1019 for (j = 0; (j = stringdex (mmdlm2, buffer)) >= 0; buffer[j]++)
1022 size += strlen (buffer) + 1;
1023 return 0; /* Is return value used? This was missing before 1999-07-15. */
1034 if (stat (packfile, &st) == NOTOK)
1036 if ((md = open (cp = map_name (packfile), O_RDONLY)) == NOTOK
1037 || map_chk (cp, md, &d, (long) st.st_size, 1)) {