]>
diplodocus.org Git - nmh/blob - uip/inc.c
647305378a2baf910617110ee0f724a4a7e5081a
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
34 #include "sbr/smatch.h"
35 #include "sbr/getfolder.h"
36 #include "sbr/ext_hook.h"
37 #include "sbr/folder_read.h"
38 #include "sbr/folder_realloc.h"
39 #include "sbr/folder_free.h"
40 #include "sbr/context_save.h"
41 #include "sbr/context_replace.h"
42 #include "sbr/context_find.h"
43 #include "sbr/ambigsw.h"
45 #include "sbr/print_version.h"
46 #include "sbr/print_help.h"
47 #include "sbr/error.h"
50 #include "h/dropsbr.h"
52 #include "h/fmt_scan.h"
53 #include "h/scansbr.h"
54 #include "h/signals.h"
58 #include "sbr/lock_file.h"
59 #include "sbr/m_maildir.h"
60 #include "sbr/m_mktemp.h"
63 # define TLSminc(a) (a)
68 #define INC_SWITCHES \
69 X("audit audit-file", 0, AUDSW) \
70 X("noaudit", 0, NAUDSW) \
71 X("changecur", 0, CHGSW) \
72 X("nochangecur", 0, NCHGSW) \
73 X("file name", 0, FILESW) \
74 X("form formatfile", 0, FORMSW) \
75 X("format string", 5, FMTSW) \
76 X("host hostname", 0, HOSTSW) \
77 X("user username", 0, USERSW) \
78 X("port name/number", 0, PORTSW) \
79 X("silent", 0, SILSW) \
80 X("nosilent", 0, NSILSW) \
81 X("truncate", 0, TRNCSW) \
82 X("notruncate", 0, NTRNCSW) \
83 X("width columns", 0, WIDTHSW) \
84 X("version", 0, VERSIONSW) \
85 X("help", 0, HELPSW) \
86 X("snoop", 0, SNOOPSW) \
87 X("sasl", 0, SASLSW) \
88 X("nosasl", 0, NOSASLSW) \
89 X("saslmech", 0, SASLMECHSW) \
90 X("initialtls", TLSminc(-10), INITTLSSW) \
91 X("notls", TLSminc(-5), NOTLSSW) \
92 X("certverify", TLSminc(-10), CERTVERSW) \
93 X("nocertverify", TLSminc(-12), NOCERTVERSW) \
94 X("authservice", 0, AUTHSERVICESW) \
95 X("proxy command", 0, PROXYSW) \
97 #define X(sw, minchars, id) id,
98 DEFINE_SWITCH_ENUM(INC
);
101 #define X(sw, minchars, id) { sw, minchars, id },
102 DEFINE_SWITCH_ARRAY(INC
, switches
);
106 * flags for the mail source
111 static struct Maildir_entry
{
115 static int num_maildir_entries
= 0;
123 extern char response
[];
125 /* This is an attempt to simplify things by putting all the
126 * privilege ops into macros.
127 * *GROUPPRIVS() is related to handling the setgid MAIL property,
128 * and only applies if MAILGROUP is defined.
129 * Basically, SAVEGROUPPRIVS() is called right at the top of main()
130 * to initialise things, and then DROPGROUPPRIVS() and GETGROUPPRIVS()
131 * do the obvious thing.
133 * There's probably a better implementation if we're allowed to use
134 * BSD-style setreuid() rather than using POSIX saved-ids.
135 * Anyway, if you're euid root it's a bit pointless to drop the group
138 * I'm pretty happy that the security is good provided we aren't setuid root.
139 * The only things we trust with group=mail privilege are lkfopen()
144 * For setting and returning to "mail" gid
147 static gid_t return_gid
;
148 #define TRYDROPGROUPPRIVS() DROPGROUPPRIVS()
149 #define DROPGROUPPRIVS() \
150 if (setegid(getgid()) != 0) { \
151 adios ("setegid", "unable to restore group to %ld", (long) getgid()); \
153 #define GETGROUPPRIVS() \
154 if (setegid(return_gid) != 0) { \
155 adios ("setegid", "unable to set group to %ld", (long) return_gid); \
157 #define SAVEGROUPPRIVS() return_gid = getegid()
159 /* define *GROUPPRIVS() as null; this avoids having lots of "#ifdef MAILGROUP"s */
160 #define TRYDROPGROUPPRIVS()
161 #define DROPGROUPPRIVS()
162 #define GETGROUPPRIVS()
163 #define SAVEGROUPPRIVS()
164 #endif /* not MAILGROUP */
166 /* these variables have to be globals so that done() can correctly clean up the lockfile */
168 static char *newmail
;
174 static int maildir_srt(const void *va
, const void *vb
) PURE
;
175 static void inc_done(int) NORETURN
;
176 static int pop_action(void *closure
, char *);
179 maildir_srt(const void *va
, const void *vb
)
181 const struct Maildir_entry
*a
= va
, *b
= vb
;
182 if (a
->mtime
> b
->mtime
)
184 if (a
->mtime
< b
->mtime
)
190 main (int argc
, char **argv
)
197 int hghnum
= 0, msgnum
= 0;
199 bool sasl
, tls
, noverify
;
200 int incerr
= 0; /* <0 if inc hits an error which means it should not truncate mailspool */
201 char *cp
, *maildir
= NULL
, *folder
= NULL
;
202 char *format
= NULL
, *form
= NULL
;
203 char *host
= NULL
, *port
= NULL
, *user
= NULL
, *proxy
= NULL
;
204 char *audfile
= NULL
, *from
= NULL
, *saslmech
= NULL
, *auth_svc
= NULL
;
205 char buf
[BUFSIZ
], **argp
, *nfs
, **arguments
;
206 struct msgs
*mp
= NULL
;
209 char b
[PATH_MAX
+ 1];
210 char *maildir_copy
= NULL
; /* copy of mail directory because the static gets overwritten */
213 char *MAILHOST_env_variable
;
216 /* absolutely the first thing we do is save our privileges,
217 * and drop them if we can.
222 if (nmh_init(argv
[0], true, true)) { return 1; }
225 arguments
= getarguments (invo_name
, argc
, argv
, 1);
230 * use MAILHOST environment variable if present,
232 * If that fails, use the default (if any)
233 * provided by mts.conf in mts_init()
235 if ((MAILHOST_env_variable
= getenv("MAILHOST")) != NULL
)
236 pophost
= MAILHOST_env_variable
;
238 * If there is a valid "pophost" entry in mts.conf,
239 * then use it as the default host.
241 if (pophost
&& *pophost
)
245 chgflag
= noisy
= noverify
= true;
246 while ((cp
= *argp
++)) {
248 switch (smatch (++cp
, switches
)) {
250 ambigsw (cp
, switches
);
253 die("-%s unknown", cp
);
256 snprintf (buf
, sizeof(buf
), "%s [+folder] [switches]", invo_name
);
257 print_help (buf
, switches
, 1);
260 print_version(invo_name
);
264 if (!(cp
= *argp
++) || *cp
== '-')
265 die("missing argument to %s", argp
[-2]);
266 audfile
= mh_xstrdup(m_maildir(cp
));
280 * The flag `trnflag' has the value:
282 * 2 if -truncate is given
283 * 1 by default (truncating is default)
284 * 0 if -notruncate is given
294 if (!(cp
= *argp
++) || *cp
== '-')
295 die("missing argument to %s", argp
[-2]);
296 from
= path (cp
, TFILE
);
299 * If the truncate file is in default state,
300 * change to not truncate.
314 if (!(form
= *argp
++) || *form
== '-')
315 die("missing argument to %s", argp
[-2]);
319 if (!(format
= *argp
++) || *format
== '-')
320 die("missing argument to %s", argp
[-2]);
325 if (!(cp
= *argp
++) || *cp
== '-')
326 die("missing argument to %s", argp
[-2]);
331 if (!(host
= *argp
++) || *host
== '-')
332 die("missing argument to %s", argp
[-2]);
336 if (!(port
= *argp
++) || *port
== '-')
337 die("missing argument to %s", argp
[-2]);
341 if (!(user
= *argp
++) || *user
== '-')
342 die("missing argument to %s", argp
[-2]);
357 if (!(saslmech
= *argp
++) || *saslmech
== '-')
358 die("missing argument to %s", argp
[-2]);
379 if (!(auth_svc
= *argp
++) || *auth_svc
== '-')
380 die("missing argument to %s", argp
[-2]);
382 die("not built with OAuth support");
387 if (!(proxy
= *argp
++) || *proxy
== '-')
388 die("missing argument to %s", argp
[-2]);
392 if (*cp
== '+' || *cp
== '@') {
394 die("only one folder at a time!");
395 folder
= pluspath (cp
);
397 die("usage: %s [+folder] [switches]", invo_name
);
401 /* NOTE: above this point you should use TRYDROPGROUPPRIVS(),
402 * not DROPGROUPPRIVS().
407 /* guarantee dropping group privileges; we might not have done so earlier */
410 /* Source of mail; -from overrides any -host. */
411 inc_type
= host
&& !from
? INC_POP
: INC_FILE
;
413 if (inc_type
== INC_POP
) {
414 /* Mail from a POP server. */
417 if (auth_svc
== NULL
) {
418 if (saslmech
&& ! strcasecmp(saslmech
, "xoauth2")) {
419 die("must specify -authservice with -saslmech xoauth2");
423 die("must specify -user with -saslmech xoauth2");
428 tlsflag
|= P_INITTLS
;
431 tlsflag
|= P_NOVERIFY
;
434 * initialize POP connection
436 if (pop_init (host
, port
, user
, proxy
, snoop
, sasl
, saslmech
,
437 tlsflag
, auth_svc
) == NOTOK
)
440 /* Check if there are any messages */
441 if (pop_stat (&nmsgs
, &nbytes
) == NOTOK
)
446 die("no mail to incorporate");
449 } else if (inc_type
== INC_FILE
) {
450 /* Mail from a spool file, or Maildir. */
453 else if ((newmail
= getenv ("MAILDROP")) && *newmail
)
454 newmail
= m_mailpath (newmail
);
455 else if ((newmail
= context_find ("maildrop")) && *newmail
)
456 newmail
= m_mailpath (newmail
);
458 newmail
= concat (MAILDIR
, "/", MAILFIL
, NULL
);
460 if (stat (newmail
, &s1
) == NOTOK
|| s1
.st_size
== 0)
461 die("no mail to incorporate");
462 if (s1
.st_mode
& S_IFDIR
) {
468 cp
= concat (newmail
, "/new", NULL
);
469 if ((md
= opendir(cp
)) == NULL
)
470 die("unable to open %s", cp
);
471 while ((de
= readdir (md
)) != NULL
) {
472 if (de
->d_name
[0] == '.')
474 if (i
>= num_maildir_entries
) {
475 if ((Maildir
= realloc(Maildir
, sizeof(*Maildir
) * (2*i
+16))) == NULL
)
476 die("not enough memory for %d messages", 2*i
+16);
477 num_maildir_entries
= 2*i
+16;
479 Maildir
[i
].filename
= concat (cp
, "/", de
->d_name
, NULL
);
480 if (stat(Maildir
[i
].filename
, &ms
) != 0)
481 adios (Maildir
[i
].filename
, "couldn't get delivery time");
482 Maildir
[i
].mtime
= ms
.st_mtime
;
487 cp
= concat (newmail
, "/cur", NULL
);
488 if ((md
= opendir(cp
)) == NULL
)
489 die("unable to open %s", cp
);
490 while ((de
= readdir (md
)) != NULL
) {
491 if (de
->d_name
[0] == '.')
493 if (i
>= num_maildir_entries
) {
494 if ((Maildir
= realloc(Maildir
, sizeof(*Maildir
) * (2*i
+16))) == NULL
)
495 die("not enough memory for %d messages", 2*i
+16);
496 num_maildir_entries
= 2*i
+16;
498 Maildir
[i
].filename
= concat (cp
, "/", de
->d_name
, NULL
);
499 if (stat(Maildir
[i
].filename
, &ms
) != 0)
500 adios (Maildir
[i
].filename
, "couldn't get delivery time");
501 Maildir
[i
].mtime
= ms
.st_mtime
;
507 die("no mail to incorporate");
508 num_maildir_entries
= i
;
509 qsort (Maildir
, num_maildir_entries
, sizeof(*Maildir
), maildir_srt
);
512 cp
= mh_xstrdup(newmail
);
516 if (!context_find ("path"))
517 free (path ("./", TFOLDER
));
519 folder
= getfolder (0);
520 maildir
= m_maildir (folder
);
521 maildir_copy
= mh_xstrdup(maildir
);
523 if (!folder_exists(maildir
)) {
524 /* If the folder doesn't exist, and we're given the -silent flag,
528 create_folder(maildir
, 0, done
);
533 if (chdir (maildir
) == NOTOK
)
534 adios (maildir
, "unable to change directory to");
536 /* read folder and create message structure */
537 if (!(mp
= folder_read (folder
, 0)))
538 die("unable to read folder %s", folder
);
540 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
541 /* Mail from a spool file. */
543 if (access (newmail
, W_OK
) != NOTOK
) {
546 SIGNAL (SIGHUP
, SIG_IGN
);
547 SIGNAL (SIGINT
, SIG_IGN
);
548 SIGNAL (SIGQUIT
, SIG_IGN
);
549 SIGNAL (SIGTERM
, SIG_IGN
);
552 GETGROUPPRIVS(); /* Reset gid to lock mail file */
553 in
= lkfopenspool (newmail
, "r");
556 die("unable to lock and fopen %s", newmail
);
557 fstat (fileno(in
), &s1
);
560 if ((in
= fopen (newmail
, "r")) == NULL
)
561 adios (newmail
, "unable to read");
565 /* This shouldn't be necessary but it can't hurt. */
570 if ((i
= stat (audfile
, &st
)) == NOTOK
)
571 inform("Creating Receive-Audit: %s", audfile
);
572 if ((aud
= fopen (audfile
, "a")) == NULL
)
573 adios (audfile
, "unable to append to");
575 chmod (audfile
, m_gmprot ());
578 fprintf (aud
, "<<inc>> %s -ms %s\n", dtimenow(0), from
);
581 fprintf (aud
, "<<inc>> %s -host %s -user %s\n", dtimenow(0),
584 fprintf (aud
, "<<inc>> %s\n", dtimenow (0));
588 /* Get new format string */
589 nfs
= new_fs (form
, format
, FORMAT
);
592 printf ("Incorporating new mail into %s...\n\n", folder
);
598 * Get the mail from a POP server
600 if (inc_type
== INC_POP
) {
601 /* Mail from a POP server. */
605 hghnum
= msgnum
= mp
->hghmsg
;
606 for (i
= 1; i
<= nmsgs
; i
++) {
607 charstring_t scanl
= NULL
;
610 cp
= mh_xstrdup(m_name (msgnum
));
611 if ((pf
= fopen (cp
, "w+")) == NULL
)
612 adios (cp
, "unable to write");
613 chmod (cp
, m_gmprot ());
617 if (pop_retr(i
, pop_action
, &pc
) == NOTOK
)
621 adios (cp
, "write error on");
622 fseek (pf
, 0L, SEEK_SET
);
623 switch (incerr
= scan (pf
, msgnum
, 0, nfs
, width
,
624 msgnum
== mp
->hghmsg
+ 1 && chgflag
,
625 1, NULL
, pc
.written
, noisy
, &scanl
)) {
627 printf ("%*d empty\n", DMAXFOLDER
, msgnum
);
633 /* advise (cp, "unable to read"); already advised */
644 fputs (charstring_buffer (scanl
), aud
);
649 charstring_free (scanl
);
651 if (ferror(pf
) || fclose (pf
)) {
653 (void) m_unlink (cp
);
656 adios (cp
, "write error on");
660 if (trnflag
&& pop_dele (i
) == NOTOK
)
666 if (pop_quit () == NOTOK
)
669 } else if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
670 /* Mail from a spool file. */
672 scan_detect_mbox_style (in
); /* the MAGIC invocation... */
673 hghnum
= msgnum
= mp
->hghmsg
;
675 charstring_t scanl
= NULL
;
677 /* create scanline for new message */
678 switch (incerr
= scan (in
, msgnum
+ 1, msgnum
+ 1, nfs
, width
,
679 msgnum
== hghnum
&& chgflag
, 1, NULL
, 0L, noisy
,
687 fputs ("inc aborted!\n", aud
);
688 inform("aborted!"); /* doesn't clean up locks! */
692 inform("BUG in %s, number out of range", invo_name
);
696 inform("BUG in %s, scan() botch (%d)", invo_name
, incerr
);
702 * Run the external program hook on the message.
705 (void)snprintf(b
, sizeof (b
), "%s/%d", maildir_copy
, msgnum
+ 1);
706 (void)ext_hook("add-hook", b
, NULL
);
709 fputs (charstring_buffer (scanl
), aud
);
716 charstring_free (scanl
);
718 /* If we get here there was some sort of error from scan(),
719 * so stop processing anything more from the spool.
725 /* Mail from Maildir. */
730 hghnum
= msgnum
= mp
->hghmsg
;
731 for (i
= 0; i
< num_maildir_entries
; i
++) {
732 charstring_t scanl
= NULL
;
736 sp
= Maildir
[i
].filename
;
737 cp
= mh_xstrdup(m_name (msgnum
));
739 if (!trnflag
|| link(sp
, cp
) == -1) {
740 static char buf
[65536];
743 if ((sf
= fopen (sp
, "r")) == NULL
)
744 adios (sp
, "unable to read for copy");
745 if ((pf
= fopen (cp
, "w+")) == NULL
)
746 adios (cp
, "unable to write for copy");
747 while ((nrd
= fread(buf
, 1, sizeof(buf
), sf
)) > 0)
748 if (fwrite(buf
, 1, nrd
, pf
) != nrd
)
750 if (ferror(sf
) || fflush(pf
) || ferror(pf
)) {
752 fclose(pf
); fclose(sf
); (void) m_unlink(cp
);
754 adios(cp
, "copy error %s -> %s", sp
, cp
);
759 if (pf
== NULL
&& (pf
= fopen (cp
, "r")) == NULL
)
760 adios (cp
, "not available");
761 chmod (cp
, m_gmprot ());
763 fseek (pf
, 0L, SEEK_SET
);
764 switch (incerr
= scan (pf
, msgnum
, 0, nfs
, width
,
765 msgnum
== mp
->hghmsg
+ 1 && chgflag
,
766 1, NULL
, 0, noisy
, &scanl
)) {
768 printf ("%*d empty\n", DMAXFOLDER
, msgnum
);
774 /* advise (cp, "unable to read"); already advised */
785 * Run the external program hook on the message.
788 (void)snprintf(b
, sizeof (b
), "%s/%d", maildir_copy
, msgnum
+ 1);
789 (void)ext_hook("add-hook", b
, NULL
);
792 fputs (charstring_buffer (scanl
), aud
);
797 charstring_free (scanl
);
799 if (ferror(pf
) || fclose (pf
)) {
801 (void) m_unlink (cp
);
803 adios (cp
, "write error on");
808 if (trnflag
&& m_unlink (sp
) == NOTOK
)
809 adios (sp
, "couldn't unlink");
810 free (sp
); /* Free Maildir[i]->filename */
814 free (Maildir
); /* From now on Maildir is just a flag - don't dref! */
819 if (incerr
< 0) { /* error */
821 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
822 (void) lkfclosespool (in
, newmail
); in
= NULL
;
823 DROPGROUPPRIVS(); /* And then return us to normal privileges */
825 fclose (in
); in
= NULL
;
836 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
837 /* Mail from a spool file; truncate it. */
840 if (stat (newmail
, &st
) != NOTOK
&& s1
.st_mtime
!= st
.st_mtime
)
841 inform("new messages have arrived!\007");
844 if ((newfd
= creat (newmail
, 0600)) != NOTOK
)
847 admonish (newmail
, "error zero'ing");
851 printf ("%s not zero'd\n", newmail
);
855 if (msgnum
== hghnum
) {
856 inform("no messages incorporated, continuing...");
859 * Lock the sequence file now, and loop to set the right flags
860 * in the folder structure
866 context_replace (pfolder
, folder
); /* update current folder */
868 if ((mp2
= folder_read(folder
, 1)) == NULL
) {
869 inform("Unable to reread folder %s, continuing...", folder
);
874 * Shouldn't happen, but just in case ...
877 if (msgnum
>= mp2
->hghoff
878 && !(mp2
= folder_realloc (mp2
, mp2
->lowoff
, msgnum
+ 1))) {
879 inform("unable to reallocate folder storage");
884 mp2
->curmsg
= hghnum
+ 1;
885 mp2
->hghmsg
= msgnum
;
887 if (mp2
->lowmsg
== 0)
889 if (chgflag
) /* sigh... */
890 seq_setcur (mp2
, mp2
->curmsg
);
892 for (i
= hghnum
+ 1; i
<= msgnum
; i
++) {
893 clear_msg_flags (mp2
, i
);
897 mp2
->msgflags
|= SEQMOD
;
898 seq_setunseen(mp2
, 0); /* Set the Unseen-Sequence */
899 seq_save(mp2
); /* Save the sequence file */
904 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
905 /* Mail from a spool file; unlock it. */
908 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
909 (void) lkfclosespool (in
, newmail
); in
= NULL
;
910 DROPGROUPPRIVS(); /* And then return us to normal privileges */
912 fclose (in
); in
= NULL
;
916 context_save (); /* save the context file */
923 inc_done (int status
)
929 lkfclosespool(in
, newmail
);
936 pop_action(void *closure
, char *s
)
942 n
= fprintf(pc
->mailout
, "%s\n", s
);
945 pc
->written
+= n
; /* Count linefeed too. */