X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=fetchmail.h;h=d759d391e6bbd7d4de651e67d2669b2a08e81922;hb=53293ee30678d3db753e51820cc554c0b2b1bd97;hp=3b673865be46f3518dc24f3ee88e725c78050f4c;hpb=cdd6a567ea8b77e6636e8368822b253fb622a025;p=~andy%2Ffetchmail diff --git a/fetchmail.h b/fetchmail.h index 3b673865..d759d391 100644 --- a/fetchmail.h +++ b/fetchmail.h @@ -8,6 +8,8 @@ /* We need this for HAVE_STDARG_H, etc */ #include "config.h" +struct addrinfo; + /* We need this for size_t */ #include @@ -23,6 +25,13 @@ # endif #endif +#ifdef HAVE_SYS_SOCKET_H +#include +#endif +#ifdef HAVE_NET_SOCKET_H +#include +#endif +#include #include /* Import Trio if needed */ @@ -35,6 +44,8 @@ char *strstr(const char *, const char *); #endif +#include "fm_strl.h" + /* constants designating the various supported protocols */ #define P_AUTO 1 #define P_POP2 2 @@ -72,6 +83,7 @@ char *strstr(const char *, const char *); #define A_GSSAPI 7 /* authenticate with GSSAPI */ #define A_SSH 8 /* authentication at session level */ #define A_MSN 9 /* same as NTLM with keyword MSN */ +#define A_EXTERNAL 10 /* external authentication (client cert) */ /* some protocols or authentication types (KERBEROS, GSSAPI, SSH) don't * require a password */ @@ -81,6 +93,7 @@ char *strstr(const char *, const char *); || (ctl)->server.authenticate == A_KERBEROS_V5 \ || (ctl)->server.authenticate == A_GSSAPI \ || (ctl)->server.authenticate == A_SSH \ + || (ctl)->server.authenticate == A_EXTERNAL \ || (ctl)->server.protocol == P_ETRN) /* @@ -110,6 +123,8 @@ char *strstr(const char *, const char *); #define DIGESTLEN 33 /* length of MD5 digest */ /* exit code values */ +/* NOTE THAT PS_SUCCESS MUST ALWAYS BE 0 - SOME PARTS OF THE CODE + * RELY ON THIS VALUE! */ #define PS_SUCCESS 0 /* successful receipt of messages */ #define PS_NOMAIL 1 /* no mail available */ #define PS_SOCKET 2 /* socket I/O woes */ @@ -130,9 +145,9 @@ char *strstr(const char *, const char *); #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) */ +#define PS_UNTAGGED 30 /* untagged response on imap command (internal use) */ /* output noise level */ #define O_SILENT 0 /* mute, max squelch, etc. */ @@ -157,39 +172,51 @@ typedef char flag; #define FLAG_TRUE 2 #define FLAG_FALSE 1 +/** run control data */ struct runctl { - char *logfile; - char *idfile; - int poll_interval; - char *postmaster; + char *logfile; /** where to write log information */ + char *idfile; /** where to store UID data */ + char *pidfile; /** where to record the PID of daemon mode processes */ + const char *postmaster; + char *properties; + int poll_interval; /** poll interval in seconds (daemon mode, 0 == off) */ flag bouncemail; flag spambounce; - char *properties; + flag softbounce; flag use_syslog; flag invisible; flag showdots; }; +/** \name idlist */ +/** Dual-use entry of singly-linked list for storing id/status or id/id2 + * pairs. */ struct idlist { - unsigned char *id; + char *id; /**< key */ union { struct { int num; - flag mark; /* UID-index information */ -#define UID_UNSEEN 0 /* hasn't been seen */ -#define UID_SEEN 1 /* seen, but not deleted */ -#define UID_DELETED 2 /* this message has been deleted */ -#define UID_EXPUNGED 3 /* this message has been expunged */ + flag mark; /**< UID-index information */ } - status; - unsigned char *id2; - } val; - struct idlist *next; + status; /**< value for id/status pairs */ + char *id2; /**< value for id/id2 pairs */ + } val; /**< union to store value for key \a id */ + struct idlist *next; /**< pointer to next list element */ +}; + +/** List of possible values for idlist::mark */ +enum { +UID_UNSEEN= 0, /**< id hasn't been seen */ +UID_SEEN= 1, /**< id was seen, but not deleted */ +UID_DELETED= 2, /**< this message has been marked deleted */ +UID_EXPUNGED= 3 /**< this message has been expunged */ }; +/*@}*/ + struct query; @@ -213,12 +240,12 @@ struct method /* describe methods for protocol state machine */ int (*is_old)(int, struct query *, int); /* check for old message */ int (*fetch_headers)(int, struct query *, int, int *); - /* fetch FROM headera given message */ + /* fetch header from a given message */ int (*fetch_body)(int, struct query *, int, int *); /* fetch a given message */ - int (*trail)(int, struct query *, int, const char *); + int (*trail)(int, struct query *, const char *); /* eat trailer of a message */ - int (*delete)(int, struct query *, int); + int (*delete_msg)(int, struct query *, int); /* delete method */ int (*mark_seen)(int, struct query *, int); /* mark as seen method */ @@ -229,6 +256,8 @@ struct method /* describe methods for protocol state machine */ flag retry; /* can getrange poll for new messages? */ }; +enum badheader { BHREJECT = 0, BHACCEPT }; + struct hostdata /* shared among all user connections to given server */ { /* rc file data */ @@ -237,7 +266,7 @@ 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 */ - char *service; /* service name */ + const char *service; /* service name */ int interval; /* # cycles to skip between polls */ int authenticate; /* authentication mode to try */ int timeout; /* inactivity timout in seconds */ @@ -254,6 +283,7 @@ struct hostdata /* shared among all user connections to given server */ 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 */ + enum badheader badheader; /* bad-header {pass|reject} */ #if defined(linux) || defined(__FreeBSD__) #define CAN_MONITOR @@ -277,8 +307,16 @@ struct hostdata /* shared among all user connections to given server */ size_t trueaddr_len; /* size of trueaddr data */ struct hostdata *lead_server; /* ptr to lead query for this server */ int esmtp_options; + int workarounds; /* track which workarounds the user was warned about */ }; +/* + * bit flags to set in workarounds after the corresponding warning, + * which we assume to be server-specific, has been printed, + * so we don't spam our users in daemon mode. + */ +#define WKA_TOP (1L << 0) /* Maillennium TOP -> RETR override warning */ + struct query { /* mailserver connection controls */ @@ -297,7 +335,7 @@ struct query 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 */ + const char *mda; /* local MDA to pass mail to */ char *bsmtp; /* BSMTP output file */ char listener; /* what's the listener's wire protocol? */ #define SMTP_MODE 'S' @@ -329,9 +367,12 @@ struct query 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 *sslproto; /** force transport protocol (ssl2|ssl3|ssl23|tls1) - if NULL, + use ssl23 for SSL and opportunistic tls1 for non-SSL connections. */ + char *sslcertfile; /* Trusted certificate file for checking the server cert */ char *sslcertpath; /* Trusted certificate directory for checking the server cert */ flag sslcertck; /* Strictly check the server cert. */ + char *sslcommonname; /* CommonName to expect from server */ char *sslfingerprint; /* Fingerprint to check against */ char *properties; /* passthrough properties for extensions */ @@ -344,26 +385,28 @@ struct query 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 */ + char smtphostmode; /* what's the actual SMTP host's wire protocol? */ 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; struct idlist **oldsavedend; char lastdigest[DIGESTLEN]; /* last MD5 hash seen on this connection */ + char *folder; /* folder currently being polled */ /* internal use -- per-message state */ int mimemsg; /* bitmask indicating MIME body-type */ - char digest[DIGESTLEN]; /* md5 digest buffer */ + unsigned char digest[DIGESTLEN]; /* md5 digest buffer */ /* internal use -- housekeeping */ struct query *next; /* next query control block in chain */ }; -struct msgblk /* message header parsed for open_sink() */ +struct msgblk /** message header parsed for open_sink() */ { - char *headers; /* raw message headers */ - struct idlist *recipients; /* addressees */ - char return_path[HOSTLEN + USERNAMELEN + 4]; + char *headers; /**< raw message headers */ + struct idlist *recipients; /**< addressees */ + char return_path[HOSTLEN + USERNAMELEN + 4]; /**< envelope sender */ int msglen; int reallen; }; @@ -381,8 +424,8 @@ struct msgblk /* message header parsed for open_sink() */ #define NUM_ZERO(n) ((n) < 0) #define NUM_SPECIFIED(n) ((n) != 0) -#define MULTIDROP(ctl) (ctl->wildcard || \ - ((ctl)->localnames && (ctl)->localnames->next)) +#define MULTIDROP(ctl) ((ctl)->wildcard || \ + ((ctl)->localnames && (ctl)->localnames->next)) /* * Note: tags are generated with an a%04d format from a 1-origin @@ -423,7 +466,7 @@ 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 char *fetchmailhost; /* either "localhost" or an FQDN */ +extern const 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 @@ -433,8 +476,8 @@ extern char *sdps_envto; extern const char *iana_charset; /* IANA assigned charset name */ -/* from ucs/norm_charmap.c */ -const char *norm_charmap(const char *name); +/* from/for ucs/norm_charmap.c */ +#include "ucs/norm_charmap.h" /* prototypes for globally callable functions */ @@ -446,6 +489,8 @@ const char *norm_charmap(const char *name); /* error.c: Error reporting */ #if defined(HAVE_STDARG_H) void report_init(int foreground); + /** Flush partial message, suppress program name tag for next report printout. */ +void report_flush(FILE *fp); void report (FILE *fp, const char *format, ...) __attribute__ ((format (printf, 2, 3))) ; @@ -472,6 +517,16 @@ void resetidletimeout(void); int do_protocol(struct query *, const struct method *); /* transact.c: transaction support */ +/** \ingroup gen_recv_split + * Data structure to cache data between \func gen_recv_split calls, + * must be initialized before use by calling \func gen_recv_split_init. */ +struct RecvSplit +{ + char prefix[100]; /**< prefix to match/repeat when splitting lines */ + int cached; /**< flag to record if we have data cached in \a buf */ + char buf[MSGBUFSIZE]; /**< buffer for cached data */ +}; + void init_transact(const struct method *); int readheaders(int sock, long fetchlen, @@ -485,24 +540,20 @@ void gen_send(int sock, const char *, ... ) __attribute__ ((format (printf, 2, 3))) ; int gen_recv(int sock, char *buf, int size); +void gen_recv_split_init(const char *prefix, struct RecvSplit *rs); +int gen_recv_split(int sock, char *buf, int size, struct RecvSplit *rs); int gen_transact(int sock, const char *, ... ) __attribute__ ((format (printf, 2, 3))) ; #else void gen_send(); int gen_recv(); +void gen_recv_split_init(); +int gen_recv_split(); 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 */ #define OPEN_WAIT 1 /* waiting from mailserver open */ @@ -534,12 +585,13 @@ extern volatile int lastsig; /* sink.c: forwarding */ void smtp_close(struct query *, int); int smtp_open(struct query *); +int smtp_setup(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 *); +int open_warning_by_mail(struct query *); #if defined(HAVE_STDARG_H) void stuff_warning(const char *, struct query *, const char *, ... ) __attribute__ ((format (printf, 3, 4))) @@ -550,51 +602,51 @@ void stuff_warning(); void close_warning_by_mail(struct query *, struct msgblk *); /* rfc822.c: RFC822 header parsing */ -unsigned char *reply_hack(unsigned char *, const unsigned char *, size_t *); -unsigned char *nxtaddr(const unsigned char *); +char *reply_hack(char *, const char *, size_t *); +char *nxtaddr(const 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 **, 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, 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_swap_lists(struct query *); +void initialize_saved_lists(struct query *hostlist, const char *idfile); +void expunge_uids(struct query *ctl); +void uid_swap_lists(struct query *ctl); void uid_discard_new_list(struct query *ctl); void uid_reset_num(struct query *ctl); -void write_saved_lists(struct query *, const char *); +void write_saved_lists(struct query *hostlist, const char *idfile); + +/* idlist.c */ +struct idlist *save_str(struct idlist **idl, const char *str, flag status); +void free_str_list(struct idlist **idl); +void save_str_pair(struct idlist **idl, const char *str1, const char *str2); +struct idlist *str_in_list(struct idlist **idl, const char *str, const flag caseblind); +int str_nr_in_list(struct idlist **idl, const char *str); +int str_nr_last_in_list(struct idlist **idl, const char *str); +void str_set_mark(struct idlist **idl, const char *str, const flag val); +int count_list(struct idlist **idl); +char *str_from_nr_list(struct idlist **idl, long number); +char *str_find(struct idlist **idl, long number); +struct idlist *id_find(struct idlist **idl, long number); +char *idpair_find(struct idlist **idl, const char *id); +int delete_str(struct idlist **idl, long num); +struct idlist *copy_str_list(struct idlist *idl); +void append_str_list(struct idlist **idl, struct idlist **nidl); /* rcfile_y.y */ int prc_parse_file(const char *, const flag); int prc_filecheck(const char *, const flag); /* base64.c */ -void to64frombits(unsigned char *, const unsigned char *, int); -int from64tobits(char *, const char *, int maxlen); +void to64frombits(char *, const void *, int); +int from64tobits(void *, const char *, int maxlen); /* unmime.c */ /* Bit-mask returned by MimeBodyType */ #define MSG_IS_7BIT 0x01 #define MSG_IS_8BIT 0x02 #define MSG_NEEDS_DECODE 0x80 -extern void UnMimeHeader(unsigned char *buf); -extern int MimeBodyType(unsigned char *hdrs, int WantDecode); -extern int UnMimeBodyline(unsigned char **buf, flag delimited, flag issoftline); +extern void UnMimeHeader(char *buf); +extern int MimeBodyType(char *hdrs, int WantDecode); +extern int UnMimeBodyline(char **buf, flag delimited, flag issoftline); /* interface.c */ void interface_init(void); @@ -602,16 +654,7 @@ void interface_parse(char *, struct hostdata *); void interface_note_activity(struct hostdata *); int interface_approve(struct hostdata *, flag domonitor); -/* xmalloc.c */ -#if defined(HAVE_VOIDPOINTER) -#define XMALLOCTYPE void -#else -#define XMALLOCTYPE char -#endif -XMALLOCTYPE *xmalloc(size_t); -XMALLOCTYPE *xrealloc(/*@null@*/ XMALLOCTYPE *, size_t); -#define xfree(p) { if (p) { free(p); } (p) = 0; } -char *xstrdup(const char *); +#include "xmalloc.h" /* protocol driver and methods */ int doPOP2 (struct query *); @@ -621,10 +664,11 @@ 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); +int do_cram_md5(int sock, const char *command, struct query *ctl, const char *strip); +int do_rfc1731(int sock, const char *command, const char *truename); +int check_gss_creds(const char *service, const char *hostname); +int do_gssauth(int sock, const char *command, const char *service, const char *hostname, const char *username); +int do_otp(int sock, const char *command, struct query *ctl); /* miscellanea */ @@ -634,20 +678,22 @@ 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); +char *MD5Digest (unsigned const char *); +void hmac_md5 (const unsigned char *, size_t, const unsigned char *, size_t, unsigned char *, size_t); +int POP3_auth_rpa(char *, 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)); +int daemonize(const char *); char *fm_getpassword(char *); void escapes(const char *, char *); char *visbuf(const char *); const char *showproto(int); void dump_config(struct runctl *runp, struct query *querylist); -int is_host_alias(const char *, struct query *); +int is_host_alias(const char *, struct query *, struct addrinfo **); + +extern struct addrinfo *ai0, *ai1; /** Try to obtain fully qualified hostname of current host. Exit with * PS_DNS if \a required is true and there is a DNS error. Exit with @@ -678,11 +724,11 @@ void itimerthread(void*); #define chdir _chdir2 #endif /* _EMX_ */ -# if HAVE_STRERROR -# ifndef strerror /* On some systems, strerror is a macro */ +#ifdef HAVE_STRERROR +# if !defined(strerror) && !defined(HAVE_DECL_STRERROR) /* On some systems, strerror is a macro */ char *strerror (int); # endif -# endif /* HAVE_STRERROR */ +#endif /* HAVE_STRERROR */ #define STRING_DISABLED (char *)-1 #define STRING_DUMMY "" @@ -697,18 +743,6 @@ char *strerror (int); 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__ */ @@ -716,22 +750,12 @@ char *stpcpy(char *, const char*); #endif /* __CYGWIN__ */ extern int mailserver_socket_temp; -extern char *program_name; +extern const char *program_name; /* POSIX space characters, * ;;;;; */ #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 - /** Resolve the a TCP service name or a string containing only a decimal * positive integer to a port number. Returns -1 for error. */ int servport(const char *service); @@ -744,5 +768,29 @@ int servport(const char *service); # define NI_DGRAM 16 #endif +int fm_getaddrinfo(const char *node, const char *serv, const struct addrinfo *hints, struct addrinfo **res); +void fm_freeaddrinfo(struct addrinfo *ai); + +/* prototypes from tls.c */ +int maybe_tls(struct query *ctl); +int must_tls(struct query *ctl); + +/* prototype from rfc822valid.c */ +int rfc822_valid_msgid(const unsigned char *); + +/* prototype from x509_name_match.c */ +int name_match(const char *p1, const char *p2); + +/* prototype from ntlmsubr.c */ +#ifdef NTLM_ENABLE +int ntlm_helper(int sock, struct query *ctl, const char *protocol); +#endif + +/* macro to determine if we want to spam progress to stdout */ +#define want_progress() \ + ((outlevel >= O_VERBOSE || (outlevel > O_SILENT && run.showdots)) \ + && !run.use_syslog \ + && (run.showdots || !is_a_file(1))) + #endif /* fetchmail.h ends here */