]> Pileus Git - ~andy/fetchmail/blobdiff - fetchmail.h
Rename lock_release to fm_lock_release, to avoid namespace collision on
[~andy/fetchmail] / fetchmail.h
index d469d3c2b2d8a64c9daadefde7417a94bfdf0640..74121bd5ea898d2f68596859f993702474ff1bd5 100644 (file)
@@ -5,6 +5,33 @@
 /* We need this for HAVE_STDARG_H, etc */
 #include "config.h"
 
+/* We need this for size_t */
+#include <sys/types.h>
+
+/* We need this for time_t */
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+#  include <sys/time.h>
+# else
+#  include <time.h>
+# endif
+#endif
+
+#include <stdio.h>
+
+/* Import Trio if needed */
+#if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
+#  include "trio/trio.h"
+#endif
+
+/* We need this for strstr */
+#if !defined(HAVE_STRSTR) && !defined(strstr)
+char *strstr(const char *, const char *);
+#endif
+
 /* constants designating the various supported protocols */
 #define                P_AUTO          1
 #define                P_POP2          2
 #define                P_APOP          4
 #define                P_RPOP          5
 #define                P_IMAP          6
-#define                P_IMAP_K4       7
-#define                P_IMAP_GSS      8
-#define                P_IMAP_CRAM_MD5 9
-#define                P_IMAP_LOGIN    10
-#define                P_ETRN          11
+#define                P_ETRN          7
+#define                P_ODMR          8
 
-#if INET6_ENABLE
+#ifdef INET6_ENABLE
 #define                SMTP_PORT       "smtp"
 #define                KPOP_PORT       "kpop"
 #else /* INET6_ENABLE */
 #define                SPOP3_PORT      995
 #endif
 
-/* preauthentication types */
-#define                A_PASSWORD      0       /* password or inline authentication */
-#define                A_KERBEROS_V4   1       /* preauthenticate w/ Kerberos V4 */
-#define                A_KERBEROS_V5   2       /* preauthenticate w/ Kerberos V5 */
-#define                A_SSH           3       /* preauthentication at session level */
+/* 
+ * We need to distinguish between mailbox and mailbag protocols.
+ * Under a mailbox protocol wwe're pulling mail for a speecific user.
+ * Under a mailbag protocol we're fetching mail for an entire domain.
+ */
+#define MAILBOX_PROTOCOL(ctl)  ((ctl)->server.protocol < P_ETRN)
+
+/* authentication types */
+#define                A_ANY           0       /* use the first method that works */
+#define                A_PASSWORD      1       /* password authentication */
+#define                A_NTLM          2       /* Microsoft NTLM protocol */
+#define                A_CRAM_MD5      3       /* CRAM-MD5 shrouding (RFC2195) */
+#define                A_OTP           4       /* One-time password (RFC1508) */
+#define                A_KERBEROS_V4   5       /* authenticate w/ Kerberos V4 */
+#define                A_KERBEROS_V5   6       /* authenticate w/ Kerberos V5 */
+#define        A_GSSAPI        7       /* authenticate with GSSAPI */
+#define                A_SSH           8       /* authentication at session level */
+
+/* some protocols (KERBEROS, GSSAPI, SSH) don't require a password */
+#define NO_PASSWORD(ctl)       ((ctl)->server.authenticate > A_OTP || (ctl)->server.protocol == P_ETRN)
 
 /*
  * Definitions for buffer sizes.  We get little help on setting maxima
 #define                PS_DNS          11      /* fatal DNS error */
 #define                PS_BSMTP        12      /* output batch could not be opened */
 #define                PS_MAXFETCH     13      /* poll ended by fetch limit */
+#define                PS_SERVBUSY     14      /* server is busy */
 /* leave space for more codes */
 #define                PS_UNDEFINED    23      /* something I hadn't thought of */
 #define                PS_TRANSIENT    24      /* transient failure (internal use) */
 #define                PS_REFUSED      25      /* mail refused (internal use) */
 #define                PS_RETAINED     26      /* message retained (internal use) */
 #define                PS_TRUNCATED    27      /* headers incomplete (internal use) */
