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