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