]>
diplodocus.org Git - nmh/blob - uip/inc.c
1 /* inc.c -- incorporate messages from a maildrop into a folder
3 * This code is Copyright (c) 2002, by the authors of nmh. See the
4 * COPYRIGHT file in the root directory of the nmh distribution for
5 * complete copyright information.
10 * Thu Feb 12 21:00 CST 2015 Marcin Cieslak <saper@saper.info>
11 * Replaced setgid() calls with setegid() so that it works with dot
12 * locking on FreeBSD. setegid() should be supported on modern POSIX
15 * Revised: Sat Apr 14 17:08:17 PDT 1990 (marvit@hplabs)
16 * Added hpux hacks to set and reset gid to be "mail" as needed. The reset
17 * is necessary so inc'ed mail is the group of the inc'er, rather than
18 * "mail". We setgid to egid only when [un]locking the mail file. This
19 * is also a major security precaution which will not be explained here.
21 * Fri Feb 7 16:04:57 PST 1992 John Romine <bug-mh@ics.uci.edu>
22 * NB: I'm not 100% sure that this setgid stuff is secure even now.
24 * See the *GROUPPRIVS() macros later. I'm reasonably happy with the setgid
25 * attribute. Running setuid root is probably not a terribly good idea, though.
26 * -- Peter Maydell <pmaydell@chiark.greenend.org.uk>, 04/1998
28 * Peter Maydell's patch slightly modified for nmh 0.28-pre2.
29 * Ruud de Rooij <ruud@debian.org> Wed, 22 Jul 1998 13:24:22 +0200
35 #include "sbr/m_name.h"
36 #include "sbr/m_gmprot.h"
37 #include "sbr/getarguments.h"
38 #include "sbr/concat.h"
39 #include "sbr/seq_setunseen.h"
40 #include "sbr/seq_setcur.h"
41 #include "sbr/seq_save.h"
42 #include "sbr/smatch.h"
43 #include "sbr/getfolder.h"
44 #include "sbr/ext_hook.h"
45 #include "sbr/folder_read.h"
46 #include "sbr/folder_realloc.h"
47 #include "sbr/folder_free.h"
48 #include "sbr/context_save.h"
49 #include "sbr/context_replace.h"
50 #include "sbr/context_find.h"
51 #include "sbr/ambigsw.h"
53 #include "sbr/print_version.h"
54 #include "sbr/print_help.h"
55 #include "sbr/error.h"
58 #include "h/dropsbr.h"
60 #include "h/fmt_scan.h"
61 #include "h/signals.h"
65 #include "sbr/lock_file.h"
66 #include "sbr/m_maildir.h"
67 #include "sbr/m_mktemp.h"
70 # define TLSminc(a) (a)
75 #define INC_SWITCHES \
76 X("audit audit-file", 0, AUDSW) \
77 X("noaudit", 0, NAUDSW) \
78 X("changecur", 0, CHGSW) \
79 X("nochangecur", 0, NCHGSW) \
80 X("file name", 0, FILESW) \
81 X("form formatfile", 0, FORMSW) \
82 X("format string", 5, FMTSW) \
83 X("host hostname", 0, HOSTSW) \
84 X("user username", 0, USERSW) \
85 X("port name/number", 0, PORTSW) \
86 X("silent", 0, SILSW) \
87 X("nosilent", 0, NSILSW) \
88 X("truncate", 0, TRNCSW) \
89 X("notruncate", 0, NTRNCSW) \
90 X("width columns", 0, WIDTHSW) \
91 X("version", 0, VERSIONSW) \
92 X("help", 0, HELPSW) \
93 X("snoop", 0, SNOOPSW) \
94 X("sasl", 0, SASLSW) \
95 X("nosasl", 0, NOSASLSW) \
96 X("saslmech", 0, SASLMECHSW) \
97 X("initialtls", TLSminc(-10), INITTLSSW) \
98 X("notls", TLSminc(-5), NOTLSSW) \
99 X("certverify", TLSminc(-10), CERTVERSW) \
100 X("nocertverify", TLSminc(-12), NOCERTVERSW) \
101 X("authservice", 0, AUTHSERVICESW) \
102 X("proxy command", 0, PROXYSW) \
104 #define X(sw, minchars, id) id,
105 DEFINE_SWITCH_ENUM(INC
);
108 #define X(sw, minchars, id) { sw, minchars, id },
109 DEFINE_SWITCH_ARRAY(INC
, switches
);
113 * flags for the mail source
118 static struct Maildir_entry
{
122 static int num_maildir_entries
= 0;
130 extern char response
[];
132 /* This is an attempt to simplify things by putting all the
133 * privilege ops into macros.
134 * *GROUPPRIVS() is related to handling the setgid MAIL property,
135 * and only applies if MAILGROUP is defined.
136 * Basically, SAVEGROUPPRIVS() is called right at the top of main()
137 * to initialise things, and then DROPGROUPPRIVS() and GETGROUPPRIVS()
138 * do the obvious thing.
140 * There's probably a better implementation if we're allowed to use
141 * BSD-style setreuid() rather than using POSIX saved-ids.
142 * Anyway, if you're euid root it's a bit pointless to drop the group
145 * I'm pretty happy that the security is good provided we aren't setuid root.
146 * The only things we trust with group=mail privilege are lkfopen()
151 * For setting and returning to "mail" gid
154 static gid_t return_gid
;
155 #define TRYDROPGROUPPRIVS() DROPGROUPPRIVS()
156 #define DROPGROUPPRIVS() \
157 if (setegid(getgid()) != 0) { \
158 adios ("setegid", "unable to restore group to %ld", (long) getgid()); \
160 #define GETGROUPPRIVS() \
161 if (setegid(return_gid) != 0) { \
162 adios ("setegid", "unable to set group to %ld", (long) return_gid); \
164 #define SAVEGROUPPRIVS() return_gid = getegid()
166 /* define *GROUPPRIVS() as null; this avoids having lots of "#ifdef MAILGROUP"s */
167 #define TRYDROPGROUPPRIVS()
168 #define DROPGROUPPRIVS()
169 #define GETGROUPPRIVS()
170 #define SAVEGROUPPRIVS()
171 #endif /* not MAILGROUP */
173 /* these variables have to be globals so that done() can correctly clean up the lockfile */
175 static char *newmail
;
181 static int maildir_srt(const void *va
, const void *vb
) PURE
;
182 static void inc_done(int) NORETURN
;
183 static int pop_action(void *closure
, char *);
186 maildir_srt(const void *va
, const void *vb
)
188 const struct Maildir_entry
*a
= va
, *b
= vb
;
189 if (a
->mtime
> b
->mtime
)
191 if (a
->mtime
< b
->mtime
)
197 main (int argc
, char **argv
)
204 int hghnum
= 0, msgnum
= 0;
206 bool sasl
, tls
, noverify
;
207 int incerr
= 0; /* <0 if inc hits an error which means it should not truncate mailspool */
208 char *cp
, *maildir
= NULL
, *folder
= NULL
;
209 char *format
= NULL
, *form
= NULL
;
210 char *host
= NULL
, *port
= NULL
, *user
= NULL
, *proxy
= NULL
;
211 char *audfile
= NULL
, *from
= NULL
, *saslmech
= NULL
, *auth_svc
= NULL
;
212 char buf
[BUFSIZ
], **argp
, *nfs
, **arguments
;
213 struct msgs
*mp
= NULL
;
216 char b
[PATH_MAX
+ 1];
217 char *maildir_copy
= NULL
; /* copy of mail directory because the static gets overwritten */
220 char *MAILHOST_env_variable
;
223 /* absolutely the first thing we do is save our privileges,
224 * and drop them if we can.
229 if (nmh_init(argv
[0], true, true)) { return 1; }
232 arguments
= getarguments (invo_name
, argc
, argv
, 1);
237 * use MAILHOST environment variable if present,
239 * If that fails, use the default (if any)
240 * provided by mts.conf in mts_init()
242 if ((MAILHOST_env_variable
= getenv("MAILHOST")) != NULL
)
243 pophost
= MAILHOST_env_variable
;
245 * If there is a valid "pophost" entry in mts.conf,
246 * then use it as the default host.
248 if (pophost
&& *pophost
)
252 chgflag
= noisy
= noverify
= true;
253 while ((cp
= *argp
++)) {
255 switch (smatch (++cp
, switches
)) {
257 ambigsw (cp
, switches
);
260 die("-%s unknown", cp
);
263 snprintf (buf
, sizeof(buf
), "%s [+folder] [switches]", invo_name
);
264 print_help (buf
, switches
, 1);
267 print_version(invo_name
);
271 if (!(cp
= *argp
++) || *cp
== '-')
272 die("missing argument to %s", argp
[-2]);
273 audfile
= mh_xstrdup(m_maildir(cp
));
287 * The flag `trnflag' has the value:
289 * 2 if -truncate is given
290 * 1 by default (truncating is default)
291 * 0 if -notruncate is given
301 if (!(cp
= *argp
++) || *cp
== '-')
302 die("missing argument to %s", argp
[-2]);
303 from
= path (cp
, TFILE
);
306 * If the truncate file is in default state,
307 * change to not truncate.
321 if (!(form
= *argp
++) || *form
== '-')
322 die("missing argument to %s", argp
[-2]);
326 if (!(format
= *argp
++) || *format
== '-')
327 die("missing argument to %s", argp
[-2]);
332 if (!(cp
= *argp
++) || *cp
== '-')
333 die("missing argument to %s", argp
[-2]);
338 if (!(host
= *argp
++) || *host
== '-')
339 die("missing argument to %s", argp
[-2]);
343 if (!(port
= *argp
++) || *port
== '-')
344 die("missing argument to %s", argp
[-2]);
348 if (!(user
= *argp
++) || *user
== '-')
349 die("missing argument to %s", argp
[-2]);
364 if (!(saslmech
= *argp
++) || *saslmech
== '-')
365 die("missing argument to %s", argp
[-2]);
386 if (!(auth_svc
= *argp
++) || *auth_svc
== '-')
387 die("missing argument to %s", argp
[-2]);
389 die("not built with OAuth support");
394 if (!(proxy
= *argp
++) || *proxy
== '-')
395 die("missing argument to %s", argp
[-2]);
399 if (*cp
== '+' || *cp
== '@') {
401 die("only one folder at a time!");
402 folder
= pluspath (cp
);
404 die("usage: %s [+folder] [switches]", invo_name
);
408 /* NOTE: above this point you should use TRYDROPGROUPPRIVS(),
409 * not DROPGROUPPRIVS().
414 /* guarantee dropping group privileges; we might not have done so earlier */
417 /* Source of mail; -from overrides any -host. */
418 inc_type
= host
&& !from
? INC_POP
: INC_FILE
;
420 if (inc_type
== INC_POP
) {
421 /* Mail from a POP server. */
424 if (auth_svc
== NULL
) {
425 if (saslmech
&& ! strcasecmp(saslmech
, "xoauth2")) {
426 die("must specify -authservice with -saslmech xoauth2");
430 die("must specify -user with -saslmech xoauth2");
435 tlsflag
|= P_INITTLS
;
438 tlsflag
|= P_NOVERIFY
;
441 * initialize POP connection
443 if (pop_init (host
, port
, user
, proxy
, snoop
, sasl
, saslmech
,
444 tlsflag
, auth_svc
) == NOTOK
)
447 /* Check if there are any messages */
448 if (pop_stat (&nmsgs
, &nbytes
) == NOTOK
)
453 die("no mail to incorporate");
456 } else if (inc_type
== INC_FILE
) {
457 /* Mail from a spool file, or Maildir. */
460 else if ((newmail
= getenv ("MAILDROP")) && *newmail
)
461 newmail
= m_mailpath (newmail
);
462 else if ((newmail
= context_find ("maildrop")) && *newmail
)
463 newmail
= m_mailpath (newmail
);
465 newmail
= concat (MAILDIR
, "/", MAILFIL
, NULL
);
467 if (stat (newmail
, &s1
) == NOTOK
|| s1
.st_size
== 0)
468 die("no mail to incorporate");
469 if (s1
.st_mode
& S_IFDIR
) {
475 cp
= concat (newmail
, "/new", NULL
);
476 if ((md
= opendir(cp
)) == NULL
)
477 die("unable to open %s", cp
);
478 while ((de
= readdir (md
)) != NULL
) {
479 if (de
->d_name
[0] == '.')
481 if (i
>= num_maildir_entries
) {
482 if ((Maildir
= realloc(Maildir
, sizeof(*Maildir
) * (2*i
+16))) == NULL
)
483 die("not enough memory for %d messages", 2*i
+16);
484 num_maildir_entries
= 2*i
+16;
486 Maildir
[i
].filename
= concat (cp
, "/", de
->d_name
, NULL
);
487 if (stat(Maildir
[i
].filename
, &ms
) != 0)
488 adios (Maildir
[i
].filename
, "couldn't get delivery time");
489 Maildir
[i
].mtime
= ms
.st_mtime
;
494 cp
= concat (newmail
, "/cur", NULL
);
495 if ((md
= opendir(cp
)) == NULL
)
496 die("unable to open %s", cp
);
497 while ((de
= readdir (md
)) != NULL
) {
498 if (de
->d_name
[0] == '.')
500 if (i
>= num_maildir_entries
) {
501 if ((Maildir
= realloc(Maildir
, sizeof(*Maildir
) * (2*i
+16))) == NULL
)
502 die("not enough memory for %d messages", 2*i
+16);
503 num_maildir_entries
= 2*i
+16;
505 Maildir
[i
].filename
= concat (cp
, "/", de
->d_name
, NULL
);
506 if (stat(Maildir
[i
].filename
, &ms
) != 0)
507 adios (Maildir
[i
].filename
, "couldn't get delivery time");
508 Maildir
[i
].mtime
= ms
.st_mtime
;
514 die("no mail to incorporate");
515 num_maildir_entries
= i
;
516 qsort (Maildir
, num_maildir_entries
, sizeof(*Maildir
), maildir_srt
);
519 cp
= mh_xstrdup(newmail
);
523 if (!context_find ("path"))
524 free (path ("./", TFOLDER
));
526 folder
= getfolder (0);
527 maildir
= m_maildir (folder
);
528 maildir_copy
= mh_xstrdup(maildir
);
530 if (!folder_exists(maildir
)) {
531 /* If the folder doesn't exist, and we're given the -silent flag,
535 create_folder(maildir
, 0, done
);
540 if (chdir (maildir
) == NOTOK
)
541 adios (maildir
, "unable to change directory to");
543 /* read folder and create message structure */
544 if (!(mp
= folder_read (folder
, 0)))
545 die("unable to read folder %s", folder
);
547 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
548 /* Mail from a spool file. */
550 if (access (newmail
, W_OK
) != NOTOK
) {
553 SIGNAL (SIGHUP
, SIG_IGN
);
554 SIGNAL (SIGINT
, SIG_IGN
);
555 SIGNAL (SIGQUIT
, SIG_IGN
);
556 SIGNAL (SIGTERM
, SIG_IGN
);
559 GETGROUPPRIVS(); /* Reset gid to lock mail file */
560 in
= lkfopenspool (newmail
, "r");
563 die("unable to lock and fopen %s", newmail
);
564 fstat (fileno(in
), &s1
);
567 if ((in
= fopen (newmail
, "r")) == NULL
)
568 adios (newmail
, "unable to read");
572 /* This shouldn't be necessary but it can't hurt. */
577 if ((i
= stat (audfile
, &st
)) == NOTOK
)
578 inform("Creating Receive-Audit: %s", audfile
);
579 if ((aud
= fopen (audfile
, "a")) == NULL
)
580 adios (audfile
, "unable to append to");
582 chmod (audfile
, m_gmprot ());
585 fprintf (aud
, "<<inc>> %s -ms %s\n", dtimenow(0), from
);
588 fprintf (aud
, "<<inc>> %s -host %s -user %s\n", dtimenow(0),
591 fprintf (aud
, "<<inc>> %s\n", dtimenow (0));
595 /* Get new format string */
596 nfs
= new_fs (form
, format
, FORMAT
);
599 printf ("Incorporating new mail into %s...\n\n", folder
);
605 * Get the mail from a POP server
607 if (inc_type
== INC_POP
) {
608 /* Mail from a POP server. */
612 hghnum
= msgnum
= mp
->hghmsg
;
613 for (i
= 1; i
<= nmsgs
; i
++) {
614 charstring_t scanl
= NULL
;
617 cp
= mh_xstrdup(m_name (msgnum
));
618 if ((pf
= fopen (cp
, "w+")) == NULL
)
619 adios (cp
, "unable to write");
620 chmod (cp
, m_gmprot ());
624 if (pop_retr(i
, pop_action
, &pc
) == NOTOK
)
628 adios (cp
, "write error on");
629 fseek (pf
, 0L, SEEK_SET
);
630 switch (incerr
= scan (pf
, msgnum
, 0, nfs
, width
,
631 msgnum
== mp
->hghmsg
+ 1 && chgflag
,
632 1, NULL
, pc
.written
, noisy
, &scanl
)) {
634 printf ("%*d empty\n", DMAXFOLDER
, msgnum
);
640 /* advise (cp, "unable to read"); already advised */
651 fputs (charstring_buffer (scanl
), aud
);
656 charstring_free (scanl
);
658 if (ferror(pf
) || fclose (pf
)) {
660 (void) m_unlink (cp
);
663 adios (cp
, "write error on");
667 if (trnflag
&& pop_dele (i
) == NOTOK
)
673 if (pop_quit () == NOTOK
)
676 } else if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
677 /* Mail from a spool file. */
679 scan_detect_mbox_style (in
); /* the MAGIC invocation... */
680 hghnum
= msgnum
= mp
->hghmsg
;
682 charstring_t scanl
= NULL
;
684 /* create scanline for new message */
685 switch (incerr
= scan (in
, msgnum
+ 1, msgnum
+ 1, nfs
, width
,
686 msgnum
== hghnum
&& chgflag
, 1, NULL
, 0L, noisy
,
694 fputs ("inc aborted!\n", aud
);
695 inform("aborted!"); /* doesn't clean up locks! */
699 inform("BUG in %s, number out of range", invo_name
);
703 inform("BUG in %s, scan() botch (%d)", invo_name
, incerr
);
709 * Run the external program hook on the message.
712 (void)snprintf(b
, sizeof (b
), "%s/%d", maildir_copy
, msgnum
+ 1);
713 (void)ext_hook("add-hook", b
, NULL
);
716 fputs (charstring_buffer (scanl
), aud
);
723 charstring_free (scanl
);
725 /* If we get here there was some sort of error from scan(),
726 * so stop processing anything more from the spool.
732 /* Mail from Maildir. */
737 hghnum
= msgnum
= mp
->hghmsg
;
738 for (i
= 0; i
< num_maildir_entries
; i
++) {
739 charstring_t scanl
= NULL
;
743 sp
= Maildir
[i
].filename
;
744 cp
= mh_xstrdup(m_name (msgnum
));
746 if (!trnflag
|| link(sp
, cp
) == -1) {
747 static char buf
[65536];
750 if ((sf
= fopen (sp
, "r")) == NULL
)
751 adios (sp
, "unable to read for copy");
752 if ((pf
= fopen (cp
, "w+")) == NULL
)
753 adios (cp
, "unable to write for copy");
754 while ((nrd
= fread(buf
, 1, sizeof(buf
), sf
)) > 0)
755 if (fwrite(buf
, 1, nrd
, pf
) != nrd
)
757 if (ferror(sf
) || fflush(pf
) || ferror(pf
)) {
759 fclose(pf
); fclose(sf
); (void) m_unlink(cp
);
761 adios(cp
, "copy error %s -> %s", sp
, cp
);
766 if (pf
== NULL
&& (pf
= fopen (cp
, "r")) == NULL
)
767 adios (cp
, "not available");
768 chmod (cp
, m_gmprot ());
770 fseek (pf
, 0L, SEEK_SET
);
771 switch (incerr
= scan (pf
, msgnum
, 0, nfs
, width
,
772 msgnum
== mp
->hghmsg
+ 1 && chgflag
,
773 1, NULL
, 0, noisy
, &scanl
)) {
775 printf ("%*d empty\n", DMAXFOLDER
, msgnum
);
781 /* advise (cp, "unable to read"); already advised */
792 * Run the external program hook on the message.
795 (void)snprintf(b
, sizeof (b
), "%s/%d", maildir_copy
, msgnum
+ 1);
796 (void)ext_hook("add-hook", b
, NULL
);
799 fputs (charstring_buffer (scanl
), aud
);
804 charstring_free (scanl
);
806 if (ferror(pf
) || fclose (pf
)) {
808 (void) m_unlink (cp
);
810 adios (cp
, "write error on");
815 if (trnflag
&& m_unlink (sp
) == NOTOK
)
816 adios (sp
, "couldn't unlink");
817 free (sp
); /* Free Maildir[i]->filename */
821 free (Maildir
); /* From now on Maildir is just a flag - don't dref! */
826 if (incerr
< 0) { /* error */
828 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
829 (void) lkfclosespool (in
, newmail
); in
= NULL
;
830 DROPGROUPPRIVS(); /* And then return us to normal privileges */
832 fclose (in
); in
= NULL
;
843 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
844 /* Mail from a spool file; truncate it. */
847 if (stat (newmail
, &st
) != NOTOK
&& s1
.st_mtime
!= st
.st_mtime
)
848 inform("new messages have arrived!\007");
851 if ((newfd
= creat (newmail
, 0600)) != NOTOK
)
854 admonish (newmail
, "error zero'ing");
858 printf ("%s not zero'd\n", newmail
);
862 if (msgnum
== hghnum
) {
863 inform("no messages incorporated, continuing...");
866 * Lock the sequence file now, and loop to set the right flags
867 * in the folder structure
873 context_replace (pfolder
, folder
); /* update current folder */
875 if ((mp2
= folder_read(folder
, 1)) == NULL
) {
876 inform("Unable to reread folder %s, continuing...", folder
);
881 * Shouldn't happen, but just in case ...
884 if (msgnum
>= mp2
->hghoff
885 && !(mp2
= folder_realloc (mp2
, mp2
->lowoff
, msgnum
+ 1))) {
886 inform("unable to reallocate folder storage");
891 mp2
->curmsg
= hghnum
+ 1;
892 mp2
->hghmsg
= msgnum
;
894 if (mp2
->lowmsg
== 0)
896 if (chgflag
) /* sigh... */
897 seq_setcur (mp2
, mp2
->curmsg
);
899 for (i
= hghnum
+ 1; i
<= msgnum
; i
++) {
900 clear_msg_flags (mp2
, i
);
904 mp2
->msgflags
|= SEQMOD
;
905 seq_setunseen(mp2
, 0); /* Set the Unseen-Sequence */
906 seq_save(mp2
); /* Save the sequence file */
911 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
912 /* Mail from a spool file; unlock it. */
915 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
916 (void) lkfclosespool (in
, newmail
); in
= NULL
;
917 DROPGROUPPRIVS(); /* And then return us to normal privileges */
919 fclose (in
); in
= NULL
;
923 context_save (); /* save the context file */
930 inc_done (int status
)
936 lkfclosespool(in
, newmail
);
943 pop_action(void *closure
, char *s
)
949 n
= fprintf(pc
->mailout
, "%s\n", s
);
952 pc
->written
+= n
; /* Count linefeed too. */