]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - src/sendmail.h
Import sendmail 8.14.7
[FreeBSD/FreeBSD.git] / src / sendmail.h
1 /*
2  * Copyright (c) 1998-2013 Sendmail, Inc. and its suppliers.
3  *      All rights reserved.
4  * Copyright (c) 1983, 1995-1997 Eric P. Allman.  All rights reserved.
5  * Copyright (c) 1988, 1993
6  *      The Regents of the University of California.  All rights reserved.
7  *
8  * By using this file, you agree to the terms and conditions set
9  * forth in the LICENSE file which can be found at the top level of
10  * the sendmail distribution.
11  */
12
13 /*
14 **  SENDMAIL.H -- MTA-specific definitions for sendmail.
15 */
16
17 #ifndef _SENDMAIL_H
18 # define _SENDMAIL_H 1
19
20 #ifndef MILTER
21 # define MILTER 1       /* turn on MILTER by default */
22 #endif /* MILTER */
23
24 #ifdef _DEFINE
25 # define EXTERN
26 #else /* _DEFINE */
27 # define EXTERN extern
28 #endif /* _DEFINE */
29
30
31 #include <unistd.h>
32
33 #include <stddef.h>
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <ctype.h>
37 #include <setjmp.h>
38 #include <string.h>
39 #include <time.h>
40 # ifdef EX_OK
41 #  undef EX_OK                  /* for SVr4.2 SMP */
42 # endif /* EX_OK */
43
44 #include "sendmail/sendmail.h"
45
46 /* profiling? */
47 #if MONCONTROL
48 # define SM_PROF(x)     moncontrol(x)
49 #else /* MONCONTROL */
50 # define SM_PROF(x)
51 #endif /* MONCONTROL */
52
53 #ifdef _DEFINE
54 # ifndef lint
55 SM_UNUSED(static char SmailId[]) = "@(#)$Id: sendmail.h,v 8.1101 2013/03/15 17:54:12 ca Exp $";
56 # endif /* ! lint */
57 #endif /* _DEFINE */
58
59 #include "bf.h"
60 #include "timers.h"
61 #include <sm/exc.h>
62 #include <sm/heap.h>
63 #include <sm/debug.h>
64 #include <sm/rpool.h>
65 #include <sm/io.h>
66 #include <sm/path.h>
67 #include <sm/signal.h>
68 #include <sm/clock.h>
69 #include <sm/mbdb.h>
70 #include <sm/errstring.h>
71 #include <sm/sysexits.h>
72 #include <sm/shm.h>
73 #include <sm/misc.h>
74
75 #ifdef LOG
76 # include <syslog.h>
77 #endif /* LOG */
78
79
80
81 # if NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25
82 #  include <sys/socket.h>
83 # endif /* NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25 */
84 # if NETUNIX
85 #  include <sys/un.h>
86 # endif /* NETUNIX */
87 # if NETINET || NETINET6
88 #  include <netinet/in.h>
89 # endif /* NETINET || NETINET6 */
90 # if NETINET6
91 /*
92 **  There is no standard yet for IPv6 includes.
93 **  Specify OS specific implementation in conf.h
94 */
95 # endif /* NETINET6 */
96 # if NETISO
97 #  include <netiso/iso.h>
98 # endif /* NETISO */
99 # if NETNS
100 #  include <netns/ns.h>
101 # endif /* NETNS */
102 # if NETX25
103 #  include <netccitt/x25.h>
104 # endif /* NETX25 */
105
106 # if NAMED_BIND
107 #  include <arpa/nameser.h>
108 #  ifdef NOERROR
109 #   undef NOERROR               /* avoid <sys/streams.h> conflict */
110 #  endif /* NOERROR */
111 #  include <resolv.h>
112 # else /* NAMED_BIND */
113 #   undef SM_SET_H_ERRNO
114 #   define SM_SET_H_ERRNO(err)
115 # endif /* NAMED_BIND */
116
117 # if HESIOD
118 #  include <hesiod.h>
119 #  if !defined(HES_ER_OK) || defined(HESIOD_INTERFACES)
120 #   define HESIOD_INIT          /* support for the new interface */
121 #  endif /* !defined(HES_ER_OK) || defined(HESIOD_INTERFACES) */
122 # endif /* HESIOD */
123
124 #if STARTTLS
125 #  include <openssl/ssl.h>
126 # if !TLS_NO_RSA
127 #  if _FFR_FIPSMODE
128 #   define RSA_KEYLENGTH        1024
129 #  else /* _FFR_FIPSMODE  */
130 #   define RSA_KEYLENGTH        512
131 #  endif /* _FFR_FIPSMODE  */
132 # endif /* !TLS_NO_RSA */
133 #endif /* STARTTLS */
134
135 #if SASL  /* include the sasl include files if we have them */
136
137
138 # if SASL == 2 || SASL >= 20000
139 #  include <sasl/sasl.h>
140 #  include <sasl/saslutil.h>
141 # else /* SASL == 2 || SASL >= 20000 */
142 #  include <sasl.h>
143 #  include <saslutil.h>
144 # endif /* SASL == 2 || SASL >= 20000 */
145 # if defined(SASL_VERSION_MAJOR) && defined(SASL_VERSION_MINOR) && defined(SASL_VERSION_STEP)
146 #  define SASL_VERSION (SASL_VERSION_MAJOR * 10000)  + (SASL_VERSION_MINOR * 100) + SASL_VERSION_STEP
147 #  if SASL == 1 || SASL == 2
148 #   undef SASL
149 #   define SASL SASL_VERSION
150 #  else /* SASL == 1 || SASL == 2 */
151 #   if SASL != SASL_VERSION
152   ERROR README: -DSASL (SASL) does not agree with the version of the CYRUS_SASL library (SASL_VERSION)
153   ERROR README: see README!
154 #   endif /* SASL != SASL_VERSION */
155 #  endif /* SASL == 1 || SASL == 2 */
156 # else /* defined(SASL_VERSION_MAJOR) && defined(SASL_VERSION_MINOR) && defined(SASL_VERSION_STEP) */
157 #  if SASL == 1
158   ERROR README: please set -DSASL to the version of the CYRUS_SASL library
159   ERROR README: see README!
160 #  endif /* SASL == 1 */
161 # endif /* defined(SASL_VERSION_MAJOR) && defined(SASL_VERSION_MINOR) && defined(SASL_VERSION_STEP) */
162 #endif /* SASL */
163
164 /*
165 **  Following are "sort of" configuration constants, but they should
166 **  be pretty solid on most architectures today.  They have to be
167 **  defined after <arpa/nameser.h> because some versions of that
168 **  file also define them.  In all cases, we can't use sizeof because
169 **  some systems (e.g., Crays) always treat everything as being at
170 **  least 64 bits.
171 */
172
173 #ifndef INADDRSZ
174 # define INADDRSZ       4               /* size of an IPv4 address in bytes */
175 #endif /* ! INADDRSZ */
176 #ifndef IN6ADDRSZ
177 # define IN6ADDRSZ      16              /* size of an IPv6 address in bytes */
178 #endif /* ! IN6ADDRSZ */
179 #ifndef INT16SZ
180 # define INT16SZ        2               /* size of a 16 bit integer in bytes */
181 #endif /* ! INT16SZ */
182 #ifndef INT32SZ
183 # define INT32SZ        4               /* size of a 32 bit integer in bytes */
184 #endif /* ! INT32SZ */
185 #ifndef INADDR_LOOPBACK
186 # define INADDR_LOOPBACK        0x7f000001      /* loopback address */
187 #endif /* ! INADDR_LOOPBACK */
188
189 /*
190 **  Error return from inet_addr(3), in case not defined in /usr/include.
191 */
192
193 #ifndef INADDR_NONE
194 # define INADDR_NONE    0xffffffff
195 #endif /* ! INADDR_NONE */
196
197
198 /* (f)open() modes for queue files */
199 # define QF_O_EXTRA     0
200
201
202 /*
203 **  An 'argument class' describes the storage allocation status
204 **  of an object pointed to by an argument to a function.
205 */
206
207 typedef enum
208 {
209         A_HEAP, /* the storage was allocated by malloc, and the
210                  * ownership of the storage is ceded by the caller
211                  * to the called function. */
212         A_TEMP, /* The storage is temporary, and is only guaranteed
213                  * to be valid for the duration of the function call. */
214         A_PERM  /* The storage is 'permanent': this might mean static
215                  * storage, or rpool storage. */
216 } ARGCLASS_T;
217
218 /* forward references for prototypes */
219 typedef struct envelope ENVELOPE;
220 typedef struct mailer   MAILER;
221 typedef struct queuegrp QUEUEGRP;
222
223 /*
224 **  Address structure.
225 **      Addresses are stored internally in this structure.
226 */
227
228 struct address
229 {
230         char            *q_paddr;       /* the printname for the address */
231         char            *q_user;        /* user name */
232         char            *q_ruser;       /* real user name, or NULL if q_user */
233         char            *q_host;        /* host name */
234         struct mailer   *q_mailer;      /* mailer to use */
235         unsigned long   q_flags;        /* status flags, see below */
236         uid_t           q_uid;          /* user-id of receiver (if known) */
237         gid_t           q_gid;          /* group-id of receiver (if known) */
238         char            *q_home;        /* home dir (local mailer only) */
239         char            *q_fullname;    /* full name if known */
240         struct address  *q_next;        /* chain */
241         struct address  *q_alias;       /* address this results from */
242         char            *q_owner;       /* owner of q_alias */
243         struct address  *q_tchain;      /* temporary use chain */
244 #if PIPELINING
245         struct address  *q_pchain;      /* chain for pipelining */
246 #endif /* PIPELINING */
247         char            *q_finalrcpt;   /* Final-Recipient: DSN header */
248         char            *q_orcpt;       /* ORCPT parameter from RCPT TO: line */
249         char            *q_status;      /* status code for DSNs */
250         char            *q_rstatus;     /* remote status message for DSNs */
251         time_t          q_statdate;     /* date of status messages */
252         char            *q_statmta;     /* MTA generating q_rstatus */
253         short           q_state;        /* address state, see below */
254         char            *q_signature;   /* MX-based sorting value */
255         int             q_qgrp;         /* index into queue groups */
256         int             q_qdir;         /* queue directory inside group */
257         char            *q_message;     /* error message */
258 };
259
260 typedef struct address ADDRESS;
261
262 /* bit values for q_flags */
263 #define QGOODUID        0x00000001      /* the q_uid q_gid fields are good */
264 #define QPRIMARY        0x00000002      /* set from RCPT or argv */
265 #define QNOTREMOTE      0x00000004      /* address not for remote forwarding */
266 #define QSELFREF        0x00000008      /* this address references itself */
267 #define QBOGUSSHELL     0x00000010      /* user has no valid shell listed */
268 #define QUNSAFEADDR     0x00000020      /* address acquired via unsafe path */
269 #define QPINGONSUCCESS  0x00000040      /* give return on successful delivery */
270 #define QPINGONFAILURE  0x00000080      /* give return on failure */
271 #define QPINGONDELAY    0x00000100      /* give return on message delay */
272 #define QHASNOTIFY      0x00000200      /* propagate notify parameter */
273 #define QRELAYED        0x00000400      /* DSN: relayed to non-DSN aware sys */
274 #define QEXPANDED       0x00000800      /* DSN: undergone list expansion */
275 #define QDELIVERED      0x00001000      /* DSN: successful final delivery */
276 #define QDELAYED        0x00002000      /* DSN: message delayed */
277 #define QALIAS          0x00004000      /* expanded alias */
278 #define QBYTRACE        0x00008000      /* DeliverBy: trace */
279 #define QBYNDELAY       0x00010000      /* DeliverBy: notify, delay */
280 #define QBYNRELAY       0x00020000      /* DeliverBy: notify, relayed */
281 #define QTHISPASS       0x40000000      /* temp: address set this pass */
282 #define QRCPTOK         0x80000000      /* recipient() processed address */
283
284 #define Q_PINGFLAGS     (QPINGONSUCCESS|QPINGONFAILURE|QPINGONDELAY)
285
286 /* values for q_state */
287 #define QS_OK           0               /* address ok (for now)/not yet tried */
288 #define QS_SENT         1               /* good address, delivery complete */
289 #define QS_BADADDR      2               /* illegal address */
290 #define QS_QUEUEUP      3               /* save address in queue */
291 #define QS_RETRY        4               /* retry delivery for next MX */
292 #define QS_VERIFIED     5               /* verified, but not expanded */
293
294 /*
295 **  Notice: all of the following values are variations of QS_DONTSEND.
296 **      If new states are added, they must be inserted in the proper place!
297 **      See the macro definition of QS_IS_DEAD() down below.
298 */
299
300 #define QS_DONTSEND     6               /* don't send to this address */
301 #define QS_EXPANDED     7               /* expanded */
302 #define QS_SENDER       8               /* message sender (MeToo) */
303 #define QS_CLONED       9               /* addr cloned to split envelope */
304 #define QS_DISCARDED    10              /* rcpt discarded (EF_DISCARD) */
305 #define QS_REPLACED     11              /* maplocaluser()/UserDB replaced */
306 #define QS_REMOVED      12              /* removed (removefromlist()) */
307 #define QS_DUPLICATE    13              /* duplicate suppressed */
308 #define QS_INCLUDED     14              /* :include: delivery */
309 #define QS_FATALERR     15              /* fatal error, don't deliver */
310
311 /* address state testing primitives */
312 #define QS_IS_OK(s)             ((s) == QS_OK)
313 #define QS_IS_SENT(s)           ((s) == QS_SENT)
314 #define QS_IS_BADADDR(s)        ((s) == QS_BADADDR)
315 #define QS_IS_QUEUEUP(s)        ((s) == QS_QUEUEUP)
316 #define QS_IS_RETRY(s)          ((s) == QS_RETRY)
317 #define QS_IS_VERIFIED(s)       ((s) == QS_VERIFIED)
318 #define QS_IS_EXPANDED(s)       ((s) == QS_EXPANDED)
319 #define QS_IS_REMOVED(s)        ((s) == QS_REMOVED)
320 #define QS_IS_UNDELIVERED(s)    ((s) == QS_OK || \
321                                  (s) == QS_QUEUEUP || \
322                                  (s) == QS_RETRY || \
323                                  (s) == QS_VERIFIED)
324 #define QS_IS_UNMARKED(s)       ((s) == QS_OK || \
325                                  (s) == QS_RETRY)
326 #define QS_IS_SENDABLE(s)       ((s) == QS_OK || \
327                                  (s) == QS_QUEUEUP || \
328                                  (s) == QS_RETRY)
329 #define QS_IS_ATTEMPTED(s)      ((s) == QS_QUEUEUP || \
330                                  (s) == QS_RETRY || \
331                                  (s) == QS_SENT || \
332                                  (s) == QS_DISCARDED)
333 #define QS_IS_DEAD(s)           ((s) >= QS_DONTSEND)
334 #define QS_IS_TEMPFAIL(s)       ((s) == QS_QUEUEUP || (s) == QS_RETRY)
335
336 #define NULLADDR        ((ADDRESS *) NULL)
337
338 extern ADDRESS  NullAddress;    /* a null (template) address [main.c] */
339
340 /* functions */
341 extern void     cataddr __P((char **, char **, char *, int, int, bool));
342 extern char     *crackaddr __P((char *, ENVELOPE *));
343 extern bool     emptyaddr __P((ADDRESS *));
344 extern ADDRESS  *getctladdr __P((ADDRESS *));
345 extern int      include __P((char *, bool, ADDRESS *, ADDRESS **, int, ENVELOPE *));
346 extern bool     invalidaddr __P((char *, char *, bool));
347 extern ADDRESS  *parseaddr __P((char *, ADDRESS *, int, int, char **,
348                                 ENVELOPE *, bool));
349 extern char     **prescan __P((char *, int, char[], int, char **, unsigned char *, bool));
350 extern void     printaddr __P((SM_FILE_T *, ADDRESS *, bool));
351 extern ADDRESS  *recipient __P((ADDRESS *, ADDRESS **, int, ENVELOPE *));
352 extern char     *remotename __P((char *, MAILER *, int, int *, ENVELOPE *));
353 extern int      rewrite __P((char **, int, int, ENVELOPE *, int));
354 extern bool     sameaddr __P((ADDRESS *, ADDRESS *));
355 extern int      sendtolist __P((char *, ADDRESS *, ADDRESS **, int, ENVELOPE *));
356 #if MILTER
357 extern int      removefromlist __P((char *, ADDRESS **, ENVELOPE *));
358 #endif /* MILTER */
359 extern void     setsender __P((char *, ENVELOPE *, char **, int, bool));
360 typedef void esmtp_args_F __P((ADDRESS *, char *, char *, ENVELOPE *));
361 extern void     parse_esmtp_args __P((ENVELOPE *, ADDRESS *, char *, char *,
362                         char *, char *args[], esmtp_args_F));
363 extern esmtp_args_F mail_esmtp_args;
364 extern esmtp_args_F rcpt_esmtp_args;
365 extern void     reset_mail_esmtp_args __P((ENVELOPE *));
366
367 /* macro to simplify the common call to rewrite() */
368 #define REWRITE(pvp, rs, env)   rewrite(pvp, rs, 0, env, MAXATOM)
369
370 /*
371 **  Token Tables for prescan
372 */
373
374 extern unsigned char    ExtTokenTab[256];       /* external strings */
375 extern unsigned char    IntTokenTab[256];       /* internal strings */
376
377
378 /*
379 **  Mailer definition structure.
380 **      Every mailer known to the system is declared in this
381 **      structure.  It defines the pathname of the mailer, some
382 **      flags associated with it, and the argument vector to
383 **      pass to it.  The flags are defined in conf.c
384 **
385 **      The argument vector is expanded before actual use.  All
386 **      words except the first are passed through the macro
387 **      processor.
388 */
389
390 struct mailer
391 {
392         char    *m_name;        /* symbolic name of this mailer */
393         char    *m_mailer;      /* pathname of the mailer to use */
394         char    *m_mtatype;     /* type of this MTA */
395         char    *m_addrtype;    /* type for addresses */
396         char    *m_diagtype;    /* type for diagnostics */
397         BITMAP256 m_flags;      /* status flags, see below */
398         short   m_mno;          /* mailer number internally */
399         short   m_nice;         /* niceness to run at (mostly for prog) */
400         char    **m_argv;       /* template argument vector */
401         short   m_sh_rwset;     /* rewrite set: sender header addresses */
402         short   m_se_rwset;     /* rewrite set: sender envelope addresses */
403         short   m_rh_rwset;     /* rewrite set: recipient header addresses */
404         short   m_re_rwset;     /* rewrite set: recipient envelope addresses */
405         char    *m_eol;         /* end of line string */
406         long    m_maxsize;      /* size limit on message to this mailer */
407         int     m_linelimit;    /* max # characters per line */
408         int     m_maxdeliveries; /* max deliveries per mailer connection */
409         char    *m_execdir;     /* directory to chdir to before execv */
410         char    *m_rootdir;     /* directory to chroot to before execv */
411         uid_t   m_uid;          /* UID to run as */
412         gid_t   m_gid;          /* GID to run as */
413         char    *m_defcharset;  /* default character set */
414         time_t  m_wait;         /* timeout to wait for end */
415         int     m_maxrcpt;      /* max recipients per envelope client-side */
416         short   m_qgrp;         /* queue group for this mailer */
417 };
418
419 /* bits for m_flags */
420 #define M_ESMTP         'a'     /* run Extended SMTP */
421 #define M_ALIASABLE     'A'     /* user can be LHS of an alias */
422 #define M_BLANKEND      'b'     /* ensure blank line at end of message */
423 #define M_STRIPBACKSL   'B'     /* strip all leading backslashes from user */
424 #define M_NOCOMMENT     'c'     /* don't include comment part of address */
425 #define M_CANONICAL     'C'     /* make addresses canonical "u@dom" */
426 #define M_NOBRACKET     'd'     /* never angle bracket envelope route-addrs */
427                 /*      'D'        CF: include Date: */
428 #define M_EXPENSIVE     'e'     /* it costs to use this mailer.... */
429 #define M_ESCFROM       'E'     /* escape From lines to >From */
430 #define M_FOPT          'f'     /* mailer takes picky -f flag */
431                 /*      'F'        CF: include From: or Resent-From: */
432 #define M_NO_NULL_FROM  'g'     /* sender of errors should be $g */
433 #define M_HST_UPPER     'h'     /* preserve host case distinction */
434 #define M_PREHEAD       'H'     /* MAIL11V3: preview headers */
435 #define M_UDBENVELOPE   'i'     /* do udbsender rewriting on envelope */
436 #define M_INTERNAL      'I'     /* SMTP to another sendmail site */
437 #define M_UDBRECIPIENT  'j'     /* do udbsender rewriting on recipient lines */
438 #define M_NOLOOPCHECK   'k'     /* don't check for loops in HELO command */
439 #define M_CHUNKING      'K'     /* CHUNKING: reserved for future use */
440 #define M_LOCALMAILER   'l'     /* delivery is to this host */
441 #define M_LIMITS        'L'     /* must enforce SMTP line limits */
442 #define M_MUSER         'm'     /* can handle multiple users at once */
443                 /*      'M'        CF: include Message-Id: */
444 #define M_NHDR          'n'     /* don't insert From line */
445 #define M_MANYSTATUS    'N'     /* MAIL11V3: DATA returns multi-status */
446 #define M_RUNASRCPT     'o'     /* always run mailer as recipient */
447 #define M_FROMPATH      'p'     /* use reverse-path in MAIL FROM: */
448                 /*      'P'        CF: include Return-Path: */
449 #define M_VRFY250       'q'     /* VRFY command returns 250 instead of 252 */
450 #define M_ROPT          'r'     /* mailer takes picky -r flag */
451 #define M_SECURE_PORT   'R'     /* try to send on a reserved TCP port */
452 #define M_STRIPQ        's'     /* strip quote chars from user/host */
453 #define M_SPECIFIC_UID  'S'     /* run as specific uid/gid */
454 #define M_USR_UPPER     'u'     /* preserve user case distinction */
455 #define M_UGLYUUCP      'U'     /* this wants an ugly UUCP from line */
456 #define M_CONTENT_LEN   'v'     /* add Content-Length: header (SVr4) */
457                 /*      'V'        UIUC: !-relativize all addresses */
458 #define M_HASPWENT      'w'     /* check for /etc/passwd entry */
459 #define M_NOHOSTSTAT    'W'     /* ignore long term host status information */
460                 /*      'x'        CF: include Full-Name: */
461 #define M_XDOT          'X'     /* use hidden-dot algorithm */
462 #define M_LMTP          'z'     /* run Local Mail Transport Protocol */
463 #define M_DIALDELAY     'Z'     /* apply dial delay sleeptime */
464 #define M_NOMX          '0'     /* turn off MX lookups */
465 #define M_NONULLS       '1'     /* don't send null bytes */
466 #define M_FSMTP         '2'     /* force SMTP (no ESMTP even if offered) */
467 #define M_EBCDIC        '3'     /* extend Q-P encoding for EBCDIC */
468 #define M_TRYRULESET5   '5'     /* use ruleset 5 after local aliasing */
469 #define M_7BITHDRS      '6'     /* strip headers to 7 bits even in 8 bit path */
470 #define M_7BITS         '7'     /* use 7-bit path */
471 #define M_8BITS         '8'     /* force "just send 8" behaviour */
472 #define M_MAKE8BIT      '9'     /* convert 7 -> 8 bit if appropriate */
473 #define M_CHECKINCLUDE  ':'     /* check for :include: files */
474 #define M_CHECKPROG     '|'     /* check for |program addresses */
475 #define M_CHECKFILE     '/'     /* check for /file addresses */
476 #define M_CHECKUDB      '@'     /* user can be user database key */
477 #define M_CHECKHDIR     '~'     /* SGI: check for valid home directory */
478 #define M_HOLD          '%'     /* Hold delivery until ETRN/-qI/-qR/-qS */
479 #define M_PLUS          '+'     /* Reserved: Used in mc for adding new flags */
480 #define M_MINUS         '-'     /* Reserved: Used in mc for removing flags */
481
482 /* functions */
483 extern void     initerrmailers __P((void));
484 extern void     makemailer __P((char *));
485 extern void     makequeue __P((char *, bool));
486 extern void     runqueueevent __P((int));
487 #if _FFR_QUEUE_RUN_PARANOIA
488 extern bool     checkqueuerunner __P((void));
489 #endif /* _FFR_QUEUE_RUN_PARANOIA */
490
491 EXTERN MAILER   *FileMailer;    /* ptr to *file* mailer */
492 EXTERN MAILER   *InclMailer;    /* ptr to *include* mailer */
493 EXTERN MAILER   *LocalMailer;   /* ptr to local mailer */
494 EXTERN MAILER   *ProgMailer;    /* ptr to program mailer */
495 EXTERN MAILER   *Mailer[MAXMAILERS + 1];
496
497 /*
498 **  Queue group definition structure.
499 **      Every queue group known to the system is declared in this structure.
500 **      It defines the basic pathname of the queue group, some flags
501 **      associated with it, and the argument vector to pass to it.
502 */
503
504 struct qpaths_s
505 {
506         char    *qp_name;       /* name of queue dir, relative path */
507         short   qp_subdirs;     /* use subdirs? */
508         short   qp_fsysidx;     /* file system index of this directory */
509 # if SM_CONF_SHM
510         int     qp_idx;         /* index into array for queue information */
511 # endif /* SM_CONF_SHM */
512 };
513
514 typedef struct qpaths_s QPATHS;
515
516 struct queuegrp
517 {
518         char    *qg_name;       /* symbolic name of this queue group */
519
520         /*
521         **  For now this is the same across all queue groups.
522         **  Otherwise we have to play around with chdir().
523         */
524
525         char    *qg_qdir;       /* common component of queue directory */
526         short   qg_index;       /* queue number internally, index in Queue[] */
527         int     qg_maxqrun;     /* max # of jobs in 1 queuerun */
528         int     qg_numqueues;   /* number of queues in this queue */
529
530         /*
531         **  qg_queueintvl == 0 denotes that no individual value is used.
532         **  Whatever accesses this must deal with "<= 0" as
533         **  "not set, use appropriate default".
534         */
535
536         time_t  qg_queueintvl;  /* interval for queue runs */
537         QPATHS  *qg_qpaths;     /* list of queue directories */
538         BITMAP256 qg_flags;     /* status flags, see below */
539         short   qg_nice;        /* niceness for queue run */
540         int     qg_wgrp;        /* Assigned to this work group */
541         int     qg_maxlist;     /* max items in work queue for this group */
542         int     qg_curnum;      /* current number of queue for queue runs */
543         int     qg_maxrcpt;     /* max recipients per envelope, 0==no limit */
544
545         time_t  qg_nextrun;     /* time for next queue runs */
546 #if _FFR_QUEUE_GROUP_SORTORDER
547         short   qg_sortorder;   /* how do we sort this queuerun */
548 #endif /* _FFR_QUEUE_GROUP_SORTORDER */
549 #if 0
550         long    qg_wkrcptfact;  /* multiplier for # recipients -> priority */
551         long    qg_qfactor;     /* slope of queue function */
552         bool    qg_doqueuerun;  /* XXX flag is it time to do a queuerun */
553 #endif /* 0 */
554 };
555
556 /* bits for qg_flags (XXX: unused as of now) */
557 #define QD_DEFINED      ((char) 1)      /* queue group has been defined */
558 #define QD_FORK         'f'     /* fork queue runs */
559
560 extern void     filesys_update __P((void));
561 #if _FFR_ANY_FREE_FS
562 extern bool     filesys_free __P((long));
563 #endif /* _FFR_ANY_FREE_FS */
564
565 #if SASL
566 /*
567 **  SASL
568 */
569
570 /* lines in authinfo file or index into SASL_AI_T */
571 # define SASL_WRONG     (-1)
572 # define SASL_USER      0       /* authorization id (user) */
573 # define SASL_AUTHID    1       /* authentication id */
574 # define SASL_PASSWORD  2       /* password fuer authid */
575 # define SASL_DEFREALM  3       /* realm to use */
576 # define SASL_MECHLIST  4       /* list of mechanisms to try */
577 # define SASL_ID_REALM  5       /* authid@defrealm */
578
579 /*
580 **  Current mechanism; this is just used to convey information between
581 **  invocation of SASL callback functions.
582 **  It must be last in the list, because it's not allocated by us
583 **  and hence we don't free() it.
584 */
585 # define SASL_MECH      6
586 # define SASL_ENTRIES   7       /* number of entries in array */
587
588 # define SASL_USER_BIT          (1 << SASL_USER)
589 # define SASL_AUTHID_BIT        (1 << SASL_AUTHID)
590 # define SASL_PASSWORD_BIT      (1 << SASL_PASSWORD)
591 # define SASL_DEFREALM_BIT      (1 << SASL_DEFREALM)
592 # define SASL_MECHLIST_BIT      (1 << SASL_MECHLIST)
593
594 /* authenticated? */
595 # define SASL_NOT_AUTH  0               /* not authenticated */
596 # define SASL_PROC_AUTH 1               /* in process of authenticating */
597 # define SASL_IS_AUTH   2               /* authenticated */
598
599 /* SASL options */
600 # define SASL_AUTH_AUTH 0x1000          /* use auth= only if authenticated */
601 # if SASL >= 20101
602 #  define SASL_SEC_MASK SASL_SEC_MAXIMUM /* mask for SASL_SEC_* values: sasl.h */
603 # else /* SASL >= 20101 */
604 #  define SASL_SEC_MASK 0x0fff          /* mask for SASL_SEC_* values: sasl.h */
605 #  if (SASL_SEC_NOPLAINTEXT & SASL_SEC_MASK) == 0 || \
606         (SASL_SEC_NOACTIVE & SASL_SEC_MASK) == 0 || \
607         (SASL_SEC_NODICTIONARY & SASL_SEC_MASK) == 0 || \
608         (SASL_SEC_FORWARD_SECRECY & SASL_SEC_MASK) == 0 || \
609         (SASL_SEC_NOANONYMOUS & SASL_SEC_MASK) == 0 || \
610         (SASL_SEC_PASS_CREDENTIALS & SASL_SEC_MASK) == 0
611 ERROR: change SASL_SEC_MASK_ notify sendmail.org!
612 #  endif /* SASL_SEC_NOPLAINTEXT & SASL_SEC_MASK) == 0 ... */
613 # endif /* SASL >= 20101 */
614 # define MAXOUTLEN 8192 /* length of output buffer, should be 2^n */
615
616 /* functions */
617 extern char     *intersect __P((char *, char *, SM_RPOOL_T *));
618 extern char     *iteminlist __P((char *, char *, char *));
619 # if SASL >= 20000
620 extern int      proxy_policy __P((sasl_conn_t *, void *, const char *, unsigned, const char *, unsigned, const char *, unsigned, struct propctx *));
621 extern int      safesaslfile __P((void *, const char *, sasl_verify_type_t));
622 # else /* SASL >= 20000 */
623 extern int      proxy_policy __P((void *, const char *, const char *, const char **, const char **));
624 #  if SASL > 10515
625 extern int      safesaslfile __P((void *, char *, int));
626 #  else /* SASL > 10515 */
627 extern int      safesaslfile __P((void *, char *));
628 #  endif /* SASL > 10515 */
629 # endif /* SASL >= 20000 */
630 extern void     stop_sasl_client __P((void));
631
632 /* structure to store authinfo */
633 typedef char *SASL_AI_T[SASL_ENTRIES];
634
635 EXTERN char     *AuthMechanisms;        /* AUTH mechanisms */
636 EXTERN char     *AuthRealm;     /* AUTH realm */
637 EXTERN char     *SASLInfo;      /* file with AUTH info */
638 EXTERN int      SASLOpts;       /* options for SASL */
639 EXTERN int      MaxSLBits;      /* max. encryption bits for SASL */
640 #endif /* SASL */
641
642 /*
643 **  Structure to store macros.
644 */
645 typedef struct
646 {
647         SM_RPOOL_T      *mac_rpool;             /* resource pool */
648         BITMAP256       mac_allocated;          /* storage has been alloc()? */
649         char            *mac_table[MAXMACROID + 1];     /* macros */
650 } MACROS_T;
651
652 EXTERN MACROS_T         GlobalMacros;
653
654 /*
655 **  Information about currently open connections to mailers, or to
656 **  hosts that we have looked up recently.
657 */
658
659 #define MCI             struct mailer_con_info
660
661 MCI
662 {
663         unsigned long   mci_flags;      /* flag bits, see below */
664         short           mci_errno;      /* error number on last connection */
665         short           mci_herrno;     /* h_errno from last DNS lookup */
666         short           mci_exitstat;   /* exit status from last connection */
667         short           mci_state;      /* SMTP state */
668         int             mci_deliveries; /* delivery attempts for connection */
669         long            mci_maxsize;    /* max size this server will accept */
670         SM_FILE_T       *mci_in;        /* input side of connection */
671         SM_FILE_T       *mci_out;       /* output side of connection */
672         pid_t           mci_pid;        /* process id of subordinate proc */
673         char            *mci_phase;     /* SMTP phase string */
674         struct mailer   *mci_mailer;    /* ptr to the mailer for this conn */
675         char            *mci_host;      /* host name */
676         char            *mci_status;    /* DSN status to be copied to addrs */
677         char            *mci_rstatus;   /* SMTP status to be copied to addrs */
678         time_t          mci_lastuse;    /* last usage time */
679         SM_FILE_T       *mci_statfile;  /* long term status file */
680         char            *mci_heloname;  /* name to use as HELO arg */
681         long            mci_min_by;     /* minimum DELIVERBY */
682         bool            mci_retryrcpt;  /* tempfail for at least one rcpt */
683         char            *mci_tolist;    /* list of valid recipients */
684         SM_RPOOL_T      *mci_rpool;     /* resource pool */
685 #if PIPELINING
686         int             mci_okrcpts;    /* number of valid recipients */
687         ADDRESS         *mci_nextaddr;  /* next address for pipelined status */
688 #endif /* PIPELINING */
689 #if SASL
690         SASL_AI_T       mci_sai;        /* authentication info */
691         bool            mci_sasl_auth;  /* authenticated? */
692         int             mci_sasl_string_len;
693         char            *mci_sasl_string;       /* sasl reply string */
694         char            *mci_saslcap;   /* SASL list of mechanisms */
695         sasl_conn_t     *mci_conn;      /* SASL connection */
696 #endif /* SASL */
697 #if STARTTLS
698         SSL             *mci_ssl;       /* SSL connection */
699 #endif /* STARTTLS */
700         MACROS_T        mci_macro;      /* macro definitions */
701 };
702
703
704 /* flag bits */
705 #define MCIF_VALID      0x00000001      /* this entry is valid */
706 /* 0x00000002 unused, was MCIF_TEMP */
707 #define MCIF_CACHED     0x00000004      /* currently in open cache */
708 #define MCIF_ESMTP      0x00000008      /* this host speaks ESMTP */
709 #define MCIF_EXPN       0x00000010      /* EXPN command supported */
710 #define MCIF_SIZE       0x00000020      /* SIZE option supported */
711 #define MCIF_8BITMIME   0x00000040      /* BODY=8BITMIME supported */
712 #define MCIF_7BIT       0x00000080      /* strip this message to 7 bits */
713 /* 0x00000100 unused, was MCIF_MULTSTAT: MAIL11V3: handles MULT status */
714 #define MCIF_INHEADER   0x00000200      /* currently outputing header */
715 #define MCIF_CVT8TO7    0x00000400      /* convert from 8 to 7 bits */
716 #define MCIF_DSN        0x00000800      /* DSN extension supported */
717 #define MCIF_8BITOK     0x00001000      /* OK to send 8 bit characters */
718 #define MCIF_CVT7TO8    0x00002000      /* convert from 7 to 8 bits */
719 #define MCIF_INMIME     0x00004000      /* currently reading MIME header */
720 #define MCIF_AUTH       0x00008000      /* AUTH= supported */
721 #define MCIF_AUTHACT    0x00010000      /* SASL (AUTH) active */
722 #define MCIF_ENHSTAT    0x00020000      /* ENHANCEDSTATUSCODES supported */
723 #define MCIF_PIPELINED  0x00040000      /* PIPELINING supported */
724 #define MCIF_VERB       0x00080000      /* VERB supported */
725 #if STARTTLS
726 #define MCIF_TLS        0x00100000      /* STARTTLS supported */
727 #define MCIF_TLSACT     0x00200000      /* STARTTLS active */
728 #else /* STARTTLS */
729 #define MCIF_TLS        0
730 #define MCIF_TLSACT     0
731 #endif /* STARTTLS */
732 #define MCIF_DLVR_BY    0x00400000      /* DELIVERBY */
733 #if _FFR_IGNORE_EXT_ON_HELO
734 # define MCIF_HELO      0x00800000      /* we used HELO: ignore extensions */
735 #endif /* _FFR_IGNORE_EXT_ON_HELO */
736 #define MCIF_INLONGLINE 0x01000000      /* in the middle of a long line */
737 #define MCIF_AUTH2      0x02000000      /* got 2 AUTH lines */
738 #define MCIF_ONLY_EHLO  0x10000000      /* use only EHLO in smtpinit */
739
740 #define MCIF_EXTENS     (MCIF_EXPN | MCIF_SIZE | MCIF_8BITMIME | MCIF_DSN | MCIF_8BITOK | MCIF_AUTH | MCIF_ENHSTAT | MCIF_TLS | MCIF_AUTH2)
741
742 /* states */
743 #define MCIS_CLOSED     0               /* no traffic on this connection */
744 #define MCIS_OPENING    1               /* sending initial protocol */
745 #define MCIS_OPEN       2               /* open, initial protocol sent */
746 #define MCIS_MAIL       3               /* MAIL command sent */
747 #define MCIS_RCPT       4               /* RCPT commands being sent */
748 #define MCIS_DATA       5               /* DATA command sent */
749 #define MCIS_QUITING    6               /* running quit protocol */
750 #define MCIS_SSD        7               /* service shutting down */
751 #define MCIS_ERROR      8               /* I/O error on connection */
752
753 /* functions */
754 extern void     mci_cache __P((MCI *));
755 extern void     mci_close __P((MCI *, char *where));
756 extern void     mci_dump __P((SM_FILE_T *, MCI *, bool));
757 extern void     mci_dump_all __P((SM_FILE_T *, bool));
758 extern void     mci_flush __P((bool, MCI *));
759 extern void     mci_clr_extensions __P((MCI *));
760 extern MCI      *mci_get __P((char *, MAILER *));
761 extern int      mci_lock_host __P((MCI *));
762 extern bool     mci_match __P((char *, MAILER *));
763 extern int      mci_print_persistent __P((char *, char *));
764 extern int      mci_purge_persistent __P((char *, char *));
765 extern MCI      **mci_scan __P((MCI *));
766 extern void     mci_setstat __P((MCI *, int, char *, char *));
767 extern void     mci_store_persistent __P((MCI *));
768 extern int      mci_traverse_persistent __P((int (*)(char *, char *), char *));
769 extern void     mci_unlock_host __P((MCI *));
770
771 EXTERN int      MaxMciCache;            /* maximum entries in MCI cache */
772 EXTERN time_t   MciCacheTimeout;        /* maximum idle time on connections */
773 EXTERN time_t   MciInfoTimeout;         /* how long 'til we retry down hosts */
774
775 /*
776 **  Header structure.
777 **      This structure is used internally to store header items.
778 */
779
780 struct header
781 {
782         char            *h_field;       /* the name of the field */
783         char            *h_value;       /* the value of that field */
784         struct header   *h_link;        /* the next header */
785         unsigned char   h_macro;        /* include header if macro defined */
786         unsigned long   h_flags;        /* status bits, see below */
787         BITMAP256       h_mflags;       /* m_flags bits needed */
788 };
789
790 typedef struct header   HDR;
791
792 /*
793 **  Header information structure.
794 **      Defined in conf.c, this struct declares the header fields
795 **      that have some magic meaning.
796 */
797
798 struct hdrinfo
799 {
800         char            *hi_field;      /* the name of the field */
801         unsigned long   hi_flags;       /* status bits, see below */
802         char            *hi_ruleset;    /* validity check ruleset */
803 };
804
805 extern struct hdrinfo   HdrInfo[];
806
807 /* bits for h_flags and hi_flags */
808 #define H_EOH           0x00000001      /* field terminates header */
809 #define H_RCPT          0x00000002      /* contains recipient addresses */
810 #define H_DEFAULT       0x00000004      /* if another value is found, drop this */
811 #define H_RESENT        0x00000008      /* this address is a "Resent-..." address */
812 #define H_CHECK         0x00000010      /* check h_mflags against m_flags */
813 #define H_ACHECK        0x00000020      /* ditto, but always (not just default) */
814 #define H_FORCE         0x00000040      /* force this field, even if default */
815 #define H_TRACE         0x00000080      /* this field contains trace information */
816 #define H_FROM          0x00000100      /* this is a from-type field */
817 #define H_VALID         0x00000200      /* this field has a validated value */
818 #define H_RECEIPTTO     0x00000400      /* field has return receipt info */
819 #define H_ERRORSTO      0x00000800      /* field has error address info */
820 #define H_CTE           0x00001000      /* field is a content-transfer-encoding */
821 #define H_CTYPE         0x00002000      /* this is a content-type field */
822 #define H_BCC           0x00004000      /* Bcc: header: strip value or delete */
823 #define H_ENCODABLE     0x00008000      /* field can be RFC 1522 encoded */
824 #define H_STRIPCOMM     0x00010000      /* header check: strip comments */
825 #define H_BINDLATE      0x00020000      /* only expand macros at deliver */
826 #define H_USER          0x00040000      /* header came from the user/SMTP */
827
828 /* bits for chompheader() */
829 #define CHHDR_DEF       0x0001  /* default header */
830 #define CHHDR_CHECK     0x0002  /* call ruleset for header */
831 #define CHHDR_USER      0x0004  /* header from user */
832 #define CHHDR_QUEUE     0x0008  /* header from queue file */
833
834 /* functions */
835 extern void     addheader __P((char *, char *, int, ENVELOPE *, bool));
836 extern unsigned long    chompheader __P((char *, int, HDR **, ENVELOPE *));
837 extern bool     commaize __P((HDR *, char *, bool, MCI *, ENVELOPE *, int));
838 extern HDR      *copyheader __P((HDR *, SM_RPOOL_T *));
839 extern void     eatheader __P((ENVELOPE *, bool, bool));
840 extern char     *hvalue __P((char *, HDR *));
841 extern void     insheader __P((int, char *, char *, int, ENVELOPE *, bool));
842 extern bool     isheader __P((char *));
843 extern bool     putfromline __P((MCI *, ENVELOPE *));
844 extern void     setupheaders __P((void));
845
846 /*
847 **  Performance monitoring
848 */
849
850 #define TIMERS          struct sm_timers
851
852 TIMERS
853 {
854         TIMER   ti_overall;     /* the whole process */
855 };
856
857
858 #define PUSHTIMER(l, t) { if (tTd(98, l)) pushtimer(&t); }
859 #define POPTIMER(l, t)  { if (tTd(98, l)) poptimer(&t); }
860
861 /*
862 **  Envelope structure.
863 **      This structure defines the message itself.  There is usually
864 **      only one of these -- for the message that we originally read
865 **      and which is our primary interest -- but other envelopes can
866 **      be generated during processing.  For example, error messages
867 **      will have their own envelope.
868 */
869
870 struct envelope
871 {
872         HDR             *e_header;      /* head of header list */
873         long            e_msgpriority;  /* adjusted priority of this message */
874         time_t          e_ctime;        /* time message appeared in the queue */
875         char            *e_to;          /* (list of) target person(s) */
876         ADDRESS         e_from;         /* the person it is from */
877         char            *e_sender;      /* e_from.q_paddr w comments stripped */
878         char            **e_fromdomain; /* the domain part of the sender */
879         ADDRESS         *e_sendqueue;   /* list of message recipients */
880         ADDRESS         *e_errorqueue;  /* the queue for error responses */
881
882         /*
883         **  Overflow detection is based on < 0, so don't change this
884         **  to unsigned.  We don't use unsigned and == ULONG_MAX because
885         **  some libc's don't have strtoul(), see mail_esmtp_args().
886         */
887
888         long            e_msgsize;      /* size of the message in bytes */
889         char            *e_msgid;       /* message id (for logging) */
890         unsigned long   e_flags;        /* flags, see below */
891         int             e_nrcpts;       /* number of recipients */
892         short           e_class;        /* msg class (priority, junk, etc.) */
893         short           e_hopcount;     /* number of times processed */
894         short           e_nsent;        /* number of sends since checkpoint */
895         short           e_sendmode;     /* message send mode */
896         short           e_errormode;    /* error return mode */
897         short           e_timeoutclass; /* message timeout class */
898         bool            (*e_puthdr)__P((MCI *, HDR *, ENVELOPE *, int));
899                                         /* function to put header of message */
900         bool            (*e_putbody)__P((MCI *, ENVELOPE *, char *));
901                                         /* function to put body of message */
902         ENVELOPE        *e_parent;      /* the message this one encloses */
903         ENVELOPE        *e_sibling;     /* the next envelope of interest */
904         char            *e_bodytype;    /* type of message body */
905         SM_FILE_T       *e_dfp;         /* data file */
906         char            *e_id;          /* code for this entry in queue */
907 #if _FFR_SESSID
908         char            *e_sessid;      /* session ID for this envelope */
909 #endif /* _FFR_SESSID */
910         int             e_qgrp;         /* queue group (index into queues) */
911         int             e_qdir;         /* index into queue directories */
912         int             e_dfqgrp;       /* data file queue group index */
913         int             e_dfqdir;       /* data file queue directory index */
914         int             e_xfqgrp;       /* queue group (index into queues) */
915         int             e_xfqdir;       /* index into queue directories (xf) */
916         SM_FILE_T       *e_xfp;         /* transcript file */
917         SM_FILE_T       *e_lockfp;      /* the lock file for this message */
918         char            *e_message;     /* error message; readonly; NULL,
919                                          * or allocated from e_rpool */
920         char            *e_statmsg;     /* stat msg (changes per delivery).
921                                          * readonly. NULL or allocated from
922                                          * e_rpool. */
923         char            *e_quarmsg;     /* why envelope is quarantined */
924         char            e_qfletter;     /* queue file letter on disk */
925         char            *e_msgboundary; /* MIME-style message part boundary */
926         char            *e_origrcpt;    /* original recipient (one only) */
927         char            *e_envid;       /* envelope id from MAIL FROM: line */
928         char            *e_status;      /* DSN status for this message */
929         time_t          e_dtime;        /* time of last delivery attempt */
930         int             e_ntries;       /* number of delivery attempts */
931         dev_t           e_dfdev;        /* data file device (crash recovery) */
932         ino_t           e_dfino;        /* data file inode (crash recovery) */
933         MACROS_T        e_macro;        /* macro definitions */
934         MCI             *e_mci;         /* connection info */
935         char            *e_auth_param;  /* readonly; NULL or static storage or
936                                          * allocated from e_rpool */
937         TIMERS          e_timers;       /* per job timers */
938         long            e_deliver_by;   /* deliver by */
939         int             e_dlvr_flag;    /* deliver by flag */
940         SM_RPOOL_T      *e_rpool;       /* resource pool for this envelope */
941         unsigned int    e_features;     /* server features */
942 #if _FFR_MILTER_ENHSC
943 #define ENHSC_LEN       11
944         char            e_enhsc[ENHSC_LEN];     /* enhanced status code */
945 #endif /* _FFR_MILTER_ENHSC */
946 };
947
948 #define PRT_NONNEGL(v)  ((v) < 0 ? LONG_MAX : (v))
949
950 /* values for e_flags */
951 #define EF_OLDSTYLE     0x00000001L     /* use spaces (not commas) in hdrs */
952 #define EF_INQUEUE      0x00000002L     /* this message is fully queued */
953 #define EF_NO_BODY_RETN 0x00000004L     /* omit message body on error */
954 #define EF_CLRQUEUE     0x00000008L     /* disk copy is no longer needed */
955 #define EF_SENDRECEIPT  0x00000010L     /* send a return receipt */
956 #define EF_FATALERRS    0x00000020L     /* fatal errors occurred */
957 #define EF_DELETE_BCC   0x00000040L     /* delete Bcc: headers entirely */
958 #define EF_RESPONSE     0x00000080L     /* this is an error or return receipt */
959 #define EF_RESENT       0x00000100L     /* this message is being forwarded */
960 #define EF_VRFYONLY     0x00000200L     /* verify only (don't expand aliases) */
961 #define EF_WARNING      0x00000400L     /* warning message has been sent */
962 #define EF_QUEUERUN     0x00000800L     /* this envelope is from queue */
963 #define EF_GLOBALERRS   0x00001000L     /* treat errors as global */
964 #define EF_PM_NOTIFY    0x00002000L     /* send return mail to postmaster */
965 #define EF_METOO        0x00004000L     /* send to me too */
966 #define EF_LOGSENDER    0x00008000L     /* need to log the sender */
967 #define EF_NORECEIPT    0x00010000L     /* suppress all return-receipts */
968 #define EF_HAS8BIT      0x00020000L     /* at least one 8-bit char in body */
969 #define EF_NL_NOT_EOL   0x00040000L     /* don't accept raw NL as EOLine */
970 #define EF_CRLF_NOT_EOL 0x00080000L     /* don't accept CR-LF as EOLine */
971 #define EF_RET_PARAM    0x00100000L     /* RCPT command had RET argument */
972 #define EF_HAS_DF       0x00200000L     /* set when data file is instantiated */
973 #define EF_IS_MIME      0x00400000L     /* really is a MIME message */
974 #define EF_DONT_MIME    0x00800000L     /* never MIME this message */
975 #define EF_DISCARD      0x01000000L     /* discard the message */
976 #define EF_TOOBIG       0x02000000L     /* message is too big */
977 #define EF_SPLIT        0x04000000L     /* envelope has been split */
978 #define EF_UNSAFE       0x08000000L     /* unsafe: read from untrusted source */
979 #define EF_TOODEEP      0x10000000L     /* message is nested too deep */
980
981 #define DLVR_NOTIFY     0x01
982 #define DLVR_RETURN     0x02
983 #define DLVR_TRACE      0x10
984 #define IS_DLVR_NOTIFY(e)       (((e)->e_dlvr_flag & DLVR_NOTIFY) != 0)
985 #define IS_DLVR_RETURN(e)       (((e)->e_dlvr_flag & DLVR_RETURN) != 0)
986 #define IS_DLVR_TRACE(e)        (((e)->e_dlvr_flag & DLVR_TRACE) != 0)
987 #define IS_DLVR_BY(e)           ((e)->e_dlvr_flag != 0)
988
989 #define BODYTYPE_NONE   (0)
990 #define BODYTYPE_7BIT   (1)
991 #define BODYTYPE_8BITMIME       (2)
992 #define BODYTYPE_ILLEGAL        (-1)
993 #define BODYTYPE_VALID(b) ((b) == BODYTYPE_7BIT || (b) == BODYTYPE_8BITMIME)
994
995 extern ENVELOPE BlankEnvelope;
996
997 /* functions */
998 extern void     clearenvelope __P((ENVELOPE *, bool, SM_RPOOL_T *));
999 extern int      dropenvelope __P((ENVELOPE *, bool, bool));
1000 extern ENVELOPE *newenvelope __P((ENVELOPE *, ENVELOPE *, SM_RPOOL_T *));
1001 extern void     clrsessenvelope __P((ENVELOPE *));
1002 extern void     printenvflags __P((ENVELOPE *));
1003 extern bool     putbody __P((MCI *, ENVELOPE *, char *));
1004 extern bool     putheader __P((MCI *, HDR *, ENVELOPE *, int));
1005
1006 /*
1007 **  Message priority classes.
1008 **
1009 **      The message class is read directly from the Priority: header
1010 **      field in the message.
1011 **
1012 **      CurEnv->e_msgpriority is the number of bytes in the message plus
1013 **      the creation time (so that jobs ``tend'' to be ordered correctly),
1014 **      adjusted by the message class, the number of recipients, and the
1015 **      amount of time the message has been sitting around.  This number
1016 **      is used to order the queue.  Higher values mean LOWER priority.
1017 **
1018 **      Each priority class point is worth WkClassFact priority points;
1019 **      each recipient is worth WkRecipFact priority points.  Each time
1020 **      we reprocess a message the priority is adjusted by WkTimeFact.
1021 **      WkTimeFact should normally decrease the priority so that jobs
1022 **      that have historically failed will be run later; thanks go to
1023 **      Jay Lepreau at Utah for pointing out the error in my thinking.
1024 **
1025 **      The "class" is this number, unadjusted by the age or size of
1026 **      this message.  Classes with negative representations will have
1027 **      error messages thrown away if they are not local.
1028 */
1029
1030 struct priority
1031 {
1032         char    *pri_name;      /* external name of priority */
1033         int     pri_val;        /* internal value for same */
1034 };
1035
1036 EXTERN int      NumPriorities;  /* pointer into Priorities */
1037 EXTERN struct priority  Priorities[MAXPRIORITIES];
1038
1039 /*
1040 **  Rewrite rules.
1041 */
1042
1043 struct rewrite
1044 {
1045         char    **r_lhs;        /* pattern match */
1046         char    **r_rhs;        /* substitution value */
1047         struct rewrite  *r_next;/* next in chain */
1048         int     r_line;         /* rule line in sendmail.cf */
1049 };
1050
1051 /*
1052 **  Special characters in rewriting rules.
1053 **      These are used internally only.
1054 **      The COND* rules are actually used in macros rather than in
1055 **              rewriting rules, but are given here because they
1056 **              cannot conflict.
1057 */
1058
1059 /* "out of band" indicator */
1060 /* sm/sendmail.h #define METAQUOTE ((unsigned char)0377) quotes the next octet */
1061
1062 /* left hand side items */
1063 #define MATCHZANY       ((unsigned char)0220)   /* match zero or more tokens */
1064 #define MATCHANY        ((unsigned char)0221)   /* match one or more tokens */
1065 #define MATCHONE        ((unsigned char)0222)   /* match exactly one token */
1066 #define MATCHCLASS      ((unsigned char)0223)   /* match one token in a class */
1067 #define MATCHNCLASS     ((unsigned char)0224)   /* match tokens not in class */
1068
1069 /* right hand side items */
1070 #define MATCHREPL       ((unsigned char)0225)   /* RHS replacement for above */
1071 #define CANONNET        ((unsigned char)0226)   /* canonical net, next token */
1072 #define CANONHOST       ((unsigned char)0227)   /* canonical host, next token */
1073 #define CANONUSER       ((unsigned char)0230)   /* canonical user, next N tokens */
1074 #define CALLSUBR        ((unsigned char)0231)   /* call another rewriting set */
1075
1076 /* conditionals in macros (anywhere) */
1077 #define CONDIF          ((unsigned char)0232)   /* conditional if-then */
1078 #define CONDELSE        ((unsigned char)0233)   /* conditional else */
1079 #define CONDFI          ((unsigned char)0234)   /* conditional fi */
1080
1081 /* bracket characters for RHS host name lookup */
1082 #define HOSTBEGIN       ((unsigned char)0235)   /* hostname lookup begin */
1083 #define HOSTEND         ((unsigned char)0236)   /* hostname lookup end */
1084
1085 /* bracket characters for RHS generalized lookup */
1086 #define LOOKUPBEGIN     ((unsigned char)0205)   /* generalized lookup begin */
1087 #define LOOKUPEND       ((unsigned char)0206)   /* generalized lookup end */
1088
1089 /* macro substitution characters (anywhere) */
1090 #define MACROEXPAND     ((unsigned char)0201)   /* macro expansion */
1091 #define MACRODEXPAND    ((unsigned char)0202)   /* deferred macro expansion */
1092
1093 /* to make the code clearer */
1094 #define MATCHZERO       CANONHOST
1095
1096 #define MAXMATCH        9       /* max params per rewrite */
1097 #define MAX_MAP_ARGS    10      /* max arguments for map */
1098
1099 /* external <==> internal mapping table */
1100 struct metamac
1101 {
1102         char            metaname;       /* external code (after $) */
1103         unsigned char   metaval;        /* internal code (as above) */
1104 };
1105
1106 /* values for macros with external names only */
1107 #define MID_OPMODE      0202    /* operation mode */
1108
1109 /* functions */
1110 #if SM_HEAP_CHECK
1111 extern void
1112 macdefine_tagged __P((
1113         MACROS_T *_mac,
1114         ARGCLASS_T _vclass,
1115         int _id,
1116         char *_value,
1117         char *_file,
1118         int _line,
1119         int _group));
1120 # define macdefine(mac,c,id,v) \
1121         macdefine_tagged(mac,c,id,v,__FILE__,__LINE__,sm_heap_group())
1122 #else /* SM_HEAP_CHECK */
1123 extern void
1124 macdefine __P((
1125         MACROS_T *_mac,
1126         ARGCLASS_T _vclass,
1127         int _id,
1128         char *_value));
1129 # define macdefine_tagged(mac,c,id,v,file,line,grp) macdefine(mac,c,id,v)
1130 #endif /* SM_HEAP_CHECK */
1131 extern void     macset __P((MACROS_T *, int, char *));
1132 #define macget(mac, i) (mac)->mac_table[i]
1133 extern void     expand __P((char *, char *, size_t, ENVELOPE *));
1134 extern int      macid_parse __P((char *, char **));
1135 #define macid(name)  macid_parse(name, NULL)
1136 extern char     *macname __P((int));
1137 extern char     *macvalue __P((int, ENVELOPE *));
1138 extern int      rscheck __P((char *, char *, char *, ENVELOPE *, int, int, char *, char *, ADDRESS *));
1139 extern int      rscap __P((char *, char *, char *, ENVELOPE *, char ***, char *, int));
1140 extern void     setclass __P((int, char *));
1141 extern int      strtorwset __P((char *, char **, int));
1142 extern char     *translate_dollars __P((char *, char *, int *));
1143 extern bool     wordinclass __P((char *, int));
1144
1145 /*
1146 **  Name canonification short circuit.
1147 **
1148 **      If the name server for a host is down, the process of trying to
1149 **      canonify the name can hang.  This is similar to (but alas, not
1150 **      identical to) looking up the name for delivery.  This stab type
1151 **      caches the result of the name server lookup so we don't hang
1152 **      multiple times.
1153 */
1154
1155 #define NAMECANON       struct _namecanon
1156
1157 NAMECANON
1158 {
1159         short           nc_errno;       /* cached errno */
1160         short           nc_herrno;      /* cached h_errno */
1161         short           nc_stat;        /* cached exit status code */
1162         short           nc_flags;       /* flag bits */
1163         char            *nc_cname;      /* the canonical name */
1164         time_t          nc_exp;         /* entry expires at */
1165 };
1166
1167 /* values for nc_flags */
1168 #define NCF_VALID       0x0001  /* entry valid */
1169
1170 /* hostsignature structure */
1171
1172 struct hostsig_t
1173 {
1174         char            *hs_sig;        /* hostsignature */
1175         time_t          hs_exp;         /* entry expires at */
1176 };
1177
1178 typedef struct hostsig_t HOSTSIG_T;
1179
1180 /*
1181 **  The standard udp packet size PACKETSZ (512) is not sufficient for some
1182 **  nameserver answers containing very many resource records. The resolver
1183 **  may switch to tcp and retry if it detects udp packet overflow.
1184 **  Also note that the resolver routines res_query and res_search return
1185 **  the size of the *un*truncated answer in case the supplied answer buffer
1186 **  it not big enough to accommodate the entire answer.
1187 */
1188
1189 # ifndef MAXPACKET
1190 #  define MAXPACKET 8192        /* max packet size used internally by BIND */
1191 # endif /* ! MAXPACKET */
1192
1193 /*
1194 **  The resolver functions res_{send,query,querydomain} expect the
1195 **  answer buffer to be aligned, but some versions of gcc4 reverse
1196 **  25 years of history and no longer align char buffers on the
1197 **  stack, resulting in crashes on strict-alignment platforms.  Use
1198 **  this union when putting the buffer on the stack to force the
1199 **  alignment, then cast to (HEADER *) or (unsigned char *) as needed.
1200 */
1201 typedef union
1202 {
1203         HEADER          qb1;
1204         unsigned char   qb2[MAXPACKET];
1205 } querybuf;
1206
1207 /* functions */
1208 extern bool     getcanonname __P((char *, int, bool, int *));
1209 extern int      getmxrr __P((char *, char **, unsigned short *, bool, int *, bool, int *));
1210 extern char     *hostsignature __P((MAILER *, char *));
1211 extern int      getfallbackmxrr __P((char *));
1212
1213 /*
1214 **  Mapping functions
1215 **
1216 **      These allow arbitrary mappings in the config file.  The idea
1217 **      (albeit not the implementation) comes from IDA sendmail.
1218 */
1219
1220 #define MAPCLASS        struct _mapclass
1221 #define MAP             struct _map
1222 #define MAXMAPACTIONS   5               /* size of map_actions array */
1223
1224
1225 /*
1226 **  An actual map.
1227 */
1228
1229 MAP
1230 {
1231         MAPCLASS        *map_class;     /* the class of this map */
1232         MAPCLASS        *map_orgclass;  /* the original class of this map */
1233         char            *map_mname;     /* name of this map */
1234         long            map_mflags;     /* flags, see below */
1235         char            *map_file;      /* the (nominal) filename */
1236         ARBPTR_T        map_db1;        /* the open database ptr */
1237         ARBPTR_T        map_db2;        /* an "extra" database pointer */
1238         char            *map_keycolnm;  /* key column name */
1239         char            *map_valcolnm;  /* value column name */
1240         unsigned char   map_keycolno;   /* key column number */
1241         unsigned char   map_valcolno;   /* value column number */
1242         char            map_coldelim;   /* column delimiter */
1243         char            map_spacesub;   /* spacesub */
1244         char            *map_app;       /* to append to successful matches */
1245         char            *map_tapp;      /* to append to "tempfail" matches */
1246         char            *map_domain;    /* the (nominal) NIS domain */
1247         char            *map_rebuild;   /* program to run to do auto-rebuild */
1248         time_t          map_mtime;      /* last database modification time */
1249         time_t          map_timeout;    /* timeout for map accesses */
1250         int             map_retry;      /* # of retries for map accesses */
1251         pid_t           map_pid;        /* PID of process which opened map */
1252         int             map_lockfd;     /* auxiliary lock file descriptor */
1253         short           map_specificity;        /* specificity of aliases */
1254         MAP             *map_stack[MAXMAPSTACK];   /* list for stacked maps */
1255         short           map_return[MAXMAPACTIONS]; /* return bitmaps for stacked maps */
1256 };
1257
1258
1259 /* bit values for map_mflags */
1260 #define MF_VALID        0x00000001      /* this entry is valid */
1261 #define MF_INCLNULL     0x00000002      /* include null byte in key */
1262 #define MF_OPTIONAL     0x00000004      /* don't complain if map not found */
1263 #define MF_NOFOLDCASE   0x00000008      /* don't fold case in keys */
1264 #define MF_MATCHONLY    0x00000010      /* don't use the map value */
1265 #define MF_OPEN         0x00000020      /* this entry is open */
1266 #define MF_WRITABLE     0x00000040      /* open for writing */
1267 #define MF_ALIAS        0x00000080      /* this is an alias file */
1268 #define MF_TRY0NULL     0x00000100      /* try with no null byte */
1269 #define MF_TRY1NULL     0x00000200      /* try with the null byte */
1270 #define MF_LOCKED       0x00000400      /* this map is currently locked */
1271 #define MF_ALIASWAIT    0x00000800      /* alias map in aliaswait state */
1272 #define MF_IMPL_HASH    0x00001000      /* implicit: underlying hash database */
1273 #define MF_IMPL_NDBM    0x00002000      /* implicit: underlying NDBM database */
1274 /* 0x00004000   */
1275 #define MF_APPEND       0x00008000      /* append new entry on rebuild */
1276 #define MF_KEEPQUOTES   0x00010000      /* don't dequote key before lookup */
1277 #define MF_NODEFER      0x00020000      /* don't defer if map lookup fails */
1278 #define MF_REGEX_NOT    0x00040000      /* regular expression negation */
1279 #define MF_DEFER        0x00080000      /* don't lookup map in defer mode */
1280 #define MF_SINGLEMATCH  0x00100000      /* successful only if match one key */
1281 #define MF_SINGLEDN     0x00200000      /* only one match, but multi values */
1282 #define MF_FILECLASS    0x00400000      /* this is a file class map */
1283 #define MF_OPENBOGUS    0x00800000      /* open failed, don't call map_close */
1284 #define MF_CLOSING      0x01000000      /* map is being closed */
1285
1286 #define DYNOPENMAP(map) \
1287         do              \
1288         {               \
1289                 if (!bitset(MF_OPEN, (map)->map_mflags)) \
1290                 {       \
1291                         if (!openmap(map))      \
1292                                 return NULL;    \
1293                 }       \
1294         } while (0)
1295
1296
1297 /* indices for map_actions */
1298 #define MA_NOTFOUND     0               /* member map returned "not found" */
1299 #define MA_UNAVAIL      1               /* member map is not available */
1300 #define MA_TRYAGAIN     2               /* member map returns temp failure */
1301
1302 /* macros to handle MapTempFail */
1303 #define BIT_IS_MTP      0x01    /* temp.failure occurred */
1304 #define BIT_ASK_MTP     0x02    /* do we care about MapTempFail? */
1305 #define RESET_MAPTEMPFAIL       MapTempFail = 0
1306 #define INIT_MAPTEMPFAIL        MapTempFail = BIT_ASK_MTP
1307 #define SET_MAPTEMPFAIL         MapTempFail |= BIT_IS_MTP
1308 #define IS_MAPTEMPFAIL          bitset(BIT_IS_MTP, MapTempFail)
1309 #define ASK_MAPTEMPFAIL         bitset(BIT_ASK_MTP, MapTempFail)
1310
1311 /*
1312 **  The class of a map -- essentially the functions to call
1313 */
1314
1315 MAPCLASS
1316 {
1317         char    *map_cname;             /* name of this map class */
1318         char    *map_ext;               /* extension for database file */
1319         short   map_cflags;             /* flag bits, see below */
1320         bool    (*map_parse)__P((MAP *, char *));
1321                                         /* argument parsing function */
1322         char    *(*map_lookup)__P((MAP *, char *, char **, int *));
1323                                         /* lookup function */
1324         void    (*map_store)__P((MAP *, char *, char *));
1325                                         /* store function */
1326         bool    (*map_open)__P((MAP *, int));
1327                                         /* open function */
1328         void    (*map_close)__P((MAP *));
1329                                         /* close function */
1330 };
1331
1332 /* bit values for map_cflags */
1333 #define MCF_ALIASOK     0x0001          /* can be used for aliases */
1334 #define MCF_ALIASONLY   0x0002          /* usable only for aliases */
1335 #define MCF_REBUILDABLE 0x0004          /* can rebuild alias files */
1336 #define MCF_OPTFILE     0x0008          /* file name is optional */
1337 #define MCF_NOTPERSIST  0x0010          /* don't keep map open all the time */
1338
1339 /* functions */
1340 extern void     closemaps __P((bool));
1341 extern bool     impl_map_open __P((MAP *, int));
1342 extern void     initmaps __P((void));
1343 extern MAP      *makemapentry __P((char *));
1344 extern void     maplocaluser __P((ADDRESS *, ADDRESS **, int, ENVELOPE *));
1345 extern char     *map_rewrite __P((MAP *, const char *, size_t, char **));
1346 #if NETINFO
1347 extern char     *ni_propval __P((char *, char *, char *, char *, int));
1348 #endif /* NETINFO */
1349 extern bool     openmap __P((MAP *));
1350 extern int      udbexpand __P((ADDRESS *, ADDRESS **, int, ENVELOPE *));
1351 #if USERDB
1352 extern void     _udbx_close __P((void));
1353 extern char     *udbsender __P((char *, SM_RPOOL_T *));
1354 #endif /* USERDB */
1355
1356 /*
1357 **  LDAP related items
1358 */
1359 #if LDAPMAP
1360 /* struct defining LDAP Auth Methods */
1361 struct lamvalues
1362 {
1363         char    *lam_name;      /* name of LDAP auth method */
1364         int     lam_code;       /* numeric code */
1365 };
1366
1367 /* struct defining LDAP Alias Dereferencing */
1368 struct ladvalues
1369 {
1370         char    *lad_name;      /* name of LDAP alias dereferencing method */
1371         int     lad_code;       /* numeric code */
1372 };
1373
1374 /* struct defining LDAP Search Scope */
1375 struct lssvalues
1376 {
1377         char    *lss_name;      /* name of LDAP search scope */
1378         int     lss_code;       /* numeric code */
1379 };
1380
1381 /* functions */
1382 extern bool     ldapmap_parseargs __P((MAP *, char *));
1383 extern void     ldapmap_set_defaults __P((char *));
1384 #endif /* LDAPMAP */
1385
1386 /*
1387 **  PH related items
1388 */
1389
1390 #if PH_MAP
1391
1392 # include <phclient.h>
1393
1394 struct ph_map_struct
1395 {
1396         char    *ph_servers;     /* list of ph servers */
1397         char    *ph_field_list;  /* list of fields to search for match */
1398         PH      *ph;             /* PH server handle */
1399         int     ph_fastclose;    /* send "quit" command on close */
1400         time_t  ph_timeout;      /* timeout interval */
1401 };
1402 typedef struct ph_map_struct    PH_MAP_STRUCT;
1403
1404 #endif /* PH_MAP */
1405
1406 /*
1407 **  Regular UNIX sockaddrs are too small to handle ISO addresses, so
1408 **  we are forced to declare a supertype here.
1409 */
1410
1411 #if NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25
1412 union bigsockaddr
1413 {
1414         struct sockaddr         sa;     /* general version */
1415 # if NETUNIX
1416         struct sockaddr_un      sunix;  /* UNIX family */
1417 # endif /* NETUNIX */
1418 # if NETINET
1419         struct sockaddr_in      sin;    /* INET family */
1420 # endif /* NETINET */
1421 # if NETINET6
1422         struct sockaddr_in6     sin6;   /* INET/IPv6 */
1423 # endif /* NETINET6 */
1424 # if NETISO
1425         struct sockaddr_iso     siso;   /* ISO family */
1426 # endif /* NETISO */
1427 # if NETNS
1428         struct sockaddr_ns      sns;    /* XNS family */
1429 # endif /* NETNS */
1430 # if NETX25
1431         struct sockaddr_x25     sx25;   /* X.25 family */
1432 # endif /* NETX25 */
1433 };
1434
1435 # define SOCKADDR       union bigsockaddr
1436
1437 /* functions */
1438 extern char     *anynet_ntoa __P((SOCKADDR *));
1439 # if NETINET6
1440 extern char     *anynet_ntop __P((struct in6_addr *, char *, size_t));
1441 extern int      anynet_pton __P((int, const char *, void *));
1442 # endif /* NETINET6 */
1443 extern char     *hostnamebyanyaddr __P((SOCKADDR *));
1444 extern char     *validate_connection __P((SOCKADDR *, char *, ENVELOPE *));
1445 # if SASL >= 20000
1446 extern bool     iptostring __P((SOCKADDR *, SOCKADDR_LEN_T, char *, unsigned));
1447 # endif /* SASL >= 20000 */
1448
1449 #endif /* NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25 */
1450
1451 /*
1452 **  Process List (proclist)
1453 */
1454
1455 #define NO_PID          ((pid_t) 0)
1456 #ifndef PROC_LIST_SEG
1457 # define PROC_LIST_SEG  32              /* number of pids to alloc at a time */
1458 #endif /* ! PROC_LIST_SEG */
1459
1460 /* process types */
1461 #define PROC_NONE               0
1462 #define PROC_DAEMON             1
1463 #define PROC_DAEMON_CHILD       2
1464 #define PROC_QUEUE              3
1465 #define PROC_QUEUE_CHILD        3
1466 #define PROC_CONTROL            4
1467 #define PROC_CONTROL_CHILD      5
1468
1469 /* functions */
1470 extern void     proc_list_add __P((pid_t, char *, int, int, int, SOCKADDR *));
1471 extern void     proc_list_clear __P((void));
1472 extern void     proc_list_display __P((SM_FILE_T *, char *));
1473 extern void     proc_list_drop __P((pid_t, int, int *));
1474 extern void     proc_list_probe __P((void));
1475 extern void     proc_list_set __P((pid_t, char *));
1476 extern void     proc_list_signal __P((int, int));
1477
1478 /*
1479 **  Symbol table definitions
1480 */
1481
1482 struct symtab
1483 {
1484         char            *s_name;        /* name to be entered */
1485         short           s_symtype;      /* general type (see below) */
1486         struct symtab   *s_next;        /* pointer to next in chain */
1487         union
1488         {
1489                 BITMAP256       sv_class;       /* bit-map of word classes */
1490                 MAILER          *sv_mailer;     /* pointer to mailer */
1491                 char            *sv_alias;      /* alias */
1492                 MAPCLASS        sv_mapclass;    /* mapping function class */
1493                 MAP             sv_map;         /* mapping function */
1494                 HOSTSIG_T       sv_hostsig;     /* host signature */
1495                 MCI             sv_mci;         /* mailer connection info */
1496                 NAMECANON       sv_namecanon;   /* canonical name cache */
1497                 int             sv_macro;       /* macro name => id mapping */
1498                 int             sv_ruleset;     /* ruleset index */
1499                 struct hdrinfo  sv_header;      /* header metainfo */
1500                 char            *sv_service[MAXMAPSTACK]; /* service switch */
1501 #if LDAPMAP
1502                 MAP             *sv_lmap;       /* Maps for LDAP connection */
1503 #endif /* LDAPMAP */
1504 #if SOCKETMAP
1505                 MAP             *sv_socketmap;  /* Maps for SOCKET connection */
1506 #endif /* SOCKETMAP */
1507 #if MILTER
1508                 struct milter   *sv_milter;     /* milter filter name */
1509 #endif /* MILTER */
1510                 QUEUEGRP        *sv_queue;      /* pointer to queue */
1511         }       s_value;
1512 };
1513
1514 typedef struct symtab   STAB;
1515
1516 /* symbol types */
1517 #define ST_UNDEF        0       /* undefined type */
1518 #define ST_CLASS        1       /* class map */
1519 /* #define ST_unused    2       UNUSED */
1520 #define ST_MAILER       3       /* a mailer header */
1521 #define ST_ALIAS        4       /* an alias */
1522 #define ST_MAPCLASS     5       /* mapping function class */
1523 #define ST_MAP          6       /* mapping function */
1524 #define ST_HOSTSIG      7       /* host signature */
1525 #define ST_NAMECANON    8       /* cached canonical name */
1526 #define ST_MACRO        9       /* macro name to id mapping */
1527 #define ST_RULESET      10      /* ruleset index */
1528 #define ST_SERVICE      11      /* service switch entry */
1529 #define ST_HEADER       12      /* special header flags */
1530 #if LDAPMAP
1531 # define ST_LMAP        13      /* List head of maps for LDAP connection */
1532 #endif /* LDAPMAP */
1533 #if MILTER
1534 # define ST_MILTER      14      /* milter filter */
1535 #endif /* MILTER */
1536 #define ST_QUEUE        15      /* a queue entry */
1537
1538 #if SOCKETMAP
1539 # define ST_SOCKETMAP   16      /* List head of maps for SOCKET connection */
1540 #endif /* SOCKETMAP */
1541
1542 /* This entry must be last */
1543 #define ST_MCI          17      /* mailer connection info (offset) */
1544
1545 #define s_class         s_value.sv_class
1546 #define s_mailer        s_value.sv_mailer
1547 #define s_alias         s_value.sv_alias
1548 #define s_mci           s_value.sv_mci
1549 #define s_mapclass      s_value.sv_mapclass
1550 #define s_hostsig       s_value.sv_hostsig
1551 #define s_map           s_value.sv_map
1552 #define s_namecanon     s_value.sv_namecanon
1553 #define s_macro         s_value.sv_macro
1554 #define s_ruleset       s_value.sv_ruleset
1555 #define s_service       s_value.sv_service
1556 #define s_header        s_value.sv_header
1557 #if LDAPMAP
1558 # define s_lmap         s_value.sv_lmap
1559 #endif /* LDAPMAP */
1560 #if SOCKETMAP
1561 # define s_socketmap    s_value.sv_socketmap
1562 #endif /* SOCKETMAP */
1563 #if MILTER
1564 # define s_milter       s_value.sv_milter
1565 #endif /* MILTER */
1566 #define s_quegrp        s_value.sv_queue
1567
1568 /* opcodes to stab */
1569 #define ST_FIND         0       /* find entry */
1570 #define ST_ENTER        1       /* enter if not there */
1571
1572 /* functions */
1573 extern STAB     *stab __P((char *, int, int));
1574 extern void     stabapply __P((void (*)(STAB *, int), int));
1575
1576 /*
1577 **  Operation, send, error, and MIME modes
1578 **
1579 **      The operation mode describes the basic operation of sendmail.
1580 **      This can be set from the command line, and is "send mail" by
1581 **      default.
1582 **
1583 **      The send mode tells how to send mail.  It can be set in the
1584 **      configuration file.  Its setting determines how quickly the
1585 **      mail will be delivered versus the load on your system.  If the
1586 **      -v (verbose) flag is given, it will be forced to SM_DELIVER
1587 **      mode.
1588 **
1589 **      The error mode tells how to return errors.
1590 */
1591
1592 #define MD_DELIVER      'm'             /* be a mail sender */
1593 #define MD_SMTP         's'             /* run SMTP on standard input */
1594 #define MD_ARPAFTP      'a'             /* obsolete ARPANET mode (Grey Book) */
1595 #define MD_DAEMON       'd'             /* run as a daemon */
1596 #define MD_FGDAEMON     'D'             /* run daemon in foreground */
1597 #define MD_LOCAL        'l'             /* like daemon, but localhost only */
1598 #define MD_VERIFY       'v'             /* verify: don't collect or deliver */
1599 #define MD_TEST         't'             /* test mode: resolve addrs only */
1600 #define MD_INITALIAS    'i'             /* initialize alias database */
1601 #define MD_PRINT        'p'             /* print the queue */
1602 #define MD_PRINTNQE     'P'             /* print number of entries in queue */
1603 #define MD_FREEZE       'z'             /* freeze the configuration file */
1604 #define MD_HOSTSTAT     'h'             /* print persistent host stat info */
1605 #define MD_PURGESTAT    'H'             /* purge persistent host stat info */
1606 #define MD_QUEUERUN     'q'             /* queue run */
1607 #define MD_CHECKCONFIG  'C'             /* check configuration file */
1608
1609 #if _FFR_LOCAL_DAEMON
1610 EXTERN bool     LocalDaemon;
1611 # if NETINET6
1612 EXTERN bool     V6LoopbackAddrFound;    /* found an IPv6 loopback address */
1613 #  define SETV6LOOPBACKADDRFOUND(sa)    \
1614         do      \
1615         {       \
1616                 if (isloopback(sa))     \
1617                         V6LoopbackAddrFound = true;     \
1618         } while (0)
1619 # endif /* NETINET6 */
1620 #else /* _FFR_LOCAL_DAEMON */
1621 # define LocalDaemon    false
1622 # define V6LoopbackAddrFound    false
1623 # define SETV6LOOPBACKADDRFOUND(sa)
1624 #endif /* _FFR_LOCAL_DAEMON */
1625
1626 /* Note: see also include/sendmail/pathnames.h: GET_CLIENT_CF */
1627
1628 /* values for e_sendmode -- send modes */
1629 #define SM_DELIVER      'i'             /* interactive delivery */
1630 #define SM_FORK         'b'             /* deliver in background */
1631 #if _FFR_DM_ONE
1632 #define SM_DM_ONE       'o' /* deliver first TA in background, then queue */
1633 #endif /* _FFR_DM_ONE */
1634 #define SM_QUEUE        'q'             /* queue, don't deliver */
1635 #define SM_DEFER        'd'             /* defer map lookups as well as queue */
1636 #define SM_VERIFY       'v'             /* verify only (used internally) */
1637 #define DM_NOTSET       (-1)    /* DeliveryMode (per daemon) option not set */
1638 # define SM_IS_INTERACTIVE(m)   ((m) == SM_DELIVER)
1639
1640 #define WILL_BE_QUEUED(m)       ((m) == SM_QUEUE || (m) == SM_DEFER)
1641
1642 /* used only as a parameter to sendall */
1643 #define SM_DEFAULT      '\0'            /* unspecified, use SendMode */
1644
1645 /* functions */
1646 extern void     set_delivery_mode __P((int, ENVELOPE *));
1647
1648 /* values for e_errormode -- error handling modes */
1649 #define EM_PRINT        'p'             /* print errors */
1650 #define EM_MAIL         'm'             /* mail back errors */
1651 #define EM_WRITE        'w'             /* write back errors */
1652 #define EM_BERKNET      'e'             /* special berknet processing */
1653 #define EM_QUIET        'q'             /* don't print messages (stat only) */
1654
1655
1656 /* bit values for MimeMode */
1657 #define MM_CVTMIME      0x0001          /* convert 8 to 7 bit MIME */
1658 #define MM_PASS8BIT     0x0002          /* just send 8 bit data blind */
1659 #define MM_MIME8BIT     0x0004          /* convert 8-bit data to MIME */
1660
1661
1662 /* how to handle messages without any recipient addresses */
1663 #define NRA_NO_ACTION           0       /* just leave it as is */
1664 #define NRA_ADD_TO              1       /* add To: header */
1665 #define NRA_ADD_APPARENTLY_TO   2       /* add Apparently-To: header */
1666 #define NRA_ADD_BCC             3       /* add empty Bcc: header */
1667 #define NRA_ADD_TO_UNDISCLOSED  4       /* add To: undisclosed:; header */
1668
1669
1670 /* flags to putxline */
1671 #define PXLF_NOTHINGSPECIAL     0       /* no special mapping */
1672 #define PXLF_MAPFROM            0x0001  /* map From_ to >From_ */
1673 #define PXLF_STRIP8BIT          0x0002  /* strip 8th bit */
1674 #define PXLF_HEADER             0x0004  /* map newlines in headers */
1675 #define PXLF_NOADDEOL           0x0008  /* if EOL not present, don't add one */
1676 #define PXLF_STRIPMQUOTE        0x0010  /* strip METAQUOTEs */
1677
1678 /*
1679 **  Privacy flags
1680 **      These are bit values for the PrivacyFlags word.
1681 */
1682
1683 #define PRIV_PUBLIC             0               /* what have I got to hide? */
1684 #define PRIV_NEEDMAILHELO       0x00000001      /* insist on HELO for MAIL */
1685 #define PRIV_NEEDEXPNHELO       0x00000002      /* insist on HELO for EXPN */
1686 #define PRIV_NEEDVRFYHELO       0x00000004      /* insist on HELO for VRFY */
1687 #define PRIV_NOEXPN             0x00000008      /* disallow EXPN command */
1688 #define PRIV_NOVRFY             0x00000010      /* disallow VRFY command */
1689 #define PRIV_AUTHWARNINGS       0x00000020      /* flag possible auth probs */
1690 #define PRIV_NOVERB             0x00000040      /* disallow VERB command */
1691 #define PRIV_RESTRICTMAILQ      0x00010000      /* restrict mailq command */
1692 #define PRIV_RESTRICTQRUN       0x00020000      /* restrict queue run */
1693 #define PRIV_RESTRICTEXPAND     0x00040000      /* restrict alias/forward expansion */
1694 #define PRIV_NOETRN             0x00080000      /* disallow ETRN command */
1695 #define PRIV_NOBODYRETN         0x00100000      /* do not return bodies on bounces */
1696 #define PRIV_NORECEIPTS         0x00200000      /* disallow return receipts */
1697 #define PRIV_NOACTUALRECIPIENT  0x00400000 /* no X-Actual-Recipient in DSNs */
1698
1699 /* don't give no info, anyway, anyhow (in the main SMTP transaction) */
1700 #define PRIV_GOAWAY             0x0000ffff
1701
1702 /* struct defining such things */
1703 struct prival
1704 {
1705         char            *pv_name;       /* name of privacy flag */
1706         unsigned long   pv_flag;        /* numeric level */
1707 };
1708
1709 EXTERN unsigned long    PrivacyFlags;   /* privacy flags */
1710
1711
1712 /*
1713 **  Flags passed to remotename, parseaddr, allocaddr, and buildaddr.
1714 */
1715
1716 #define RF_SENDERADDR           0x001   /* this is a sender address */
1717 #define RF_HEADERADDR           0x002   /* this is a header address */
1718 #define RF_CANONICAL            0x004   /* strip comment information */
1719 #define RF_ADDDOMAIN            0x008   /* OK to do domain extension */
1720 #define RF_COPYPARSE            0x010   /* copy parsed user & host */
1721 #define RF_COPYPADDR            0x020   /* copy print address */
1722 #define RF_COPYALL              (RF_COPYPARSE|RF_COPYPADDR)
1723 #define RF_COPYNONE             0
1724 #define RF_RM_ADDR              0x040   /* address to be removed */
1725
1726 /*
1727 **  Flags passed to rscheck
1728 */
1729
1730 #define RSF_RMCOMM              0x0001  /* strip comments */
1731 #define RSF_UNSTRUCTURED        0x0002  /* unstructured, ignore syntax errors */
1732 #define RSF_COUNT               0x0004  /* count rejections (statistics)? */
1733
1734 /*
1735 **  Flags passed to mime8to7 and putheader.
1736 */
1737
1738 #define M87F_OUTER              0       /* outer context */
1739 #define M87F_NO8BIT             0x0001  /* can't have 8-bit in this section */
1740 #define M87F_DIGEST             0x0002  /* processing multipart/digest */
1741 #define M87F_NO8TO7             0x0004  /* don't do 8->7 bit conversions */
1742
1743 /* functions */
1744 extern bool     mime7to8 __P((MCI *, HDR *, ENVELOPE *));
1745 extern int      mime8to7 __P((MCI *, HDR *, ENVELOPE *, char **, int, int));
1746
1747 /*
1748 **  Flags passed to returntosender.
1749 */
1750
1751 #define RTSF_NO_BODY            0       /* send headers only */
1752 #define RTSF_SEND_BODY          0x0001  /* include body of message in return */
1753 #define RTSF_PM_BOUNCE          0x0002  /* this is a postmaster bounce */
1754
1755 /* functions */
1756 extern int      returntosender __P((char *, ADDRESS *, int, ENVELOPE *));
1757
1758 /*
1759 **  Mail Filters (milter)
1760 */
1761
1762 /*
1763 **  32-bit type used by milter
1764 **  (needed by libmilter even if MILTER isn't defined)
1765 */
1766
1767 typedef SM_INT32        mi_int32;
1768
1769 #if MILTER
1770 # define SMFTO_WRITE    0               /* Timeout for sending information */
1771 # define SMFTO_READ     1               /* Timeout waiting for a response */
1772 # define SMFTO_EOM      2               /* Timeout for ACK/NAK to EOM */
1773 # define SMFTO_CONNECT  3               /* Timeout for connect() */
1774
1775 # define SMFTO_NUM_TO   4               /* Total number of timeouts */
1776
1777 struct milter
1778 {
1779         char            *mf_name;       /* filter name */
1780         BITMAP256       mf_flags;       /* MTA flags */
1781         mi_int32        mf_fvers;       /* filter version */
1782         mi_int32        mf_fflags;      /* filter flags */
1783         mi_int32        mf_pflags;      /* protocol flags */
1784         char            *mf_conn;       /* connection info */
1785         int             mf_sock;        /* connected socket */
1786         char            mf_state;       /* state of filter */
1787         char            mf_lflags;      /* "local" flags */
1788         int             mf_idx;         /* milter number (index) */
1789         time_t          mf_timeout[SMFTO_NUM_TO]; /* timeouts */
1790 #if _FFR_MILTER_CHECK
1791         /* for testing only */
1792         mi_int32        mf_mta_prot_version;
1793         mi_int32        mf_mta_prot_flags;
1794         mi_int32        mf_mta_actions;
1795 #endif /* _FFR_MILTER_CHECK */
1796 };
1797
1798 #define MI_LFL_NONE     0x00000000
1799 #define MI_LFLAGS_SYM(st) (1 << (st))   /* has its own symlist for stage st */
1800
1801 struct milters
1802 {
1803         mi_int32        mis_flags;      /* filter flags */
1804 };
1805 typedef struct milters  milters_T;
1806
1807 #define MIS_FL_NONE     0x00000000      /* no requirements... */
1808 #define MIS_FL_DEL_RCPT 0x00000001      /* can delete rcpt */
1809 #define MIS_FL_REJ_RCPT 0x00000002      /* can reject rcpt */
1810
1811
1812 /* MTA flags */
1813 # define SMF_REJECT             'R'     /* Reject connection on filter fail */
1814 # define SMF_TEMPFAIL           'T'     /* tempfail connection on failure */
1815 # define SMF_TEMPDROP           '4'     /* 421 connection on failure */
1816
1817 EXTERN struct milter    *InputFilters[MAXFILTERS];
1818 EXTERN char             *InputFilterList;
1819 EXTERN int              MilterLogLevel;
1820
1821 /* functions */
1822 extern void     setup_daemon_milters __P((void));
1823 #endif /* MILTER */
1824
1825 /*
1826 **  Vendor codes
1827 **
1828 **      Vendors can customize sendmail to add special behaviour,
1829 **      generally for back compatibility.  Ideally, this should
1830 **      be set up in the .cf file using the "V" command.  However,
1831 **      it's quite reasonable for some vendors to want the default
1832 **      be their old version; this can be set using
1833 **              -DVENDOR_DEFAULT=VENDOR_xxx
1834 **      in the Makefile.
1835 **
1836 **      Vendors should apply to sendmail@sendmail.org for
1837 **      unique vendor codes.
1838 */
1839
1840 #define VENDOR_BERKELEY 1       /* Berkeley-native configuration file */
1841 #define VENDOR_SUN      2       /* Sun-native configuration file */
1842 #define VENDOR_HP       3       /* Hewlett-Packard specific config syntax */
1843 #define VENDOR_IBM      4       /* IBM specific config syntax */
1844 #define VENDOR_SENDMAIL 5       /* Sendmail, Inc. specific config syntax */
1845 #define VENDOR_DEC      6       /* Compaq, DEC, Digital */
1846
1847 /* prototypes for vendor-specific hook routines */
1848 extern void     vendor_daemon_setup __P((ENVELOPE *));
1849 extern void     vendor_set_uid __P((UID_T));
1850
1851
1852 /*
1853 **  Terminal escape codes.
1854 **
1855 **      To make debugging output clearer.
1856 */
1857
1858 struct termescape
1859 {
1860         char    *te_rv_on;      /* turn reverse-video on */
1861         char    *te_under_on;   /* turn underlining on */
1862         char    *te_normal;     /* revert to normal output */
1863 };
1864
1865 /*
1866 **  Additional definitions
1867 */
1868
1869 /*
1870 **  d_flags, see daemon.c
1871 **  general rule: lower case: required, upper case: No
1872 */
1873
1874 #define D_AUTHREQ       'a'     /* authentication required */
1875 #define D_BINDIF        'b'     /* use if_addr for outgoing connection */
1876 #define D_CANONREQ      'c'     /* canonification required (cf) */
1877 #define D_IFNHELO       'h'     /* use if name for HELO */
1878 #define D_FQMAIL        'f'     /* fq sender address required (cf) */
1879 #define D_FQRCPT        'r'     /* fq recipient address required (cf) */
1880 #define D_SMTPS         's'     /* SMTP over SSL (smtps) */
1881 #define D_UNQUALOK      'u'     /* unqualified address is ok (cf) */
1882 #define D_NOAUTH        'A'     /* no AUTH */
1883 #define D_NOCANON       'C'     /* no canonification (cf) */
1884 #define D_NOETRN        'E'     /* no ETRN (MSA) */
1885 #define D_NOTLS         'S'     /* don't use STARTTLS */
1886 #define D_ETRNONLY      ((char)0x01)    /* allow only ETRN (disk low) */
1887 #define D_OPTIONAL      'O'     /* optional socket */
1888 #define D_DISABLE       ((char)0x02)    /* optional socket disabled */
1889 #define D_ISSET         ((char)0x03)    /* this client struct is set */
1890
1891 #if STARTTLS
1892 /*
1893 **  TLS
1894 */
1895
1896 /* what to do in the TLS initialization */
1897 #define TLS_I_NONE      0x00000000      /* no requirements... */
1898 #define TLS_I_CERT_EX   0x00000001      /* cert must exist */
1899 #define TLS_I_CERT_UNR  0x00000002      /* cert must be g/o unreadable */
1900 #define TLS_I_KEY_EX    0x00000004      /* key must exist */
1901 #define TLS_I_KEY_UNR   0x00000008      /* key must be g/o unreadable */
1902 #define TLS_I_CERTP_EX  0x00000010      /* CA cert path must exist */
1903 #define TLS_I_CERTP_UNR 0x00000020      /* CA cert path must be g/o unreadable */
1904 #define TLS_I_CERTF_EX  0x00000040      /* CA cert file must exist */
1905 #define TLS_I_CERTF_UNR 0x00000080      /* CA cert file must be g/o unreadable */
1906 #define TLS_I_RSA_TMP   0x00000100      /* RSA TMP must be generated */
1907 #define TLS_I_USE_KEY   0x00000200      /* private key must usable */
1908 #define TLS_I_USE_CERT  0x00000400      /* certificate must be usable */
1909 #define TLS_I_VRFY_PATH 0x00000800      /* load verify path must succeed */
1910 #define TLS_I_VRFY_LOC  0x00001000      /* load verify default must succeed */
1911 #define TLS_I_CACHE     0x00002000      /* require cache */
1912 #define TLS_I_TRY_DH    0x00004000      /* try DH certificate */
1913 #define TLS_I_REQ_DH    0x00008000      /* require DH certificate */
1914 #define TLS_I_DHPAR_EX  0x00010000      /* require DH parameters */
1915 #define TLS_I_DHPAR_UNR 0x00020000      /* DH param. must be g/o unreadable */
1916 #define TLS_I_DH512     0x00040000      /* generate 512bit DH param */
1917 #define TLS_I_DH1024    0x00080000      /* generate 1024bit DH param */
1918 #define TLS_I_DH2048    0x00100000      /* generate 2048bit DH param */
1919 #define TLS_I_NO_VRFY   0x00200000      /* do not require authentication */
1920 #define TLS_I_KEY_OUNR  0x00400000      /* Key must be other unreadable */
1921 #define TLS_I_CRLF_EX   0x00800000      /* CRL file must exist */
1922 #define TLS_I_CRLF_UNR  0x01000000      /* CRL file must be g/o unreadable */
1923
1924 /* require server cert */
1925 #define TLS_I_SRV_CERT   (TLS_I_CERT_EX | TLS_I_KEY_EX | \
1926                           TLS_I_KEY_UNR | TLS_I_KEY_OUNR | \
1927                           TLS_I_CERTP_EX | TLS_I_CERTF_EX | \
1928                           TLS_I_USE_KEY | TLS_I_USE_CERT | TLS_I_CACHE)
1929
1930 /* server requirements */
1931 #define TLS_I_SRV       (TLS_I_SRV_CERT | TLS_I_RSA_TMP | TLS_I_VRFY_PATH | \
1932                          TLS_I_VRFY_LOC | TLS_I_TRY_DH | TLS_I_DH512 | \
1933                          TLS_I_CACHE)
1934
1935 /* client requirements */
1936 #define TLS_I_CLT       (TLS_I_KEY_UNR | TLS_I_KEY_OUNR)
1937
1938 #define TLS_AUTH_OK     0
1939 #define TLS_AUTH_NO     1
1940 #define TLS_AUTH_FAIL   (-1)
1941
1942 /* functions */
1943 extern bool     init_tls_library __P((bool _fipsmode));
1944 extern bool     inittls __P((SSL_CTX **, unsigned long, long, bool, char *, char *, char *, char *, char *));
1945 extern bool     initclttls __P((bool));
1946 extern void     setclttls __P((bool));
1947 extern bool     initsrvtls __P((bool));
1948 extern int      tls_get_info __P((SSL *, bool, char *, MACROS_T *, bool));
1949 extern int      endtls __P((SSL *, char *));
1950 extern void     tlslogerr __P((int, const char *));
1951
1952
1953 EXTERN char     *CACertPath;    /* path to CA certificates (dir. with hashes) */
1954 EXTERN char     *CACertFile;    /* file with CA certificate */
1955 EXTERN char     *CltCertFile;   /* file with client certificate */
1956 EXTERN char     *CltKeyFile;    /* file with client private key */
1957 # if _FFR_TLS_1
1958 EXTERN char     *CipherList;    /* list of ciphers */
1959 EXTERN char     *DHParams5;     /* file with DH parameters (512) */
1960 # endif /* _FFR_TLS_1 */
1961 EXTERN char     *DHParams;      /* file with DH parameters */
1962 EXTERN char     *RandFile;      /* source of random data */
1963 EXTERN char     *SrvCertFile;   /* file with server certificate */
1964 EXTERN char     *SrvKeyFile;    /* file with server private key */
1965 EXTERN char     *CRLFile;       /* file CRLs */
1966 #if _FFR_CRLPATH
1967 EXTERN char     *CRLPath;       /* path to CRLs (dir. with hashes) */
1968 #endif /* _FFR_CRLPATH */
1969 EXTERN unsigned long    TLS_Srv_Opts;   /* TLS server options */
1970 EXTERN long     Srv_SSL_Options, Clt_SSL_Options; /* SSL options */
1971 #endif /* STARTTLS */
1972
1973 /*
1974 **  Queue related items
1975 */
1976
1977 /* queue file names */
1978 #define ANYQFL_LETTER '?'
1979 #define QUARQF_LETTER 'h'
1980 #define DATAFL_LETTER 'd'
1981 #define XSCRPT_LETTER 'x'
1982 #define NORMQF_LETTER 'q'
1983 #define NEWQFL_LETTER 't'
1984
1985 # define TEMPQF_LETTER 'T'
1986 # define LOSEQF_LETTER 'Q'
1987
1988 /* queue sort order */
1989 #define QSO_BYPRIORITY  0               /* sort by message priority */
1990 #define QSO_BYHOST      1               /* sort by first host name */
1991 #define QSO_BYTIME      2               /* sort by submission time */
1992 #define QSO_BYFILENAME  3               /* sort by file name only */
1993 #define QSO_RANDOM      4               /* sort in random order */
1994 #define QSO_BYMODTIME   5               /* sort by modification time */
1995 #define QSO_NONE        6               /* do not sort */
1996 #if _FFR_RHS
1997 # define QSO_BYSHUFFLE  7               /* sort by shuffled host name */
1998 #endif /* _FFR_RHS */
1999
2000 #define NOQGRP  (-1)            /* no queue group (yet) */
2001 #define ENVQGRP (-2)            /* use queue group of envelope */
2002 #define NOAQGRP (-3)            /* no queue group in addr (yet) */
2003 #define ISVALIDQGRP(x)  ((x) >= 0)      /* valid queue group? */
2004 #define NOQDIR  (-1)            /* no queue directory (yet) */
2005 #define ENVQDIR (-2)            /* use queue directory of envelope */
2006 #define NOAQDIR (-3)            /* no queue directory in addr (yet) */
2007 #define ISVALIDQDIR(x)  ((x) >= 0)      /* valid queue directory? */
2008 #define RS_QUEUEGROUP   "queuegroup"    /* ruleset for queue group selection */
2009
2010 #define NOW     ((time_t) (-1))         /* queue return: now */
2011
2012 /* SuperSafe values */
2013 #define SAFE_NO                 0       /* no fsync(): don't use... */
2014 #define SAFE_INTERACTIVE        1       /* limit fsync() in -odi */
2015 #define SAFE_REALLY             2       /* always fsync() */
2016 #define SAFE_REALLY_POSTMILTER  3       /* fsync() if milter says OK */
2017
2018 /* QueueMode bits */
2019 #define QM_NORMAL               ' '
2020 #define QM_QUARANTINE           'Q'
2021 #define QM_LOST                 'L'
2022
2023 /* Queue Run Limitations */
2024 struct queue_char
2025 {
2026         char                    *queue_match;   /* string to match */
2027         bool                    queue_negate;   /* or not match, if set */
2028         struct queue_char       *queue_next;
2029 };
2030
2031 /* run_work_group() flags */
2032 #define RWG_NONE                0x0000
2033 #define RWG_FORK                0x0001
2034 #define RWG_VERBOSE             0x0002
2035 #define RWG_PERSISTENT          0x0004
2036 #define RWG_FORCE               0x0008
2037 #define RWG_RUNALL              0x0010
2038
2039 typedef struct queue_char       QUEUE_CHAR;
2040
2041 EXTERN int      volatile CurRunners;    /* current number of runner children */
2042 EXTERN int      MaxQueueRun;    /* maximum number of jobs in one queue run */
2043 EXTERN int      MaxQueueChildren;       /* max # of forked queue children */
2044 EXTERN int      MaxRunnersPerQueue;     /* max # proc's active in queue group */
2045 EXTERN int      NiceQueueRun;   /* nice queue runs to this value */
2046 EXTERN int      NumQueue;       /* number of queue groups */
2047 EXTERN int      QueueFileMode;  /* mode on files in mail queue */
2048 EXTERN int      QueueMode;      /* which queue items to act upon */
2049 EXTERN int      QueueSortOrder; /* queue sorting order algorithm */
2050 EXTERN time_t   MinQueueAge;    /* min delivery interval */
2051 #if _FFR_EXPDELAY
2052 EXTERN time_t   MaxQueueAge;    /* max delivery interval */
2053 #endif /* _FFR_EXPDELAY */
2054 EXTERN time_t   QueueIntvl;     /* intervals between running the queue */
2055 EXTERN char     *QueueDir;      /* location of queue directory */
2056 EXTERN QUEUE_CHAR       *QueueLimitId;          /* limit queue run to id */
2057 EXTERN QUEUE_CHAR       *QueueLimitQuarantine;  /* limit queue run to quarantine reason */
2058 EXTERN QUEUE_CHAR       *QueueLimitRecipient;   /* limit queue run to rcpt */
2059 EXTERN QUEUE_CHAR       *QueueLimitSender;      /* limit queue run to sender */
2060 EXTERN QUEUEGRP *Queue[MAXQUEUEGROUPS + 1];     /* queue groups */
2061
2062 /* functions */
2063 extern void     assign_queueid __P((ENVELOPE *));
2064 extern ADDRESS  *copyqueue __P((ADDRESS *, SM_RPOOL_T *));
2065 extern void     cleanup_queues __P((void));
2066 extern bool     doqueuerun __P((void));
2067 extern void     initsys __P((ENVELOPE *));
2068 extern void     loseqfile __P((ENVELOPE *, char *));
2069 extern int      name2qid __P((char *));
2070 extern char     *qid_printname __P((ENVELOPE *));
2071 extern char     *qid_printqueue __P((int, int));
2072 extern void     quarantine_queue __P((char *, int));
2073 extern char     *queuename __P((ENVELOPE *, int));
2074 extern void     queueup __P((ENVELOPE *, bool, bool));
2075 extern bool     runqueue __P((bool, bool, bool, bool));
2076 extern bool     run_work_group __P((int, int));
2077 extern void     set_def_queueval __P((QUEUEGRP *, bool));
2078 extern void     setup_queues __P((bool));
2079 extern bool     setnewqueue __P((ENVELOPE *));
2080 extern bool     shouldqueue __P((long, time_t));
2081 extern void     sync_queue_time __P((void));
2082 extern void     init_qid_alg __P((void));
2083 extern int      print_single_queue __P((int, int));
2084 #if REQUIRES_DIR_FSYNC
2085 # define SYNC_DIR(path, panic) sync_dir(path, panic)
2086 extern void     sync_dir __P((char *, bool));
2087 #else /* REQUIRES_DIR_FSYNC */
2088 # define SYNC_DIR(path, panic) ((void) 0)
2089 #endif /* REQUIRES_DIR_FSYNC */
2090
2091 /*
2092 **  Timeouts
2093 **
2094 **      Indicated values are the MINIMUM per RFC 1123 section 5.3.2.
2095 */
2096
2097 EXTERN struct
2098 {
2099                         /* RFC 1123-specified timeouts [minimum value] */
2100         time_t  to_initial;     /* initial greeting timeout [5m] */
2101         time_t  to_mail;        /* MAIL command [5m] */
2102         time_t  to_rcpt;        /* RCPT command [5m] */
2103         time_t  to_datainit;    /* DATA initiation [2m] */
2104         time_t  to_datablock;   /* DATA block [3m] */
2105         time_t  to_datafinal;   /* DATA completion [10m] */
2106         time_t  to_nextcommand; /* next command [5m] */
2107                         /* following timeouts are not mentioned in RFC 1123 */
2108         time_t  to_iconnect;    /* initial connection timeout (first try) */
2109         time_t  to_connect;     /* initial connection timeout (later tries) */
2110         time_t  to_aconnect;    /* all connections timeout (MX and A records) */
2111         time_t  to_rset;        /* RSET command */
2112         time_t  to_helo;        /* HELO command */
2113         time_t  to_quit;        /* QUIT command */
2114         time_t  to_miscshort;   /* misc short commands (NOOP, VERB, etc) */
2115         time_t  to_ident;       /* IDENT protocol requests */
2116         time_t  to_fileopen;    /* opening :include: and .forward files */
2117         time_t  to_control;     /* process a control socket command */
2118         time_t  to_lhlo;        /* LMTP: LHLO command */
2119 #if SASL
2120         time_t  to_auth;        /* AUTH dialogue [10m] */
2121 #endif /* SASL */
2122 #if STARTTLS
2123         time_t  to_starttls;    /* STARTTLS dialogue [10m] */
2124 #endif /* STARTTLS */
2125                         /* following are per message */
2126         time_t  to_q_return[MAXTOCLASS];        /* queue return timeouts */
2127         time_t  to_q_warning[MAXTOCLASS];       /* queue warning timeouts */
2128         time_t  res_retrans[MAXRESTOTYPES];     /* resolver retransmit */
2129         int     res_retry[MAXRESTOTYPES];       /* resolver retry */
2130 } TimeOuts;
2131
2132 /* timeout classes for return and warning timeouts */
2133 #define TOC_NORMAL      0       /* normal delivery */
2134 #define TOC_URGENT      1       /* urgent delivery */
2135 #define TOC_NONURGENT   2       /* non-urgent delivery */
2136 #define TOC_DSN         3       /* DSN delivery */
2137
2138 /* resolver timeout specifiers */
2139 #define RES_TO_FIRST    0       /* first attempt */
2140 #define RES_TO_NORMAL   1       /* subsequent attempts */
2141 #define RES_TO_DEFAULT  2       /* default value */
2142
2143 /* functions */
2144 extern void     inittimeouts __P((char *, bool));
2145
2146 /*
2147 **  Interface probing
2148 */
2149
2150 #define DPI_PROBENONE           0       /* Don't probe any interfaces */
2151 #define DPI_PROBEALL            1       /* Probe all interfaces */
2152 #define DPI_SKIPLOOPBACK        2       /* Don't probe loopback interfaces */
2153
2154 /*
2155 **  Trace information
2156 */
2157
2158 /* macros for debugging flags */
2159 #if NOT_SENDMAIL
2160 # define tTd(flag, level)       (tTdvect[flag] >= (unsigned char)level)
2161 #else
2162 # define tTd(flag, level)       (tTdvect[flag] >= (unsigned char)level && !IntSig)
2163 #endif
2164 #define tTdlevel(flag)          (tTdvect[flag])
2165
2166 /* variables */
2167 extern unsigned char    tTdvect[100];   /* trace vector */
2168
2169 /*
2170 **  Miscellaneous information.
2171 */
2172
2173 /*
2174 **  The "no queue id" queue id for sm_syslog
2175 */
2176
2177 #define NOQID           ""
2178
2179 #define CURHOSTNAME     (CurHostName == NULL ? "local" : CurHostName)
2180
2181 /*
2182 **  Some in-line functions
2183 */
2184
2185 /* set exit status */
2186 #define setstat(s)      \
2187         do              \
2188         {               \
2189                 if (ExitStat == EX_OK || ExitStat == EX_TEMPFAIL) \
2190                         ExitStat = s; \
2191         } while (0)
2192
2193
2194 #define STRUCTCOPY(s, d)        d = s
2195
2196 /* free a pointer if it isn't NULL and set it to NULL */
2197 #define SM_FREE_CLR(p)  \
2198         do              \
2199         {               \
2200                 if ((p) != NULL) \
2201                 { \
2202                         sm_free(p); \
2203                         (p) = NULL; \
2204                 } \
2205         } while (0)
2206
2207 /*
2208 **  Update a permanent string variable with a new value.
2209 **  The old value is freed, the new value is strdup'ed.
2210 **
2211 **  We use sm_pstrdup_x to duplicate the string because it raises
2212 **  an exception on error, and because it allocates "permanent storage"
2213 **  which is not expected to be freed before process exit.
2214 **  The latter is important for memory leak analysis.
2215 **
2216 **  If an exception occurs while strdup'ing the new value,
2217 **  then the variable remains set to the old value.
2218 **  That's why the strdup must occur before we free the old value.
2219 **
2220 **  The macro uses a do loop so that this idiom will work:
2221 **      if (...)
2222 **              PSTRSET(var, val1);
2223 **      else
2224 **              PSTRSET(var, val2);
2225 */
2226 #define PSTRSET(var, val) \
2227         do \
2228         { \
2229                 char *_newval = sm_pstrdup_x(val); \
2230                 if (var != NULL) \
2231                         sm_free(var); \
2232                 var = _newval; \
2233         } while (0)
2234
2235 #define _CHECK_RESTART \
2236         do \
2237         { \
2238                 if (ShutdownRequest != NULL) \
2239                         shutdown_daemon(); \
2240                 else if (RestartRequest != NULL) \
2241                         restart_daemon(); \
2242                 else if (RestartWorkGroup) \
2243                         restart_marked_work_groups(); \
2244         } while (0)
2245
2246 # define CHECK_RESTART _CHECK_RESTART
2247
2248 #define CHK_CUR_RUNNERS(fct, idx, count)        \
2249         do      \
2250         {       \
2251                 if (CurRunners < 0)     \
2252                 {       \
2253                         if (LogLevel > 3)       \
2254                                 sm_syslog(LOG_ERR, NOQID,       \
2255                                         "%s: CurRunners=%d, i=%d, count=%d, status=should not happen",  \
2256                                         fct, CurRunners, idx, count);   \
2257                         CurRunners = 0; \
2258                 }       \
2259         } while (0)
2260
2261 /* reply types (text in SmtpMsgBuffer) */
2262 #define XS_DEFAULT      0
2263 #define XS_STARTTLS     1
2264 #define XS_AUTH         2
2265 #define XS_GREET        3
2266 #define XS_EHLO         4
2267 #define XS_MAIL         5
2268 #define XS_RCPT         6
2269 #define XS_DATA         7
2270 #define XS_EOM          8
2271 #define XS_DATA2        9
2272 #define XS_RCPT2        10
2273 #define XS_QUIT         15
2274
2275 /*
2276 **  Global variables.
2277 */
2278
2279 #if _FFR_ADDR_TYPE_MODES
2280 EXTERN bool     AddrTypeModes;  /* addr_type: extra "mode" information */
2281 #endif /* _FFR_ADDR_TYPE_MODES */
2282 EXTERN bool     AllowBogusHELO; /* allow syntax errors on HELO command */
2283 EXTERN bool     CheckAliases;   /* parse addresses during newaliases */
2284 #if _FFR_QUEUE_RUN_PARANOIA
2285 EXTERN int      CheckQueueRunners; /* check whether queue runners are OK */
2286 #endif /* _FFR_QUEUE_RUN_PARANOIA */
2287 EXTERN bool     ColonOkInAddr;  /* single colon legal in address */
2288 #if !defined(_USE_SUN_NSSWITCH_) && !defined(_USE_DEC_SVC_CONF_)
2289 EXTERN bool     ConfigFileRead; /* configuration file has been read */
2290 #endif /* !defined(_USE_SUN_NSSWITCH_) && !defined(_USE_DEC_SVC_CONF_) */
2291 EXTERN bool     DisConnected;   /* running with OutChannel redirect to transcript file */
2292 EXTERN bool     DontExpandCnames;       /* do not $[...$] expand CNAMEs */
2293 EXTERN bool     DontInitGroups; /* avoid initgroups() because of NIS cost */
2294 EXTERN bool     DontLockReadFiles;      /* don't read lock support files */
2295 EXTERN bool     DontPruneRoutes;        /* don't prune source routes */
2296 EXTERN bool     ForkQueueRuns;  /* fork for each job when running the queue */
2297 EXTERN bool     FromFlag;       /* if set, "From" person is explicit */
2298 EXTERN bool     FipsMode;
2299 EXTERN bool     GrabTo;         /* if set, get recipients from msg */
2300 EXTERN bool     EightBitAddrOK; /* we'll let 8-bit addresses through */
2301 EXTERN bool     HasEightBits;   /* has at least one eight bit input byte */
2302 EXTERN bool     HasWildcardMX;  /* don't use MX records when canonifying */
2303 EXTERN bool     HoldErrs;       /* only output errors to transcript */
2304 EXTERN bool     IgnoreHostStatus;       /* ignore long term host status files */
2305 EXTERN bool     IgnrDot;        /* don't let dot end messages */
2306 EXTERN bool     LogUsrErrs;     /* syslog user errors (e.g., SMTP RCPT cmd) */
2307 EXTERN bool     MatchGecos;     /* look for user names in gecos field */
2308 EXTERN bool     MeToo;          /* send to the sender also */
2309 EXTERN bool     NoAlias;        /* suppress aliasing */
2310 EXTERN bool     NoConnect;      /* don't connect to non-local mailers */
2311 EXTERN bool     OnlyOneError;   /*  .... or only want to give one SMTP reply */
2312 EXTERN bool     QuickAbort;     /*  .... but only if we want a quick abort */
2313 #if _FFR_REJECT_NUL_BYTE
2314 EXTERN bool     RejectNUL;      /* reject NUL input byte? */
2315 #endif /* _FFR_REJECT_NUL_BYTE */
2316 #if REQUIRES_DIR_FSYNC
2317 EXTERN bool     RequiresDirfsync;       /* requires fsync() for directory */
2318 #endif /* REQUIRES_DIR_FSYNC */
2319 EXTERN bool     volatile RestartWorkGroup; /* daemon needs to restart some work groups */
2320 EXTERN bool     RrtImpliesDsn;  /* turn Return-Receipt-To: into DSN */
2321 EXTERN bool     SaveFrom;       /* save leading "From" lines */
2322 EXTERN bool     SendMIMEErrors; /* send error messages in MIME format */
2323 EXTERN bool     SevenBitInput;  /* force 7-bit data on input */
2324 EXTERN bool     SingleLineFromHeader;   /* force From: header to be one line */
2325 EXTERN bool     SingleThreadDelivery;   /* single thread hosts on delivery */
2326 EXTERN bool     SoftBounce;     /* replace 5xy by 4xy (for testing) */
2327 EXTERN bool     volatile StopRequest;   /* stop sending output */
2328 EXTERN bool     SuprErrs;       /* set if we are suppressing errors */
2329 EXTERN bool     TryNullMXList;  /* if we are the best MX, try host directly */
2330 EXTERN bool     UseMSP;         /* mail submission: group writable queue ok? */
2331 EXTERN bool     WorkAroundBrokenAAAA;   /* some nameservers return SERVFAIL on AAAA queries */
2332 EXTERN bool     UseErrorsTo;    /* use Errors-To: header (back compat) */
2333 EXTERN bool     UseNameServer;  /* using DNS -- interpret h_errno & MX RRs */
2334 EXTERN char     InetMode;               /* default network for daemon mode */
2335 EXTERN char     OpMode;         /* operation mode, see below */
2336 EXTERN char     SpaceSub;       /* substitution for <lwsp> */
2337 #if _FFR_BADRCPT_SHUTDOWN
2338 EXTERN int      BadRcptShutdown; /* Shutdown connection for rejected RCPTs */
2339 EXTERN int      BadRcptShutdownGood; /* above even when there are good RCPTs */
2340 #endif /* _FFR_BADRCPT_SHUTDOWN */
2341 EXTERN int      BadRcptThrottle; /* Throttle rejected RCPTs per SMTP message */
2342 #if _FFR_RCPTTHROTDELAY
2343 EXTERN unsigned int BadRcptThrottleDelay; /* delay for BadRcptThrottle */
2344 #else
2345 # define BadRcptThrottleDelay   1
2346 #endif /* _FFR_RCPTTHROTDELAY */
2347 EXTERN int      CheckpointInterval;     /* queue file checkpoint interval */
2348 EXTERN int      ConfigLevel;    /* config file level */
2349 EXTERN int      ConnRateThrottle;       /* throttle for SMTP connection rate */
2350 EXTERN int      volatile CurChildren;   /* current number of daemonic children */
2351 EXTERN int      CurrentLA;      /* current load average */
2352 EXTERN int      DefaultNotify;  /* default DSN notification flags */
2353 EXTERN int      DelayLA;        /* load average to delay connections */
2354 EXTERN int      DontProbeInterfaces;    /* don't probe interfaces for names */
2355 EXTERN int      Errors;         /* set if errors (local to single pass) */
2356 EXTERN int      ExitStat;       /* exit status code */
2357 EXTERN int      FastSplit;      /* fast initial splitting of envelopes */
2358 EXTERN int      FileMode;       /* mode on files */
2359 EXTERN int      LineNumber;     /* line number in current input */
2360 EXTERN int      LogLevel;       /* level of logging to perform */
2361 EXTERN int      MaxAliasRecursion;      /* maximum depth of alias recursion */
2362 EXTERN int      MaxChildren;    /* maximum number of daemonic children */
2363 EXTERN int      MaxForwardEntries;      /* maximum number of forward entries */
2364 EXTERN int      MaxHeadersLength;       /* max length of headers */
2365 EXTERN int      MaxHopCount;    /* max # of hops until bounce */
2366 EXTERN int      MaxMacroRecursion;      /* maximum depth of macro recursion */
2367 EXTERN int      MaxMimeFieldLength;     /* maximum MIME field length */
2368 EXTERN int      MaxMimeHeaderLength;    /* maximum MIME header length */
2369 EXTERN int      MaxNOOPCommands; /* max "noise" commands before slowdown */
2370
2371 EXTERN int      MaxRcptPerMsg;  /* max recipients per SMTP message */
2372 EXTERN int      MaxRuleRecursion;       /* maximum depth of ruleset recursion */
2373 #if _FFR_MSG_ACCEPT
2374 EXTERN char     *MessageAccept; /* "Message accepted for delivery" reply text */
2375 #endif /* _FFR_MSG_ACCEPT */
2376
2377 EXTERN int      MimeMode;       /* MIME processing mode */
2378 EXTERN int      NoRecipientAction;
2379
2380 #if SM_CONF_SHM
2381 EXTERN int      Numfilesys;     /* number of queue file systems */
2382 EXTERN int      *PNumFileSys;
2383 # define NumFileSys     (*PNumFileSys)
2384 # else /* SM_CONF_SHM */
2385 EXTERN int      NumFileSys;     /* number of queue file systems */
2386 # endif /* SM_CONF_SHM */
2387
2388 EXTERN int      QueueLA;        /* load average starting forced queueing */
2389 EXTERN int      RefuseLA;       /* load average refusing connections */
2390 EXTERN time_t   RejectLogInterval;      /* time btwn log msgs while refusing */
2391 #if _FFR_MEMSTAT
2392 EXTERN long     QueueLowMem;    /* low memory starting forced queueing */
2393 EXTERN long     RefuseLowMem;   /* low memory refusing connections */
2394 EXTERN char     *MemoryResource;/* memory resource to look up */
2395 #endif /* _FFR_MEMSTAT */
2396 EXTERN int      SuperSafe;      /* be extra careful, even if expensive */
2397 EXTERN int      VendorCode;     /* vendor-specific operation enhancements */
2398 EXTERN int      Verbose;        /* set if blow-by-blow desired */
2399 EXTERN gid_t    DefGid;         /* default gid to run as */
2400 EXTERN gid_t    RealGid;        /* real gid of caller */
2401 EXTERN gid_t    RunAsGid;       /* GID to become for bulk of run */
2402 EXTERN gid_t    EffGid;         /* effective gid */
2403 #if SM_CONF_SHM
2404 EXTERN key_t    ShmKey;         /* shared memory key */
2405 EXTERN char     *ShmKeyFile;    /* shared memory key file */
2406 #endif /* SM_CONF_SHM */
2407 EXTERN pid_t    CurrentPid;     /* current process id */
2408 EXTERN pid_t    DaemonPid;      /* process id of daemon */
2409 EXTERN pid_t    PidFilePid;     /* daemon/queue runner who wrote pid file */
2410 EXTERN uid_t    DefUid;         /* default uid to run as */
2411 EXTERN uid_t    RealUid;        /* real uid of caller */
2412 EXTERN uid_t    RunAsUid;       /* UID to become for bulk of run */
2413 EXTERN uid_t    TrustedUid;     /* uid of trusted user for files and startup */
2414 EXTERN size_t   DataFileBufferSize;     /* size of buf for in-core data file */
2415 EXTERN time_t   DeliverByMin;   /* deliver by minimum time */
2416 EXTERN time_t   DialDelay;      /* delay between dial-on-demand tries */
2417 EXTERN time_t   SafeAlias;      /* interval to wait until @:@ in alias file */
2418 EXTERN time_t   ServiceCacheMaxAge;     /* refresh interval for cache */
2419 EXTERN size_t   XscriptFileBufferSize;  /* size of buf for in-core transcript file */
2420 EXTERN MODE_T   OldUmask;       /* umask when sendmail starts up */
2421 EXTERN long     MaxMessageSize; /* advertised max size we will accept */
2422 EXTERN long     MinBlocksFree;  /* min # of blocks free on queue fs */
2423 EXTERN long     QueueFactor;    /* slope of queue function */
2424 EXTERN long     WkClassFact;    /* multiplier for message class -> priority */
2425 EXTERN long     WkRecipFact;    /* multiplier for # of recipients -> priority */
2426 EXTERN long     WkTimeFact;     /* priority offset each time this job is run */
2427 EXTERN char     *ControlSocketName; /* control socket filename [control.c] */
2428 EXTERN char     *CurHostName;   /* current host we are dealing with */
2429 EXTERN char     *DeadLetterDrop;        /* path to dead letter office */
2430 EXTERN char     *DefUser;       /* default user to run as (from DefUid) */
2431 EXTERN char     *DefaultCharSet;        /* default character set for MIME */
2432 EXTERN char     *DoubleBounceAddr;      /* where to send double bounces */
2433 EXTERN char     *ErrMsgFile;    /* file to prepend to all error messages */
2434 EXTERN char     *FallbackMX;    /* fall back MX host */
2435 EXTERN char     *FallbackSmartHost;     /* fall back smart host */
2436 EXTERN char     *FileName;      /* name to print on error messages */
2437 EXTERN char     *ForwardPath;   /* path to search for .forward files */
2438 EXTERN char     *HeloName;      /* hostname to announce in HELO */
2439 EXTERN char     *HelpFile;      /* location of SMTP help file */
2440 EXTERN char     *HostStatDir;   /* location of host status information */
2441 EXTERN char     *HostsFile;     /* path to /etc/hosts file */
2442 extern char     *Mbdb;          /* mailbox database type */
2443 EXTERN char     *MustQuoteChars;        /* quote these characters in phrases */
2444 EXTERN char     *MyHostName;    /* name of this host for SMTP messages */
2445 EXTERN char     *OperatorChars; /* operators (old $o macro) */
2446 EXTERN char     *PidFile;       /* location of proc id file [conf.c] */
2447 EXTERN char     *PostMasterCopy;        /* address to get errs cc's */
2448 EXTERN char     *ProcTitlePrefix; /* process title prefix */
2449 EXTERN char     *RealHostName;  /* name of host we are talking to */
2450 EXTERN char     *RealUserName;  /* real user name of caller */
2451 EXTERN char     *volatile RestartRequest;/* a sendmail restart has been requested */
2452 EXTERN char     *RunAsUserName; /* user to become for bulk of run */
2453 EXTERN char     *SafeFileEnv;   /* chroot location for file delivery */
2454 EXTERN char     *ServiceSwitchFile;     /* backup service switch */
2455 EXTERN char     *volatile ShutdownRequest;/* a sendmail shutdown has been requested */
2456 EXTERN bool     volatile IntSig;
2457 EXTERN char     *SmtpGreeting;  /* SMTP greeting message (old $e macro) */
2458 EXTERN char     *SmtpPhase;     /* current phase in SMTP processing */
2459 EXTERN char     SmtpError[MAXLINE];     /* save failure error messages */
2460 EXTERN char     *StatFile;      /* location of statistics summary */
2461 EXTERN char     *TimeZoneSpec;  /* override time zone specification */
2462 EXTERN char     *UdbSpec;       /* user database source spec */
2463 EXTERN char     *UnixFromLine;  /* UNIX From_ line (old $l macro) */
2464 EXTERN char     **ExternalEnviron;      /* saved user (input) environment */
2465 EXTERN char     **SaveArgv;     /* argument vector for re-execing */
2466 EXTERN BITMAP256        DontBlameSendmail;      /* DontBlameSendmail bits */
2467 EXTERN SM_FILE_T        *InChannel;     /* input connection */
2468 EXTERN SM_FILE_T        *OutChannel;    /* output connection */
2469 EXTERN SM_FILE_T        *TrafficLogFile; /* file in which to log all traffic */
2470 #if HESIOD
2471 EXTERN void     *HesiodContext;
2472 #endif /* HESIOD */
2473 EXTERN ENVELOPE *CurEnv;        /* envelope currently being processed */
2474 EXTERN char     *RuleSetNames[MAXRWSETS];       /* ruleset number to name */
2475 EXTERN char     *UserEnviron[MAXUSERENVIRON + 1];
2476 EXTERN struct rewrite   *RewriteRules[MAXRWSETS];
2477 EXTERN struct termescape        TermEscape;     /* terminal escape codes */
2478 EXTERN SOCKADDR ConnectOnlyTo;  /* override connection address (for testing) */
2479 EXTERN SOCKADDR RealHostAddr;   /* address of host we are talking to */
2480 extern const SM_EXC_TYPE_T EtypeQuickAbort; /* type of a QuickAbort exception */
2481
2482
2483 EXTERN int ConnectionRateWindowSize;
2484 #if STARTTLS && USE_OPENSSL_ENGINE
2485 EXTERN bool     SSLEngineInitialized;
2486 #endif /* STARTTLS && USE_OPENSSL_ENGINE */
2487
2488 /*
2489 **  Declarations of useful functions
2490 */
2491
2492 /* Transcript file */
2493 extern void     closexscript __P((ENVELOPE *));
2494 extern void     openxscript __P((ENVELOPE *));
2495
2496 /* error related */
2497 extern void     buffer_errors __P((void));
2498 extern void     flush_errors __P((bool));
2499 extern void PRINTFLIKE(1, 2)    message __P((const char *, ...));
2500 extern void PRINTFLIKE(1, 2)    nmessage __P((const char *, ...));
2501 extern void PRINTFLIKE(1, 2)    syserr __P((const char *, ...));
2502 extern void PRINTFLIKE(2, 3)    usrerrenh __P((char *, const char *, ...));
2503 extern void PRINTFLIKE(1, 2)    usrerr __P((const char *, ...));
2504 extern int      isenhsc __P((const char *, int));
2505 extern int      extenhsc __P((const char *, int, char *));
2506
2507 /* alias file */
2508 extern void     alias __P((ADDRESS *, ADDRESS **, int, ENVELOPE *));
2509 extern bool     aliaswait __P((MAP *, char *, bool));
2510 extern void     forward __P((ADDRESS *, ADDRESS **, int, ENVELOPE *));
2511 extern void     readaliases __P((MAP *, SM_FILE_T *, bool, bool));
2512 extern bool     rebuildaliases __P((MAP *, bool));
2513 extern void     setalias __P((char *));
2514
2515 /* logging */
2516 extern void     logdelivery __P((MAILER *, MCI *, char *, const char *, ADDRESS *, time_t, ENVELOPE *));
2517 extern void     logsender __P((ENVELOPE *, char *));
2518 extern void PRINTFLIKE(3, 4) sm_syslog __P((int, const char *, const char *, ...));
2519
2520 /* SMTP */
2521 extern void     giveresponse __P((int, char *, MAILER *, MCI *, ADDRESS *, time_t, ENVELOPE *, ADDRESS *));
2522 extern int      reply __P((MAILER *, MCI *, ENVELOPE *, time_t, void (*)__P((char *, bool, MAILER *, MCI *, ENVELOPE *)), char **, int));
2523 extern void     smtp __P((char *volatile, BITMAP256, ENVELOPE *volatile));
2524 #if SASL
2525 extern int      smtpauth __P((MAILER *, MCI *, ENVELOPE *));
2526 #endif /* SASL */
2527 extern int      smtpdata __P((MAILER *, MCI *, ENVELOPE *, ADDRESS *, time_t));
2528 extern int      smtpgetstat __P((MAILER *, MCI *, ENVELOPE *));
2529 extern int      smtpmailfrom __P((MAILER *, MCI *, ENVELOPE *));
2530 extern void     smtpmessage __P((char *, MAILER *, MCI *, ...));
2531 extern void     smtpinit __P((MAILER *, MCI *, ENVELOPE *, bool));
2532 extern char     *smtptodsn __P((int));
2533 extern int      smtpprobe __P((MCI *));
2534 extern void     smtpquit __P((MAILER *, MCI *, ENVELOPE *));
2535 extern int      smtprcpt __P((ADDRESS *, MAILER *, MCI *, ENVELOPE *, ADDRESS *, time_t));
2536 extern void     smtprset __P((MAILER *, MCI *, ENVELOPE *));
2537
2538 #define REPLYTYPE(r)    ((r) / 100)             /* first digit of reply code */
2539 #define REPLYCLASS(r)   (((r) / 10) % 10)       /* second digit of reply code */
2540 #define REPLYMINOR(r)   ((r) % 10)      /* last digit of reply code */
2541 #define ISSMTPCODE(c)   (isascii(c[0]) && isdigit(c[0]) && \
2542                     isascii(c[1]) && isdigit(c[1]) && \
2543                     isascii(c[2]) && isdigit(c[2]))
2544 #define ISSMTPREPLY(c)  (ISSMTPCODE(c) && \
2545                     (c[3] == ' ' || c[3] == '-' || c[3] == '\0'))
2546
2547 /* delivery */
2548 extern pid_t    dowork __P((int, int, char *, bool, bool, ENVELOPE *));
2549 extern pid_t    doworklist __P((ENVELOPE *, bool, bool));
2550 extern int      endmailer __P((MCI *, ENVELOPE *, char **));
2551 extern int      mailfile __P((char *volatile, MAILER *volatile, ADDRESS *, volatile long, ENVELOPE *));
2552 extern void     sendall __P((ENVELOPE *, int));
2553
2554 /* stats */
2555 #define STATS_NORMAL            'n'
2556 #define STATS_QUARANTINE        'q'
2557 #define STATS_REJECT            'r'
2558 #define STATS_CONNECT           'c'
2559
2560 extern void     markstats __P((ENVELOPE *, ADDRESS *, int));
2561 extern void     clearstats __P((void));
2562 extern void     poststats __P((char *));
2563
2564 /* control socket */
2565 extern void     closecontrolsocket  __P((bool));
2566 extern void     clrcontrol  __P((void));
2567 extern void     control_command __P((int, ENVELOPE *));
2568 extern int      opencontrolsocket __P((void));
2569
2570 #if MILTER
2571 /* milter functions */
2572 extern void     milter_config __P((char *, struct milter **, int));
2573 extern void     milter_setup __P((char *));
2574 extern void     milter_set_option __P((char *, char *, bool));
2575 extern bool     milter_init __P((ENVELOPE *, char *, milters_T *));
2576 extern void     milter_quit __P((ENVELOPE *));
2577 extern void     milter_abort __P((ENVELOPE *));
2578 extern char     *milter_connect __P((char *, SOCKADDR, ENVELOPE *, char *));
2579 extern char     *milter_helo __P((char *, ENVELOPE *, char *));
2580 extern char     *milter_envfrom __P((char **, ENVELOPE *, char *));
2581 extern char     *milter_data_cmd __P((ENVELOPE *, char *));
2582 extern char     *milter_envrcpt __P((char **, ENVELOPE *, char *, bool));
2583 extern char     *milter_data __P((ENVELOPE *, char *));
2584 extern char     *milter_unknown __P((char *, ENVELOPE *, char *));
2585 #endif /* MILTER */
2586
2587 extern char     *addquotes __P((char *, SM_RPOOL_T *));
2588 extern char     *arpadate __P((char *));
2589 extern bool     atobool __P((char *));
2590 extern int      atooct __P((char *));
2591 extern void     auth_warning __P((ENVELOPE *, const char *, ...));
2592 extern int      blocksignal __P((int));
2593 extern bool     bitintersect __P((BITMAP256, BITMAP256));
2594 extern bool     bitzerop __P((BITMAP256));
2595 extern int      check_bodytype __P((char *));
2596 extern void     buildfname __P((char *, char *, char *, int));
2597 extern bool     chkclientmodifiers __P((int));
2598 extern bool     chkdaemonmodifiers __P((int));
2599 extern int      checkcompat __P((ADDRESS *, ENVELOPE *));
2600 #ifdef XDEBUG
2601 extern void     checkfd012 __P((char *));
2602 extern void     checkfdopen __P((int, char *));
2603 #endif /* XDEBUG */
2604 extern void     checkfds __P((char *));
2605 extern bool     chownsafe __P((int, bool));
2606 extern void     cleanstrcpy __P((char *, char *, int));
2607 #if SM_CONF_SHM
2608 extern void     cleanup_shm __P((bool));
2609 #endif /* SM_CONF_SHM */
2610 extern void     close_sendmail_pid __P((void));
2611 extern void     clrdaemon __P((void));
2612 extern void     collect __P((SM_FILE_T *, bool, HDR **, ENVELOPE *, bool));
2613 extern bool     connection_rate_check __P((SOCKADDR *, ENVELOPE *));
2614 extern time_t   convtime __P((char *, int));
2615 extern char     **copyplist __P((char **, bool, SM_RPOOL_T *));
2616 extern void     copy_class __P((int, int));
2617 extern int      count_open_connections __P((SOCKADDR *));
2618 extern time_t   curtime __P((void));
2619 extern char     *defcharset __P((ENVELOPE *));
2620 extern char     *denlstring __P((char *, bool, bool));
2621 extern void     dferror __P((SM_FILE_T *volatile, char *, ENVELOPE *));
2622 extern void     disconnect __P((int, ENVELOPE *));
2623 extern void     disk_status __P((SM_FILE_T *, char *));
2624 extern bool     dns_getcanonname __P((char *, int, bool, int *, int *));
2625 extern pid_t    dofork __P((void));
2626 extern int      drop_privileges __P((bool));
2627 extern int      dsntoexitstat __P((char *));
2628 extern void     dumpfd __P((int, bool, bool));
2629 #if SM_HEAP_CHECK
2630 extern void     dumpstab __P((void));
2631 #endif /* SM_HEAP_CHECK */
2632 extern void     dumpstate __P((char *));
2633 extern bool     enoughdiskspace __P((long, ENVELOPE *));
2634 extern char     *exitstat __P((char *));
2635 extern void     fatal_error __P((SM_EXC_T *));
2636 extern char     *fgetfolded __P((char *, int *, SM_FILE_T *));
2637 extern void     fill_fd __P((int, char *));
2638 extern char     *find_character __P((char *, int));
2639 extern int      finduser __P((char *, bool *, SM_MBDB_T *));
2640 extern void     finis __P((bool, bool, volatile int));
2641 extern void     fixcrlf __P((char *, bool));
2642 extern long     freediskspace __P((const char *, long *));
2643 #if NETINET6 && NEEDSGETIPNODE
2644 extern void     freehostent __P((struct hostent *));
2645 #endif /* NETINET6 && NEEDSGETIPNODE */
2646 extern char     *get_column __P((char *, int, int, char *, int));
2647 extern char     *getauthinfo __P((int, bool *));
2648 extern int      getdtsize __P((void));
2649 extern int      getla __P((void));
2650 extern char     *getmodifiers __P((char *, BITMAP256));
2651 extern BITMAP256        *getrequests __P((ENVELOPE *));
2652 extern char     *getvendor __P((int));
2653 extern void     help __P((char *, ENVELOPE *));
2654 extern void     init_md __P((int, char **));
2655 extern void     initdaemon __P((void));
2656 extern void     inithostmaps __P((void));
2657 extern void     initmacros __P((ENVELOPE *));
2658 extern void     initsetproctitle __P((int, char **, char **));
2659 extern void     init_vendor_macros __P((ENVELOPE *));
2660 extern SIGFUNC_DECL     intsig __P((int));
2661 extern bool     isatom __P((const char *));
2662 extern bool     isloopback __P((SOCKADDR sa));
2663 extern void     load_if_names __P((void));
2664 extern bool     lockfile __P((int, char *, char *, int));
2665 extern void     log_sendmail_pid __P((ENVELOPE *));
2666 extern void     logundelrcpts __P((ENVELOPE *, char *, int, bool));
2667 extern char     lower __P((int));
2668 extern void     makelower __P((char *));
2669 extern int      makeconnection_ds __P((char *, MCI *));
2670 extern int      makeconnection __P((char *, volatile unsigned int, MCI *, ENVELOPE *, time_t));
2671 extern void     makeworkgroups __P((void));
2672 extern void     markfailure __P((ENVELOPE *, ADDRESS *, MCI *, int, bool));
2673 extern void     mark_work_group_restart __P((int, int));
2674 extern MCI      *mci_new __P((SM_RPOOL_T *));
2675 extern char     *munchstring __P((char *, char **, int));
2676 extern struct hostent   *myhostname __P((char *, int));
2677 extern char     *newstr __P((const char *));
2678 #if NISPLUS
2679 extern char     *nisplus_default_domain __P((void));    /* extern for Sun */
2680 #endif /* NISPLUS */
2681 extern bool     path_is_dir __P((char *, bool));
2682 extern int      pickqdir __P((QUEUEGRP *qg, long fsize, ENVELOPE *e));
2683 extern char     *pintvl __P((time_t, bool));
2684 extern void     printav __P((SM_FILE_T *, char **));
2685 extern void     printmailer __P((SM_FILE_T *, MAILER *));
2686 extern void     printnqe __P((SM_FILE_T *, char *));
2687 extern void     printopenfds __P((bool));
2688 extern void     printqueue __P((void));
2689 extern void     printrules __P((void));
2690 extern pid_t    prog_open __P((char **, int *, ENVELOPE *));
2691 extern bool     putline __P((char *, MCI *));
2692 extern bool     putxline __P((char *, size_t, MCI *, int));
2693 extern void     queueup_macros __P((int, SM_FILE_T *, ENVELOPE *));
2694 extern void     readcf __P((char *, bool, ENVELOPE *));
2695 extern SIGFUNC_DECL     reapchild __P((int));
2696 extern int      releasesignal __P((int));
2697 extern void     resetlimits __P((void));
2698 extern void     restart_daemon __P((void));
2699 extern void     restart_marked_work_groups __P((void));
2700 extern bool     rfc822_string __P((char *));
2701 extern void     rmexpstab __P((void));
2702 extern bool     savemail __P((ENVELOPE *, bool));
2703 extern void     seed_random __P((void));
2704 extern void     sendtoargv __P((char **, ENVELOPE *));
2705 extern void     setclientoptions __P((char *));
2706 extern bool     setdaemonoptions __P((char *));
2707 extern void     setdefaults __P((ENVELOPE *));
2708 extern void     setdefuser __P((void));
2709 extern bool     setvendor __P((char *));
2710 extern void     set_op_mode __P((int));
2711 extern void     setoption __P((int, char *, bool, bool, ENVELOPE *));
2712 extern sigfunc_t        setsignal __P((int, sigfunc_t));
2713 extern void     sm_setuserenv __P((const char *, const char *));
2714 extern void     settime __P((ENVELOPE *));
2715 #if STARTTLS
2716 extern void     set_tls_rd_tmo __P((int));
2717 #else /* STARTTLS */
2718 #define set_tls_rd_tmo(rd_tmo)
2719 #endif /* STARTTLS */
2720 extern char     *sfgets __P((char *, int, SM_FILE_T *, time_t, char *));
2721 extern char     *shortenstring __P((const char *, size_t));
2722 extern char     *shorten_hostname __P((char []));
2723 extern bool     shorten_rfc822_string __P((char *, size_t));
2724 extern void     shutdown_daemon __P((void));
2725 extern void     sm_closefrom __P((int lowest, int highest));
2726 extern void     sm_close_on_exec __P((int lowest, int highest));
2727 extern struct hostent   *sm_gethostbyname __P((char *, int));
2728 extern struct hostent   *sm_gethostbyaddr __P((char *, int, int));
2729 extern void     sm_getla __P((void));
2730 extern struct passwd    *sm_getpwnam __P((char *));
2731 extern struct passwd    *sm_getpwuid __P((UID_T));
2732 extern void     sm_setproctitle __P((bool, ENVELOPE *, const char *, ...));
2733 extern pid_t    sm_wait __P((int *));
2734 extern bool     split_by_recipient __P((ENVELOPE *e));
2735 extern void     stop_sendmail __P((void));
2736 extern void     stripbackslash __P((char *));
2737 extern bool     strreplnonprt __P((char *, int));
2738 extern bool     strcontainedin __P((bool, char *, char *));
2739 extern int      switch_map_find __P((char *, char *[], short []));
2740 #if STARTTLS
2741 extern void     tls_set_verify __P((SSL_CTX *, SSL *, bool));
2742 #endif /* STARTTLS */
2743 extern bool     transienterror __P((int));
2744 extern void     truncate_at_delim __P((char *, size_t, int));
2745 extern void     tTflag __P((char *));
2746 extern void     tTsetup __P((unsigned char *, unsigned int, char *));
2747 extern SIGFUNC_DECL     tick __P((int));
2748 extern char     *ttypath __P((void));
2749 extern void     unlockqueue __P((ENVELOPE *));
2750 #if !HASUNSETENV
2751 extern void     unsetenv __P((char *));
2752 #endif /* !HASUNSETENV */
2753
2754 /* update file system information: +/- some blocks */
2755 #if SM_CONF_SHM
2756 extern void     upd_qs __P((ENVELOPE *, int, int, char *));
2757 # define updfs(e, count, space, where) upd_qs(e, count, space, where)
2758 #else /* SM_CONF_SHM */
2759 # define updfs(e, count, space, where)
2760 # define upd_qs(e, count, space, where)
2761 #endif /* SM_CONF_SHM */
2762
2763 extern char     *username __P((void));
2764 extern bool     usershellok __P((char *, char *));
2765 extern void     vendor_post_defaults __P((ENVELOPE *));
2766 extern void     vendor_pre_defaults __P((ENVELOPE *));
2767 extern int      waitfor __P((pid_t));
2768 extern bool     writable __P((char *, ADDRESS *, long));
2769 #if SM_HEAP_CHECK
2770 # define xalloc(size)   xalloc_tagged(size, __FILE__, __LINE__)
2771 extern char *xalloc_tagged __P((int, char*, int));
2772 #else /* SM_HEAP_CHECK */
2773 extern char *xalloc __P((int));
2774 #endif /* SM_HEAP_CHECK */
2775 extern void     xputs __P((SM_FILE_T *, const char *));
2776 extern char     *xtextify __P((char *, char *));
2777 extern bool     xtextok __P((char *));
2778 extern int      xunlink __P((char *));
2779 extern char     *xuntextify __P((char *));
2780
2781
2782 #undef EXTERN
2783 #endif /* ! _SENDMAIL_H */