+#define                PS_REPOLL       28      /* repoll immediately with changed parameters (internal use) */
+#define                PS_IDLETIMEOUT  29      /* timeout on imap IDLE (internal use) */
 
 /* output noise level */
 #define         O_SILENT       0       /* mute, max squelch, etc. */
@@ -115,19 +157,21 @@ struct runctl
     int                poll_interval;
     char       *postmaster;
     flag       bouncemail;
+    flag       spambounce;
     char       *properties;
     flag       use_syslog;
     flag       invisible;
+    flag       showdots;
 };
 
 struct idlist
 {
-    char *id;
+    unsigned char *id;
     union
     {
        struct
        {
-           short       num;
+           int         num;
            flag        mark;           /* UID-index information */
 #define UID_UNSEEN     0               /* hasn't been seen */
 #define UID_SEEN       1               /* seen, but not deleted */
@@ -135,7 +179,7 @@ struct idlist
 #define UID_EXPUNGED   3               /* this message has been expunged */ 
         }
        status;
-       char *id2;
+       unsigned char *id2;
     } val;
     struct idlist *next;
 };
@@ -145,7 +189,7 @@ struct query;
 struct method          /* describe methods for protocol state machine */
 {
     const char *name;          /* protocol name */
-#if INET6_ENABLE
+#ifdef INET6_ENABLE
     const char *service;
     const char *sslservice;
 #else /* INET6_ENABLE */
@@ -156,14 +200,14 @@ struct method             /* describe methods for protocol state machine */
     flag delimited;            /* if true, accept "." message delimiter */
     int (*parse_response)(int, char *);
                                /* response_parsing function */
-    int (*password_canonify)(char *, char *, int);
-                               /* canonicalize password */
     int (*getauth)(int, struct query *, char *);
                                /* authorization fetcher */
     int (*getrange)(int, struct query *, const char *, int *, int *, int *);
                                /* get message range to fetch */
     int (*getsizes)(int, int, int *);
                                /* get sizes of messages */
+    int (*getpartialsizes)(int, int, int, int *);
+                               /* get sizes of subset of messages */
     int (*is_old)(int, struct query *, int);
                                /* check for old message */
     int (*fetch_headers)(int, struct query *, int, int *);
@@ -174,6 +218,8 @@ struct method               /* describe methods for protocol state machine */
                                /* eat trailer of a message */
     int (*delete)(int, struct query *, int);
                                /* delete method */
+    int (*mark_seen)(int, struct query *, int);
+                               /* mark as seen method */
     int (*logout_cmd)(int, struct query *);
                                /* logout command */
     flag retry;                        /* can getrange poll for new messages? */
@@ -187,14 +233,14 @@ struct hostdata           /* shared among all user connections to given server */
     struct idlist *akalist;            /* server name first, then akas */
     struct idlist *localdomains;       /* list of pass-through domains */
     int protocol;                      /* protocol type */
-#if INET6_ENABLE
+#ifdef INET6_ENABLE
     char *service;                     /* IPv6 service name */
     void *netsec;                      /* IPv6 security request */
 #else /* INET6_ENABLE */
     int port;                          /* TCP/IP service port number */
 #endif /* INET6_ENABLE */
     int interval;                      /* # cycles to skip between polls */
-    int preauthenticate;               /* preauthentication mode to try */
+    int authenticate;                  /* authentication mode to try */
     int timeout;                       /* inactivity timout in seconds */
     char *envelope;                    /* envelope address list header */
     int envskip;                       /* skip to numbered envelope header */
@@ -205,8 +251,10 @@ struct hostdata            /* shared among all user connections to given server */
 #ifdef SDPS_ENABLE
     flag sdps;                         /* use Demon Internet SDPS *ENV */
 #endif /* SDPS_ENABLE */
-    flag checkalias;                   /* resolve aliases by comparing IPs? */
-
+    flag checkalias;                   /* resolve aliases by comparing IPs? */
+    flag tracepolls;                   /* if TRUE, add poll trace info to Received */
+    char *principal;                   /* Kerberos principal for mail service */
+    char *esmtp_name, *esmtp_password; /* ESMTP AUTH information */
 
 #if defined(linux) || defined(__FreeBSD__)
     char *interface;
@@ -222,6 +270,7 @@ struct hostdata             /* shared among all user connections to given server */
     int poll_count;                    /* count of polls so far */
     char *queryname;                   /* name to attempt DNS lookup on */
     char *truename;                    /* "true name" of server host */
+    char *trueaddr;                     /* IP address of truename, as char */
     struct hostdata *lead_server;      /* ptr to lead query for this server */
     int esmtp_options;
 };
