1 /* $NetBSD: mail_server.h,v 1.2 2017/02/14 01:16:45 christos Exp $ */ 2 3 /*++ 4 /* NAME 5 /* mail_server 3h 6 /* SUMMARY 7 /* skeleton servers 8 /* SYNOPSIS 9 /* #include <mail_server.h> 10 /* DESCRIPTION 11 /* .nf 12 13 /* 14 * Utility library. 15 */ 16 #include <vstream.h> 17 18 /* 19 * Global library. 20 */ 21 #include <mail_conf.h> 22 23 /* 24 * External interface. Tables are defined in mail_conf.h. 25 */ 26 #define MAIL_SERVER_INT_TABLE 1 27 #define MAIL_SERVER_STR_TABLE 2 28 #define MAIL_SERVER_BOOL_TABLE 3 29 #define MAIL_SERVER_TIME_TABLE 4 30 #define MAIL_SERVER_RAW_TABLE 5 31 #define MAIL_SERVER_NINT_TABLE 6 32 #define MAIL_SERVER_NBOOL_TABLE 7 33 #define MAIL_SERVER_LONG_TABLE 8 34 35 #define MAIL_SERVER_PRE_INIT 10 36 #define MAIL_SERVER_POST_INIT 11 37 #define MAIL_SERVER_LOOP 12 38 #define MAIL_SERVER_EXIT 13 39 #define MAIL_SERVER_PRE_ACCEPT 14 40 #define MAIL_SERVER_SOLITARY 15 41 #define MAIL_SERVER_UNLIMITED 16 42 #define MAIL_SERVER_PRE_DISCONN 17 43 #define MAIL_SERVER_PRIVILEGED 18 44 #define MAIL_SERVER_WATCHDOG 19 45 46 #define MAIL_SERVER_IN_FLOW_DELAY 20 47 #define MAIL_SERVER_SLOW_EXIT 21 48 #define MAIL_SERVER_BOUNCE_INIT 22 49 50 typedef void (*MAIL_SERVER_INIT_FN) (char *, char **); 51 typedef int (*MAIL_SERVER_LOOP_FN) (char *, char **); 52 typedef void (*MAIL_SERVER_EXIT_FN) (char *, char **); 53 typedef void (*MAIL_SERVER_ACCEPT_FN) (char *, char **); 54 typedef void (*MAIL_SERVER_DISCONN_FN) (VSTREAM *, char *, char **); 55 typedef void (*MAIL_SERVER_SLOW_EXIT_FN) (char *, char **); 56 57 /* Type-checked API for external use. */ 58 #define CA_MAIL_SERVER_INT_TABLE(v) MAIL_SERVER_INT_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_INT_TABLE, (v)) 59 #define CA_MAIL_SERVER_STR_TABLE(v) MAIL_SERVER_STR_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_STR_TABLE, (v)) 60 #define CA_MAIL_SERVER_BOOL_TABLE(v) MAIL_SERVER_BOOL_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_BOOL_TABLE, (v)) 61 #define CA_MAIL_SERVER_TIME_TABLE(v) MAIL_SERVER_TIME_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_TIME_TABLE, (v)) 62 #define CA_MAIL_SERVER_RAW_TABLE(v) MAIL_SERVER_RAW_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_RAW_TABLE, (v)) 63 #define CA_MAIL_SERVER_NINT_TABLE(v) MAIL_SERVER_NINT_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_NINT_TABLE, (v)) 64 #define CA_MAIL_SERVER_NBOOL_TABLE(v) MAIL_SERVER_NBOOL_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_NBOOL_TABLE, (v)) 65 #define CA_MAIL_SERVER_LONG_TABLE(v) MAIL_SERVER_LONG_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_LONG_TABLE, (v)) 66 #define CA_MAIL_SERVER_PRE_INIT(v) MAIL_SERVER_PRE_INIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_INIT_FN, (v)) 67 #define CA_MAIL_SERVER_POST_INIT(v) MAIL_SERVER_POST_INIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_INIT_FN, (v)) 68 #define CA_MAIL_SERVER_LOOP(v) MAIL_SERVER_LOOP, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_LOOP_FN, (v)) 69 #define CA_MAIL_SERVER_EXIT(v) MAIL_SERVER_EXIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_EXIT_FN, (v)) 70 #define CA_MAIL_SERVER_PRE_ACCEPT(v) MAIL_SERVER_PRE_ACCEPT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_ACCEPT_FN, (v)) 71 #define CA_MAIL_SERVER_SOLITARY MAIL_SERVER_SOLITARY 72 #define CA_MAIL_SERVER_UNLIMITED MAIL_SERVER_UNLIMITED 73 #define CA_MAIL_SERVER_PRE_DISCONN(v) MAIL_SERVER_PRE_DISCONN, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_DISCONN_FN, (v)) 74 #define CA_MAIL_SERVER_PRIVILEGED MAIL_SERVER_PRIVILEGED 75 #define CA_MAIL_SERVER_WATCHDOG(v) MAIL_SERVER_WATCHDOG, CHECK_PTR(MAIL_SERVER, int, (v)) 76 #define CA_MAIL_SERVER_IN_FLOW_DELAY MAIL_SERVER_IN_FLOW_DELAY 77 #define CA_MAIL_SERVER_SLOW_EXIT(v) MAIL_SERVER_SLOW_EXIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_SLOW_EXIT_FN, (v)) 78 #define CA_MAIL_SERVER_BOUNCE_INIT(v, w) MAIL_SERVER_BOUNCE_INIT, CHECK_PTR(MAIL_SERVER, char, (v)), CHECK_PPTR(MAIL_SERVER, char, (w)) 79 80 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_SLOW_EXIT_FN); 81 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_LOOP_FN); 82 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_INIT_FN); 83 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_EXIT_FN); 84 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_DISCONN_FN); 85 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_ACCEPT_FN); 86 CHECK_PTR_HELPER_DCL(MAIL_SERVER, int); 87 CHECK_PTR_HELPER_DCL(MAIL_SERVER, char); 88 CHECK_PPTR_HELPER_DCL(MAIL_SERVER, char); 89 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_TIME_TABLE); 90 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_STR_TABLE); 91 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_RAW_TABLE); 92 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_NINT_TABLE); 93 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_NBOOL_TABLE); 94 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_LONG_TABLE); 95 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_INT_TABLE); 96 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_BOOL_TABLE); 97 98 /* 99 * single_server.c 100 */ 101 typedef void (*SINGLE_SERVER_FN) (VSTREAM *, char *, char **); 102 extern NORETURN single_server_main(int, char **, SINGLE_SERVER_FN,...); 103 104 /* 105 * multi_server.c 106 */ 107 typedef void (*MULTI_SERVER_FN) (VSTREAM *, char *, char **); 108 extern NORETURN multi_server_main(int, char **, MULTI_SERVER_FN,...); 109 extern void multi_server_disconnect(VSTREAM *); 110 extern int multi_server_drain(void); 111 112 /* 113 * event_server.c 114 */ 115 typedef void (*EVENT_SERVER_FN) (VSTREAM *, char *, char **); 116 extern NORETURN event_server_main(int, char **, EVENT_SERVER_FN,...); 117 extern void event_server_disconnect(VSTREAM *); 118 extern int event_server_drain(void); 119 120 /* 121 * trigger_server.c 122 */ 123 typedef void (*TRIGGER_SERVER_FN) (char *, ssize_t, char *, char **); 124 extern NORETURN trigger_server_main(int, char **, TRIGGER_SERVER_FN,...); 125 126 #define TRIGGER_BUF_SIZE 1024 127 128 /* LICENSE 129 /* .ad 130 /* .fi 131 /* The Secure Mailer license must be distributed with this software. 132 /* AUTHOR(S) 133 /* Wietse Venema 134 /* IBM T.J. Watson Research 135 /* P.O. Box 704 136 /* Yorktown Heights, NY 10598, USA 137 /*--*/ 138