/* We need this for HAVE_STDARG_H, etc */
#include "config.h"
+struct addrinfo;
+
/* We need this for size_t */
#include <sys/types.h>
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
#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 */
|| (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)
/*
#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 */
#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. */
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 */
- char *postmaster;
+ const char *postmaster;
char *properties;
- int poll_interval;
+ int poll_interval; /** poll interval in seconds (daemon mode, 0 == off) */
flag bouncemail;
flag spambounce;
+ 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
{
- 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 marked deleted */
-#define UID_EXPUNGED 3 /* this message has been expunged */
+ flag mark; /**< UID-index information */
}
- status;
- 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;
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 */
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 */
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
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'
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 */
/* 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;
};
#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
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
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 */
/* 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)))
;
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,
__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;
/* 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*);
/* 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);
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 *);
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 */
int parsecmdline (int, char **, struct runctl *, struct query *);
char *prependdir (const char *, const char *);
char *MD5Digest (unsigned const char *);
-void hmac_md5 (char *, size_t, char *, size_t, unsigned char *, size_t);
+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);
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__ */
#endif /* __CYGWIN__ */
extern int mailserver_socket_temp;
-extern char *program_name;
+extern const 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
-
/** 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);
# 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 */