[exim.git] / src / src / local_scan.h

/*************************************************
*     Exim - an Internet mail transport agent    *
*************************************************/

/* Copyright (c) University of Cambridge 1995 - 2015 */
/* See the file NOTICE for conditions of use and distribution. */

/* This file is the header that is the only Exim header to be included in the
source for the local_scan.c() function. It contains definitions that are made
available for use in that function, and which are documented.

This API is also used for functions called by the ${dlfunc expansion item. */


/* Some basic types that make some things easier, the Exim configuration
settings, and the store functions. */

#include <stdarg.h>
#include <sys/types.h>
#include "config.h"
#include "mytypes.h"
#include "store.h"


/* The function and its return codes. */

extern int local_scan(int, uschar **);

enum {
  LOCAL_SCAN_ACCEPT,              /* Accept */
  LOCAL_SCAN_ACCEPT_FREEZE,       /* Accept, but freeze */
  LOCAL_SCAN_ACCEPT_QUEUE,        /* Accept, but no immediate delivery */
  LOCAL_SCAN_REJECT,              /* Permanent rejection */
  LOCAL_SCAN_REJECT_NOLOGHDR,     /* Permanent rejection, no log header */
  LOCAL_SCAN_TEMPREJECT,          /* Temporary rejection */
  LOCAL_SCAN_TEMPREJECT_NOLOGHDR  /* Temporary rejection, no log header */
};


/* Functions called by ${dlfunc{file}{func}{arg}...} return one of the five
status codes defined immediately below. The function's first argument is either
the result of expansion, or the error message in case of failure. The second
and third arguments are standard argument count and vector, comprising the
{arg} values specified in the expansion item. */

typedef int exim_dlfunc_t(uschar **yield, int argc, uschar *argv[]);


/* Return codes from the support functions lss_match_xxx(). These are also the
codes that dynamically-loaded ${dlfunc functions must return. */

#define  OK            0          /* Successful match */
#define  DEFER         1          /* Defer - some problem */
#define  FAIL          2          /* Matching failed */
#define  ERROR         3          /* Internal or config error */

/* Extra return code for ${dlfunc functions */

#define  FAIL_FORCED   4          /* "Forced" failure */


/* Available logging destinations */

#define LOG_MAIN        1    /* Write to the main log */
#define LOG_PANIC       2    /* Write to the panic log */
#define LOG_REJECT     16    /* Write to the reject log, with headers */


/* Accessible debugging bits */

#define D_v                          0x00000001
#define D_local_scan                 0x00000002


/* Option types that can be used for local_scan_options. The boolean ones
MUST be last so that they are contiguous with the internal boolean specials. */

enum { opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed,
  opt_time, opt_bool };


/* The length of message identification strings. This is the id used internally
by exim. The external version for use in Received: strings has a leading 'E'
added to ensure it starts with a letter. */

#define MESSAGE_ID_LENGTH 16

/* The offset to the start of the data in the data file - this allows for
the name of the data file to be present in the first line. */

#define SPOOL_DATA_START_OFFSET (MESSAGE_ID_LENGTH+3)

/* Some people (Marc Merlin et al) are maintaining a patch that allows for
dynamic local_scan() libraries. This code is not yet in Exim proper, but it
helps the maintainers if we keep their ABI version numbers here. This may
mutate into more general support later. The major number is increased when the
ABI is changed in a non backward compatible way. The minor number is increased
each time a new feature is added (in a way that doesn't break backward
compatibility). */

#define LOCAL_SCAN_ABI_VERSION_MAJOR 2
#define LOCAL_SCAN_ABI_VERSION_MINOR 0
#define LOCAL_SCAN_ABI_VERSION \
  LOCAL_SCAN_ABI_VERSION_MAJOR.LOCAL_SCAN_ABI_VERSION_MINOR

/* Structure definitions that are documented as visible in the function. */

typedef struct header_line {
  struct header_line *next;
  int    type;
  int    slen;
  uschar *text;
} header_line;

/* Entries in lists options are in this form. */

typedef struct {
  const char   *name;
  int           type;
  void         *value;
} optionlist;

/*Structure for holding information about an envelope address. The errors_to
field is always NULL except for one_time aliases that had errors_to on the
routers that generated them. */

