1 /* $NetBSD: mail_server.h,v 1.3 2020/03/18 19:05:16 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 #define MAIL_SERVER_RETIRE_ME 23 50 51 typedef void (*MAIL_SERVER_INIT_FN) (char *, char **); 52 typedef int (*MAIL_SERVER_LOOP_FN) (char *, char **); 53 typedef void (*MAIL_SERVER_EXIT_FN) (char *, char **); 54 typedef void (*MAIL_SERVER_ACCEPT_FN) (char *, char **); 55 typedef void (*MAIL_SERVER_DISCONN_FN) (VSTREAM *, char *, char **); 56 typedef void (*MAIL_SERVER_SLOW_EXIT_FN) (char *, char **); 57 58 /* Type-checked API for external use. */ 59 #define CA_MAIL_SERVER_INT_TABLE(v) MAIL_SERVER_INT_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_INT_TABLE, (v)) 60 #define CA_MAIL_SERVER_STR_TABLE(v) MAIL_SERVER_STR_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_STR_TABLE, (v)) 61 #define CA_MAIL_SERVER_BOOL_TABLE(v) MAIL_SERVER_BOOL_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_BOOL_TABLE, (v)) 62 #define CA_MAIL_SERVER_TIME_TABLE(v) MAIL_SERVER_TIME_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_TIME_TABLE, (v)) 63 #define CA_MAIL_SERVER_RAW_TABLE(v) MAIL_SERVER_RAW_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_RAW_TABLE, (v)) 64 #define CA_MAIL_SERVER_NINT_TABLE(v) MAIL_SERVER_NINT_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_NINT_TABLE, (v)) 65 #define CA_MAIL_SERVER_NBOOL_TABLE(v) MAIL_SERVER_NBOOL_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_NBOOL_TABLE, (v)) 66 #define CA_MAIL_SERVER_LONG_TABLE(v) MAIL_SERVER_LONG_TABLE, CHECK_CPTR(MAIL_SERVER, CONFIG_LONG_TABLE, (v)) 67 #define CA_MAIL_SERVER_PRE_INIT(v) MAIL_SERVER_PRE_INIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_INIT_FN, (v)) 68 #define CA_MAIL_SERVER_POST_INIT(v) MAIL_SERVER_POST_INIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_INIT_FN, (v)) 69 #define CA_MAIL_SERVER_LOOP(v) MAIL_SERVER_LOOP, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_LOOP_FN, (v)) 70 #define CA_MAIL_SERVER_EXIT(v) MAIL_SERVER_EXIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_EXIT_FN, (v)) 71 #define CA_MAIL_SERVER_PRE_ACCEPT(v) MAIL_SERVER_PRE_ACCEPT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_ACCEPT_FN, (v)) 72 #define CA_MAIL_SERVER_SOLITARY MAIL_SERVER_SOLITARY 73 #define CA_MAIL_SERVER_UNLIMITED MAIL_SERVER_UNLIMITED 74 #define CA_MAIL_SERVER_PRE_DISCONN(v) MAIL_SERVER_PRE_DISCONN, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_DISCONN_FN, (v)) 75 #define CA_MAIL_SERVER_PRIVILEGED MAIL_SERVER_PRIVILEGED 76 #define CA_MAIL_SERVER_WATCHDOG(v) MAIL_SERVER_WATCHDOG, CHECK_PTR(MAIL_SERVER, int, (v)) 77 #define CA_MAIL_SERVER_IN_FLOW_DELAY MAIL_SERVER_IN_FLOW_DELAY 78 #define CA_MAIL_SERVER_SLOW_EXIT(v) MAIL_SERVER_SLOW_EXIT, CHECK_VAL(MAIL_SERVER, MAIL_SERVER_SLOW_EXIT_FN, (v)) 79 #define CA_MAIL_SERVER_BOUNCE_INIT(v, w) MAIL_SERVER_BOUNCE_INIT, CHECK_PTR(MAIL_SERVER, char, (v)), CHECK_PPTR(MAIL_SERVER, char, (w)) 80 #define CA_MAIL_SERVER_RETIRE_ME MAIL_SERVER_RETIRE_ME 81 82 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_SLOW_EXIT_FN); 83 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_LOOP_FN); 84 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_INIT_FN); 85 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_EXIT_FN); 86 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_DISCONN_FN); 87 CHECK_VAL_HELPER_DCL(MAIL_SERVER, MAIL_SERVER_ACCEPT_FN); 88 CHECK_PTR_HELPER_DCL(MAIL_SERVER, int); 89 CHECK_PTR_HELPER_DCL(MAIL_SERVER, char); 90 CHECK_PPTR_HELPER_DCL(MAIL_SERVER, char); 91 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_TIME_TABLE); 92 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_STR_TABLE); 93 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_RAW_TABLE); 94 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_NINT_TABLE); 95 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_NBOOL_TABLE); 96 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_LONG_TABLE); 97 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_INT_TABLE); 98 CHECK_CPTR_HELPER_DCL(MAIL_SERVER, CONFIG_BOOL_TABLE); 99 100 /* 101 * single_server.c 102 */ 103 typedef void (*SINGLE_SERVER_FN) (VSTREAM *, char *, char **); 104 extern NORETURN single_server_main(int, char **, SINGLE_SERVER_FN,...); 105 106 /* 107 * multi_server.c 108 */ 109 typedef void (*MULTI_SERVER_FN) (VSTREAM *, char *, char **); 110 extern NORETURN multi_server_main(int, char **, MULTI_SERVER_FN,...); 111 extern void multi_server_disconnect(VSTREAM *); 112 extern int multi_server_drain(void); 113 114 /* 115 * event_server.c 116 */ 117 typedef void (*EVENT_SERVER_FN) (VSTREAM *, char *, char **); 118 extern NORETURN event_server_main(int, char **, EVENT_SERVER_FN,...); 119 extern void event_server_disconnect(VSTREAM *); 120 extern int event_server_drain(void); 121 122 /* 123 * trigger_server.c 124 */ 125 typedef void (*TRIGGER_SERVER_FN) (char *, ssize_t, char *, char **); 126 extern NORETURN trigger_server_main(int, char **, TRIGGER_SERVER_FN,...); 127 128 #define TRIGGER_BUF_SIZE 1024 129 130 /* 131 * dgram_server.c 132 */ 133 typedef void (*DGRAM_SERVER_FN) (char *, ssize_t, char *, char **); 134 extern NORETURN dgram_server_main(int, char **, DGRAM_SERVER_FN,...); 135 136 #define DGRAM_BUF_SIZE 4096 137 138 /* LICENSE 139 /* .ad 140 /* .fi 141 /* The Secure Mailer license must be distributed with this software. 142 /* AUTHOR(S) 143 /* Wietse Venema 144 /* IBM T.J. Watson Research 145 /* P.O. Box 704 146 /* Yorktown Heights, NY 10598, USA 147 /* 148 /* Wietse Venema 149 /* Google, Inc. 150 /* 111 8th Avenue 151 /* New York, NY 10011, USA 152 /*--*/ 153