Pileus Git - ~andy/fetchmail/blob - fetchmail.h

   1 /*
   2  * For license terms, see the file COPYING in this directory.
   3  */
   4
   5 /* We need this for HAVE_STDARG_H, etc */
   6 #include "config.h"
   7
   8 /* constants designating the various supported protocols */
   9 #define         P_AUTO          1
  10 #define         P_POP2          2
  11 #define         P_POP3          3
  12 #define         P_IMAP          4
  13 #define         P_IMAP_K4       5
  14 #define         P_IMAP_GSS      6
  15 #define         P_APOP          7
  16 #define         P_RPOP          8
  17 #define         P_ETRN          9
  18
  19 #if INET6
  20 #define         SMTP_PORT       "smtp"
  21 #define         KPOP_PORT       "kpop"
  22 #else /* INET6 */
  23 #define         SMTP_PORT       25
  24 #define         KPOP_PORT       1109
  25 #endif /* INET6 */
  26
  27 /* preauthentication types */
  28 #define         A_PASSWORD      0       /* password or inline authentication */
  29 #define         A_KERBEROS_V4   1       /* preauthenticate w/ Kerberos V4 */
  30 #define         A_KERBEROS_V5   2       /* preauthenticate w/ Kerberos V5 */
  31
  32 /*
  33  * Definitions for buffer sizes.  We get little help on setting maxima
  34  * from IMAP RFCs up to 2060, so these are mostly from POP3.
  35  */
  36 #define         HOSTLEN         635     /* max hostname length (RFC1123) */
  37 #define         POPBUFSIZE      512     /* max length of response (RFC1939) */
  38 #define         IDLEN           128     /* max length of UID (RFC1939) */
  39
  40 /* per RFC1939 this should be 40, but Microsoft Exchange ignores that limit */
  41 #define         USERNAMELEN     128     /* max POP3 arg length */
  42
  43 /* clear a netBSD kernel parameter out of the way */
  44 #undef          MSGBUFSIZE
  45
  46 /*
  47  * The RFC822 limit on message line size is just 998.  But
  48  * make this *way* oversized; idiot DOS-world mailers that
  49  * don't line-wrap properly often ship entire paragraphs as
  50  * lines.
  51  */
  52 #define         MSGBUFSIZE      8192
  53
  54 #define         PASSWORDLEN     64      /* max password length */
  55 #define         DIGESTLEN       33      /* length of MD5 digest */
  56
  57 /* exit code values */
  58 #define         PS_SUCCESS      0       /* successful receipt of messages */
  59 #define         PS_NOMAIL       1       /* no mail available */
  60 #define         PS_SOCKET       2       /* socket I/O woes */
  61 #define         PS_AUTHFAIL     3       /* user authorization failed */
  62 #define         PS_PROTOCOL     4       /* protocol violation */
  63 #define         PS_SYNTAX       5       /* command-line syntax error */
  64 #define         PS_IOERR        6       /* bad permissions on rc file */
  65 #define         PS_ERROR        7       /* protocol error */
  66 #define         PS_EXCLUDE      8       /* client-side exclusion error */
  67 #define         PS_LOCKBUSY     9       /* server responded lock busy */
  68 #define         PS_SMTP         10      /* SMTP error */
  69 #define         PS_DNS          11      /* fatal DNS error */
  70 #define         PS_BSMTP        12      /* output batch could not be opened */
  71 #define         PS_MAXFETCH     13      /* poll ended by fetch limit */
  72 /* leave space for more codes */
  73 #define         PS_UNDEFINED    23      /* something I hadn't thought of */
  74 #define         PS_TRANSIENT    24      /* transient failure (internal use) */
  75 #define         PS_REFUSED      25      /* mail refused (internal use) */
  76 #define         PS_RETAINED     26      /* message retained (internal use) */
  77 #define         PS_TRUNCATED    27      /* headers incomplete (internal use) */
  78
  79 /* output noise level */
  80 #define         O_SILENT        0       /* mute, max squelch, etc. */
  81 #define         O_NORMAL        1       /* user-friendly */
  82 #define         O_VERBOSE       2       /* chatty */
  83 #define         O_DEBUG         3       /* prolix */
  84 #define         O_MONITOR       O_VERBOSE
  85
  86 #define         SIZETICKER      1024    /* print 1 dot per this many bytes */
  87
  88 /*
  89  * We #ifdef this and use flag rather than bool
  90  * to avoid a type clash with curses.h
  91  */
  92 #ifndef TRUE
  93 #define FALSE   0
  94 #define TRUE    1
  95 #endif /* TRUE */
  96 typedef char    flag;
  97
  98 /* we need to use zero as a flag-uninitialized value */
  99 #define FLAG_TRUE       2
 100 #define FLAG_FALSE      1
 101
 102 struct runctl
 103 {
 104     char        *logfile;
 105     char        *idfile;
 106     int         poll_interval;
 107     char        *postmaster;
 108     flag        bouncemail;
 109     char        *properties;
 110     flag        use_syslog;
 111     flag        invisible;
 112 };
 113
 114 struct idlist
 115 {
 116     char *id;
 117     union
 118     {
 119         struct
 120         {
 121             short       num;
 122             flag        mark;           /* UID-index information */
 123 #define UID_UNSEEN      0               /* hasn't been seen */
 124 #define UID_SEEN        1               /* seen, but not deleted */
 125 #define UID_DELETED     2               /* this message has been deleted */
 126 #define UID_EXPUNGED    3               /* this message has been expunged */
 127         }
 128         status;
 129         char *id2;
 130     } val;
 131     struct idlist *next;
 132 };
 133
 134 struct query;
 135
 136 struct method           /* describe methods for protocol state machine */
 137 {
 138     const char *name;           /* protocol name */
 139 #if INET6
 140     const char *service;
 141 #else /* INET6 */
 142     int port;                   /* service port */
 143 #endif /* INET6 */
 144     flag tagged;                /* if true, generate & expect command tags */
 145     flag delimited;             /* if true, accept "." message delimiter */
 146     int (*parse_response)(int, char *);
 147                                 /* response_parsing function */
 148     int (*password_canonify)(char *, char *);
 149                                 /* canonicalize password */
 150     int (*getauth)(int, struct query *, char *);
 151                                 /* authorization fetcher */
 152     int (*getrange)(int, struct query *, const char *, int *, int *, int *);
 153                                 /* get message range to fetch */
 154     int (*getsizes)(int, int, int *);
 155                                 /* get sizes of messages */
 156     int (*is_old)(int, struct query *, int);
 157                                 /* check for old message */
 158     int (*fetch_headers)(int, struct query *, int, int *);
 159                                 /* fetch FROM headera given message */
 160     int (*fetch_body)(int, struct query *, int, int *);
 161                                 /* fetch a given message */
 162     int (*trail)(int, struct query *, int);
 163                                 /* eat trailer of a message */
 164     int (*delete)(int, struct query *, int);
 165                                 /* delete method */
 166     int (*logout_cmd)(int, struct query *);
 167                                 /* logout command */
 168     flag retry;                 /* can getrange poll for new messages? */
 169 };
 170
 171 struct hostdata         /* shared among all user connections to given server */
 172 {
 173     /* rc file data */
 174     char *pollname;                     /* poll label of host */
 175     char *via;                          /* "true" server name if non-NULL */
 176     struct idlist *akalist;             /* server name first, then akas */
 177     struct idlist *localdomains;        /* list of pass-through domains */
 178     int protocol;                       /* protocol type */
 179 #if INET6
 180     char *service;                      /* IPv6 service name */
 181     void *netsec;                       /* IPv6 security request */
 182 #else /* INET6 */
 183     int port;                           /* TCP/IP service port number */
 184 #endif /* INET6 */
 185     int interval;                       /* # cycles to skip between polls */
 186     int preauthenticate;                /* preauthentication mode to try */
 187     int timeout;                        /* inactivity timout in seconds */
 188     char *envelope;                     /* envelope address list header */
 189     int envskip;                        /* skip to numbered envelope header */
 190     char *qvirtual;                     /* prefix removed from local user id */
 191     flag skip;                          /* suppress poll in implicit mode? */
 192     flag dns;                           /* do DNS lookup on multidrop? */
 193     flag uidl;                          /* use RFC1725 UIDLs? */
 194 #ifdef SDPS_ENABLE
 195     flag sdps;                          /* use Demon Internet SDPS *ENV */
 196 #endif /* SDPS_ENABLE */
 197     flag checkalias;                    /* resolve aliases by comparing IPs? */
 198
 199
 200 #if defined(linux) || defined(__FreeBSD__)
 201     char *interface;
 202     char *monitor;
 203     int  monitor_io;
 204     struct interface_pair_s *interface_pair;
 205 #endif /* linux */
 206
 207     char *plugin,*plugout;
 208
 209     /* computed for internal use */
 210     const struct method *base_protocol; /* relevant protocol method table */
 211     int poll_count;                     /* count of polls so far */
 212     char *queryname;                    /* name to attempt DNS lookup on */
 213     char *truename;                     /* "true name" of server host */
 214     struct hostdata *lead_server;       /* ptr to lead query for this server */
 215     int esmtp_options;
 216 };
 217
 218 struct query
 219 {
 220     /* mailserver connection controls */
 221     struct hostdata server;
 222
 223     /* per-user data */
 224     struct idlist *localnames;  /* including calling user's name */
 225     int wildcard;               /* should unmatched names be passed through */
 226     char *remotename;           /* remote login name to use */
 227     char *password;             /* remote password to use */
 228     struct idlist *mailboxes;   /* list of mailboxes to check */
 229
 230     /* per-forwarding-target data */
 231     struct idlist *smtphunt;    /* list of SMTP hosts to try forwarding to */
 232     char *smtpaddress;          /* address to force in RCPT TO */
 233     struct idlist *antispam;    /* list of listener's antispam response */
 234     char *mda;                  /* local MDA to pass mail to */
 235     char *bsmtp;                /* BSMTP output file */
 236     char listener;              /* what's the listener's wire protocol? */
 237 #define SMTP_MODE       'S'
 238 #define LMTP_MODE       'L'
 239     char *preconnect;           /* pre-connection command to execute */
 240     char *postconnect;          /* post-connection command to execute */
 241
 242     /* per-user control flags */
 243     flag keep;                  /* if TRUE, leave messages undeleted */
 244     flag fetchall;              /* if TRUE, fetch all (not just unseen) */
 245     flag flush;                 /* if TRUE, delete messages already seen */
 246     flag rewrite;               /* if TRUE, canonicalize recipient addresses */
 247     flag stripcr;               /* if TRUE, strip CRs in text */
 248     flag forcecr;               /* if TRUE, force CRs before LFs in text */
 249     flag pass8bits;             /* if TRUE, ignore Content-Transfer-Encoding */
 250     flag dropstatus;            /* if TRUE, drop Status lines in mail */
 251     flag mimedecode;            /* if TRUE, decode MIME-armored messages */
 252     int limit;                  /* limit size of retrieved messages */
 253     int warnings;               /* size warning interval */
 254     int fetchlimit;             /* max # msgs to get in single poll */
 255     int batchlimit;             /* max # msgs to pass in single SMTP session */
 256     int expunge;                /* max # msgs to pass between expunges */
 257     char *properties;           /* passthrough properties for extensions */
 258
 259     /* internal use -- per-poll state */
 260     flag active;                /* should we actually poll this server? */
 261     const char *destaddr;       /* destination host for this query */
 262     int errcount;               /* count transient errors in last pass */
 263     int wedged;                 /* wedged by auth failures or timeouts? */
 264     char *smtphost;             /* actual SMTP host we connected to */
 265     int smtp_socket;            /* socket descriptor for SMTP connection */
 266     unsigned int uid;           /* UID of user to deliver to */
 267     struct idlist *skipped;     /* messages skipped on the mail server */
 268     struct idlist *oldsaved, *newsaved;
 269     char *lastid;               /* last Message-ID seen on this connection */
 270
 271     /* internal use -- per-message state */
 272     int mimemsg;                /* bitmask indicating MIME body-type */
 273     char digest [DIGESTLEN];    /* md5 digest buffer */
 274
 275     /* internal use -- housekeeping */
 276     struct query *next;         /* next query control block in chain */
 277 };
 278
 279 struct msgblk                   /* message header parsed for open_sink() */
 280 {
 281     char                *headers;       /* raw message headers */
 282     struct idlist       *recipients;    /* addressees */
 283     char                return_path[HOSTLEN + USERNAMELEN + 4];
 284     int                 reallen;
 285 };
 286
 287
 288 /*
 289  * Numeric option handling.  Numeric option value of zero actually means
 290  * it's unspecified.  Value less than zero is zero.  The reason for this
 291  * screwy encoding is so we can zero out an option block in order to set the
 292  * numeric flags in it to unspecified.
 293  */
 294 #define NUM_VALUE_IN(n)         (((n) == 0) ? -1 : (n))
 295 #define NUM_VALUE_OUT(n)        (((n) < 0) ? 0 : (n))
 296 #define NUM_NONZERO(n)          ((n) > 0)
 297 #define NUM_ZERO(n)             ((n) < 0)
 298 #define NUM_SPECIFIED(n)        ((n) != 0)
 299
 300 #define MULTIDROP(ctl)  (ctl->wildcard || \
 301                                 ((ctl)->localnames && (ctl)->localnames->next))
 302
 303 /*
 304  * Note: tags are generated with an a%04d format from a 1-origin
 305  * integer sequence number.  Length 4 permits transaction numbers
 306  * up to 9999, so we force rollover with % 10000.  There's no special
 307  * reason for this format other than to look like the exmples in the
 308  * IMAP RFCs.
 309  */
 310 #define TAGLEN  6               /* 'a' + 4 digits + NUL */
 311 extern char tag[TAGLEN];
 312 #define TAGMOD  10000
 313
 314 /* list of hosts assembled from run control file and command line */
 315 extern struct query cmd_opts, *querylist;
 316
 317 /* what's returned by envquery */
 318 extern void envquery(int, char **);
 319
 320 /* controls the detail level of status/progress messages written to stderr */
 321 extern int outlevel;            /* see the O_.* constants above */
 322 extern int yydebug;             /* enable parse debugging */
 323
 324 /* these get computed */
 325 extern int batchcount;          /* count of messages sent in current batch */
 326 extern flag peek_capable;       /* can we read msgs without setting seen? */
 327
 328 /* miscellaneous global controls */
 329 extern struct runctl run;       /* global controls for this run */
 330 extern flag nodetach;           /* if TRUE, don't detach daemon process */
 331 extern flag quitmode;           /* if --quit was set */
 332 extern flag check_only;         /* if --check was set */
 333 extern char *rcfile;            /* path name of rc file */
 334 extern int linelimit;           /* limit # lines retrieved per site */
 335 extern flag versioninfo;        /* emit only version info */
 336 extern char *user;              /* name of invoking user */
 337 extern char *home;              /* home directory of invoking user */
 338 extern int pass;                /* number of re-polling pass */
 339 extern flag configdump;         /* dump control blocks as Python dictionary */
 340 extern const char *fetchmailhost;
 341                                 /* either "localhost" or an FQDN */
 342 #ifdef SDPS_ENABLE
 343 extern char *sdps_envfrom;
 344 extern char *sdps_envto;
 345 #endif /* SDPS_ENABLE */
 346
 347 /* prototypes for globally callable functions */
 348
 349 /* error.c: Error reporting */
 350 #if defined(HAVE_STDARG_H)
 351 void report_init(int foreground);
 352 void report (FILE *fp, const char *format, ...);
 353 void report_build (FILE *fp, const char *format, ...);
 354 void report_complete (FILE *fp, const char *format, ...);
 355 void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...);
 356 #else
 357 void report ();
 358 void report_build ();
 359 void report_complete ();
 360 void report_at_line ();
 361 #endif
 362
 363 /* driver.c: transaction support */
 364 void set_timeout(int);
 365 #if defined(HAVE_STDARG_H)
 366 void gen_send (int sock, const char *, ... );
 367 int gen_recv(int sock, char *buf, int size);
 368 int gen_transact (int sock, const char *, ... );
 369 #else
 370 void gen_send ();
 371 int gen_recv();
 372 int gen_transact ();
 373 #endif
 374
 375 /* use these to track what was happening when the nonresponse timer fired */
 376 #define GENERAL_WAIT    0       /* unknown wait type */
 377 #define OPEN_WAIT       1       /* waiting from mailserver open */
 378 #define SERVER_WAIT     2       /* waiting for mailserver response */
 379 #define LISTENER_WAIT   3       /* waiting for listener initialization */
 380 #define FORWARDING_WAIT 4       /* waiting for listener response */
 381 extern int phase;
 382
 383 /* mark values for name lists */
 384 #define XMIT_ACCEPT     1       /* accepted; matches local domain or name */
 385 #define XMIT_REJECT     2       /* rejected; no match */
 386 #define XMIT_RCPTBAD    3       /* SMTP listener rejected the name */
 387
 388 /* sink.c: forwarding */
 389 int stuffline(struct query *, char *);
 390 int open_sink(struct query*, struct msgblk *, int*, int*);
 391 void release_sink(struct query *);
 392 int close_sink(struct query *, struct msgblk *, flag);
 393 int open_warning_by_mail(struct query *, struct msgblk *);
 394 #if defined(HAVE_STDARG_H)
 395 void stuff_warning(struct query *, const char *, ... );
 396 #else
 397 void stuff_warning();
 398 #endif
 399 void close_warning_by_mail(struct query *, struct msgblk *);
 400
 401 /* rfc822.c: RFC822 header parsing */
 402 char *reply_hack(char *, const char *);
 403 char *nxtaddr(const char *);
 404
 405 /* uid.c: UID support */
 406 void initialize_saved_lists(struct query *, const char *);
 407 struct idlist *save_str(struct idlist **, const char *, flag);
 408 void free_str_list(struct idlist **);
 409 void save_str_pair(struct idlist **, const char *, const char *);
 410 void free_str_pair_list(struct idlist **);
 411 int delete_str(struct idlist **, int);
 412 int str_in_list(struct idlist **, const char *, const flag);
 413 int str_nr_in_list(struct idlist **, const char *);
 414 int str_nr_last_in_list(struct idlist **, const char *);
 415 void str_set_mark( struct idlist **, const char *, const flag);
 416 int count_list( struct idlist **idl );
 417 char *str_from_nr_list( struct idlist **idl, int number );
 418 char *str_find(struct idlist **, int);
 419 char *idpair_find(struct idlist **, const char *);
 420 void append_str_list(struct idlist **, struct idlist **);
 421 void expunge_uids(struct query *);
 422 void update_str_lists(struct query *);
 423 void write_saved_lists(struct query *, const char *);
 424
 425 /* rcfile_y.y */
 426 int prc_parse_file(const char *, const flag);
 427 int prc_filecheck(const char *, const flag);
 428
 429 /* base64.c */
 430 void to64frombits(unsigned char *, const unsigned char *, int);
 431 int from64tobits(char *, const char *);
 432
 433 /* unmime.c */
 434 /* Bit-mask returned by MimeBodyType */
 435 #define MSG_IS_7BIT       0x01
 436 #define MSG_IS_8BIT       0x02
 437 #define MSG_NEEDS_DECODE  0x80
 438 extern void UnMimeHeader(unsigned char *buf);
 439 extern int  MimeBodyType(unsigned char *hdrs, int WantDecode);
 440 extern int  UnMimeBodyline(unsigned char **buf, flag delimited, flag issoftline);
 441
 442 /* interface.c */
 443 void interface_init(void);
 444 void interface_parse(char *, struct hostdata *);
 445 void interface_note_activity(struct hostdata *);
 446 int interface_approve(struct hostdata *);
 447
 448 /* xmalloc.c */
 449 #if defined(HAVE_VOIDPOINTER)
 450 #define XMALLOCTYPE void
 451 #else
 452 #define XMALLOCTYPE char
 453 #endif
 454 XMALLOCTYPE *xmalloc(int);
 455 XMALLOCTYPE *xrealloc(XMALLOCTYPE *, int);
 456 char *xstrdup(const char *);
 457 #if defined(HAVE_ALLOCA_H)
 458 #include <alloca.h>
 459 #else
 460 #ifdef _AIX
 461  #pragma alloca
 462 #endif
 463 #endif
 464 #define xalloca(ptr, t, n)      if (!(ptr = (t) alloca(n))) {report(stderr, "alloca failed"); exit(PS_UNDEFINED);}
 465
 466 /* protocol driver and methods */
 467 int do_protocol(struct query *, const struct method *);
 468 int doPOP2 (struct query *);
 469 int doPOP3 (struct query *);
 470 int doIMAP (struct query *);
 471 int doETRN (struct query *);
 472
 473 /* miscellanea */
 474 struct query *hostalloc(struct query *);
 475 int parsecmdline (int, char **, struct runctl *, struct query *);
 476 char *MD5Digest (unsigned char *);
 477 int POP3_auth_rpa(unsigned char *, unsigned char *, int socket);
 478 int daemonize(const char *, void (*)(int));
 479 char *getpassword(char *);
 480 void escapes(const char *, char *);
 481 char *visbuf(const char *);
 482 const char *showproto(int);
 483 void dump_config(struct runctl *runp, struct query *querylist);
 484 int is_host_alias(const char *, struct query *);
 485 char *host_fqdn(void);
 486 char *rfc822timestamp(void);
 487
 488 void yyerror(const char *);
 489 int yylex(void);
 490
 491 #ifdef __EMX__
 492 void itimerthread(void*);
 493 /* Have to include these first to avoid errors from redefining getcwd
 494    and chdir.  They're re-include protected in EMX, so it's okay, I
 495    guess.  */
 496 #include <stdlib.h>
 497 #include <unistd.h>
 498 /* Redefine getcwd and chdir to get drive-letter support so we can
 499    find all of our lock files and stuff. */
 500 #define getcwd _getcwd2
 501 #define chdir _chdir2
 502 #endif /* _EMX_ */
 503
 504 # if HAVE_STRERROR
 505 #  ifndef strerror              /* On some systems, strerror is a macro */
 506 char *strerror ();
 507 #  endif
 508 # endif /* HAVE_STRERROR */
 509
 510 #define STRING_DISABLED (char *)-1
 511 #define STRING_DUMMY    ""
 512
 513 #ifdef NeXT
 514 #ifndef S_IXGRP
 515 #define S_IXGRP 0000010
 516 #endif
 517 #endif
 518
 519 /* fetchmail.h ends here */