1 /* 2 ** SENDMAIL.H -- Global definitions for sendmail. 3 */ 4 5 6 7 # ifdef _DEFINE 8 # define EXTERN 9 # ifndef lint 10 static char SmailSccsId[] = "@(#)sendmail.h 3.99 11/17/82"; 11 # endif lint 12 # else _DEFINE 13 # define EXTERN extern 14 # endif _DEFINE 15 16 # include <stdio.h> 17 # include <ctype.h> 18 # include <setjmp.h> 19 # include "conf.h" 20 # include "useful.h" 21 22 # ifdef LOG 23 # include <syslog.h> 24 # endif LOG 25 /* 26 ** Address structure. 27 ** Addresses are stored internally in this structure. 28 */ 29 30 struct address 31 { 32 char *q_paddr; /* the printname for the address */ 33 char *q_user; /* user name */ 34 char *q_host; /* host name */ 35 struct mailer *q_mailer; /* mailer to use */ 36 u_short q_flags; /* status flags, see below */ 37 short q_uid; /* user-id of receiver (if known) */ 38 short q_gid; /* group-id of receiver (if known) */ 39 char *q_home; /* home dir (local mailer only) */ 40 char *q_fullname; /* full name if known */ 41 struct address *q_next; /* chain */ 42 struct address *q_alias; /* address this results from */ 43 struct address *q_tchain; /* temporary use chain */ 44 time_t q_timeout; /* timeout for this address */ 45 }; 46 47 typedef struct address ADDRESS; 48 49 # define QDONTSEND 000001 /* don't send to this address */ 50 # define QBADADDR 000002 /* this address is verified bad */ 51 # define QGOODUID 000004 /* the q_uid q_gid fields are good */ 52 # define QPRIMARY 000010 /* set from argv */ 53 # define QQUEUEUP 000020 /* queue for later transmission */ 54 /* 55 ** Mailer definition structure. 56 ** Every mailer known to the system is declared in this 57 ** structure. It defines the pathname of the mailer, some 58 ** flags associated with it, and the argument vector to 59 ** pass to it. The flags are defined in conf.c 60 ** 61 ** The argument vector is expanded before actual use. All 62 ** words except the first are passed through the macro 63 ** processor. 64 */ 65 66 struct mailer 67 { 68 char *m_name; /* symbolic name of this mailer */ 69 char *m_mailer; /* pathname of the mailer to use */ 70 u_long m_flags; /* status flags, see below */ 71 short m_badstat; /* the status code to use on unknown error */ 72 short m_mno; /* mailer number internally */ 73 char **m_argv; /* template argument vector */ 74 short m_s_rwset; /* rewriting set for sender addresses */ 75 short m_r_rwset; /* rewriting set for recipient addresses */ 76 }; 77 78 typedef struct mailer MAILER; 79 80 /* bits for m_flags */ 81 # define M_FOPT 000000001L /* mailer takes picky -f flag */ 82 # define M_ROPT 000000002L /* mailer takes picky -r flag */ 83 # define M_QUIET 000000004L /* don't print error on bad status */ 84 # define M_RESTR 000000010L /* must be daemon to execute */ 85 # define M_NHDR 000000020L /* don't insert From line */ 86 # define M_LOCAL 000000040L /* delivery is to this host */ 87 # define M_STRIPQ 000000100L /* strip quote chars from user/host */ 88 # define M_MUSER 000000200L /* can handle multiple users at once */ 89 # define M_NEEDFROM 000000400L /* need arpa-style From: line */ 90 # define M_NEEDDATE 000001000L /* need arpa-style Date: line */ 91 # define M_MSGID 000002000L /* need Message-Id: field */ 92 # define M_CANONICAL 000004000L /* make addresses canonical "u@dom" */ 93 # define M_USR_UPPER 000010000L /* preserve user case distinction */ 94 # define M_HST_UPPER 000020000L /* preserve host case distinction */ 95 # define M_FULLNAME 000040000L /* want Full-Name field */ 96 # define M_UGLYUUCP 000100000L /* this wants an ugly UUCP from line */ 97 # define M_EXPENSIVE 000200000L /* it costs to use this mailer.... */ 98 # define M_FULLSMTP 000400000L /* must run full SMTP, inc. limits */ 99 100 # define M_ARPAFMT (M_NEEDDATE|M_NEEDFROM|M_MSGID) 101 102 EXTERN MAILER *Mailer[MAXMAILERS+1]; 103 104 EXTERN MAILER *LocalMailer; /* ptr to local mailer */ 105 EXTERN MAILER *ProgMailer; /* ptr to program mailer */ 106 /* 107 ** Header structure. 108 ** This structure is used internally to store header items. 109 */ 110 111 struct header 112 { 113 char *h_field; /* the name of the field */ 114 char *h_value; /* the value of that field */ 115 struct header *h_link; /* the next header */ 116 u_short h_flags; /* status bits, see below */ 117 u_long h_mflags; /* m_flags bits needed */ 118 }; 119 120 typedef struct header HDR; 121 122 /* 123 ** Header information structure. 124 ** Defined in conf.c, this struct declares the header fields 125 ** that have some magic meaning. 126 */ 127 128 struct hdrinfo 129 { 130 char *hi_field; /* the name of the field */ 131 u_short hi_flags; /* status bits, see below */ 132 }; 133 134 extern struct hdrinfo HdrInfo[]; 135 136 /* bits for h_flags and hi_flags */ 137 # define H_EOH 00001 /* this field terminates header */ 138 # define H_RCPT 00002 /* contains recipient addresses */ 139 # define H_DEFAULT 00004 /* if another value is found, drop this */ 140 # define H_USED 00010 /* indicates that this has been output */ 141 # define H_CHECK 00020 /* check h_mflags against m_flags */ 142 # define H_ACHECK 00040 /* ditto, but always (not just default) */ 143 # define H_FORCE 00100 /* force this field, even if default */ 144 # define H_TRACE 00200 /* this field contains trace information */ 145 # define H_FROM 00400 /* this is a from-type field */ 146 /* 147 ** Envelope structure. 148 ** This structure defines the message itself. There is usually 149 ** only one of these -- for the message that we originally read 150 ** and which is our primary interest -- but other envelopes can 151 ** be generated during processing. For example, error messages 152 ** will have their own envelope. 153 */ 154 155 struct envelope 156 { 157 HDR *e_header; /* head of header list */ 158 long e_msgpriority; /* adjusted priority of this message */ 159 time_t e_ctime; /* time message appeared in the queue */ 160 bool e_queueup; /* queue this message */ 161 bool e_dontqueue; /* override queueing */ 162 bool e_oldstyle; /* use spaces (not commas) in hdrs */ 163 bool e_sendreceipt; /* actually send a receipt back */ 164 char *e_to; /* the target person */ 165 char *e_receiptto; /* return receipt address */ 166 ADDRESS e_from; /* the person it is from */ 167 char **e_fromdomain; /* the domain part of the sender */ 168 ADDRESS *e_sendqueue; /* list of message recipients */ 169 ADDRESS *e_errorqueue; /* the queue for error responses */ 170 long e_msgsize; /* size of the message in bytes */ 171 short e_class; /* msg class (priority, junk, etc.) */ 172 int (*e_puthdr)(); /* function to put header of message */ 173 int (*e_putbody)(); /* function to put body of message */ 174 struct envelope *e_parent; /* the message this one encloses */ 175 char *e_df; /* location of temp file */ 176 char *e_qf; /* queue control file */ 177 char *e_id; /* code for this entry in queue */ 178 char *e_macro[128]; /* macro definitions */ 179 }; 180 181 typedef struct envelope ENVELOPE; 182 183 EXTERN ENVELOPE *CurEnv; /* envelope currently being processed */ 184 /* 185 ** Work queue. 186 */ 187 188 struct work 189 { 190 char *w_name; /* name of control file */ 191 long w_pri; /* priority of message, see below */ 192 struct work *w_next; /* next in queue */ 193 }; 194 195 typedef struct work WORK; 196 197 EXTERN WORK *WorkQ; /* queue of things to be done */ 198 199 200 /* 201 ** Message priorities. 202 ** Priorities > 0 should be preemptive. 203 ** 204 ** CurEnv->e_msgpriority is the number of bytes in the message adjusted 205 ** by the message priority and the amount of time the message 206 ** has been sitting around. Each priority point is worth 207 ** WKPRIFACT bytes of message, and each time we reprocess a 208 ** message the size gets reduced by WKTIMEFACT. 209 ** 210 ** The "class" is this number, unadjusted by the age or size of 211 ** this message. Classes with negative representations will have 212 ** error messages thrown away if they are not local. 213 */ 214 215 struct priority 216 { 217 char *pri_name; /* external name of priority */ 218 int pri_val; /* internal value for same */ 219 }; 220 221 EXTERN struct priority Priorities[MAXPRIORITIES]; 222 EXTERN int NumPriorities; /* pointer into Priorities */ 223 224 # define WKPRIFACT 1800 /* bytes each pri point is worth */ 225 # define WKTIMEFACT 400 /* bytes each time unit is worth */ 226 /* 227 ** Rewrite rules. 228 */ 229 230 struct rewrite 231 { 232 char **r_lhs; /* pattern match */ 233 char **r_rhs; /* substitution value */ 234 struct rewrite *r_next;/* next in chain */ 235 }; 236 237 EXTERN struct rewrite *RewriteRules[MAXRWSETS]; 238 239 /* 240 ** Special characters in rewriting rules. 241 ** These are used internally only. 242 ** The COND* rules are actually used in macros rather than in 243 ** rewriting rules, but are given here because they 244 ** cannot conflict. 245 */ 246 247 /* left hand side items */ 248 # define MATCHZANY '\020' /* match zero or more tokens */ 249 # define MATCHANY '\021' /* match one or more tokens */ 250 # define MATCHONE '\022' /* match exactly one token */ 251 # define MATCHCLASS '\023' /* match one token in a class */ 252 # define MATCHREPL '\024' /* replacement on RHS for above */ 253 254 /* right hand side items */ 255 # define CANONNET '\025' /* canonical net, next token */ 256 # define CANONHOST '\026' /* canonical host, next token */ 257 # define CANONUSER '\027' /* canonical user, next N tokens */ 258 # define CALLSUBR '\030' /* call another rewriting set */ 259 260 /* conditionals in macros */ 261 # define CONDIF '\031' /* conditional if-then */ 262 # define CONDELSE '\032' /* conditional else */ 263 # define CONDFI '\033' /* conditional fi */ 264 /* 265 ** Symbol table definitions 266 */ 267 268 struct symtab 269 { 270 char *s_name; /* name to be entered */ 271 char s_type; /* general type (see below) */ 272 struct symtab *s_next; /* pointer to next in chain */ 273 union 274 { 275 long sv_class; /* bit-map of word classes */ 276 ADDRESS *sv_addr; /* pointer to address header */ 277 MAILER *sv_mailer; /* pointer to mailer */ 278 char *sv_alias; /* alias */ 279 } s_value; 280 }; 281 282 typedef struct symtab STAB; 283 284 /* symbol types */ 285 # define ST_UNDEF 0 /* undefined type */ 286 # define ST_CLASS 1 /* class map */ 287 # define ST_ADDRESS 2 /* an address in parsed format */ 288 # define ST_MAILER 3 /* a mailer header */ 289 # define ST_ALIAS 4 /* an alias */ 290 291 # define s_class s_value.sv_class 292 # define s_address s_value.sv_addr 293 # define s_mailer s_value.sv_mailer 294 # define s_alias s_value.sv_alias 295 296 extern STAB *stab(); 297 298 /* opcodes to stab */ 299 # define ST_FIND 0 /* find entry */ 300 # define ST_ENTER 1 /* enter if not there */ 301 /* 302 ** STRUCT EVENT -- event queue. 303 ** 304 ** Maintained in sorted order. 305 ** 306 ** We store the pid of the process that set this event to insure 307 ** that when we fork we will not take events intended for the parent. 308 */ 309 310 struct event 311 { 312 time_t ev_time; /* time of the function call */ 313 int (*ev_func)(); /* function to call */ 314 int ev_arg; /* argument to ev_func */ 315 int ev_pid; /* pid that set this event */ 316 struct event *ev_link; /* link to next item */ 317 }; 318 319 typedef struct event EVENT; 320 321 EXTERN EVENT *EventQueue; /* head of event queue */ 322 /* 323 ** Statistics structure. 324 */ 325 326 struct statistics 327 { 328 time_t stat_itime; /* file initialization time */ 329 short stat_size; /* size of this structure */ 330 long stat_nf[MAXMAILERS]; /* # msgs from each mailer */ 331 long stat_bf[MAXMAILERS]; /* kbytes from each mailer */ 332 long stat_nt[MAXMAILERS]; /* # msgs to each mailer */ 333 long stat_bt[MAXMAILERS]; /* kbytes to each mailer */ 334 }; 335 336 EXTERN struct statistics Stat; 337 extern long kbytes(); /* for _bf, _bt */ 338 /* 339 ** Operation and send modes 340 ** 341 ** The operation mode describes the basic operation of sendmail. 342 ** This can be set from the command line, and is "send mail" by 343 ** default. 344 ** 345 ** The send mode tells how to send mail. It can be set in the 346 ** configuration file. It's setting determines how quickly the 347 ** mail will be delivered versus the load on your system. If the 348 ** -v (verbose) flag is given, it will be forced to SM_DELIVER 349 ** mode. 350 ** 351 ** The default send mode can be safely changed. 352 */ 353 354 EXTERN char OpMode; /* operation mode, see below */ 355 356 #define MD_DELIVER 'm' /* be a mail sender */ 357 #define MD_ARPAFTP 'a' /* old-style arpanet protocols */ 358 #define MD_SMTP 's' /* run SMTP on standard input */ 359 #define MD_DAEMON 'd' /* run as a daemon */ 360 #define MD_VERIFY 'v' /* verify: don't collect or deliver */ 361 #define MD_TEST 't' /* test mode: resolve addrs only */ 362 #define MD_INITALIAS 'i' /* initialize alias database */ 363 #define MD_PRINT 'p' /* print the queue */ 364 #define MD_FREEZE 'z' /* freeze the configuration file */ 365 366 367 EXTERN char SendMode; /* send mode, see below */ 368 369 #define SM_DELIVER 'i' /* interactive delivery */ 370 #define SM_QUICKD 'j' /* deliver w/o queueing */ 371 #define SM_FORK 'b' /* deliver in background */ 372 #define SM_QUEUE 'q' /* queue, don't deliver */ 373 #define SM_VERIFY 'v' /* verify only (used internally) */ 374 /* 375 ** Global variables. 376 */ 377 378 EXTERN bool FromFlag; /* if set, "From" person is explicit */ 379 EXTERN bool MailBack; /* mail back response on error */ 380 EXTERN bool BerkNet; /* called from BerkNet */ 381 EXTERN bool WriteBack; /* write back response on error */ 382 EXTERN bool NoAlias; /* if set, don't do any aliasing */ 383 EXTERN bool ForceMail; /* if set, mail even if already got a copy */ 384 EXTERN bool MeToo; /* send to the sender also */ 385 EXTERN bool IgnrDot; /* don't let dot end messages */ 386 EXTERN bool SaveFrom; /* save leading "From" lines */ 387 EXTERN bool Verbose; /* set if blow-by-blow desired */ 388 EXTERN bool GrabTo; /* if set, get recipients from msg */ 389 EXTERN bool DontSend; /* mark recipients as QDONTSEND */ 390 EXTERN bool NoReturn; /* don't return letter to sender */ 391 EXTERN bool SuprErrs; /* set if we are suppressing errors */ 392 EXTERN bool QueueRun; /* currently running message from the queue */ 393 EXTERN bool HoldErrs; /* only output errors to transcript */ 394 EXTERN bool NoConnect; /* don't connect to non-local mailers */ 395 EXTERN bool FatalErrors; /* set if fatal errors during processing */ 396 EXTERN bool SuperSafe; /* be extra careful, even if expensive */ 397 EXTERN bool SafeAlias; /* alias file must have "@:@" to be complete */ 398 EXTERN bool AutoRebuild; /* auto-rebuild the alias database as needed */ 399 EXTERN time_t TimeOut; /* time until timeout */ 400 EXTERN FILE *InChannel; /* input connection */ 401 EXTERN FILE *OutChannel; /* output connection */ 402 EXTERN FILE *TempFile; /* mail temp file */ 403 EXTERN FILE *Xscript; /* mail transcript file */ 404 EXTERN int RealUid; /* when Daemon, real uid of caller */ 405 EXTERN int RealGid; /* when Daemon, real gid of caller */ 406 EXTERN int DefUid; /* default uid to run as */ 407 EXTERN int DefGid; /* default gid to run as */ 408 EXTERN int OldUmask; /* umask when sendmail starts up */ 409 EXTERN int Errors; /* set if errors (local to single pass) */ 410 EXTERN int ExitStat; /* exit status code */ 411 EXTERN int HopCount; /* hop count */ 412 EXTERN int AliasLevel; /* depth of aliasing */ 413 EXTERN int MotherPid; /* proc id of parent process */ 414 EXTERN int LineNumber; /* line number in current input */ 415 EXTERN int ReadTimeout; /* timeout on reads */ 416 EXTERN int LogLevel; /* level of logging to perform */ 417 EXTERN int FileMode; /* mode on files */ 418 EXTERN time_t QueueIntvl; /* intervals between running the queue */ 419 EXTERN char *HostName; /* name of this host for SMTP messages */ 420 EXTERN char *Transcript; /* the transcript file name */ 421 EXTERN char *AliasFile; /* location of alias file */ 422 EXTERN char *HelpFile; /* location of SMTP help file */ 423 EXTERN char *StatFile; /* location of statistics summary */ 424 EXTERN char *QueueDir; /* location of queue directory */ 425 EXTERN char *TrustedUsers[MAXTRUST+1]; /* list of trusted users */ 426 EXTERN jmp_buf TopFrame; /* branch-to-top-of-loop-on-error frame */ 427 EXTERN bool QuickAbort; /* .... but only if we want a quick abort */ 428 extern char *ConfFile; /* location of configuration file [conf.c] */ 429 extern char *FreezeFile; /* location of frozen memory image [conf.c] */ 430 extern char Arpa_Info[]; /* the reply code for Arpanet info [conf.c] */ 431 extern char SpaceSub; /* substitution for <lwsp> [conf.c] */ 432 /* 433 ** Trace information 434 */ 435 436 /* trace vector and macros for debugging flags */ 437 EXTERN u_char tTdvect[100]; 438 # define tTd(flag, level) (tTdvect[flag] >= level) 439 # define tTdlevel(flag) (tTdvect[flag]) 440 /* 441 ** Miscellaneous information. 442 */ 443 444 # include <sysexits.h> 445 446 # define setstat(s) { if (ExitStat == EX_OK) ExitStat = s; } 447 448 449 /* useful functions */ 450 451 extern char *newstr(); 452 extern ADDRESS *parse(); 453 extern char *xalloc(); 454 extern bool sameaddr(); 455 extern FILE *dfopen(); 456 extern EVENT *setevent(); 457 extern char *sfgets(); 458 extern char *queuename(); 459 extern time_t curtime(); 460