typedef struct recipient_item {
  uschar *address;              /* the recipient address */
  int     pno;                  /* parent number for "one_time" alias, or -1 */
  uschar *errors_to;            /* the errors_to address or NULL */
  uschar *orcpt;                /* DSN orcpt */
  int     dsn_flags;            /* DSN flags */
#ifdef EXPERIMENTAL_BRIGHTMAIL
  uschar *bmi_optin;
#endif
} recipient_item;


/* Global variables that are documented as visible in the function. */

extern unsigned int debug_selector;    /* Debugging bits */

extern int     body_linecount;         /* Line count in body */
extern int     body_zerocount;         /* Binary zero count in body */
extern uschar *expand_string_message;  /* Error info for failing expansion */
extern uschar *headers_charset;        /* Charset for RFC 2047 decoding */
extern header_line *header_last;       /* Final header */
extern header_line *header_list;       /* First header */
extern BOOL    host_checking;          /* Set when checking a host */
extern uschar *interface_address;      /* Interface for incoming call */
extern int     interface_port;         /* Port number for incoming call */
extern uschar *message_id;             /* Internal id of message being handled */
extern uschar *received_protocol;      /* Name of incoming protocol */
extern int     recipients_count;       /* Number of recipients */
extern recipient_item *recipients_list;/* List of recipient addresses */
extern unsigned char *sender_address;  /* Sender address */
extern uschar *sender_host_address;    /* IP address of sender, as chars */
extern uschar *sender_host_authenticated; /* Name of authentication mechanism */
extern uschar *sender_host_name;       /* Host name from lookup */
extern int     sender_host_port;       /* Port number of sender */
extern BOOL    smtp_batched_input;     /* TRUE if SMTP batch (no interaction) */
extern BOOL    smtp_input;             /* TRUE if input is via SMTP */


/* Functions that are documented as visible in local_scan(). */

extern int     child_close(pid_t, int);
extern pid_t   child_open(uschar **, uschar **, int, int *, int *, BOOL);
extern pid_t   child_open_exim(int *);
extern pid_t   child_open_exim2(int *, uschar *, uschar *);
extern void    debug_printf(const char *, ...) PRINTF_FUNCTION(1,2);
extern uschar *expand_string(uschar *);
extern void    header_add(int, const char *, ...);
extern void    header_add_at_position(BOOL, uschar *, BOOL, int, const char *, ...);
extern void    header_remove(int, const uschar *);
extern BOOL    header_testname(header_line *, const uschar *, int, BOOL);
extern BOOL    header_testname_incomplete(header_line *, const uschar *, int, BOOL);
extern void    log_write(unsigned int, int, const char *format, ...) PRINTF_FUNCTION(3,4);
extern int     lss_b64decode(uschar *, uschar **);
extern uschar *lss_b64encode(uschar *, int);
extern int     lss_match_domain(uschar *, uschar *);
extern int     lss_match_local_part(uschar *, uschar *, BOOL);
extern int     lss_match_address(uschar *, uschar *, BOOL);
extern int     lss_match_host(uschar *, uschar *, uschar *);
extern void    receive_add_recipient(uschar *, int);
extern BOOL    receive_remove_recipient(uschar *);
extern uschar *rfc2047_decode(uschar *, BOOL, uschar *, int, int *, uschar **);
extern int     smtp_fflush(void);
extern void    smtp_printf(const char *, ...) PRINTF_FUNCTION(1,2);
extern void    smtp_vprintf(const char *, va_list);
extern uschar *string_copy(const uschar *);
extern uschar *string_copyn(const uschar *, int);
extern uschar *string_sprintf(const char *, ...) ALMOST_PRINTF(1,2);

/* End of local_scan.h */
Commit	Line	Data
059ec3d9 PH	1	/*************************************************
	2	* Exim - an Internet mail transport agent *
	3	*************************************************/
	4
3386088d	5	/* Copyright (c) University of Cambridge 1995 - 2015 */
059ec3d9 PH	6	/* See the file NOTICE for conditions of use and distribution. */
	7
	8	/* This file is the header that is the only Exim header to be included in the
	9	source for the local_scan.c() function. It contains definitions that are made
1a46a8c5 PH	10	available for use in that function, and which are documented.
	11
	12	This API is also used for functions called by the ${dlfunc expansion item. */