@@ -240,7 +289,9 @@ struct query
 
     /* per-forwarding-target data */
     struct idlist *smtphunt;   /* list of SMTP hosts to try forwarding to */
+    struct idlist *domainlist; /* domainlist to fetch from */
     char *smtpaddress;         /* address to force in RCPT TO */ 
+    char *smtpname;             /* full RCPT TO name, including domain */
     struct idlist *antispam;   /* list of listener's antispam response */
     char *mda;                 /* local MDA to pass mail to */
     char *bsmtp;               /* BSMTP output file */
@@ -259,16 +310,24 @@ struct query
     flag forcecr;              /* if TRUE, force CRs before LFs in text */
     flag pass8bits;            /* if TRUE, ignore Content-Transfer-Encoding */
     flag dropstatus;           /* if TRUE, drop Status lines in mail */
+    flag dropdelivered;         /* if TRUE, drop Delivered-To lines in mail */
     flag mimedecode;           /* if TRUE, decode MIME-armored messages */
     flag idle;                 /* if TRUE, idle after each poll */
     int        limit;                  /* limit size of retrieved messages */
     int warnings;              /* size warning interval */
     int        fetchlimit;             /* max # msgs to get in single poll */
+    int fetchsizelimit;                /* max # msg sizes to get in a request */
+    int fastuidl;              /* do binary search for new UIDLs? */
+    int fastuidlcount;         /* internal count for frequency of binary search */
     int        batchlimit;             /* max # msgs to pass in single SMTP session */
     int        expunge;                /* max # msgs to pass between expunges */
     flag use_ssl;              /* use SSL encrypted session */
     char *sslkey;              /* optional SSL private key file */
     char *sslcert;             /* optional SSL certificate file */
+       char *sslproto;         /* force usage of protocol (ssl2|ssl3|tls1) - defaults to ssl23 */
+    char *sslcertpath;         /* Trusted certificate directory for checking the server cert */
+    flag sslcertck;            /* Strictly check the server cert. */
+    char *sslfingerprint;      /* Fingerprint to check against */
     char *properties;          /* passthrough properties for extensions */
 
     /* internal use -- per-poll state */
@@ -276,17 +335,20 @@ struct query
     const char *destaddr;      /* destination host for this query */
     int errcount;              /* count transient errors in last pass */
     int authfailcount;         /* count of authorization failures */
+    int wehaveauthed;          /* We've managed to logon at least once! */
+    int wehavesentauthnote;    /* We've sent an authorization failure note */
     int wedged;                        /* wedged by auth failures or timeouts? */
     char *smtphost;            /* actual SMTP host we connected to */
     int smtp_socket;           /* socket descriptor for SMTP connection */
     unsigned int uid;          /* UID of user to deliver to */
     struct idlist *skipped;    /* messages skipped on the mail server */
     struct idlist *oldsaved, *newsaved;
-    char *lastid;              /* last Message-ID seen on this connection */
+    struct idlist **oldsavedend;
+    char lastdigest[DIGESTLEN];        /* last MD5 hash seen on this connection */
 
     /* internal use -- per-message state */
     int mimemsg;               /* bitmask indicating MIME body-type */
-    char digest [DIGESTLEN];   /* md5 digest buffer */
+    char digest[DIGESTLEN];    /* md5 digest buffer */
 
     /* internal use -- housekeeping */
     struct query *next;                /* next query control block in chain */
@@ -297,6 +359,7 @@ struct msgblk                       /* message header parsed for open_sink() */
     char               *headers;       /* raw message headers */
     struct idlist      *recipients;    /* addressees */
     char               return_path[HOSTLEN + USERNAMELEN + 4]; 
+    int                        msglen;
     int                        reallen;
 };
 
