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