059ec3d9 PH	13
059ec3d9 PH	14
750af86e PH	15	/* Some basic types that make some things easier, the Exim configuration
750af86e PH	16	settings, and the store functions. */
059ec3d9	17
ce552449	18	#include <stdarg.h>
059ec3d9	19	#include <sys/types.h>
750af86e	20	#include "config.h"
059ec3d9 PH	21	#include "mytypes.h"
	22	#include "store.h"
	23
	24
	25	/* The function and its return codes. */
	26
	27	extern int local_scan(int, uschar **);
	28
	29	enum {
	30	LOCAL_SCAN_ACCEPT, /* Accept */
	31	LOCAL_SCAN_ACCEPT_FREEZE, /* Accept, but freeze */
	32	LOCAL_SCAN_ACCEPT_QUEUE, /* Accept, but no immediate delivery */
	33	LOCAL_SCAN_REJECT, /* Permanent rejection */
	34	LOCAL_SCAN_REJECT_NOLOGHDR, /* Permanent rejection, no log header */
	35	LOCAL_SCAN_TEMPREJECT, /* Temporary rejection */
	36	LOCAL_SCAN_TEMPREJECT_NOLOGHDR /* Temporary rejection, no log header */
	37	};
	38
	39
1a46a8c5 PH	40	/* Functions called by ${dlfunc{file}{func}{arg}...} return one of the five
	41	status codes defined immediately below. The function's first argument is either
	42	the result of expansion, or the error message in case of failure. The second
	43	and third arguments are standard argument count and vector, comprising the
	44	{arg} values specified in the expansion item. */
	45
	46	typedef int exim_dlfunc_t(uschar *yield, int argc, uschar argv[]);
	47
	48
	49	/* Return codes from the support functions lss_match_xxx(). These are also the
	50	codes that dynamically-loaded ${dlfunc functions must return. */
059ec3d9 PH	51
	52	#define OK 0 /* Successful match */
	53	#define DEFER 1 /* Defer - some problem */
	54	#define FAIL 2 /* Matching failed */
	55	#define ERROR 3 /* Internal or config error */
	56
1a46a8c5 PH	57	/* Extra return code for ${dlfunc functions */
	58
	59	#define FAIL_FORCED 4 /* "Forced" failure */
	60
059ec3d9 PH	61
	62	/* Available logging destinations */
	63
	64	#define LOG_MAIN 1 /* Write to the main log */
	65	#define LOG_PANIC 2 /* Write to the panic log */
	66	#define LOG_REJECT 16 /* Write to the reject log, with headers */
	67
	68
	69	/* Accessible debugging bits */
	70
	71	#define D_v 0x00000001
	72	#define D_local_scan 0x00000002
	73
	74
	75	/* Option types that can be used for local_scan_options. The boolean ones
	76	MUST be last so that they are contiguous with the internal boolean specials. */
	77
	78	enum { opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed,
	79	opt_time, opt_bool };
	80
	81
	82	/* The length of message identification strings. This is the id used internally
	83	by exim. The external version for use in Received: strings has a leading 'E'
	84	added to ensure it starts with a letter. */
	85
	86	#define MESSAGE_ID_LENGTH 16
	87
	88	/* The offset to the start of the data in the data file - this allows for
	89	the name of the data file to be present in the first line. */
	90
	91	#define SPOOL_DATA_START_OFFSET (MESSAGE_ID_LENGTH+3)
	92
	93	/* Some people (Marc Merlin et al) are maintaining a patch that allows for
	94	dynamic local_scan() libraries. This code is not yet in Exim proper, but it
	95	helps the maintainers if we keep their ABI version numbers here. This may
	96	mutate into more general support later. The major number is increased when the
	97	ABI is changed in a non backward compatible way. The minor number is increased
	98	each time a new feature is added (in a way that doesn't break backward
	99	compatibility). */
	100
0750f099 AM	101	#define LOCAL_SCAN_ABI_VERSION_MAJOR 2
0750f099 AM	102	#define LOCAL_SCAN_ABI_VERSION_MINOR 0
e57faad2 MH	103	#define LOCAL_SCAN_ABI_VERSION \
e57faad2 MH	104	LOCAL_SCAN_ABI_VERSION_MAJOR.LOCAL_SCAN_ABI_VERSION_MINOR
059ec3d9 PH	105
	106	/* Structure definitions that are documented as visible in the function. */
	107
	108	typedef struct header_line {
	109	struct header_line *next;
	110	int type;
	111	int slen;
	112	uschar *text;
	113	} header_line;
	114
	115	/* Entries in lists options are in this form. */
	116
	117	typedef struct {
1ba28e2b PP	118	const char *name;
	119	int type;
	120	void *value;
059ec3d9 PH	121	} optionlist;
	122
	123	/*Structure for holding information about an envelope address. The errors_to
	124	field is always NULL except for one_time aliases that had errors_to on the
	125	routers that generated them. */
	126
	127	typedef struct recipient_item {
	128	uschar address; / the recipient address */
	129	int pno; /* parent number for "one_time" alias, or -1 */
	130	uschar errors_to; / the errors_to address or NULL */
6c1c3d1d WB	131	uschar orcpt; / DSN orcpt */
6c1c3d1d WB	132	int dsn_flags; /* DSN flags */
8523533c TK	133	#ifdef EXPERIMENTAL_BRIGHTMAIL
	134	uschar *bmi_optin;
	135	#endif
059ec3d9 PH	136	} recipient_item;
	137
	138
	139	/* Global variables that are documented as visible in the function. */
	140
	141	extern unsigned int debug_selector; /* Debugging bits */
	142