@@ -351,24 +414,44 @@ extern int linelimit;             /* limit # lines retrieved per site */
 extern flag versioninfo;       /* emit only version info */
 extern char *user;             /* name of invoking user */
 extern char *home;             /* home directory of invoking user */
+extern char *fmhome;           /* fetchmail home directory */
 extern int pass;               /* number of re-polling pass */
 extern flag configdump;                /* dump control blocks as Python dictionary */
-extern const char *fetchmailhost;
-                               /* either "localhost" or an FQDN */
+extern char *fetchmailhost;    /* either "localhost" or an FQDN */
+extern int suppress_tags;      /* suppress tags in tagged protocols? */
+extern char shroud[PASSWORDLEN*2+3];   /* string to shroud in debug output */
 #ifdef SDPS_ENABLE
 extern char *sdps_envfrom;
 extern char *sdps_envto;
 #endif /* SDPS_ENABLE */
 
+extern const char *iana_charset;       /* IANA assigned charset name */
+
+/* from ucs/norm_charmap.c */
+const char *norm_charmap(const char *name);
+
 /* prototypes for globally callable functions */
 
+/* from /usr/include/sys/cdefs.h */
+#if !defined __GNUC__ || __GNUC__ < 2
+# define __attribute__(xyz)    /* Ignore. */
+#endif
+
 /* error.c: Error reporting */
 #if defined(HAVE_STDARG_H)
 void report_init(int foreground);
