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