projects / unix-history / blob
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Don't pass EX_TEMPFAIL code out (since we have already taken responsibility
[unix-history] / usr / src / usr.sbin / sendmail / src / sendmail.h
/*
** SENDMAIL.H -- Global definitions for sendmail.
*/
# ifdef _DEFINE
# define EXTERN
# ifndef lint
static char SmailSccsId[] = "@(#)sendmail.h 3.117 %G%";
# endif lint
# else _DEFINE
# define EXTERN extern
# endif _DEFINE
# include <stdio.h>
# include <ctype.h>
# include <setjmp.h>
# include "conf.h"
# include "conf.h"
# include "useful.h"
# ifdef LOG
# include <syslog.h>
# endif LOG
/*
** Data structure for bit maps.
**
** Each bit in this map can be referenced by an ascii character.
** This is 128 possible bits, or 12 8-bit bytes.
*/
#define BITMAPBYTES 16 /* number of bytes in a bit map */
#define BYTEBITS 8 /* number of bits in a byte */
/* internal macros */
#define _BITWORD(bit) (bit / (BYTEBITS * sizeof (int)))
#define _BITBIT(bit) (1 << (bit % (BYTEBITS * sizeof (int))))
typedef int BITMAP[BITMAPBYTES / sizeof (int)];
/* test bit number N */
#define bitnset(bit, map) ((map)[_BITWORD(bit)] & _BITBIT(bit))
/* set bit number N */
#define setbitn(bit, map) (map)[_BITWORD(bit)] |= _BITBIT(bit)
/* clear bit number N */
#define clrbitn(bit, map) (map)[_BITWORD(bit)] &= ~_BITBIT(bit)
/* clear an entire bit map */
#define clrbitmap(map) bzero((char *) map, BITMAPBYTES)
\f/*
** Address structure.
** Addresses are stored internally in this structure.
**
** Each address is on two chains and in one tree.
** The q_next chain is used to link together addresses
** for one mailer (and is rooted in a mailer).
** The q_chain chain is used to maintain a list of
** addresses originating from one call to sendto, and
** is used primarily for printing messages.
** The q_alias, q_sibling, and q_child tree maintains
** a complete tree of the aliases. q_alias points to
** the parent -- obviously, there can be several, and
** so this points to "one" of them. Ditto for q_sibling.
*/
struct address
{
char *q_paddr; /* the printname for the address */
char *q_user; /* user name */
char *q_host; /* host name */
struct mailer *q_mailer; /* mailer to use */
u_short q_flags; /* status flags, see below */
short q_uid; /* user-id of receiver (if known) */
short q_gid; /* group-id of receiver (if known) */
char *q_home; /* home dir (local mailer only) */
char *q_fullname; /* full name if known */
char *q_fullname; /* full name of this person */
time_t q_timeout; /* timeout for this address */
struct address *q_next; /* chain */
struct address *q_alias; /* parent in alias tree */
struct address *q_sibling; /* sibling in alias tree */
struct address *q_child; /* child in alias tree */
};
typedef struct address ADDRESS;
# define QDONTSEND 000001 /* don't send to this address */
# define QBADADDR 000002 /* this address is verified bad */
# define QGOODUID 000004 /* the q_uid q_gid fields are good */
# define QPRIMARY 000010 /* set from argv */
# define QQUEUEUP 000020 /* queue for later transmission */
# define QPSEUDO 000040 /* only on the list for verification */
\f/*
** Mailer definition structure.
** Every mailer known to the system is declared in this
** structure. It defines the pathname of the mailer, some
** flags associated with it, and the argument vector to
** pass to it. The flags are defined in conf.c
**
** The argument vector is expanded before actual use. All
** words except the first are passed through the macro
** processor.
*/
struct mailer
{
char *m_name; /* symbolic name of this mailer */
char *m_mailer; /* pathname of the mailer to use */
BITMAP m_flags; /* status flags, see below */
short m_mno; /* mailer number internally */
char **m_argv; /* template argument vector */
short m_s_rwset; /* rewriting set for sender addresses */
short m_r_rwset; /* rewriting set for recipient addresses */
char *m_eol; /* end of line string */
long m_maxsize; /* size limit on message to this mailer */
};
typedef struct mailer MAILER;
/* bits for m_flags */
# define M_FOPT 'f' /* mailer takes picky -f flag */
# define M_ROPT 'r' /* mailer takes picky -r flag */
# define M_RESTR 'S' /* must be daemon to execute */
# define M_NHDR 'n' /* don't insert From line */
# define M_LOCAL 'l' /* delivery is to this host */
# define M_STRIPQ 's' /* strip quote chars from user/host */
# define M_MUSER 'm' /* can handle multiple users at once */
# define M_CANONICAL 'C' /* make addresses canonical "u@dom" */
# define M_USR_UPPER 'u' /* preserve user case distinction */
# define M_HST_UPPER 'h' /* preserve host case distinction */
# define M_UGLYUUCP 'U' /* this wants an ugly UUCP from line */
# define M_EXPENSIVE 'e' /* it costs to use this mailer.... */
# define M_LIMITS 'L' /* must enforce SMTP line limits */
# define M_INTERNAL 'I' /* SMTP to another sendmail site */
# define M_FROMPATH 'p' /* use reverse-path in MAIL FROM: */
# define M_XDOT 'X' /* use hidden-dot algorithm */
EXTERN MAILER *Mailer[MAXMAILERS+1];
EXTERN MAILER *LocalMailer; /* ptr to local mailer */
EXTERN MAILER *ProgMailer; /* ptr to program mailer */
\f/*
** Header structure.
** This structure is used internally to store header items.
*/
struct header
{
char *h_field; /* the name of the field */
char *h_value; /* the value of that field */
struct header *h_link; /* the next header */
u_short h_flags; /* status bits, see below */
BITMAP h_mflags; /* m_flags bits needed */
};
typedef struct header HDR;
/*
** Header information structure.
** Defined in conf.c, this struct declares the header fields
** that have some magic meaning.
*/
struct hdrinfo
{
char *hi_field; /* the name of the field */
u_short hi_flags; /* status bits, see below */
};
extern struct hdrinfo HdrInfo[];
/* bits for h_flags and hi_flags */
# define H_EOH 00001 /* this field terminates header */
# define H_RCPT 00002 /* contains recipient addresses */
# define H_DEFAULT 00004 /* if another value is found, drop this */
# define H_RESENT 00010 /* this address is a "Resent-..." address */
# define H_CHECK 00020 /* check h_mflags against m_flags */
# define H_ACHECK 00040 /* ditto, but always (not just default) */
# define H_FORCE 00100 /* force this field, even if default */
# define H_TRACE 00200 /* this field contains trace information */
# define H_FROM 00400 /* this is a from-type field */
\f/*
** Envelope structure.
** This structure defines the message itself. There is usually
** only one of these -- for the message that we originally read
** and which is our primary interest -- but other envelopes can
** be generated during processing. For example, error messages
** will have their own envelope.
*/
struct envelope
{
HDR *e_header; /* head of header list */
long e_msgpriority; /* adjusted priority of this message */
time_t e_ctime; /* time message appeared in the queue */
char *e_to; /* the target person */
char *e_receiptto; /* return receipt address */
ADDRESS e_from; /* the person it is from */
char **e_fromdomain; /* the domain part of the sender */
ADDRESS *e_returnto; /* place to return the message to */
ADDRESS *e_sendqueue; /* list of message recipients */
ADDRESS *e_errorqueue; /* the queue for error responses */
long e_msgsize; /* size of the message in bytes */
short e_class; /* msg class (priority, junk, etc.) */
short e_flags; /* flags, see below */
short e_hopcount; /* number of times processed */
int (*e_puthdr)(); /* function to put header of message */
int (*e_putbody)(); /* function to put body of message */
struct envelope *e_parent; /* the message this one encloses */
struct envelope *e_sibling; /* the next envelope of interest */
char *e_df; /* location of temp file */
FILE *e_dfp; /* temporary file */
char *e_id; /* code for this entry in queue */
FILE *e_xfp; /* transcript file */
char *e_message; /* error message */
char *e_macro[128]; /* macro definitions */
};
typedef struct envelope ENVELOPE;
/* values for e_flags */
#define EF_OLDSTYLE 000001 /* use spaces (not commas) in hdrs */
#define EF_INQUEUE 000002 /* this message is fully queued */
#define EF_TIMEOUT 000004 /* this message is too old */
#define EF_CLRQUEUE 000010 /* disk copy is no longer needed */
#define EF_SENDRECEIPT 000020 /* send a return receipt */
#define EF_FATALERRS 000040 /* fatal errors occured */
#define EF_KEEPQUEUE 000100 /* keep queue files always */
#define EF_RESPONSE 000200 /* this is an error or return receipt */
#define EF_RESENT 000400 /* this message is being forwarded */
EXTERN ENVELOPE *CurEnv; /* envelope currently being processed */
\f/*
** Message priorities.
** Priorities > 0 should be preemptive.
**
** CurEnv->e_msgpriority is the number of bytes in the message adjusted
** by the message priority and the amount of time the message
** has been sitting around. Each priority point is worth
** WKPRIFACT bytes of message, and each time we reprocess a
** message the size gets reduced by WKTIMEFACT.
**
** The "class" is this number, unadjusted by the age or size of
** this message. Classes with negative representations will have
** error messages thrown away if they are not local.
*/
struct priority
{
char *pri_name; /* external name of priority */
int pri_val; /* internal value for same */
};
EXTERN struct priority Priorities[MAXPRIORITIES];
EXTERN int NumPriorities; /* pointer into Priorities */
# define WKPRIFACT 1800 /* bytes each pri point is worth */
# define WKTIMEFACT 400 /* bytes each time unit is worth */
\f/*
** Rewrite rules.
*/
struct rewrite
{
char **r_lhs; /* pattern match */
char **r_rhs; /* substitution value */
struct rewrite *r_next;/* next in chain */
};
EXTERN struct rewrite *RewriteRules[MAXRWSETS];
/*
** Special characters in rewriting rules.
** These are used internally only.
** The COND* rules are actually used in macros rather than in
** rewriting rules, but are given here because they
** cannot conflict.
*/
/* left hand side items */
# define MATCHZANY '\020' /* match zero or more tokens */
# define MATCHANY '\021' /* match one or more tokens */
# define MATCHONE '\022' /* match exactly one token */
# define MATCHCLASS '\023' /* match one token in a class */
# define MATCHNCLASS '\034' /* match anything not in class */
# define MATCHREPL '\024' /* replacement on RHS for above */
/* right hand side items */
# define CANONNET '\025' /* canonical net, next token */
# define CANONHOST '\026' /* canonical host, next token */
# define CANONUSER '\027' /* canonical user, next N tokens */
# define CALLSUBR '\030' /* call another rewriting set */
/* conditionals in macros */
# define CONDIF '\031' /* conditional if-then */
# define CONDELSE '\032' /* conditional else */
# define CONDFI '\033' /* conditional fi */
\f/*
** Symbol table definitions
*/
struct symtab
{
char *s_name; /* name to be entered */
char s_type; /* general type (see below) */
struct symtab *s_next; /* pointer to next in chain */
union
{
BITMAP sv_class; /* bit-map of word classes */
ADDRESS *sv_addr; /* pointer to address header */
MAILER *sv_mailer; /* pointer to mailer */
char *sv_alias; /* alias */
} s_value;
};
typedef struct symtab STAB;
/* symbol types */
# define ST_UNDEF 0 /* undefined type */
# define ST_CLASS 1 /* class map */
# define ST_ADDRESS 2 /* an address in parsed format */
# define ST_MAILER 3 /* a mailer header */
# define ST_ALIAS 4 /* an alias */
# define s_class s_value.sv_class
# define s_address s_value.sv_addr
# define s_mailer s_value.sv_mailer
# define s_alias s_value.sv_alias
extern STAB *stab();
/* opcodes to stab */
# define ST_FIND 0 /* find entry */
# define ST_ENTER 1 /* enter if not there */
\f/*
** STRUCT EVENT -- event queue.
**
** Maintained in sorted order.
**
** We store the pid of the process that set this event to insure
** that when we fork we will not take events intended for the parent.
*/
struct event
{
time_t ev_time; /* time of the function call */
int (*ev_func)(); /* function to call */
int ev_arg; /* argument to ev_func */
int ev_pid; /* pid that set this event */
struct event *ev_link; /* link to next item */
};
typedef struct event EVENT;
EXTERN EVENT *EventQueue; /* head of event queue */
\f/*
** Operation, send, and error modes
**
** The operation mode describes the basic operation of sendmail.
** This can be set from the command line, and is "send mail" by
** default.
**
** The send mode tells how to send mail. It can be set in the
** configuration file. It's setting determines how quickly the
** mail will be delivered versus the load on your system. If the
** -v (verbose) flag is given, it will be forced to SM_DELIVER
** mode.
**
** The error mode tells how to return errors.
*/
EXTERN char OpMode; /* operation mode, see below */
#define MD_DELIVER 'm' /* be a mail sender */
#define MD_ARPAFTP 'a' /* old-style arpanet protocols */
#define MD_SMTP 's' /* run SMTP on standard input */
#define MD_DAEMON 'd' /* run as a daemon */
#define MD_VERIFY 'v' /* verify: don't collect or deliver */
#define MD_TEST 't' /* test mode: resolve addrs only */
#define MD_INITALIAS 'i' /* initialize alias database */
#define MD_PRINT 'p' /* print the queue */
#define MD_FREEZE 'z' /* freeze the configuration file */
EXTERN char SendMode; /* send mode, see below */
#define SM_DELIVER 'i' /* interactive delivery */
#define SM_QUICKD 'j' /* deliver w/o queueing */
#define SM_FORK 'b' /* deliver in background */
#define SM_QUEUE 'q' /* queue, don't deliver */
#define SM_VERIFY 'v' /* verify only (used internally) */
EXTERN char ErrorMode; /* error mode, see below */
#define EM_PRINT 'p' /* print errors */
#define EM_MAIL 'm' /* mail back errors */
#define EM_WRITE 'w' /* write back errors */
#define EM_BERKNET 'e' /* special berknet processing */
#define EM_QUIET 'q' /* don't print messages (stat only) */
\f/*
** Global variables.
*/
EXTERN bool FromFlag; /* if set, "From" person is explicit */
EXTERN bool NoAlias; /* if set, don't do any aliasing */
EXTERN bool ForceMail; /* if set, mail even if already got a copy */
EXTERN bool MeToo; /* send to the sender also */
EXTERN bool IgnrDot; /* don't let dot end messages */
EXTERN bool SaveFrom; /* save leading "From" lines */
EXTERN bool Verbose; /* set if blow-by-blow desired */
EXTERN bool GrabTo; /* if set, get recipients from msg */
EXTERN bool NoReturn; /* don't return letter to sender */
EXTERN bool SuprErrs; /* set if we are suppressing errors */
EXTERN bool QueueRun; /* currently running message from the queue */
EXTERN bool HoldErrs; /* only output errors to transcript */
EXTERN bool NoConnect; /* don't connect to non-local mailers */
EXTERN bool SuperSafe; /* be extra careful, even if expensive */
EXTERN bool SafeAlias; /* alias file must have "@:@" to be complete */
EXTERN bool AutoRebuild; /* auto-rebuild the alias database as needed */
EXTERN time_t TimeOut; /* time until timeout */
EXTERN FILE *InChannel; /* input connection */
EXTERN FILE *OutChannel; /* output connection */
EXTERN int RealUid; /* when Daemon, real uid of caller */
EXTERN int RealGid; /* when Daemon, real gid of caller */
EXTERN int DefUid; /* default uid to run as */
EXTERN int DefGid; /* default gid to run as */
EXTERN int OldUmask; /* umask when sendmail starts up */
EXTERN int Errors; /* set if errors (local to single pass) */
EXTERN int ExitStat; /* exit status code */
EXTERN int AliasLevel; /* depth of aliasing */
EXTERN int MotherPid; /* proc id of parent process */
EXTERN int LineNumber; /* line number in current input */
EXTERN int ReadTimeout; /* timeout on reads */
EXTERN int LogLevel; /* level of logging to perform */
EXTERN int FileMode; /* mode on files */
EXTERN time_t QueueIntvl; /* intervals between running the queue */
EXTERN char *HostName; /* name of this host for SMTP messages */
EXTERN char *AliasFile; /* location of alias file */
EXTERN char *HelpFile; /* location of SMTP help file */
EXTERN char *StatFile; /* location of statistics summary */
EXTERN char *QueueDir; /* location of queue directory */
EXTERN char *FileName; /* name to print on error messages */
EXTERN char *TrustedUsers[MAXTRUST+1]; /* list of trusted users */
EXTERN jmp_buf TopFrame; /* branch-to-top-of-loop-on-error frame */
EXTERN bool QuickAbort; /* .... but only if we want a quick abort */
extern char *ConfFile; /* location of configuration file [conf.c] */
extern char *FreezeFile; /* location of frozen memory image [conf.c] */
extern char Arpa_Info[]; /* the reply code for Arpanet info [conf.c] */
extern char SpaceSub; /* substitution for <lwsp> [conf.c] */
\f/*
** Trace information
*/
/* trace vector and macros for debugging flags */
EXTERN u_char tTdvect[100];
# define tTd(flag, level) (tTdvect[flag] >= level)
# define tTdlevel(flag) (tTdvect[flag])
\f/*
** Miscellaneous information.
*/
# include <sysexits.h>
/*
** Some in-line functions
*/
/* set exit status */
#define setstat(s) { \
if (ExitStat == EX_OK || ExitStat == EX_TEMPFAIL) \
ExitStat = s; \
}
/* make a copy of a string */
#define newstr(s) strcpy(xalloc(strlen(s) + 1), s)
/*
** Declarations of useful functions
*/
extern ADDRESS *parseaddr();
extern char *xalloc();
extern bool sameaddr();
extern FILE *dfopen();
extern EVENT *setevent();
extern char *sfgets();
extern char *queuename();
extern time_t curtime();
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.