-void report (FILE *fp, const char *format, ...);
-void report_build (FILE *fp, const char *format, ...);
-void report_complete (FILE *fp, const char *format, ...);
-void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...);
+void report (FILE *fp, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
+void report_build (FILE *fp, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
+void report_complete (FILE *fp, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
+void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...)
+    __attribute__ ((format (printf, 5, 6)))
+    ;
 #else
 void report ();
 void report_build ();
@@ -376,17 +459,43 @@ void report_complete ();
 void report_at_line ();
 #endif
 
-/* driver.c: transaction support */
+/* driver.c -- main driver loop */
 void set_timeout(int);
+int isidletimeout(void);
+void resetidletimeout(void);
+int do_protocol(struct query *, const struct method *);
+
+/* transact.c: transaction support */
+void init_transact(const struct method *);
+int readheaders(int sock,
+                      long fetchlen,
+                      long reallen,
+                      struct query *ctl,
+                      int num,
+                      flag *suppress_readbody);
+int readbody(int sock, struct query *ctl, flag forward, int len);
 #if defined(HAVE_STDARG_H)
-void gen_send (int sock, const char *, ... );
+void gen_send(int sock, const char *, ... )
+    __attribute__ ((format (printf, 2, 3)))
+    ;
 int gen_recv(int sock, char *buf, int size);
-int gen_transact (int sock, const char *, ... );
+int gen_transact(int sock, const char *, ... )
+    __attribute__ ((format (printf, 2, 3)))
+    ;
 #else
-void gen_send ();
+void gen_send();
 int gen_recv();
-int gen_transact ();
+int gen_transact();
 #endif
+extern struct msgblk msgblk;
+
+/* lock.c: concurrency locking */
+void lock_setup(void);
+void lock_assert(void);
+void lock_or_die(void);
+void fm_lock_release(void);
+int lock_state(void);
+void lock_dispose(void);
 
 /* use these to track what was happening when the nonresponse timer fired */
 #define GENERAL_WAIT   0       /* unknown wait type */
@@ -401,9 +510,12 @@ extern int phase;
 #define STAGE_GETRANGE 1
 #define STAGE_GETSIZES 2
 #define STAGE_FETCH    3
-#define STAGE_LOGOUT   4
+#define STAGE_IDLE     4
+#define STAGE_LOGOUT   5
 extern int stage;
 
+extern int mytimeout;
+
 /* mark values for name lists */
 #define XMIT_ACCEPT    1       /* accepted; matches local domain or name */
 #define XMIT_REJECT    2       /* rejected; no match */
@@ -411,43 +523,54 @@ extern int stage;
 
 /* idle.c */
 int interruptible_idle(int interval);
+extern volatile int lastsig;
 
 /* sink.c: forwarding */
+void smtp_close(struct query *, int);
+int smtp_open(struct query *);
+char *rcpt_address(struct query *, const char *, int);
 int stuffline(struct query *, char *);
 int open_sink(struct query*, struct msgblk *, int*, int*);
 void release_sink(struct query *);
 int close_sink(struct query *, struct msgblk *, flag);
 int open_warning_by_mail(struct query *, struct msgblk *);
 #if defined(HAVE_STDARG_H)
-void stuff_warning(struct query *, const char *, ... );
+void stuff_warning(const char *, struct query *, const char *, ... )
+    __attribute__ ((format (printf, 3, 4)))
+    ;
 #else
 void stuff_warning();
 #endif
 void close_warning_by_mail(struct query *, struct msgblk *);
 
 /* rfc822.c: RFC822 header parsing */
-char *reply_hack(char *, const char *);
-char *nxtaddr(const char *);
+unsigned char *reply_hack(unsigned char *, const unsigned char *, size_t *);
+unsigned char *nxtaddr(const unsigned char *);
 
 /* uid.c: UID support */
+extern int dofastuidl;
+
 void initialize_saved_lists(struct query *, const char *);
 struct idlist *save_str(struct idlist **, const char *, flag);
 void free_str_list(struct idlist **);
 struct idlist *copy_str_list(struct idlist *idl);
 void save_str_pair(struct idlist **, const char *, const char *);
 void free_str_pair_list(struct idlist **);
-int delete_str(struct idlist **, int);
-int str_in_list(struct idlist **, const char *, const flag);
+int delete_str(struct idlist **, long);
+struct idlist *str_in_list(struct idlist **, const char *, const flag);
 int str_nr_in_list(struct idlist **, const char *);
 int str_nr_last_in_list(struct idlist **, const char *);
 void str_set_mark( struct idlist **, const char *, const flag);
 int count_list( struct idlist **idl );
-char *str_from_nr_list( struct idlist **idl, int number );
-char *str_find(struct idlist **, int);
+char *str_from_nr_list( struct idlist **idl, long number );
+char *str_find(struct idlist **, long);
+struct idlist *id_find(struct idlist **idl, long);
 char *idpair_find(struct idlist **, const char *);
 void append_str_list(struct idlist **, struct idlist **);
 void expunge_uids(struct query *);
-void uid_end_query(struct query *);
+void uid_swap_lists(struct query *);
+void uid_discard_new_list(struct query *ctl);
+void uid_reset_num(struct query *ctl);
 void write_saved_lists(struct query *, const char *);
 
 /* rcfile_y.y */
@@ -456,7 +579,7 @@ int prc_filecheck(const char *, const flag);
 
 /* base64.c */
 void to64frombits(unsigned char *, const unsigned char *, int);
-int from64tobits(char *, const char *);
+int from64tobits(char *, const char *, int maxlen);
 
 /* unmime.c */
 /* Bit-mask returned by MimeBodyType */
@@ -471,7 +594,7 @@ extern int  UnMimeBodyline(unsigned char **buf, flag delimited, flag issoftline)
 void interface_init(void);
 void interface_parse(char *, struct hostdata *);
 void interface_note_activity(struct hostdata *);
-int interface_approve(struct hostdata *);
+int interface_approve(struct hostdata *, flag domonitor);
 
 /* xmalloc.c */
 #if defined(HAVE_VOIDPOINTER)
@@ -479,32 +602,56 @@ int interface_approve(struct hostdata *);
 #else
 #define XMALLOCTYPE char
 #endif
-XMALLOCTYPE *xmalloc(int);
-XMALLOCTYPE *xrealloc(XMALLOCTYPE *, int);
+XMALLOCTYPE *xmalloc(size_t);
+XMALLOCTYPE *xrealloc(/*@null@*/ XMALLOCTYPE *, size_t);
 char *xstrdup(const char *);
 #if defined(HAVE_ALLOCA_H)
 #include <alloca.h>
 #else
 #ifdef _AIX
- #pragma alloca
+#pragma alloca
 #endif
 #endif
-#define        xalloca(ptr, t, n)      if (!(ptr = (t) alloca(n))) {report(stderr, "alloca failed"); exit(PS_UNDEFINED);}
+#define        xalloca(ptr, t, n)      if (!(ptr = (t) alloca(n)))\
+       {report(stderr, GT_("alloca failed")); exit(PS_UNDEFINED);}
+#if 0
+/*
+ * This is a hack to help xgettext which cannot find strings in
+ * macro definitions like the one for xalloca above.
+ */
+static char *dummy = gettext_noop("alloca failed");
+#endif
 
 /* protocol driver and methods */
-int do_protocol(struct query *, const struct method *);
 int doPOP2 (struct query *); 
 int doPOP3 (struct query *);
 int doIMAP (struct query *);
 int doETRN (struct query *);
+int doODMR (struct query *);
+
+/* authentication functions */
+int do_cram_md5(int sock, char *command, struct query *ctl, char *strip);
+int do_rfc1731(int sock, char *command, char *truename);
+int do_gssauth(int sock, char *command, char *service, char *hostname, char *username);
+int do_otp(int sock, char *command, struct query *ctl);
 
 /* miscellanea */
+
+/* these should be of size PATH_MAX */
+extern char currentwd[1024], rcfiledir[1024];
+
 struct query *hostalloc(struct query *); 
 int parsecmdline (int, char **, struct runctl *, struct query *);
+char *prependdir (const char *, const char *);
 char *MD5Digest (unsigned char *);
+void hmac_md5 (unsigned char *, size_t, unsigned char *, size_t, unsigned char *, size_t);
 int POP3_auth_rpa(unsigned char *, unsigned char *, int socket);
+typedef RETSIGTYPE (*SIGHANDLERTYPE) (int);
+void deal_with_sigchld(void);
+RETSIGTYPE null_signal_handler(int sig);
+SIGHANDLERTYPE set_signal_handler(int sig, SIGHANDLERTYPE handler);
 int daemonize(const char *, void (*)(int));
-char *getpassword(char *);
+char *fm_getpassword(char *);
 void escapes(const char *, char *);
 char *visbuf(const char *);
 const char *showproto(int);
@@ -512,6 +659,8 @@ void dump_config(struct runctl *runp, struct query *querylist);
 int is_host_alias(const char *, struct query *);
 char *host_fqdn(void);
 char *rfc822timestamp(void);
+flag isafile(int);
+char *rfc2047e(const char*, const char *);
 
 void yyerror(const char *);
 int yylex(void);
@@ -531,7 +680,7 @@ void itimerthread(void*);
 
 # if HAVE_STRERROR
 #  ifndef strerror             /* On some systems, strerror is a macro */
-char *strerror ();
+char *strerror (int);
 #  endif
 # endif /* HAVE_STRERROR */
 
@@ -544,4 +693,43 @@ char *strerror ();
 #endif
 #endif
 
+#ifndef HAVE_STPCPY
+char *stpcpy(char *, const char*);
+#endif
+
+#ifdef FETCHMAIL_DEBUG
+#define exit(e) do { \
+       FILE *out; \
+       out = fopen("/tmp/fetchmail.log", "a"); \
+       fprintf(out, \
+               "Exiting fetchmail from file %s, line %d with status %d\n", \
+               __FILE__, __LINE__, e); \
+       fclose(out); \
+       _exit(e); \
+       } while(0)
+#endif /* FETCHMAIL_DEBUG */
+
+#ifdef __CYGWIN__
+#define ROOT_UID 18
+#else /* !__CYGWIN__ */
+#define ROOT_UID 0
+#endif /* __CYGWIN__ */
+
+extern int mailserver_socket_temp;
+extern char *program_name;
+
+/* POSIX space characters,
+ * <tab>;<newline>;<vertical-tab>;<form-feed>;<carriage-return>;<space> */
+#define POSIX_space "\t\n\v\f\r "
+
+/* strlcpy/strlcat prototypes */
+#ifndef HAVE_STRLCAT
+size_t
+strlcat(char *dst, const char *src, size_t siz);
+#endif
+#ifndef HAVE_STRLCPY
+size_t
+strlcpy(char *dst, const char *src, size_t siz);
+#endif
+
 /* fetchmail.h ends here */