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

   1 /** \file fetchmail.h  header file for fetchmail */
   2 #ifndef _FETCHMAIL_H
   3 #define _FETCHMAIL_H
   4 /*
   5  * For license terms, see the file COPYING in this directory.
   6  */
   7
   8 /* We need this for HAVE_STDARG_H, etc */
   9 #include "config.h"
  10
  11 struct addrinfo;
  12
  13 /* We need this for size_t */
  14 #include <sys/types.h>
  15
  16 /* We need this for time_t */
  17 #if TIME_WITH_SYS_TIME
  18 # include <sys/time.h>
  19 # include <time.h>
  20 #else
  21 # if HAVE_SYS_TIME_H
  22 #  include <sys/time.h>
  23 # else
  24 #  include <time.h>
  25 # endif
  26 #endif
  27
  28 #ifdef HAVE_SYS_SOCKET_H
  29 #include <sys/socket.h>
  30 #endif
  31 #ifdef HAVE_NET_SOCKET_H
  32 #include <net/socket.h>
  33 #endif
  34 #include <netdb.h>
  35 #include <stdio.h>
  36
  37 /* Import Trio if needed */
  38 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
  39 #  include "trio/trio.h"
  40 #endif
  41
  42 /* We need this for strstr */
  43 #if !defined(HAVE_STRSTR) && !defined(strstr)
  44 char *strstr(const char *, const char *);
  45 #endif
  46
  47 /* constants designating the various supported protocols */
  48 #define         P_AUTO          1
  49 #define         P_POP2          2
  50 #define         P_POP3          3
  51 #define         P_APOP          4
  52 #define         P_RPOP          5
  53 #define         P_IMAP          6
  54 #define         P_ETRN          7
  55 #define         P_ODMR          8
  56
  57 #define         SMTP_PORT       "smtp"
  58 #define         SMTP_PORT_NUM   25
  59 #define         KPOP_PORT       "kpop"
  60
  61 #ifdef SSL_ENABLE
  62 #define         SIMAP_PORT      993
  63 #define         SPOP3_PORT      995
  64 #endif
  65
  66 /*
  67  * We need to distinguish between mailbox and mailbag protocols.
  68  * Under a mailbox protocol wwe're pulling mail for a speecific user.
  69  * Under a mailbag protocol we're fetching mail for an entire domain.
  70  */
  71 #define MAILBOX_PROTOCOL(ctl)   ((ctl)->server.protocol < P_ETRN)
  72
  73 /* authentication types */
  74 #define         A_ANY           0       /* use the first method that works */
  75 #define         A_PASSWORD      1       /* password authentication */
  76 #define         A_NTLM          2       /* Microsoft NTLM protocol */
  77 #define         A_CRAM_MD5      3       /* CRAM-MD5 shrouding (RFC2195) */
  78 #define         A_OTP           4       /* One-time password (RFC1508) */
  79 #define         A_KERBEROS_V4   5       /* authenticate w/ Kerberos V4 */
  80 #define         A_KERBEROS_V5   6       /* authenticate w/ Kerberos V5 */
  81 #define         A_GSSAPI        7       /* authenticate with GSSAPI */
  82 #define         A_SSH           8       /* authentication at session level */
  83 #define         A_MSN           9       /* same as NTLM with keyword MSN */
  84 #define         A_EXTERNAL      10      /* external authentication (client cert) */
  85
  86 /* some protocols or authentication types (KERBEROS, GSSAPI, SSH) don't
  87  * require a password */
  88 #define NO_PASSWORD(ctl) \
  89     ((ctl)->server.authenticate == A_OTP \
  90      || (ctl)->server.authenticate == A_KERBEROS_V4 \
  91      || (ctl)->server.authenticate == A_KERBEROS_V5 \
  92      || (ctl)->server.authenticate == A_GSSAPI \
  93      || (ctl)->server.authenticate == A_SSH \
  94      || (ctl)->server.authenticate == A_EXTERNAL \
  95      || (ctl)->server.protocol == P_ETRN)
  96
  97 /*
  98  * Definitions for buffer sizes.  We get little help on setting maxima
  99  * from IMAP RFCs up to 2060, so these are mostly from POP3.
 100  */
 101 #define         HOSTLEN         635     /* max hostname length (RFC1123) */
 102 #define         POPBUFSIZE      512     /* max length of response (RFC1939) */
 103 #define         IDLEN           128     /* max length of UID (RFC1939) */
 104
 105 /* per RFC1939 this should be 40, but Microsoft Exchange ignores that limit */
 106 #define         USERNAMELEN     128     /* max POP3 arg length */
 107
 108 /* clear a netBSD kernel parameter out of the way */
 109 #undef          MSGBUFSIZE
 110
 111 /*
 112  * The RFC822 limit on message line size is just 998.  But
 113  * make this *way* oversized; idiot DOS-world mailers that
 114  * don't line-wrap properly often ship entire paragraphs as
 115  * lines.
 116  */
 117 #define         MSGBUFSIZE      8192
 118
 119 #define         NAMELEN         64      /* max username length */
 120 #define         PASSWORDLEN     64      /* max password length */
 121 #define         DIGESTLEN       33      /* length of MD5 digest */
 122
 123 /* exit code values */
 124 /* NOTE THAT PS_SUCCESS MUST ALWAYS BE 0 - SOME PARTS OF THE CODE
 125  * RELY ON THIS VALUE! */
 126 #define         PS_SUCCESS      0       /* successful receipt of messages */
 127 #define         PS_NOMAIL       1       /* no mail available */
 128 #define         PS_SOCKET       2       /* socket I/O woes */
 129 #define         PS_AUTHFAIL     3       /* user authorization failed */
 130 #define         PS_PROTOCOL     4       /* protocol violation */
 131 #define         PS_SYNTAX       5       /* command-line syntax error */
 132 #define         PS_IOERR        6       /* bad permissions on rc file */
 133 #define         PS_ERROR        7       /* protocol error */
 134 #define         PS_EXCLUDE      8       /* client-side exclusion error */
 135 #define         PS_LOCKBUSY     9       /* server responded lock busy */
 136 #define         PS_SMTP         10      /* SMTP error */
 137 #define         PS_DNS          11      /* fatal DNS error */
 138 #define         PS_BSMTP        12      /* output batch could not be opened */
 139 #define         PS_MAXFETCH     13      /* poll ended by fetch limit */
 140 #define         PS_SERVBUSY     14      /* server is busy */
 141 /* leave space for more codes */
 142 #define         PS_UNDEFINED    23      /* something I hadn't thought of */
 143 #define         PS_TRANSIENT    24      /* transient failure (internal use) */
 144 #define         PS_REFUSED      25      /* mail refused (internal use) */
 145 #define         PS_RETAINED     26      /* message retained (internal use) */
 146 #define         PS_REPOLL       28      /* repoll immediately with changed parameters (internal use) */
 147 #define         PS_IDLETIMEOUT  29      /* timeout on imap IDLE (internal use) */
 148 #define         PS_UNTAGGED     30      /* untagged response on imap command (internal use) */
 149
 150 /* output noise level */
 151 #define         O_SILENT        0       /* mute, max squelch, etc. */
 152 #define         O_NORMAL        1       /* user-friendly */
 153 #define         O_VERBOSE       2       /* chatty */
 154 #define         O_DEBUG         3       /* prolix */
 155 #define         O_MONITOR       O_VERBOSE
 156
 157 #define         SIZETICKER      1024    /* print 1 dot per this many bytes */
 158
 159 /*
 160  * We #ifdef this and use flag rather than bool
 161  * to avoid a type clash with curses.h
 162  */
 163 #ifndef TRUE
 164 #define FALSE   0
 165 #define TRUE    1
 166 #endif /* TRUE */
 167 typedef char    flag;
 168
 169 /* we need to use zero as a flag-uninitialized value */
 170 #define FLAG_TRUE       2
 171 #define FLAG_FALSE      1
 172
 173 /** run control data */
 174 struct runctl
 175 {
 176     char        *logfile;       /** where to write log information */
 177     char        *idfile;        /** where to store UID data */
 178     char        *pidfile;       /** where to record the PID of daemon mode processes */
 179     const char  *postmaster;
 180     char        *properties;
 181     int         poll_interval;  /** poll interval in seconds (daemon mode, 0 == off) */
 182     flag        bouncemail;
 183     flag        spambounce;
 184     flag        softbounce;
 185     flag        use_syslog;
 186     flag        invisible;
 187     flag        showdots;
 188 };
 189
 190 /** \name idlist */
 191 /** Dual-use entry of singly-linked list for storing id/status or id/id2
 192  * pairs. */
 193 struct idlist
 194 {
 195     char *id;   /**< key */
 196     union
 197     {
 198         struct
 199         {
 200             int         num;
 201             flag        mark;           /**< UID-index information */
 202         }
 203         status;                         /**< value for id/status pairs */
 204         char *id2;                      /**< value for id/id2 pairs */
 205     } val;                              /**< union to store value for key \a id */
 206     struct idlist *next;                /**< pointer to next list element */
 207 };
 208
 209 /** List of possible values for idlist::mark */
 210 enum {
 211 UID_UNSEEN=     0,              /**< id hasn't been seen */
 212 UID_SEEN=       1,              /**< id was seen, but not deleted */
 213 UID_DELETED=    2,              /**< this message has been marked deleted */
 214 UID_EXPUNGED=   3               /**< this message has been expunged */
 215 };
 216 /*@}*/
 217
 218
 219 struct query;
 220
 221 struct method           /* describe methods for protocol state machine */
 222 {
 223     const char *name;           /* protocol name */
 224     const char *service;        /* service port (unencrypted) */
 225     const char *sslservice;     /* service port (SSL) */
 226     flag tagged;                /* if true, generate & expect command tags */
 227     flag delimited;             /* if true, accept "." message delimiter */
 228     int (*parse_response)(int, char *);
 229                                 /* response_parsing function */
 230     int (*getauth)(int, struct query *, char *);
 231                                 /* authorization fetcher */
 232     int (*getrange)(int, struct query *, const char *, int *, int *, int *);
 233                                 /* get message range to fetch */
 234     int (*getsizes)(int, int, int *);
 235                                 /* get sizes of messages */
 236     int (*getpartialsizes)(int, int, int, int *);
 237                                 /* get sizes of subset of messages */
 238     int (*is_old)(int, struct query *, int);
 239                                 /* check for old message */
 240     int (*fetch_headers)(int, struct query *, int, int *);
 241                                 /* fetch header from a given message */
 242     int (*fetch_body)(int, struct query *, int, int *);
 243                                 /* fetch a given message */
 244     int (*trail)(int, struct query *, const char *);
 245                                 /* eat trailer of a message */
 246     int (*delete_msg)(int, struct query *, int);
 247                                 /* delete method */
 248     int (*mark_seen)(int, struct query *, int);
 249                                 /* mark as seen method */
 250     int (*end_mailbox_poll)(int, struct query *);
 251                                 /* end-of-mailbox processing */
 252     int (*logout_cmd)(int, struct query *);
 253                                 /* logout command */
 254     flag retry;                 /* can getrange poll for new messages? */
 255 };
 256
 257 enum badheader { BHREJECT = 0, BHACCEPT };
 258
 259 /* Message retrieval error mode */
 260 enum retrieveerror { RE_ABORT = 0, RE_CONTINUE, RE_MARKSEEN };
 261
 262 struct hostdata         /* shared among all user connections to given server */
 263 {
 264     /* rc file data */
 265     char *pollname;                     /* poll label of host */
 266     char *via;                          /* "true" server name if non-NULL */
 267     struct idlist *akalist;             /* server name first, then akas */
 268     struct idlist *localdomains;        /* list of pass-through domains */
 269     int protocol;                       /* protocol type */
 270     const char *service;                /* service name */
 271     int interval;                       /* # cycles to skip between polls */
 272     int authenticate;                   /* authentication mode to try */
 273     int timeout;                        /* inactivity timout in seconds */
 274     char *envelope;                     /* envelope address list header */
 275     int envskip;                        /* skip to numbered envelope header */
 276     char *qvirtual;                     /* prefix removed from local user id */
 277     flag skip;                          /* suppress poll in implicit mode? */
 278     flag dns;                           /* do DNS lookup on multidrop? */
 279     flag uidl;                          /* use RFC1725 UIDLs? */
 280 #ifdef SDPS_ENABLE
 281     flag sdps;                          /* use Demon Internet SDPS *ENV */
 282 #endif /* SDPS_ENABLE */
 283     flag checkalias;                    /* resolve aliases by comparing IPs? */
 284     flag tracepolls;                    /* if TRUE, add poll trace info to Received */
 285     char *principal;                    /* Kerberos principal for mail service */
 286     char *esmtp_name, *esmtp_password;  /* ESMTP AUTH information */
 287     enum badheader badheader;           /* bad-header {pass|reject} */
 288     enum retrieveerror retrieveerror;   /* retrieve-error (abort|continue|markseen) */
 289
 290 #if defined(linux) || defined(__FreeBSD__)
 291 #define CAN_MONITOR
 292 #endif
 293
 294 #ifdef CAN_MONITOR
 295     char *interface;
 296     char *monitor;
 297     int  monitor_io;
 298     struct interface_pair_s *interface_pair;
 299 #endif
 300
 301     char *plugin,*plugout;
 302
 303     /* computed for internal use */
 304     const struct method *base_protocol; /* relevant protocol method table */
 305     int poll_count;                     /* count of polls so far */
 306     char *queryname;                    /* name to attempt DNS lookup on */
 307     char *truename;                     /* "true name" of server host */
 308     struct sockaddr *trueaddr;          /* IP address of truename */
 309     size_t trueaddr_len;                /* size of trueaddr data */
 310     struct hostdata *lead_server;       /* ptr to lead query for this server */
 311     int esmtp_options;
 312     int workarounds;                    /* track which workarounds the user was warned about */
 313 };
 314
 315 /*
 316  * bit flags to set in workarounds after the corresponding warning,
 317  * which we assume to be server-specific, has been printed,
 318  * so we don't spam our users in daemon mode.
 319  */
 320 #define WKA_TOP (1L << 0)               /* Maillennium TOP -> RETR override warning */
 321
 322 struct query
 323 {
 324     /* mailserver connection controls */
 325     struct hostdata server;
 326
 327     /* per-user data */
 328     struct idlist *localnames;  /* including calling user's name */
 329     int wildcard;               /* should unmatched names be passed through */
 330     char *remotename;           /* remote login name to use */
 331     char *password;             /* remote password to use */
 332     struct idlist *mailboxes;   /* list of mailboxes to check */
 333
 334     /* per-forwarding-target data */
 335     struct idlist *smtphunt;    /* list of SMTP hosts to try forwarding to */
 336     struct idlist *domainlist;  /* domainlist to fetch from */
 337     char *smtpaddress;          /* address to force in RCPT TO */
 338     char *smtpname;             /* full RCPT TO name, including domain */
 339     struct idlist *antispam;    /* list of listener's antispam response */
 340     const char *mda;            /* local MDA to pass mail to */
 341     char *bsmtp;                /* BSMTP output file */
 342     char listener;              /* what's the listener's wire protocol? */
 343 #define SMTP_MODE       'S'
 344 #define LMTP_MODE       'L'
 345     char *preconnect;           /* pre-connection command to execute */
 346     char *postconnect;          /* post-connection command to execute */
 347
 348     /* per-user control flags */
 349     flag keep;                  /* if TRUE, leave messages undeleted */
 350     flag fetchall;              /* if TRUE, fetch all (not just unseen) */
 351     flag flush;                 /* if TRUE, delete messages already seen */
 352     flag limitflush;            /* if TRUE, delete oversized mails */
 353     flag rewrite;               /* if TRUE, canonicalize recipient addresses */
 354     flag stripcr;               /* if TRUE, strip CRs in text */
 355     flag forcecr;               /* if TRUE, force CRs before LFs in text */
 356     flag pass8bits;             /* if TRUE, ignore Content-Transfer-Encoding */
 357     flag dropstatus;            /* if TRUE, drop Status lines in mail */
 358     flag dropdelivered;         /* if TRUE, drop Delivered-To lines in mail */
 359     flag mimedecode;            /* if TRUE, decode MIME-armored messages */
 360     flag idle;                  /* if TRUE, idle after each poll */
 361     int limit;                  /* limit size of retrieved messages */
 362     int warnings;               /* size warning interval */
 363     int fetchlimit;             /* max # msgs to get in single poll */
 364     int fetchsizelimit;         /* max # msg sizes to get in a request */
 365     int fastuidl;               /* do binary search for new UIDLs? */
 366     int fastuidlcount;          /* internal count for frequency of binary search */
 367     int batchlimit;             /* max # msgs to pass in single SMTP session */
 368     int expunge;                /* max # msgs to pass between expunges */
 369     flag use_ssl;               /* use SSL encrypted session */
 370     char *sslkey;               /* optional SSL private key file */
 371     char *sslcert;              /* optional SSL certificate file */
 372     char *sslproto;             /** force transport protocol (ssl2|ssl3|ssl23|tls1) - if NULL,
 373                                   use ssl23 for SSL and opportunistic tls1 for non-SSL connections. */
 374     char *sslcertfile;          /* Trusted certificate file for checking the server cert */
 375     char *sslcertpath;          /* Trusted certificate directory for checking the server cert */
 376     flag sslcertck;             /* Strictly check the server cert. */
 377     char *sslcommonname;        /* CommonName to expect from server */
 378     char *sslfingerprint;       /* Fingerprint to check against */
 379     char *properties;           /* passthrough properties for extensions */
 380
 381     /* internal use -- per-poll state */
 382     flag active;                /* should we actually poll this server? */
 383     char *destaddr;             /* destination host for this query */
 384     int errcount;               /* count transient errors in last pass */
 385     int authfailcount;          /* count of authorization failures */
 386     int wehaveauthed;           /* We've managed to logon at least once! */
 387     int wehavesentauthnote;     /* We've sent an authorization failure note */
 388     int wedged;                 /* wedged by auth failures or timeouts? */
 389     char *smtphost;             /* actual SMTP host we connected to */
 390     char smtphostmode;          /* what's the actual SMTP host's wire protocol? */
 391     int smtp_socket;            /* socket descriptor for SMTP connection */
 392     unsigned int uid;           /* UID of user to deliver to */
 393     struct idlist *skipped;     /* messages skipped on the mail server */
 394     struct idlist *oldsaved, *newsaved;
 395     struct idlist **oldsavedend;
 396     char lastdigest[DIGESTLEN]; /* last MD5 hash seen on this connection */
 397     char *folder;               /* folder currently being polled */
 398
 399     /* internal use -- per-message state */
 400     int mimemsg;                /* bitmask indicating MIME body-type */
 401     unsigned char digest[DIGESTLEN];    /* md5 digest buffer */
 402
 403     /* internal use -- housekeeping */
 404     struct query *next;         /* next query control block in chain */
 405 };
 406
 407 struct msgblk                   /* message header parsed for open_sink() */
 408 {
 409     char                *headers;       /* raw message headers */
 410     struct idlist       *recipients;    /* addressees */
 411     char                return_path[HOSTLEN + USERNAMELEN + 4];
 412     int                 msglen;
 413     int                 reallen;
 414 };
 415
 416
 417 /*
 418  * Numeric option handling.  Numeric option value of zero actually means
 419  * it's unspecified.  Value less than zero is zero.  The reason for this
 420  * screwy encoding is so we can zero out an option block in order to set the
 421  * numeric flags in it to unspecified.
 422  */
 423 #define NUM_VALUE_IN(n)         (((n) == 0) ? -1 : (n))
 424 #define NUM_VALUE_OUT(n)        (((n) < 0) ? 0 : (n))
 425 #define NUM_NONZERO(n)          ((n) > 0)
 426 #define NUM_ZERO(n)             ((n) < 0)
 427 #define NUM_SPECIFIED(n)        ((n) != 0)
 428
 429 #define MULTIDROP(ctl)          ((ctl)->wildcard || \
 430                                  ((ctl)->localnames && (ctl)->localnames->next))
 431
 432 /*
 433  * Note: tags are generated with an a%04d format from a 1-origin
 434  * integer sequence number.  Length 4 permits transaction numbers
 435  * up to 9999, so we force rollover with % 10000.  There's no special
 436  * reason for this format other than to look like the exmples in the
 437  * IMAP RFCs.
 438  */
 439 #define TAGLEN  6               /* 'a' + 4 digits + NUL */
 440 extern char tag[TAGLEN];
 441 #define TAGMOD  10000
 442
 443 /* list of hosts assembled from run control file and command line */
 444 extern struct query cmd_opts, *querylist;
 445
 446 /* what's returned by envquery */
 447 extern void envquery(int, char **);
 448
 449 /* controls the detail level of status/progress messages written to stderr */
 450 extern int outlevel;            /* see the O_.* constants above */
 451 extern int yydebug;             /* enable parse debugging */
 452
 453 /* these get computed */
 454 extern int batchcount;          /* count of messages sent in current batch */
 455 extern flag peek_capable;       /* can we read msgs without setting seen? */
 456
 457 /* miscellaneous global controls */
 458 extern struct runctl run;       /* global controls for this run */
 459 extern flag nodetach;           /* if TRUE, don't detach daemon process */
 460 extern flag quitmode;           /* if --quit was set */
 461 extern int  quitind;            /* optind after position of last --quit option */
 462 extern flag check_only;         /* if --check was set */
 463 extern char *rcfile;            /* path name of rc file */
 464 extern int linelimit;           /* limit # lines retrieved per site */
 465 extern flag versioninfo;        /* emit only version info */
 466 extern char *user;              /* name of invoking user */
 467 extern char *home;              /* home directory of invoking user */
 468 extern char *fmhome;            /* fetchmail home directory */
 469 extern int pass;                /* number of re-polling pass */
 470 extern flag configdump;         /* dump control blocks as Python dictionary */
 471 extern const char *fetchmailhost; /* either "localhost" or an FQDN */
 472 extern int suppress_tags;       /* suppress tags in tagged protocols? */
 473 extern char shroud[PASSWORDLEN*2+3];    /* string to shroud in debug output */
 474 #ifdef SDPS_ENABLE
 475 extern char *sdps_envfrom;
 476 extern char *sdps_envto;
 477 #endif /* SDPS_ENABLE */
 478
 479 extern const char *iana_charset;        /* IANA assigned charset name */
 480
 481 /* from ucs/norm_charmap.c */
 482 const char *norm_charmap(const char *name);
 483
 484 /* prototypes for globally callable functions */
 485
 486 /* from /usr/include/sys/cdefs.h */
 487 #if !defined __GNUC__ || __GNUC__ < 2
 488 # define __attribute__(xyz)    /* Ignore. */
 489 #endif
 490
 491 /* error.c: Error reporting */
 492 #if defined(HAVE_STDARG_H)
 493 void report_init(int foreground);
 494  /** Flush partial message, suppress program name tag for next report printout. */
 495 void report_flush(FILE *fp);
 496 void report (FILE *fp, const char *format, ...)
 497     __attribute__ ((format (printf, 2, 3)))
 498     ;
 499 void report_build (FILE *fp, const char *format, ...)
 500     __attribute__ ((format (printf, 2, 3)))
 501     ;
 502 void report_complete (FILE *fp, const char *format, ...)
 503     __attribute__ ((format (printf, 2, 3)))
 504     ;
 505 void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...)
 506     __attribute__ ((format (printf, 5, 6)))
 507     ;
 508 #else
 509 void report ();
 510 void report_build ();
 511 void report_complete ();
 512 void report_at_line ();
 513 #endif
 514
 515 /* driver.c -- main driver loop */
 516 void set_timeout(int);
 517 int is_idletimeout(void);
 518 void resetidletimeout(void);
 519 int do_protocol(struct query *, const struct method *);
 520
 521 /* transact.c: transaction support */
 522 void init_transact(const struct method *);
 523 int readheaders(int sock,
 524                        long fetchlen,
 525                        long reallen,
 526                        struct query *ctl,
 527                        int num,
 528                        flag *suppress_readbody);
 529 int readbody(int sock, struct query *ctl, flag forward, int len);
 530 #if defined(HAVE_STDARG_H)
 531 void gen_send(int sock, const char *, ... )
 532     __attribute__ ((format (printf, 2, 3)))
 533     ;
 534 int gen_recv(int sock, char *buf, int size);
 535 int gen_transact(int sock, const char *, ... )
 536     __attribute__ ((format (printf, 2, 3)))
 537     ;
 538 #else
 539 void gen_send();
 540 int gen_recv();
 541 int gen_transact();
 542 #endif
 543 extern struct msgblk msgblk;
 544
 545 /* use these to track what was happening when the nonresponse timer fired */
 546 #define GENERAL_WAIT    0       /* unknown wait type */
 547 #define OPEN_WAIT       1       /* waiting from mailserver open */
 548 #define SERVER_WAIT     2       /* waiting for mailserver response */
 549 #define LISTENER_WAIT   3       /* waiting for listener initialization */
 550 #define FORWARDING_WAIT 4       /* waiting for listener response */
 551 extern int phase;
 552
 553 /* response hooks can use this to identify the query stage */
 554 #define STAGE_GETAUTH   0
 555 #define STAGE_GETRANGE  1
 556 #define STAGE_GETSIZES  2
 557 #define STAGE_FETCH     3
 558 #define STAGE_IDLE      4
 559 #define STAGE_LOGOUT    5
 560 extern int stage;
 561
 562 extern int mytimeout;
 563
 564 /* mark values for name lists */
 565 #define XMIT_ACCEPT     1       /* accepted; matches local domain or name */
 566 #define XMIT_REJECT     2       /* rejected; no match */
 567 #define XMIT_RCPTBAD    3       /* SMTP listener rejected the name */
 568
 569 /* idle.c */
 570 int interruptible_idle(int interval);
 571 extern volatile int lastsig;
 572
 573 /* sink.c: forwarding */
 574 void smtp_close(struct query *, int);
 575 int smtp_open(struct query *);
 576 int smtp_setup(struct query *);
 577 char *rcpt_address(struct query *, const char *, int);
 578 int stuffline(struct query *, char *);
 579 int open_sink(struct query*, struct msgblk *, int*, int*);
 580 void release_sink(struct query *);
 581 int close_sink(struct query *, struct msgblk *, flag);
 582 int open_warning_by_mail(struct query *);
 583 #if defined(HAVE_STDARG_H)
 584 void stuff_warning(const char *, struct query *, const char *, ... )
 585     __attribute__ ((format (printf, 3, 4)))
 586     ;
 587 #else
 588 void stuff_warning();
 589 #endif
 590 void close_warning_by_mail(struct query *, struct msgblk *);
 591
 592 /* rfc822.c: RFC822 header parsing */
 593 char *reply_hack(char *, const char *, size_t *);
 594 char *nxtaddr(const char *);
 595
 596 /* uid.c: UID support */
 597 extern int dofastuidl;
 598 void initialize_saved_lists(struct query *hostlist, const char *idfile);
 599 void expunge_uids(struct query *ctl);
 600 void uid_swap_lists(struct query *ctl);
 601 void uid_discard_new_list(struct query *ctl);
 602 void uid_reset_num(struct query *ctl);
 603 void write_saved_lists(struct query *hostlist, const char *idfile);
 604
 605 /* idlist.c */
 606 struct idlist *save_str(struct idlist **idl, const char *str, flag status);
 607 void free_str_list(struct idlist **idl);
 608 void save_str_pair(struct idlist **idl, const char *str1, const char *str2);
 609 struct idlist *str_in_list(struct idlist **idl, const char *str, const flag caseblind);
 610 int str_nr_in_list(struct idlist **idl, const char *str);
 611 int str_nr_last_in_list(struct idlist **idl, const char *str);
 612 void str_set_mark(struct idlist **idl, const char *str, const flag val);
 613 int count_list(struct idlist **idl);
 614 char *str_from_nr_list(struct idlist **idl, long number);
 615 char *str_find(struct idlist **idl, long number);
 616 struct idlist *id_find(struct idlist **idl, long number);
 617 char *idpair_find(struct idlist **idl, const char *id);
 618 int delete_str(struct idlist **idl, long num);
 619 struct idlist *copy_str_list(struct idlist *idl);
 620 void append_str_list(struct idlist **idl, struct idlist **nidl);
 621
 622 /* rcfile_y.y */
 623 int prc_parse_file(const char *, const flag);
 624 int prc_filecheck(const char *, const flag);
 625
 626 /* base64.c */
 627 void to64frombits(char *, const void *, int);
 628 int from64tobits(void *, const char *, int maxlen);
 629
 630 /* unmime.c */
 631 /* Bit-mask returned by MimeBodyType */
 632 #define MSG_IS_7BIT       0x01
 633 #define MSG_IS_8BIT       0x02
 634 #define MSG_NEEDS_DECODE  0x80
 635 extern void UnMimeHeader(char *buf);
 636 extern int  MimeBodyType(char *hdrs, int WantDecode);
 637 extern int  UnMimeBodyline(char **buf, flag delimited, flag issoftline);
 638
 639 /* interface.c */
 640 void interface_init(void);
 641 void interface_parse(char *, struct hostdata *);
 642 void interface_note_activity(struct hostdata *);
 643 int interface_approve(struct hostdata *, flag domonitor);
 644
 645 #include "xmalloc.h"
 646
 647 /* protocol driver and methods */
 648 int doPOP2 (struct query *);
 649 int doPOP3 (struct query *);
 650 int doIMAP (struct query *);
 651 int doETRN (struct query *);
 652 int doODMR (struct query *);
 653
 654 /* authentication functions */
 655 int do_cram_md5(int sock, const char *command, struct query *ctl, const char *strip);
 656 int do_rfc1731(int sock, const char *command, const char *truename);
 657 int do_gssauth(int sock, const char *command, const char *service, const char *hostname, const char *username);
 658 int do_otp(int sock, const char *command, struct query *ctl);
 659
 660 /* miscellanea */
 661
 662 /* these should be of size PATH_MAX */
 663 extern char currentwd[1024], rcfiledir[1024];
 664
 665 struct query *hostalloc(struct query *);
 666 int parsecmdline (int, char **, struct runctl *, struct query *);
 667 char *prependdir (const char *, const char *);
 668 char *MD5Digest (unsigned const char *);
 669 void hmac_md5 (const unsigned char *, size_t, const unsigned char *, size_t, unsigned char *, size_t);
 670 int POP3_auth_rpa(char *, char *, int socket);
 671 typedef RETSIGTYPE (*SIGHANDLERTYPE) (int);
 672 void deal_with_sigchld(void);
 673 RETSIGTYPE null_signal_handler(int sig);
 674 SIGHANDLERTYPE set_signal_handler(int sig, SIGHANDLERTYPE handler);
 675 int daemonize(const char *);
 676 char *fm_getpassword(char *);
 677 void escapes(const char *, char *);
 678 char *visbuf(const char *);
 679 const char *showproto(int);
 680 void dump_config(struct runctl *runp, struct query *querylist);
 681 int is_host_alias(const char *, struct query *, struct addrinfo **);
 682
 683 extern struct addrinfo *ai0, *ai1;
 684
 685 /** Try to obtain fully qualified hostname of current host. Exit with
 686  * PS_DNS if \a required is true and there is a DNS error. Exit with
 687  * PS_DNS if gethostname() fails, independent of the value of \a
 688  * required.
 689  * \return
 690  * - fully qualified hostname if \a required is non-zero.
 691  * - unqualified or fully qualified hostname if \a required is zero (0).
 692  */
 693 char *host_fqdn(int required /** exit with PS_DNS if the name cannot be qualified */);
 694 char *rfc822timestamp(void);
 695 flag is_a_file(int);
 696 char *rfc2047e(const char*, const char *);
 697
 698 void yyerror(const char *);
 699 int yylex(void);
 700
 701 #ifdef __EMX__
 702 void itimerthread(void*);
 703 /* Have to include these first to avoid errors from redefining getcwd
 704    and chdir.  They're re-include protected in EMX, so it's okay, I
 705    guess.  */
 706 #include <stdlib.h>
 707 #include <unistd.h>
 708 /* Redefine getcwd and chdir to get drive-letter support so we can
 709    find all of our lock files and stuff. */
 710 #define getcwd _getcwd2
 711 #define chdir _chdir2
 712 #endif /* _EMX_ */
 713
 714 #ifdef HAVE_STRERROR
 715 #  if !defined(strerror) && !defined(HAVE_DECL_STRERROR)        /* On some systems, strerror is a macro */
 716 char *strerror (int);
 717 #  endif
 718 #endif /* HAVE_STRERROR */
 719
 720 #define STRING_DISABLED (char *)-1
 721 #define STRING_DUMMY    ""
 722
 723 #ifdef NeXT
 724 #ifndef S_IXGRP
 725 #define S_IXGRP 0000010
 726 #endif
 727 #endif
 728
 729 #ifndef HAVE_STPCPY
 730 char *stpcpy(char *, const char*);
 731 #endif
 732
 733 #ifdef __CYGWIN__
 734 #define ROOT_UID 18
 735 #else /* !__CYGWIN__ */
 736 #define ROOT_UID 0
 737 #endif /* __CYGWIN__ */
 738
 739 extern int mailserver_socket_temp;
 740 extern const char *program_name;
 741
 742 /* POSIX space characters,
 743  * <tab>;<newline>;<vertical-tab>;<form-feed>;<carriage-return>;<space> */
 744 #define POSIX_space "\t\n\v\f\r "
 745
 746 /* strlcpy/strlcat prototypes */
 747 #ifndef HAVE_STRLCAT
 748 size_t
 749 strlcat(char *dst, const char *src, size_t siz);
 750 #endif
 751 #ifndef HAVE_STRLCPY
 752 size_t
 753 strlcpy(char *dst, const char *src, size_t siz);
 754 #endif
 755
 756 /** Resolve the a TCP service name or a string containing only a decimal
 757  * positive integer to a port number. Returns -1 for error. */
 758 int servport(const char *service);
 759
 760 #ifndef HAVE_GETNAMEINFO
 761 # define NI_NUMERICHOST 1
 762 # define NI_NUMERICSERV 2
 763 # define NI_NOFQDN      4
 764 # define NI_NAMEREQD    8
 765 # define NI_DGRAM       16
 766 #endif
 767
 768 int fm_getaddrinfo(const char *node, const char *serv, const struct addrinfo *hints, struct addrinfo **res);
 769 void fm_freeaddrinfo(struct addrinfo *ai);
 770
 771 /* prototypes from tls.c */
 772 int maybe_tls(struct query *ctl);
 773 int must_tls(struct query *ctl);
 774
 775 /* prototype from rfc822valid.c */
 776 int rfc822_valid_msgid(const unsigned char *);
 777
 778 /* macro to determine if we want to spam progress to stdout */
 779 #define want_progress() \
 780         ((outlevel >= O_VERBOSE || (outlevel > O_SILENT && run.showdots)) \
 781         && !run.use_syslog \
 782         && (run.showdots || !is_a_file(1)))
 783
 784 #endif
 785 /* fetchmail.h ends here */