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