]>
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
34 #include "sbr/seq_setcur.h"
35 #include "sbr/seq_save.h"
36 #include "sbr/smatch.h"
37 #include "sbr/getfolder.h"
38 #include "sbr/ext_hook.h"
39 #include "sbr/folder_read.h"
40 #include "sbr/folder_realloc.h"
41 #include "sbr/folder_free.h"
42 #include "sbr/context_save.h"
43 #include "sbr/context_replace.h"
44 #include "sbr/context_find.h"
45 #include "sbr/ambigsw.h"
47 #include "sbr/print_version.h"
48 #include "sbr/print_help.h"
49 #include "sbr/error.h"
52 #include "h/dropsbr.h"
54 #include "h/fmt_scan.h"
55 #include "h/scansbr.h"
56 #include "h/signals.h"
60 #include "sbr/lock_file.h"
61 #include "sbr/m_maildir.h"
62 #include "sbr/m_mktemp.h"
65 # define TLSminc(a) (a)
70 #define INC_SWITCHES \
71 X("audit audit-file", 0, AUDSW) \
72 X("noaudit", 0, NAUDSW) \
73 X("changecur", 0, CHGSW) \
74 X("nochangecur", 0, NCHGSW) \
75 X("file name", 0, FILESW) \
76 X("form formatfile", 0, FORMSW) \
77 X("format string", 5, FMTSW) \
78 X("host hostname", 0, HOSTSW) \
79 X("user username", 0, USERSW) \
80 X("port name/number", 0, PORTSW) \
81 X("silent", 0, SILSW) \
82 X("nosilent", 0, NSILSW) \
83 X("truncate", 0, TRNCSW) \
84 X("notruncate", 0, NTRNCSW) \
85 X("width columns", 0, WIDTHSW) \
86 X("version", 0, VERSIONSW) \
87 X("help", 0, HELPSW) \
88 X("snoop", 0, SNOOPSW) \
89 X("sasl", 0, SASLSW) \
90 X("nosasl", 0, NOSASLSW) \
91 X("saslmech", 0, SASLMECHSW) \
92 X("initialtls", TLSminc(-10), INITTLSSW) \
93 X("notls", TLSminc(-5), NOTLSSW) \
94 X("certverify", TLSminc(-10), CERTVERSW) \
95 X("nocertverify", TLSminc(-12), NOCERTVERSW) \
96 X("authservice", 0, AUTHSERVICESW) \
97 X("proxy command", 0, PROXYSW) \
99 #define X(sw, minchars, id) id,
100 DEFINE_SWITCH_ENUM(INC
);
103 #define X(sw, minchars, id) { sw, minchars, id },
104 DEFINE_SWITCH_ARRAY(INC
, switches
);
108 * flags for the mail source
113 static struct Maildir_entry
{
117 static int num_maildir_entries
= 0;
125 extern char response
[];
127 /* This is an attempt to simplify things by putting all the
128 * privilege ops into macros.
129 * *GROUPPRIVS() is related to handling the setgid MAIL property,
130 * and only applies if MAILGROUP is defined.
131 * Basically, SAVEGROUPPRIVS() is called right at the top of main()
132 * to initialise things, and then DROPGROUPPRIVS() and GETGROUPPRIVS()
133 * do the obvious thing.
135 * There's probably a better implementation if we're allowed to use
136 * BSD-style setreuid() rather than using POSIX saved-ids.
137 * Anyway, if you're euid root it's a bit pointless to drop the group
140 * I'm pretty happy that the security is good provided we aren't setuid root.
141 * The only things we trust with group=mail privilege are lkfopen()
146 * For setting and returning to "mail" gid
149 static gid_t return_gid
;
150 #define TRYDROPGROUPPRIVS() DROPGROUPPRIVS()
151 #define DROPGROUPPRIVS() \
152 if (setegid(getgid()) != 0) { \
153 adios ("setegid", "unable to restore group to %ld", (long) getgid()); \
155 #define GETGROUPPRIVS() \
156 if (setegid(return_gid) != 0) { \
157 adios ("setegid", "unable to set group to %ld", (long) return_gid); \
159 #define SAVEGROUPPRIVS() return_gid = getegid()
161 /* define *GROUPPRIVS() as null; this avoids having lots of "#ifdef MAILGROUP"s */
162 #define TRYDROPGROUPPRIVS()
163 #define DROPGROUPPRIVS()
164 #define GETGROUPPRIVS()
165 #define SAVEGROUPPRIVS()
166 #endif /* not MAILGROUP */
168 /* these variables have to be globals so that done() can correctly clean up the lockfile */
170 static char *newmail
;
176 static int maildir_srt(const void *va
, const void *vb
) PURE
;
177 static void inc_done(int) NORETURN
;
178 static int pop_action(void *closure
, char *);
181 maildir_srt(const void *va
, const void *vb
)
183 const struct Maildir_entry
*a
= va
, *b
= vb
;
184 if (a
->mtime
> b
->mtime
)
186 if (a
->mtime
< b
->mtime
)
192 main (int argc
, char **argv
)
199 int hghnum
= 0, msgnum
= 0;
201 bool sasl
, tls
, noverify
;
202 int incerr
= 0; /* <0 if inc hits an error which means it should not truncate mailspool */
203 char *cp
, *maildir
= NULL
, *folder
= NULL
;
204 char *format
= NULL
, *form
= NULL
;
205 char *host
= NULL
, *port
= NULL
, *user
= NULL
, *proxy
= NULL
;
206 char *audfile
= NULL
, *from
= NULL
, *saslmech
= NULL
, *auth_svc
= NULL
;
207 char buf
[BUFSIZ
], **argp
, *nfs
, **arguments
;
208 struct msgs
*mp
= NULL
;
211 char b
[PATH_MAX
+ 1];
212 char *maildir_copy
= NULL
; /* copy of mail directory because the static gets overwritten */
215 char *MAILHOST_env_variable
;
218 /* absolutely the first thing we do is save our privileges,
219 * and drop them if we can.
224 if (nmh_init(argv
[0], true, true)) { return 1; }
227 arguments
= getarguments (invo_name
, argc
, argv
, 1);
232 * use MAILHOST environment variable if present,
234 * If that fails, use the default (if any)
235 * provided by mts.conf in mts_init()
237 if ((MAILHOST_env_variable
= getenv("MAILHOST")) != NULL
)
238 pophost
= MAILHOST_env_variable
;
240 * If there is a valid "pophost" entry in mts.conf,
241 * then use it as the default host.
243 if (pophost
&& *pophost
)
247 chgflag
= noisy
= noverify
= true;
248 while ((cp
= *argp
++)) {
250 switch (smatch (++cp
, switches
)) {
252 ambigsw (cp
, switches
);
255 die("-%s unknown", cp
);
258 snprintf (buf
, sizeof(buf
), "%s [+folder] [switches]", invo_name
);
259 print_help (buf
, switches
, 1);
262 print_version(invo_name
);
266 if (!(cp
= *argp
++) || *cp
== '-')
267 die("missing argument to %s", argp
[-2]);
268 audfile
= mh_xstrdup(m_maildir(cp
));
282 * The flag `trnflag' has the value:
284 * 2 if -truncate is given
285 * 1 by default (truncating is default)
286 * 0 if -notruncate is given
296 if (!(cp
= *argp
++) || *cp
== '-')
297 die("missing argument to %s", argp
[-2]);
298 from
= path (cp
, TFILE
);
301 * If the truncate file is in default state,
302 * change to not truncate.
316 if (!(form
= *argp
++) || *form
== '-')
317 die("missing argument to %s", argp
[-2]);
321 if (!(format
= *argp
++) || *format
== '-')
322 die("missing argument to %s", argp
[-2]);
327 if (!(cp
= *argp
++) || *cp
== '-')
328 die("missing argument to %s", argp
[-2]);
333 if (!(host
= *argp
++) || *host
== '-')
334 die("missing argument to %s", argp
[-2]);
338 if (!(port
= *argp
++) || *port
== '-')
339 die("missing argument to %s", argp
[-2]);
343 if (!(user
= *argp
++) || *user
== '-')
344 die("missing argument to %s", argp
[-2]);
359 if (!(saslmech
= *argp
++) || *saslmech
== '-')
360 die("missing argument to %s", argp
[-2]);
381 if (!(auth_svc
= *argp
++) || *auth_svc
== '-')
382 die("missing argument to %s", argp
[-2]);
384 die("not built with OAuth support");
389 if (!(proxy
= *argp
++) || *proxy
== '-')
390 die("missing argument to %s", argp
[-2]);
394 if (*cp
== '+' || *cp
== '@') {
396 die("only one folder at a time!");
397 folder
= pluspath (cp
);
399 die("usage: %s [+folder] [switches]", invo_name
);
403 /* NOTE: above this point you should use TRYDROPGROUPPRIVS(),
404 * not DROPGROUPPRIVS().
409 /* guarantee dropping group privileges; we might not have done so earlier */
412 /* Source of mail; -from overrides any -host. */
413 inc_type
= host
&& !from
? INC_POP
: INC_FILE
;
415 if (inc_type
== INC_POP
) {
416 /* Mail from a POP server. */
419 if (auth_svc
== NULL
) {
420 if (saslmech
&& ! strcasecmp(saslmech
, "xoauth2")) {
421 die("must specify -authservice with -saslmech xoauth2");
425 die("must specify -user with -saslmech xoauth2");
430 tlsflag
|= P_INITTLS
;
433 tlsflag
|= P_NOVERIFY
;
436 * initialize POP connection
438 if (pop_init (host
, port
, user
, proxy
, snoop
, sasl
, saslmech
,
439 tlsflag
, auth_svc
) == NOTOK
)
442 /* Check if there are any messages */
443 if (pop_stat (&nmsgs
, &nbytes
) == NOTOK
)
448 die("no mail to incorporate");
451 } else if (inc_type
== INC_FILE
) {
452 /* Mail from a spool file, or Maildir. */
455 else if ((newmail
= getenv ("MAILDROP")) && *newmail
)
456 newmail
= m_mailpath (newmail
);
457 else if ((newmail
= context_find ("maildrop")) && *newmail
)
458 newmail
= m_mailpath (newmail
);
460 newmail
= concat (MAILDIR
, "/", MAILFIL
, NULL
);
462 if (stat (newmail
, &s1
) == NOTOK
|| s1
.st_size
== 0)
463 die("no mail to incorporate");
464 if (s1
.st_mode
& S_IFDIR
) {
470 cp
= concat (newmail
, "/new", NULL
);
471 if ((md
= opendir(cp
)) == NULL
)
472 die("unable to open %s", cp
);
473 while ((de
= readdir (md
)) != NULL
) {
474 if (de
->d_name
[0] == '.')
476 if (i
>= num_maildir_entries
) {
477 if ((Maildir
= realloc(Maildir
, sizeof(*Maildir
) * (2*i
+16))) == NULL
)
478 die("not enough memory for %d messages", 2*i
+16);
479 num_maildir_entries
= 2*i
+16;
481 Maildir
[i
].filename
= concat (cp
, "/", de
->d_name
, NULL
);
482 if (stat(Maildir
[i
].filename
, &ms
) != 0)
483 adios (Maildir
[i
].filename
, "couldn't get delivery time");
484 Maildir
[i
].mtime
= ms
.st_mtime
;
489 cp
= concat (newmail
, "/cur", NULL
);
490 if ((md
= opendir(cp
)) == NULL
)
491 die("unable to open %s", cp
);
492 while ((de
= readdir (md
)) != NULL
) {
493 if (de
->d_name
[0] == '.')
495 if (i
>= num_maildir_entries
) {
496 if ((Maildir
= realloc(Maildir
, sizeof(*Maildir
) * (2*i
+16))) == NULL
)
497 die("not enough memory for %d messages", 2*i
+16);
498 num_maildir_entries
= 2*i
+16;
500 Maildir
[i
].filename
= concat (cp
, "/", de
->d_name
, NULL
);
501 if (stat(Maildir
[i
].filename
, &ms
) != 0)
502 adios (Maildir
[i
].filename
, "couldn't get delivery time");
503 Maildir
[i
].mtime
= ms
.st_mtime
;
509 die("no mail to incorporate");
510 num_maildir_entries
= i
;
511 qsort (Maildir
, num_maildir_entries
, sizeof(*Maildir
), maildir_srt
);
514 cp
= mh_xstrdup(newmail
);
518 if (!context_find ("path"))
519 free (path ("./", TFOLDER
));
521 folder
= getfolder (0);
522 maildir
= m_maildir (folder
);
523 maildir_copy
= mh_xstrdup(maildir
);
525 if (!folder_exists(maildir
)) {
526 /* If the folder doesn't exist, and we're given the -silent flag,
530 create_folder(maildir
, 0, done
);
535 if (chdir (maildir
) == NOTOK
)
536 adios (maildir
, "unable to change directory to");
538 /* read folder and create message structure */
539 if (!(mp
= folder_read (folder
, 0)))
540 die("unable to read folder %s", folder
);
542 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
543 /* Mail from a spool file. */
545 if (access (newmail
, W_OK
) != NOTOK
) {
548 SIGNAL (SIGHUP
, SIG_IGN
);
549 SIGNAL (SIGINT
, SIG_IGN
);
550 SIGNAL (SIGQUIT
, SIG_IGN
);
551 SIGNAL (SIGTERM
, SIG_IGN
);
554 GETGROUPPRIVS(); /* Reset gid to lock mail file */
555 in
= lkfopenspool (newmail
, "r");
558 die("unable to lock and fopen %s", newmail
);
559 fstat (fileno(in
), &s1
);
562 if ((in
= fopen (newmail
, "r")) == NULL
)
563 adios (newmail
, "unable to read");
567 /* This shouldn't be necessary but it can't hurt. */
572 if ((i
= stat (audfile
, &st
)) == NOTOK
)
573 inform("Creating Receive-Audit: %s", audfile
);
574 if ((aud
= fopen (audfile
, "a")) == NULL
)
575 adios (audfile
, "unable to append to");
577 chmod (audfile
, m_gmprot ());
580 fprintf (aud
, "<<inc>> %s -ms %s\n", dtimenow(0), from
);
583 fprintf (aud
, "<<inc>> %s -host %s -user %s\n", dtimenow(0),
586 fprintf (aud
, "<<inc>> %s\n", dtimenow (0));
590 /* Get new format string */
591 nfs
= new_fs (form
, format
, FORMAT
);
594 printf ("Incorporating new mail into %s...\n\n", folder
);
600 * Get the mail from a POP server
602 if (inc_type
== INC_POP
) {
603 /* Mail from a POP server. */
607 hghnum
= msgnum
= mp
->hghmsg
;
608 for (i
= 1; i
<= nmsgs
; i
++) {
609 charstring_t scanl
= NULL
;
612 cp
= mh_xstrdup(m_name (msgnum
));
613 if ((pf
= fopen (cp
, "w+")) == NULL
)
614 adios (cp
, "unable to write");
615 chmod (cp
, m_gmprot ());
619 if (pop_retr(i
, pop_action
, &pc
) == NOTOK
)
623 adios (cp
, "write error on");
624 fseek (pf
, 0L, SEEK_SET
);
625 switch (incerr
= scan (pf
, msgnum
, 0, nfs
, width
,
626 msgnum
== mp
->hghmsg
+ 1 && chgflag
,
627 1, NULL
, pc
.written
, noisy
, &scanl
)) {
629 printf ("%*d empty\n", DMAXFOLDER
, msgnum
);
635 /* advise (cp, "unable to read"); already advised */
646 fputs (charstring_buffer (scanl
), aud
);
651 charstring_free (scanl
);
653 if (ferror(pf
) || fclose (pf
)) {
655 (void) m_unlink (cp
);
658 adios (cp
, "write error on");
662 if (trnflag
&& pop_dele (i
) == NOTOK
)
668 if (pop_quit () == NOTOK
)
671 } else if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
672 /* Mail from a spool file. */
674 scan_detect_mbox_style (in
); /* the MAGIC invocation... */
675 hghnum
= msgnum
= mp
->hghmsg
;
677 charstring_t scanl
= NULL
;
679 /* create scanline for new message */
680 switch (incerr
= scan (in
, msgnum
+ 1, msgnum
+ 1, nfs
, width
,
681 msgnum
== hghnum
&& chgflag
, 1, NULL
, 0L, noisy
,
689 fputs ("inc aborted!\n", aud
);
690 inform("aborted!"); /* doesn't clean up locks! */
694 inform("BUG in %s, number out of range", invo_name
);
698 inform("BUG in %s, scan() botch (%d)", invo_name
, incerr
);
704 * Run the external program hook on the message.
707 (void)snprintf(b
, sizeof (b
), "%s/%d", maildir_copy
, msgnum
+ 1);
708 (void)ext_hook("add-hook", b
, NULL
);
711 fputs (charstring_buffer (scanl
), aud
);
718 charstring_free (scanl
);
720 /* If we get here there was some sort of error from scan(),
721 * so stop processing anything more from the spool.
727 /* Mail from Maildir. */
732 hghnum
= msgnum
= mp
->hghmsg
;
733 for (i
= 0; i
< num_maildir_entries
; i
++) {
734 charstring_t scanl
= NULL
;
738 sp
= Maildir
[i
].filename
;
739 cp
= mh_xstrdup(m_name (msgnum
));
741 if (!trnflag
|| link(sp
, cp
) == -1) {
742 static char buf
[65536];
745 if ((sf
= fopen (sp
, "r")) == NULL
)
746 adios (sp
, "unable to read for copy");
747 if ((pf
= fopen (cp
, "w+")) == NULL
)
748 adios (cp
, "unable to write for copy");
749 while ((nrd
= fread(buf
, 1, sizeof(buf
), sf
)) > 0)
750 if (fwrite(buf
, 1, nrd
, pf
) != nrd
)
752 if (ferror(sf
) || fflush(pf
) || ferror(pf
)) {
754 fclose(pf
); fclose(sf
); (void) m_unlink(cp
);
756 adios(cp
, "copy error %s -> %s", sp
, cp
);
761 if (pf
== NULL
&& (pf
= fopen (cp
, "r")) == NULL
)
762 adios (cp
, "not available");
763 chmod (cp
, m_gmprot ());
765 fseek (pf
, 0L, SEEK_SET
);
766 switch (incerr
= scan (pf
, msgnum
, 0, nfs
, width
,
767 msgnum
== mp
->hghmsg
+ 1 && chgflag
,
768 1, NULL
, 0, noisy
, &scanl
)) {
770 printf ("%*d empty\n", DMAXFOLDER
, msgnum
);
776 /* advise (cp, "unable to read"); already advised */
787 * Run the external program hook on the message.
790 (void)snprintf(b
, sizeof (b
), "%s/%d", maildir_copy
, msgnum
+ 1);
791 (void)ext_hook("add-hook", b
, NULL
);
794 fputs (charstring_buffer (scanl
), aud
);
799 charstring_free (scanl
);
801 if (ferror(pf
) || fclose (pf
)) {
803 (void) m_unlink (cp
);
805 adios (cp
, "write error on");
810 if (trnflag
&& m_unlink (sp
) == NOTOK
)
811 adios (sp
, "couldn't unlink");
812 free (sp
); /* Free Maildir[i]->filename */
816 free (Maildir
); /* From now on Maildir is just a flag - don't dref! */
821 if (incerr
< 0) { /* error */
823 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
824 (void) lkfclosespool (in
, newmail
); in
= NULL
;
825 DROPGROUPPRIVS(); /* And then return us to normal privileges */
827 fclose (in
); in
= NULL
;
838 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
839 /* Mail from a spool file; truncate it. */
842 if (stat (newmail
, &st
) != NOTOK
&& s1
.st_mtime
!= st
.st_mtime
)
843 inform("new messages have arrived!\007");
846 if ((newfd
= creat (newmail
, 0600)) != NOTOK
)
849 admonish (newmail
, "error zero'ing");
853 printf ("%s not zero'd\n", newmail
);
857 if (msgnum
== hghnum
) {
858 inform("no messages incorporated, continuing...");
861 * Lock the sequence file now, and loop to set the right flags
862 * in the folder structure
868 context_replace (pfolder
, folder
); /* update current folder */
870 if ((mp2
= folder_read(folder
, 1)) == NULL
) {
871 inform("Unable to reread folder %s, continuing...", folder
);
876 * Shouldn't happen, but just in case ...
879 if (msgnum
>= mp2
->hghoff
880 && !(mp2
= folder_realloc (mp2
, mp2
->lowoff
, msgnum
+ 1))) {
881 inform("unable to reallocate folder storage");
886 mp2
->curmsg
= hghnum
+ 1;
887 mp2
->hghmsg
= msgnum
;
889 if (mp2
->lowmsg
== 0)
891 if (chgflag
) /* sigh... */
892 seq_setcur (mp2
, mp2
->curmsg
);
894 for (i
= hghnum
+ 1; i
<= msgnum
; i
++) {
895 clear_msg_flags (mp2
, i
);
899 mp2
->msgflags
|= SEQMOD
;
900 seq_setunseen(mp2
, 0); /* Set the Unseen-Sequence */
901 seq_save(mp2
); /* Save the sequence file */
906 if (inc_type
== INC_FILE
&& Maildir
== NULL
) {
907 /* Mail from a spool file; unlock it. */
910 GETGROUPPRIVS(); /* Be sure we can unlock mail file */
911 (void) lkfclosespool (in
, newmail
); in
= NULL
;
912 DROPGROUPPRIVS(); /* And then return us to normal privileges */
914 fclose (in
); in
= NULL
;
918 context_save (); /* save the context file */
925 inc_done (int status
)
931 lkfclosespool(in
, newmail
);
938 pop_action(void *closure
, char *s
)
944 n
= fprintf(pc
->mailout
, "%s\n", s
);
947 pc
->written
+= n
; /* Count linefeed too. */