2b85bce7 PH	143	extern int body_linecount; /* Line count in body */
2b85bce7 PH	144	extern int body_zerocount; /* Binary zero count in body */
059ec3d9 PH	145	extern uschar expand_string_message; / Error info for failing expansion */
	146	extern uschar headers_charset; / Charset for RFC 2047 decoding */
	147	extern header_line header_last; / Final header */
	148	extern header_line header_list; / First header */
	149	extern BOOL host_checking; /* Set when checking a host */
	150	extern uschar interface_address; / Interface for incoming call */
	151	extern int interface_port; /* Port number for incoming call */
	152	extern uschar message_id; / Internal id of message being handled */
	153	extern uschar received_protocol; / Name of incoming protocol */
	154	extern int recipients_count; /* Number of recipients */
	155	extern recipient_item recipients_list;/ List of recipient addresses */
	156	extern unsigned char sender_address; / Sender address */
	157	extern uschar sender_host_address; / IP address of sender, as chars */
	158	extern uschar sender_host_authenticated; / Name of authentication mechanism */
	159	extern uschar sender_host_name; / Host name from lookup */
	160	extern int sender_host_port; /* Port number of sender */
	161	extern BOOL smtp_batched_input; /* TRUE if SMTP batch (no interaction) */
	162	extern BOOL smtp_input; /* TRUE if input is via SMTP */
	163
	164
	165	/* Functions that are documented as visible in local_scan(). */
	166
	167	extern int child_close(pid_t, int);
	168	extern pid_t child_open(uschar , uschar , int, int , int , BOOL);
	169	extern pid_t child_open_exim(int *);
5977a0b3	170	extern pid_t child_open_exim2(int , uschar , uschar *);
1ba28e2b	171	extern void debug_printf(const char *, ...) PRINTF_FUNCTION(1,2);
059ec3d9	172	extern uschar expand_string(uschar );
1ba28e2b PP	173	extern void header_add(int, const char *, ...);
	174	extern void header_add_at_position(BOOL, uschar , BOOL, int, const char , ...);
	175	extern void header_remove(int, const uschar *);
	176	extern BOOL header_testname(header_line , const uschar , int, BOOL);
	177	extern BOOL header_testname_incomplete(header_line , const uschar , int, BOOL);
e0df1c83	178	extern void log_write(unsigned int, int, const char *format, ...) PRINTF_FUNCTION(3,4);
059ec3d9 PH	179	extern int lss_b64decode(uschar , uschar *);
	180	extern uschar lss_b64encode(uschar , int);
	181	extern int lss_match_domain(uschar , uschar );
	182	extern int lss_match_local_part(uschar , uschar , BOOL);
	183	extern int lss_match_address(uschar , uschar , BOOL);
	184	extern int lss_match_host(uschar , uschar , uschar *);
	185	extern void receive_add_recipient(uschar *, int);
	186	extern BOOL receive_remove_recipient(uschar *);
	187	extern uschar rfc2047_decode(uschar , BOOL, uschar , int, int , uschar **);
	188	extern int smtp_fflush(void);
1ba28e2b PP	189	extern void smtp_printf(const char *, ...) PRINTF_FUNCTION(1,2);
1ba28e2b PP	190	extern void smtp_vprintf(const char *, va_list);
3f0945ff	191	extern uschar string_copy(const uschar );
1dc92d5a	192	extern uschar string_copyn(const uschar , int);
81f91683	193	extern uschar string_sprintf(const char , ...) ALMOST_PRINTF(1,2);
059ec3d9 PH	194
059ec3d9 PH	195	/* End of local_scan.h */