| 1 | /************************************************* |
| 2 | * Exim - an Internet mail transport agent * |
| 3 | *************************************************/ |
| 4 | |
| 5 | /* Copyright (c) University of Cambridge 1995 - 2018 */ |
| 6 | /* Copyright (c) The Exim Maintainers 2020 */ |
| 7 | /* See the file NOTICE for conditions of use and distribution. */ |
| 8 | |
| 9 | |
| 10 | /* Prototypes for functions that appear in various modules. Gathered together |
| 11 | to avoid having a lot of tiddly little headers with only a couple of lines in |
| 12 | them. However, some functions that are used (or not used) by utility programs |
| 13 | are in in fact in separate headers. */ |
| 14 | #ifndef _FUNCTIONS_H_ |
| 15 | #define _FUNCTIONS_H_ |
| 16 | |
| 17 | #include <ctype.h> |
| 18 | #include <sys/time.h> |
| 19 | |
| 20 | |
| 21 | #ifdef EXIM_PERL |
| 22 | extern gstring *call_perl_cat(gstring *, uschar **, uschar *, |
| 23 | uschar **) WARN_UNUSED_RESULT; |
| 24 | extern void cleanup_perl(void); |
| 25 | extern uschar *init_perl(uschar *); |
| 26 | #endif |
| 27 | |
| 28 | |
| 29 | #ifndef DISABLE_TLS |
| 30 | extern const char * |
| 31 | std_dh_prime_default(void); |
| 32 | extern const char * |
| 33 | std_dh_prime_named(const uschar *); |
| 34 | |
| 35 | extern uschar * tls_cert_crl_uri(void *, uschar * mod); |
| 36 | extern uschar * tls_cert_ext_by_oid(void *, uschar *, int); |
| 37 | extern uschar * tls_cert_issuer(void *, uschar * mod); |
| 38 | extern uschar * tls_cert_not_before(void *, uschar * mod); |
| 39 | extern uschar * tls_cert_not_after(void *, uschar * mod); |
| 40 | extern uschar * tls_cert_ocsp_uri(void *, uschar * mod); |
| 41 | extern uschar * tls_cert_serial_number(void *, uschar * mod); |
| 42 | extern uschar * tls_cert_signature(void *, uschar * mod); |
| 43 | extern uschar * tls_cert_signature_algorithm(void *, uschar * mod); |
| 44 | extern uschar * tls_cert_subject(void *, uschar * mod); |
| 45 | extern uschar * tls_cert_subject_altname(void *, uschar * mod); |
| 46 | extern uschar * tls_cert_version(void *, uschar * mod); |
| 47 | |
| 48 | extern uschar * tls_cert_der_b64(void * cert); |
| 49 | extern uschar * tls_cert_fprt_md5(void *); |
| 50 | extern uschar * tls_cert_fprt_sha1(void *); |
| 51 | extern uschar * tls_cert_fprt_sha256(void *); |
| 52 | |
| 53 | extern void tls_clean_env(void); |
| 54 | extern BOOL tls_client_start(client_conn_ctx *, smtp_connect_args *, |
| 55 | void *, tls_support *, uschar **); |
| 56 | |
| 57 | extern void tls_close(void *, int); |
| 58 | extern BOOL tls_could_read(void); |
| 59 | extern void tls_daemon_init(void); |
| 60 | extern BOOL tls_dropprivs_validate_require_cipher(BOOL); |
| 61 | extern BOOL tls_export_cert(uschar *, size_t, void *); |
| 62 | extern int tls_feof(void); |
| 63 | extern int tls_ferror(void); |
| 64 | extern void tls_free_cert(void **); |
| 65 | extern int tls_getc(unsigned); |
| 66 | extern uschar *tls_getbuf(unsigned *); |
| 67 | extern void tls_get_cache(void); |
| 68 | extern BOOL tls_import_cert(const uschar *, void **); |
| 69 | extern int tls_read(void *, uschar *, size_t); |
| 70 | extern int tls_server_start(const uschar *, uschar **); |
| 71 | extern BOOL tls_smtp_buffered(void); |
| 72 | extern int tls_ungetc(int); |
| 73 | extern int tls_write(void *, const uschar *, size_t, BOOL); |
| 74 | extern uschar *tls_validate_require_cipher(void); |
| 75 | extern void tls_version_report(FILE *); |
| 76 | # ifdef USE_OPENSSL |
| 77 | extern BOOL tls_openssl_options_parse(uschar *, long *); |
| 78 | # endif |
| 79 | extern uschar * tls_field_from_dn(uschar *, const uschar *); |
| 80 | extern BOOL tls_is_name_for_cert(const uschar *, void *); |
| 81 | |
| 82 | # ifdef SUPPORT_DANE |
| 83 | extern int tlsa_lookup(const host_item *, dns_answer *, BOOL); |
| 84 | # endif |
| 85 | |
| 86 | #endif /*DISABLE_TLS*/ |
| 87 | |
| 88 | |
| 89 | /* Everything else... */ |
| 90 | |
| 91 | extern acl_block *acl_read(uschar *(*)(void), uschar **); |
| 92 | extern int acl_check(int, uschar *, uschar *, uschar **, uschar **); |
| 93 | extern int acl_eval(int, uschar *, uschar **, uschar **); |
| 94 | |
| 95 | extern tree_node *acl_var_create(uschar *); |
| 96 | extern void acl_var_write(uschar *, uschar *, void *); |
| 97 | |
| 98 | #ifdef EXPERIMENTAL_ARC |
| 99 | extern void *arc_ams_setup_sign_bodyhash(void); |
| 100 | extern const uschar *arc_header_feed(gstring *, BOOL); |
| 101 | extern gstring *arc_sign(const uschar *, gstring *, uschar **); |
| 102 | extern void arc_sign_init(void); |
| 103 | extern const uschar *acl_verify_arc(void); |
| 104 | extern uschar * fn_arc_domains(void); |
| 105 | #endif |
| 106 | |
| 107 | extern void assert_no_variables(void *, int, const char *, int); |
| 108 | extern int auth_call_pam(const uschar *, uschar **); |
| 109 | extern int auth_call_pwcheck(uschar *, uschar **); |
| 110 | extern int auth_call_radius(const uschar *, uschar **); |
| 111 | extern int auth_call_saslauthd(const uschar *, const uschar *, |
| 112 | const uschar *, const uschar *, uschar **); |
| 113 | extern int auth_check_serv_cond(auth_instance *); |
| 114 | extern int auth_check_some_cond(auth_instance *, uschar *, uschar *, int); |
| 115 | extern int auth_client_item(void *, auth_instance *, const uschar **, |
| 116 | unsigned, int, uschar *, int); |
| 117 | |
| 118 | |
| 119 | extern int auth_get_data(uschar **, const uschar *, int); |
| 120 | extern int auth_get_no64_data(uschar **, uschar *); |
| 121 | extern int auth_prompt(const uschar *); |
| 122 | extern int auth_read_input(const uschar *); |
| 123 | extern gstring * auth_show_supported(gstring *); |
| 124 | extern uschar *auth_xtextencode(uschar *, int); |
| 125 | extern int auth_xtextdecode(uschar *, uschar **); |
| 126 | |
| 127 | #ifdef EXPERIMENTAL_ARC |
| 128 | extern gstring *authres_arc(gstring *); |
| 129 | #endif |
| 130 | #ifndef DISABLE_DKIM |
| 131 | extern gstring *authres_dkim(gstring *); |
| 132 | #endif |
| 133 | #ifdef SUPPORT_DMARC |
| 134 | extern gstring *authres_dmarc(gstring *); |
| 135 | #endif |
| 136 | extern gstring *authres_smtpauth(gstring *); |
| 137 | #ifdef SUPPORT_SPF |
| 138 | extern gstring *authres_spf(gstring *); |
| 139 | #endif |
| 140 | |
| 141 | extern uschar *b64encode(const uschar *, int); |
| 142 | extern uschar *b64encode_taint(const uschar *, int, BOOL); |
| 143 | extern int b64decode(const uschar *, uschar **); |
| 144 | extern int bdat_getc(unsigned); |
| 145 | extern uschar *bdat_getbuf(unsigned *); |
| 146 | extern int bdat_ungetc(int); |
| 147 | extern void bdat_flush_data(void); |
| 148 | |
| 149 | extern void bits_clear(unsigned int *, size_t, int *); |
| 150 | extern void bits_set(unsigned int *, size_t, int *); |
| 151 | |
| 152 | extern void cancel_cutthrough_connection(BOOL, const uschar *); |
| 153 | extern gstring *cat_file(FILE *, gstring *, uschar *); |
| 154 | extern gstring *cat_file_tls(void *, gstring *, uschar *); |
| 155 | extern int check_host(void *, const uschar *, const uschar **, uschar **); |
| 156 | extern uschar **child_exec_exim(int, BOOL, int *, BOOL, int, ...); |
| 157 | extern pid_t child_open_exim_function(int *, const uschar *); |
| 158 | extern pid_t child_open_exim2_function(int *, uschar *, uschar *, |
| 159 | const uschar *); |
| 160 | extern pid_t child_open_function(uschar **, uschar **, int, |
| 161 | int *, int *, BOOL, const uschar *); |
| 162 | extern pid_t child_open_uid(const uschar **, const uschar **, int, |
| 163 | uid_t *, gid_t *, int *, int *, uschar *, BOOL, const uschar *); |
| 164 | extern BOOL cleanup_environment(void); |
| 165 | extern void cutthrough_data_puts(uschar *, int); |
| 166 | extern void cutthrough_data_put_nl(void); |
| 167 | extern uschar *cutthrough_finaldot(void); |
| 168 | extern BOOL cutthrough_flush_send(void); |
| 169 | extern BOOL cutthrough_headers_send(void); |
| 170 | extern BOOL cutthrough_predata(void); |
| 171 | extern void release_cutthrough_connection(const uschar *); |
| 172 | |
| 173 | extern void daemon_go(void); |
| 174 | |
| 175 | #ifdef EXPERIMENTAL_DCC |
| 176 | extern int dcc_process(uschar **); |
| 177 | #endif |
| 178 | |
| 179 | extern void debug_logging_activate(uschar *, uschar *); |
| 180 | extern void debug_logging_stop(void); |
| 181 | extern void debug_print_argv(const uschar **); |
| 182 | extern void debug_print_ids(uschar *); |
| 183 | extern void debug_printf_indent(const char *, ...) PRINTF_FUNCTION(1,2); |
| 184 | extern void debug_print_string(uschar *); |
| 185 | extern void debug_print_tree(tree_node *); |
| 186 | extern void debug_vprintf(int, const char *, va_list); |
| 187 | extern void debug_print_socket(int); |
| 188 | |
| 189 | extern void decode_bits(unsigned int *, size_t, int *, |
| 190 | uschar *, bit_table *, int, uschar *, int); |
| 191 | extern void delete_pid_file(void); |
| 192 | extern address_item *deliver_make_addr(uschar *, BOOL); |
| 193 | extern void delivery_log(int, address_item *, int, uschar *); |
| 194 | extern int deliver_message(uschar *, BOOL, BOOL); |
| 195 | extern void deliver_msglog(const char *, ...) PRINTF_FUNCTION(1,2); |
| 196 | extern void deliver_set_expansions(address_item *); |
| 197 | extern int deliver_split_address(address_item *); |
| 198 | extern void deliver_succeeded(address_item *); |
| 199 | |
| 200 | extern uschar *deliver_get_sender_address (uschar *id); |
| 201 | extern void delivery_re_exec(int); |
| 202 | |
| 203 | extern void die_tainted(const uschar *, const uschar *, int); |
| 204 | extern BOOL directory_make(const uschar *, const uschar *, int, BOOL); |
| 205 | #ifndef DISABLE_DKIM |
| 206 | extern uschar *dkim_exim_query_dns_txt(const uschar *); |
| 207 | extern void dkim_exim_sign_init(void); |
| 208 | |
| 209 | extern BOOL dkim_transport_write_message(transport_ctx *, |
| 210 | struct ob_dkim *, const uschar ** errstr); |
| 211 | #endif |
| 212 | extern dns_address *dns_address_from_rr(dns_answer *, dns_record *); |
| 213 | extern int dns_basic_lookup(dns_answer *, const uschar *, int); |
| 214 | extern uschar *dns_build_reverse(const uschar *); |
| 215 | extern time_t dns_expire_from_soa(dns_answer *, int); |
| 216 | extern void dns_init(BOOL, BOOL, BOOL); |
| 217 | extern BOOL dns_is_aa(const dns_answer *); |
| 218 | extern BOOL dns_is_secure(const dns_answer *); |
| 219 | extern int dns_lookup(dns_answer *, const uschar *, int, const uschar **); |
| 220 | extern void dns_pattern_init(void); |
| 221 | extern int dns_special_lookup(dns_answer *, const uschar *, int, const uschar **); |
| 222 | extern dns_record *dns_next_rr(const dns_answer *, dns_scan *, int); |
| 223 | extern uschar *dns_text_type(int); |
| 224 | extern void dscp_list_to_stream(FILE *); |
| 225 | extern BOOL dscp_lookup(const uschar *, int, int *, int *, int *); |
| 226 | |
| 227 | extern void enq_end(uschar *); |
| 228 | extern BOOL enq_start(uschar *, unsigned); |
| 229 | #ifndef DISABLE_EVENT |
| 230 | extern uschar *event_raise(uschar *, const uschar *, uschar *); |
| 231 | extern void msg_event_raise(const uschar *, const address_item *); |
| 232 | #endif |
| 233 | |
| 234 | extern int exim_chown_failure(int, const uschar*, uid_t, gid_t); |
| 235 | extern const uschar * exim_errstr(int); |
| 236 | extern void exim_exit(int) NORETURN; |
| 237 | extern void exim_nullstd(void); |
| 238 | extern void exim_setugid(uid_t, gid_t, BOOL, uschar *); |
| 239 | extern void exim_underbar_exit(int) NORETURN; |
| 240 | extern void exim_wait_tick(struct timeval *, int); |
| 241 | extern int exp_bool(address_item *addr, |
| 242 | uschar *mtype, uschar *mname, unsigned dgb_opt, uschar *oname, BOOL bvalue, |
| 243 | uschar *svalue, BOOL *rvalue); |
| 244 | extern BOOL expand_check_condition(uschar *, uschar *, uschar *); |
| 245 | extern uschar *expand_file_big_buffer(const uschar *); |
| 246 | extern uschar *expand_string(uschar *); /* public, cannot make const */ |
| 247 | extern const uschar *expand_cstring(const uschar *); /* ... so use this one */ |
| 248 | extern uschar *expand_getkeyed(const uschar *, const uschar *); |
| 249 | |
| 250 | extern uschar *expand_hide_passwords(uschar * ); |
| 251 | extern uschar *expand_string_copy(const uschar *); |
| 252 | extern int_eximarith_t expand_string_integer(uschar *, BOOL); |
| 253 | extern void modify_variable(uschar *, void *); |
| 254 | |
| 255 | extern BOOL fd_ready(int, time_t); |
| 256 | |
| 257 | extern int filter_interpret(uschar *, int, address_item **, uschar **); |
| 258 | extern BOOL filter_personal(string_item *, BOOL); |
| 259 | extern BOOL filter_runtest(int, uschar *, BOOL, BOOL); |
| 260 | extern BOOL filter_system_interpret(address_item **, uschar **); |
| 261 | |
| 262 | extern uschar * fn_hdrs_added(void); |
| 263 | |
| 264 | extern void header_add(int, const char *, ...); |
| 265 | extern header_line *header_add_at_position_internal(BOOL, uschar *, BOOL, int, const char *, ...); |
| 266 | extern int header_checkname(header_line *, BOOL); |
| 267 | extern BOOL header_match(uschar *, BOOL, BOOL, string_item *, int, ...); |
| 268 | extern int host_address_extract_port(uschar *); |
| 269 | extern uschar *host_and_ident(BOOL); |
| 270 | extern int host_aton(const uschar *, int *); |
| 271 | extern void host_build_hostlist(host_item **, const uschar *, BOOL); |
| 272 | extern ip_address_item *host_build_ifacelist(const uschar *, uschar *); |
| 273 | extern void host_build_log_info(void); |
| 274 | extern void host_build_sender_fullhost(void); |
| 275 | extern int host_find_byname(host_item *, const uschar *, int, |
| 276 | const uschar **, BOOL); |
| 277 | extern int host_find_bydns(host_item *, const uschar *, int, uschar *, uschar *, |
| 278 | uschar *, const dnssec_domains *, const uschar **, BOOL *); |
| 279 | extern ip_address_item *host_find_interfaces(void); |
| 280 | extern BOOL host_is_in_net(const uschar *, const uschar *, int); |
| 281 | extern BOOL host_is_tls_on_connect_port(int); |
| 282 | extern int host_item_get_port(host_item *); |
| 283 | extern void host_mask(int, int *, int); |
| 284 | extern int host_name_lookup(void); |
| 285 | extern int host_nmtoa(int, int *, int, uschar *, int); |
| 286 | extern uschar *host_ntoa(int, const void *, uschar *, int *); |
| 287 | extern int host_scan_for_local_hosts(host_item *, host_item **, BOOL *); |
| 288 | |
| 289 | extern uschar *imap_utf7_encode(uschar *, const uschar *, |
| 290 | uschar, uschar *, uschar **); |
| 291 | |
| 292 | extern void invert_address(uschar *, uschar *); |
| 293 | extern int ip_addr(void *, int, const uschar *, int); |
| 294 | extern int ip_bind(int, int, uschar *, int); |
| 295 | extern int ip_connect(int, int, const uschar *, int, int, const blob *); |
| 296 | extern int ip_connectedsocket(int, const uschar *, int, int, |
| 297 | int, host_item *, uschar **, const blob *); |
| 298 | extern int ip_get_address_family(int); |
| 299 | extern void ip_keepalive(int, const uschar *, BOOL); |
| 300 | extern int ip_recv(client_conn_ctx *, uschar *, int, time_t); |
| 301 | extern int ip_socket(int, int); |
| 302 | |
| 303 | extern int ip_tcpsocket(const uschar *, uschar **, int, host_item *); |
| 304 | extern int ip_unixsocket(const uschar *, uschar **); |
| 305 | extern int ip_streamsocket(const uschar *, uschar **, int, host_item *); |
| 306 | |
| 307 | extern int ipv6_nmtoa(int *, uschar *); |
| 308 | |
| 309 | extern uschar *local_part_quote(uschar *); |
| 310 | extern int log_create(uschar *); |
| 311 | extern int log_create_as_exim(uschar *); |
| 312 | extern void log_close_all(void); |
| 313 | |
| 314 | extern macro_item * macro_create(const uschar *, const uschar *, BOOL); |
| 315 | extern BOOL macro_read_assignment(uschar *); |
| 316 | extern uschar *macros_expand(int, int *, BOOL *); |
| 317 | extern void mainlog_close(void); |
| 318 | #ifdef WITH_CONTENT_SCAN |
| 319 | extern int malware(const uschar *, int); |
| 320 | extern int malware_in_file(uschar *); |
| 321 | extern void malware_init(void); |
| 322 | extern gstring * malware_show_supported(gstring *); |
| 323 | #endif |
| 324 | extern int match_address_list(const uschar *, BOOL, BOOL, const uschar **, |
| 325 | unsigned int *, int, int, const uschar **); |
| 326 | extern int match_address_list_basic(const uschar *, const uschar **, int); |
| 327 | extern int match_check_list(const uschar **, int, tree_node **, unsigned int **, |
| 328 | int(*)(void *, const uschar *, const uschar **, uschar **), void *, int, |
| 329 | const uschar *, const uschar **); |
| 330 | extern int match_isinlist(const uschar *, const uschar **, int, tree_node **, |
| 331 | unsigned int *, int, BOOL, const uschar **); |
| 332 | extern int match_check_string(const uschar *, const uschar *, int, BOOL, BOOL, BOOL, |
| 333 | const uschar **); |
| 334 | extern void md5_end(md5 *, const uschar *, int, uschar *); |
| 335 | extern void md5_mid(md5 *, const uschar *); |
| 336 | extern void md5_start(md5 *); |
| 337 | extern void millisleep(int); |
| 338 | #ifdef WITH_CONTENT_SCAN |
| 339 | struct mime_boundary_context; |
| 340 | extern int mime_acl_check(uschar *acl, FILE *f, |
| 341 | struct mime_boundary_context *, uschar **, uschar **); |
| 342 | extern int mime_decode(const uschar **); |
| 343 | extern ssize_t mime_decode_base64(FILE *, FILE *, uschar *); |
| 344 | extern int mime_regex(const uschar **); |
| 345 | extern void mime_set_anomaly(int); |
| 346 | #endif |
| 347 | extern uschar *moan_check_errorcopy(uschar *); |
| 348 | extern BOOL moan_skipped_syntax_errors(uschar *, error_block *, uschar *, |
| 349 | BOOL, uschar *); |
| 350 | extern void moan_smtp_batch(uschar *, const char *, ...) PRINTF_FUNCTION(2,3); |
| 351 | extern BOOL moan_send_message(uschar *, int, error_block *eblock, |
| 352 | header_line *, FILE *, uschar *); |
| 353 | extern void moan_tell_someone(uschar *, address_item *, |
| 354 | const uschar *, const char *, ...) PRINTF_FUNCTION(4,5); |
| 355 | extern BOOL moan_to_sender(int, error_block *, header_line *, FILE *, BOOL); |
| 356 | extern void moan_write_from(FILE *); |
| 357 | extern void moan_write_references(FILE *, uschar *); |
| 358 | extern FILE *modefopen(const uschar *, const char *, mode_t); |
| 359 | |
| 360 | extern int open_cutthrough_connection( address_item * addr ); |
| 361 | |
| 362 | extern uschar *parse_extract_address(uschar *, uschar **, int *, int *, int *, |
| 363 | BOOL); |
| 364 | extern int parse_forward_list(uschar *, int, address_item **, uschar **, |
| 365 | const uschar *, uschar *, error_block **); |
| 366 | extern uschar *parse_find_address_end(uschar *, BOOL); |
| 367 | extern uschar *parse_find_at(uschar *); |
| 368 | extern const uschar *parse_fix_phrase(const uschar *, int, uschar *, int); |
| 369 | extern uschar *parse_message_id(uschar *, uschar **, uschar **); |
| 370 | extern const uschar *parse_quote_2047(const uschar *, int, uschar *, uschar *, int, BOOL); |
| 371 | extern uschar *parse_date_time(uschar *str, time_t *t); |
| 372 | extern int vaguely_random_number(int); |
| 373 | #ifndef DISABLE_TLS |
| 374 | extern int vaguely_random_number_fallback(int); |
| 375 | #endif |
| 376 | |
| 377 | extern BOOL queue_action(uschar *, int, uschar **, int, int); |
| 378 | extern void queue_check_only(void); |
| 379 | extern unsigned queue_count(void); |
| 380 | extern unsigned queue_count_cached(void); |
| 381 | extern void queue_list(int, uschar **, int); |
| 382 | #ifdef EXPERIMENTAL_QUEUE_RAMP |
| 383 | extern void queue_notify_daemon(const uschar * hostname); |
| 384 | #endif |
| 385 | extern void queue_run(uschar *, uschar *, BOOL); |
| 386 | |
| 387 | extern int random_number(int); |
| 388 | extern const uschar *rc_to_string(int); |
| 389 | extern int rda_interpret(redirect_block *, int, uschar *, uschar *, |
| 390 | uschar *, uschar *, uschar *, ugid_block *, address_item **, |
| 391 | uschar **, error_block **, int *, uschar *); |
| 392 | extern int rda_is_filter(const uschar *); |
| 393 | extern BOOL readconf_depends(driver_instance *, uschar *); |
| 394 | extern void readconf_driver_init(uschar *, driver_instance **, |
| 395 | driver_info *, int, void *, int, optionlist *, int); |
| 396 | extern uschar *readconf_find_option(void *); |
| 397 | extern void readconf_main(BOOL); |
| 398 | extern void readconf_options_from_list(optionlist *, unsigned, const uschar *, uschar *); |
| 399 | extern BOOL readconf_print(uschar *, uschar *, BOOL); |
| 400 | extern uschar *readconf_printtime(int); |
| 401 | extern uschar *readconf_readname(uschar *, int, uschar *); |
| 402 | extern int readconf_readtime(const uschar *, int, BOOL); |
| 403 | extern void readconf_rest(void); |
| 404 | extern uschar *readconf_retry_error(const uschar *, const uschar *, int *, int *); |
| 405 | extern void readconf_save_config(const uschar *); |
| 406 | extern void read_message_body(BOOL); |
| 407 | extern void receive_bomb_out(uschar *, uschar *) NORETURN; |
| 408 | extern BOOL receive_check_fs(int); |
| 409 | extern BOOL receive_check_set_sender(uschar *); |
| 410 | extern BOOL receive_msg(BOOL); |
| 411 | extern int_eximarith_t receive_statvfs(BOOL, int *); |
| 412 | extern void receive_swallow_smtp(void); |
| 413 | #ifdef WITH_CONTENT_SCAN |
| 414 | extern int regex(const uschar **); |
| 415 | #endif |
| 416 | extern BOOL regex_match_and_setup(const pcre *, const uschar *, int, int); |
| 417 | extern const pcre *regex_must_compile(const uschar *, BOOL, BOOL); |
| 418 | extern void retry_add_item(address_item *, uschar *, int); |
| 419 | extern BOOL retry_check_address(const uschar *, host_item *, uschar *, BOOL, |
| 420 | uschar **, uschar **); |
| 421 | extern retry_config *retry_find_config(const uschar *, const uschar *, int, int); |
| 422 | extern BOOL retry_ultimate_address_timeout(uschar *, const uschar *, |
| 423 | dbdata_retry *, time_t); |
| 424 | extern void retry_update(address_item **, address_item **, address_item **); |
| 425 | extern uschar *rewrite_address(uschar *, BOOL, BOOL, rewrite_rule *, int); |
| 426 | extern uschar *rewrite_address_qualify(uschar *, BOOL); |
| 427 | extern header_line *rewrite_header(header_line *, |
| 428 | const uschar *, const uschar *, |
| 429 | rewrite_rule *, int, BOOL); |
| 430 | extern uschar *rewrite_one(uschar *, int, BOOL *, BOOL, uschar *, |
| 431 | rewrite_rule *); |
| 432 | extern void rewrite_test(uschar *); |
| 433 | extern uschar *rfc2047_decode2(uschar *, BOOL, uschar *, int, int *, int *, |
| 434 | uschar **); |
| 435 | extern int route_address(address_item *, address_item **, address_item **, |
| 436 | address_item **, address_item **, int); |
| 437 | extern int route_check_prefix(const uschar *, const uschar *, unsigned *); |
| 438 | extern int route_check_suffix(const uschar *, const uschar *, unsigned *); |
| 439 | extern BOOL route_findgroup(uschar *, gid_t *); |
| 440 | extern BOOL route_finduser(const uschar *, struct passwd **, uid_t *); |
| 441 | extern BOOL route_find_expanded_group(uschar *, uschar *, uschar *, gid_t *, |
| 442 | uschar **); |
| 443 | extern BOOL route_find_expanded_user(uschar *, uschar *, uschar *, |
| 444 | struct passwd **, uid_t *, uschar **); |
| 445 | extern void route_init(void); |
| 446 | extern gstring * route_show_supported(gstring *); |
| 447 | extern void route_tidyup(void); |
| 448 | |
| 449 | extern uschar *search_find(void *, const uschar *, uschar *, int, |
| 450 | const uschar *, int, int, int *, const uschar *); |
| 451 | extern int search_findtype(const uschar *, int); |
| 452 | extern int search_findtype_partial(const uschar *, int *, const uschar **, int *, |
| 453 | int *, const uschar **); |
| 454 | extern void *search_open(const uschar *, int, int, uid_t *, gid_t *); |
| 455 | extern void search_tidyup(void); |
| 456 | extern void set_process_info(const char *, ...) PRINTF_FUNCTION(1,2); |
| 457 | extern void sha1_end(hctx *, const uschar *, int, uschar *); |
| 458 | extern void sha1_mid(hctx *, const uschar *); |
| 459 | extern void sha1_start(hctx *); |
| 460 | extern int sieve_interpret(uschar *, int, uschar *, uschar *, uschar *, |
| 461 | uschar *, address_item **, uschar **); |
| 462 | extern void sigalrm_handler(int); |
| 463 | extern BOOL smtp_buffered(void); |
| 464 | extern void smtp_closedown(uschar *); |
| 465 | extern void smtp_command_timeout_exit(void) NORETURN; |
| 466 | extern void smtp_command_sigterm_exit(void) NORETURN; |
| 467 | extern void smtp_data_timeout_exit(void) NORETURN; |
| 468 | extern void smtp_data_sigint_exit(void) NORETURN; |
| 469 | extern void smtp_deliver_init(void); |
| 470 | extern uschar *smtp_cmd_hist(void); |
| 471 | extern int smtp_connect(smtp_connect_args *, const blob *); |
| 472 | extern int smtp_sock_connect(host_item *, int, int, uschar *, |
| 473 | transport_instance * tb, int, const blob *); |
| 474 | extern int smtp_feof(void); |
| 475 | extern int smtp_ferror(void); |
| 476 | extern uschar *smtp_get_connection_info(void); |
| 477 | extern BOOL smtp_get_interface(uschar *, int, address_item *, |
| 478 | uschar **, uschar *); |
| 479 | extern BOOL smtp_get_port(uschar *, address_item *, int *, uschar *); |
| 480 | extern int smtp_getc(unsigned); |
| 481 | extern uschar *smtp_getbuf(unsigned *); |
| 482 | extern void smtp_get_cache(void); |
| 483 | extern int smtp_handle_acl_fail(int, int, uschar *, uschar *); |
| 484 | extern void smtp_log_no_mail(void); |
| 485 | extern void smtp_message_code(uschar **, int *, uschar **, uschar **, BOOL); |
| 486 | extern void smtp_proxy_tls(void *, uschar *, size_t, int *, int) NORETURN; |
| 487 | extern BOOL smtp_read_response(void *, uschar *, int, int, int); |
| 488 | extern void *smtp_reset(void *); |
| 489 | extern void smtp_respond(uschar *, int, BOOL, uschar *); |
| 490 | extern void smtp_notquit_exit(uschar *, uschar *, uschar *, ...); |
| 491 | extern void smtp_port_for_connect(host_item *, int); |
| 492 | extern void smtp_send_prohibition_message(int, uschar *); |
| 493 | extern int smtp_setup_msg(void); |
| 494 | extern BOOL smtp_start_session(void); |
| 495 | extern int smtp_ungetc(int); |
| 496 | extern BOOL smtp_verify_helo(void); |
| 497 | extern int smtp_write_command(void *, int, const char *, ...) PRINTF_FUNCTION(3,4); |
| 498 | #ifdef WITH_CONTENT_SCAN |
| 499 | extern int spam(const uschar **); |
| 500 | extern FILE *spool_mbox(unsigned long *, const uschar *, uschar **); |
| 501 | #endif |
| 502 | extern void spool_clear_header_globals(void); |
| 503 | extern BOOL spool_move_message(uschar *, uschar *, uschar *, uschar *); |
| 504 | extern int spool_open_datafile(uschar *); |
| 505 | extern int spool_open_temp(uschar *); |
| 506 | extern int spool_read_header(uschar *, BOOL, BOOL); |
| 507 | extern int spool_write_header(uschar *, int, uschar **); |
| 508 | extern int stdin_getc(unsigned); |
| 509 | extern int stdin_feof(void); |
| 510 | extern int stdin_ferror(void); |
| 511 | extern int stdin_ungetc(int); |
| 512 | |
| 513 | extern void store_exit(void); |
| 514 | extern gstring *string_append(gstring *, int, ...) WARN_UNUSED_RESULT; |
| 515 | extern gstring *string_append_listele(gstring *, uschar, const uschar *) WARN_UNUSED_RESULT; |
| 516 | extern gstring *string_append_listele_n(gstring *, uschar, const uschar *, unsigned) WARN_UNUSED_RESULT; |
| 517 | extern gstring *string_append2_listele_n(gstring *, const uschar *, const uschar *, unsigned) WARN_UNUSED_RESULT; |
| 518 | extern uschar *string_base62(unsigned long int); |
| 519 | extern gstring *string_cat (gstring *, const uschar * ) WARN_UNUSED_RESULT; |
| 520 | extern gstring *string_catn(gstring *, const uschar *, int) WARN_UNUSED_RESULT; |
| 521 | extern int string_compare_by_pointer(const void *, const void *); |
| 522 | extern uschar *string_copy_dnsdomain(uschar *); |
| 523 | extern uschar *string_copy_malloc(const uschar *); |
| 524 | extern uschar *string_dequote(const uschar **); |
| 525 | extern uschar *string_format_size(int, uschar *); |
| 526 | extern int string_interpret_escape(const uschar **); |
| 527 | extern int string_is_ip_address(const uschar *, int *); |
| 528 | #ifdef SUPPORT_I18N |
| 529 | extern BOOL string_is_utf8(const uschar *); |
| 530 | #endif |
| 531 | extern const uschar *string_printing2(const uschar *, BOOL); |
| 532 | extern uschar *string_split_message(uschar *); |
| 533 | extern uschar *string_unprinting(uschar *); |
| 534 | #ifdef SUPPORT_I18N |
| 535 | extern uschar *string_address_utf8_to_alabel(const uschar *, uschar **); |
| 536 | extern uschar *string_domain_alabel_to_utf8(const uschar *, uschar **); |
| 537 | extern uschar *string_domain_utf8_to_alabel(const uschar *, uschar **); |
| 538 | extern uschar *string_localpart_alabel_to_utf8(const uschar *, uschar **); |
| 539 | extern uschar *string_localpart_utf8_to_alabel(const uschar *, uschar **); |
| 540 | #endif |
| 541 | |
| 542 | #define string_format(buf, siz, fmt, ...) \ |
| 543 | string_format_trc(buf, siz, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__) |
| 544 | extern BOOL string_format_trc(uschar *, int, const uschar *, unsigned, |
| 545 | const char *, ...) ALMOST_PRINTF(5,6); |
| 546 | |
| 547 | #define string_vformat(g, flgs, fmt, ap) \ |
| 548 | string_vformat_trc(g, US __FUNCTION__, __LINE__, \ |
| 549 | STRING_SPRINTF_BUFFER_SIZE, flgs, fmt, ap) |
| 550 | extern gstring *string_vformat_trc(gstring *, const uschar *, unsigned, |
| 551 | unsigned, unsigned, const char *, va_list); |
| 552 | |
| 553 | #define string_open_failed(eno, fmt, ...) \ |
| 554 | string_open_failed_trc(eno, US __FUNCTION__, __LINE__, fmt, __VA_ARGS__) |
| 555 | extern uschar *string_open_failed_trc(int, const uschar *, unsigned, |
| 556 | const char *, ...) PRINTF_FUNCTION(4,5); |
| 557 | |
| 558 | #define string_nextinlist(lp, sp, b, l) \ |
| 559 | string_nextinlist_trc((lp), (sp), (b), (l), US __FUNCTION__, __LINE__) |
| 560 | extern uschar *string_nextinlist_trc(const uschar **listptr, int *separator, uschar *buffer, int buflen, |
| 561 | const uschar * func, int line); |
| 562 | |
| 563 | extern int strcmpic(const uschar *, const uschar *); |
| 564 | extern int strncmpic(const uschar *, const uschar *, int); |
| 565 | extern uschar *strstric(uschar *, uschar *, BOOL); |
| 566 | |
| 567 | extern int test_harness_fudged_queue_time(int); |
| 568 | extern void tcp_init(void); |
| 569 | #ifdef EXIM_TFO_PROBE |
| 570 | extern void tfo_probe(void); |
| 571 | #endif |
| 572 | extern void tls_modify_variables(tls_support *); |
| 573 | extern uschar *tod_stamp(int); |
| 574 | |
| 575 | extern BOOL transport_check_waiting(const uschar *, const uschar *, int, uschar *, |
| 576 | BOOL *, oicf, void*); |
| 577 | extern void transport_init(void); |
| 578 | extern void transport_do_pass_socket(const uschar *, const uschar *, |
| 579 | const uschar *, uschar *, int); |
| 580 | extern BOOL transport_pass_socket(const uschar *, const uschar *, const uschar *, uschar *, |
| 581 | int); |
| 582 | extern uschar *transport_rcpt_address(address_item *, BOOL); |
| 583 | extern BOOL transport_set_up_command(const uschar ***, uschar *, |
| 584 | BOOL, int, address_item *, uschar *, uschar **); |
| 585 | extern void transport_update_waiting(host_item *, uschar *); |
| 586 | extern BOOL transport_write_block(transport_ctx *, uschar *, int, BOOL); |
| 587 | extern void transport_write_reset(int); |
| 588 | extern BOOL transport_write_string(int, const char *, ...); |
| 589 | extern BOOL transport_headers_send(transport_ctx *, |
| 590 | BOOL (*)(transport_ctx *, uschar *, int)); |
| 591 | extern gstring * transport_show_supported(gstring *); |
| 592 | extern BOOL transport_write_message(transport_ctx *, int); |
| 593 | extern void tree_add_duplicate(uschar *, address_item *); |
| 594 | extern void tree_add_nonrecipient(uschar *); |
| 595 | extern void tree_add_unusable(host_item *); |
| 596 | extern void tree_dup(tree_node **, tree_node *); |
| 597 | extern int tree_insertnode(tree_node **, tree_node *); |
| 598 | extern tree_node *tree_search(tree_node *, const uschar *); |
| 599 | extern void tree_write(tree_node *, FILE *); |
| 600 | extern void tree_walk(tree_node *, void (*)(uschar*, uschar*, void*), void *); |
| 601 | |
| 602 | #ifdef WITH_CONTENT_SCAN |
| 603 | extern void unspool_mbox(void); |
| 604 | #endif |
| 605 | #ifdef SUPPORT_I18N |
| 606 | extern void utf8_version_report(FILE *); |
| 607 | #endif |
| 608 | |
| 609 | extern int verify_address(address_item *, FILE *, int, int, int, int, |
| 610 | uschar *, uschar *, BOOL *); |
| 611 | extern int verify_check_dnsbl(int, const uschar **, uschar **); |
| 612 | extern int verify_check_header_address(uschar **, uschar **, int, int, int, |
| 613 | uschar *, uschar *, int, int *); |
| 614 | extern int verify_check_headers(uschar **); |
| 615 | extern int verify_check_header_names_ascii(uschar **); |
| 616 | extern int verify_check_host(uschar **); |
| 617 | extern int verify_check_notblind(BOOL); |
| 618 | extern int verify_check_given_host(const uschar **, const host_item *); |
| 619 | extern int verify_check_this_host(const uschar **, unsigned int *, |
| 620 | const uschar*, const uschar *, const uschar **); |
| 621 | extern address_item *verify_checked_sender(uschar *); |
| 622 | extern void verify_get_ident(int); |
| 623 | extern BOOL verify_sender(int *, uschar **); |
| 624 | extern BOOL verify_sender_preliminary(int *, uschar **); |
| 625 | extern void version_init(void); |
| 626 | |
| 627 | extern BOOL write_chunk(transport_ctx *, uschar *, int); |
| 628 | extern ssize_t write_to_fd_buf(int, const uschar *, size_t); |
| 629 | |
| 630 | |
| 631 | /******************************************************************************/ |
| 632 | /* Predicate: if an address is in a tainted pool. |
| 633 | By extension, a variable pointing to this address is tainted. |
| 634 | */ |
| 635 | |
| 636 | static inline BOOL |
| 637 | is_tainted(const void * p) |
| 638 | { |
| 639 | #if defined(COMPILE_UTILITY) || defined(MACRO_PREDEF) || defined(EM_VERSION_C) |
| 640 | return FALSE; |
| 641 | |
| 642 | #else |
| 643 | extern BOOL is_tainted_fn(const void *); |
| 644 | return is_tainted_fn(p); |
| 645 | #endif |
| 646 | } |
| 647 | |
| 648 | /******************************************************************************/ |
| 649 | /* String functions */ |
| 650 | static inline uschar * __Ustrcat(uschar * dst, const uschar * src, const char * func, int line) |
| 651 | { |
| 652 | #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) |
| 653 | if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcat", CUS func, line); |
| 654 | #endif |
| 655 | return US strcat(CS dst, CCS src); |
| 656 | } |
| 657 | static inline uschar * __Ustrcpy(uschar * dst, const uschar * src, const char * func, int line) |
| 658 | { |
| 659 | #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) |
| 660 | if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrcpy", CUS func, line); |
| 661 | #endif |
| 662 | return US strcpy(CS dst, CCS src); |
| 663 | } |
| 664 | static inline uschar * __Ustrncat(uschar * dst, const uschar * src, size_t n, const char * func, int line) |
| 665 | { |
| 666 | #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) |
| 667 | if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncat", CUS func, line); |
| 668 | #endif |
| 669 | return US strncat(CS dst, CCS src, n); |
| 670 | } |
| 671 | static inline uschar * __Ustrncpy(uschar * dst, const uschar * src, size_t n, const char * func, int line) |
| 672 | { |
| 673 | #if !defined(COMPILE_UTILITY) && !defined(MACRO_PREDEF) |
| 674 | if (!is_tainted(dst) && is_tainted(src)) die_tainted(US"Ustrncpy", CUS func, line); |
| 675 | #endif |
| 676 | return US strncpy(CS dst, CCS src, n); |
| 677 | } |
| 678 | /*XXX will likely need unchecked copy also */ |
| 679 | |
| 680 | |
| 681 | /* Advance the string pointer given over any whitespace. |
| 682 | Return the next char as there's enought places using it to be useful. */ |
| 683 | |
| 684 | #define Uskip_whitespace(sp) skip_whitespace(CUSS sp) |
| 685 | |
| 686 | static inline uschar skip_whitespace(const uschar ** sp) |
| 687 | { while (isspace(**sp)) (*sp)++; return **sp; } |
| 688 | |
| 689 | |
| 690 | /******************************************************************************/ |
| 691 | |
| 692 | #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY) |
| 693 | /* exim_chown - in some NFSv4 setups *seemes* to be an issue with |
| 694 | chown(<exim-uid>, <exim-gid>). |
| 695 | |
| 696 | Probably because the idmapping is broken, misconfigured or set up in |
| 697 | an unusal way. (see Bug 2931). As I'm not sure, if this was a single |
| 698 | case of misconfiguration, or if there are more such broken systems |
| 699 | out, I try to impose as least impact as possible and for now just write |
| 700 | a panic log entry pointing to the bug report. You're encouraged to |
| 701 | contact the developers, if you experience this issue. |
| 702 | |
| 703 | fd the file descriptor (or -1 if not valid) |
| 704 | name the file name for error messages or for file operations, |
| 705 | if fd is < 0 |
| 706 | owner the owner |
| 707 | group the group |
| 708 | |
| 709 | returns 0 on success, -1 on failure */ |
| 710 | |
| 711 | static inline int |
| 712 | exim_fchown(int fd, uid_t owner, gid_t group, const uschar *name) |
| 713 | { |
| 714 | return fchown(fd, owner, group) |
| 715 | ? exim_chown_failure(fd, name, owner, group) : 0; |
| 716 | } |
| 717 | |
| 718 | static inline int |
| 719 | exim_chown(const uschar *name, uid_t owner, gid_t group) |
| 720 | { |
| 721 | return chown(CCS name, owner, group) |
| 722 | ? exim_chown_failure(-1, name, owner, group) : 0; |
| 723 | } |
| 724 | #endif /* !MACRO_PREDEF && !COMPILE_UTILITY */ |
| 725 | |
| 726 | /******************************************************************************/ |
| 727 | /* String functions */ |
| 728 | |
| 729 | #if !defined(MACRO_PREDEF) |
| 730 | /************************************************* |
| 731 | * Copy and save string * |
| 732 | *************************************************/ |
| 733 | |
| 734 | /* This function assumes that memcpy() is faster than strcpy(). |
| 735 | The result is explicitly nul-terminated. |
| 736 | */ |
| 737 | |
| 738 | static inline uschar * |
| 739 | string_copyn_taint_trc(const uschar * s, unsigned len, |
| 740 | BOOL tainted, const char * func, int line) |
| 741 | { |
| 742 | uschar * ss = store_get_3(len + 1, tainted, func, line); |
| 743 | memcpy(ss, s, len); |
| 744 | ss[len] = '\0'; |
| 745 | return ss; |
| 746 | } |
| 747 | |
| 748 | static inline uschar * |
| 749 | string_copy_taint_trc(const uschar * s, BOOL tainted, const char * func, int line) |
| 750 | { return string_copyn_taint_trc(s, Ustrlen(s), tainted, func, line); } |
| 751 | |
| 752 | static inline uschar * |
| 753 | string_copyn_trc(const uschar * s, unsigned len, const char * func, int line) |
| 754 | { return string_copyn_taint_trc(s, len, is_tainted(s), func, line); } |
| 755 | static inline uschar * |
| 756 | string_copy_trc(const uschar * s, const char * func, int line) |
| 757 | { return string_copy_taint_trc(s, is_tainted(s), func, line); } |
| 758 | |
| 759 | |
| 760 | /* String-copy functions explicitly setting the taint status */ |
| 761 | |
| 762 | #define string_copyn_taint(s, len, tainted) \ |
| 763 | string_copyn_taint_trc((s), (len), (tainted), __FUNCTION__, __LINE__) |
| 764 | #define string_copy_taint(s, tainted) \ |
| 765 | string_copy_taint_trc((s), (tainted), __FUNCTION__, __LINE__) |
| 766 | |
| 767 | /* Simple string-copy functions maintaining the taint */ |
| 768 | |
| 769 | #define string_copyn(s, len) \ |
| 770 | string_copyn_taint_trc((s), (len), is_tainted(s), __FUNCTION__, __LINE__) |
| 771 | #define string_copy(s) \ |
| 772 | string_copy_taint_trc((s), is_tainted(s), __FUNCTION__, __LINE__) |
| 773 | |
| 774 | |
| 775 | /************************************************* |
| 776 | * Copy, lowercase and save string * |
| 777 | *************************************************/ |
| 778 | |
| 779 | /* |
| 780 | Argument: string to copy |
| 781 | Returns: copy of string in new store, with letters lowercased |
| 782 | */ |
| 783 | |
| 784 | static inline uschar * |
| 785 | string_copylc(const uschar *s) |
| 786 | { |
| 787 | uschar *ss = store_get(Ustrlen(s) + 1, is_tainted(s)); |
| 788 | uschar *p = ss; |
| 789 | while (*s != 0) *p++ = tolower(*s++); |
| 790 | *p = 0; |
| 791 | return ss; |
| 792 | } |
| 793 | |
| 794 | |
| 795 | |
| 796 | /************************************************* |
| 797 | * Copy, lowercase, and save string, given length * |
| 798 | *************************************************/ |
| 799 | |
| 800 | /* It is assumed the data contains no zeros. A zero is added |
| 801 | onto the end. |
| 802 | |
| 803 | Arguments: |
| 804 | s string to copy |
| 805 | n number of characters |
| 806 | |
| 807 | Returns: copy of string in new store, with letters lowercased |
| 808 | */ |
| 809 | |
| 810 | static inline uschar * |
| 811 | string_copynlc(uschar *s, int n) |
| 812 | { |
| 813 | uschar *ss = store_get(n + 1, is_tainted(s)); |
| 814 | uschar *p = ss; |
| 815 | while (n-- > 0) *p++ = tolower(*s++); |
| 816 | *p = 0; |
| 817 | return ss; |
| 818 | } |
| 819 | |
| 820 | |
| 821 | # ifndef COMPILE_UTILITY |
| 822 | /************************************************* |
| 823 | * Copy and save string in longterm store * |
| 824 | *************************************************/ |
| 825 | |
| 826 | /* This function assumes that memcpy() is faster than strcpy(). |
| 827 | |
| 828 | Argument: string to copy |
| 829 | Returns: copy of string in new store |
| 830 | */ |
| 831 | |
| 832 | static inline uschar * |
| 833 | string_copy_perm(const uschar *s, BOOL force_taint) |
| 834 | { |
| 835 | int old_pool = store_pool; |
| 836 | int len = Ustrlen(s) + 1; |
| 837 | uschar *ss; |
| 838 | |
| 839 | store_pool = POOL_PERM; |
| 840 | ss = store_get(len, force_taint || is_tainted(s)); |
| 841 | memcpy(ss, s, len); |
| 842 | store_pool = old_pool; |
| 843 | return ss; |
| 844 | } |
| 845 | # endif |
| 846 | |
| 847 | |
| 848 | |
| 849 | /* sprintf into a buffer, taint-unchecked */ |
| 850 | |
| 851 | static inline void |
| 852 | string_format_nt(uschar * buf, int siz, const char * fmt, ...) |
| 853 | { |
| 854 | gstring gs = { .size = siz, .ptr = 0, .s = buf }; |
| 855 | va_list ap; |
| 856 | va_start(ap, fmt); |
| 857 | (void) string_vformat(&gs, SVFMT_TAINT_NOCHK, fmt, ap); |
| 858 | va_end(ap); |
| 859 | } |
| 860 | |
| 861 | |
| 862 | |
| 863 | /******************************************************************************/ |
| 864 | /* Growable-string functions */ |
| 865 | |
| 866 | /* Create a growable-string with some preassigned space */ |
| 867 | |
| 868 | #define string_get_tainted(size, tainted) \ |
| 869 | string_get_tainted_trc((size), (tainted), __FUNCTION__, __LINE__) |
| 870 | |
| 871 | static inline gstring * |
| 872 | string_get_tainted_trc(unsigned size, BOOL tainted, const char * func, unsigned line) |
| 873 | { |
| 874 | gstring * g = store_get_3(sizeof(gstring) + size, tainted, func, line); |
| 875 | g->size = size; |
| 876 | g->ptr = 0; |
| 877 | g->s = US(g + 1); |
| 878 | return g; |
| 879 | } |
| 880 | |
| 881 | #define string_get(size) \ |
| 882 | string_get_trc((size), __FUNCTION__, __LINE__) |
| 883 | |
| 884 | static inline gstring * |
| 885 | string_get_trc(unsigned size, const char * func, unsigned line) |
| 886 | { |
| 887 | return string_get_tainted_trc(size, FALSE, func, line); |
| 888 | } |
| 889 | |
| 890 | /* NUL-terminate the C string in the growable-string, and return it. */ |
| 891 | |
| 892 | static inline uschar * |
| 893 | string_from_gstring(gstring * g) |
| 894 | { |
| 895 | if (!g) return NULL; |
| 896 | g->s[g->ptr] = '\0'; |
| 897 | return g->s; |
| 898 | } |
| 899 | |
| 900 | static inline unsigned |
| 901 | gstring_length(const gstring * g) |
| 902 | { |
| 903 | return g ? (unsigned)g->ptr : 0; |
| 904 | } |
| 905 | |
| 906 | |
| 907 | #define gstring_release_unused(g) \ |
| 908 | gstring_release_unused_trc(g, __FUNCTION__, __LINE__) |
| 909 | |
| 910 | static inline void |
| 911 | gstring_release_unused_trc(gstring * g, const char * file, unsigned line) |
| 912 | { |
| 913 | if (g) store_release_above_3(g->s + (g->size = g->ptr + 1), file, line); |
| 914 | } |
| 915 | |
| 916 | |
| 917 | /* sprintf-append to a growable-string */ |
| 918 | |
| 919 | #define string_fmt_append(g, fmt, ...) \ |
| 920 | string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \ |
| 921 | SVFMT_EXTEND|SVFMT_REBUFFER, fmt, __VA_ARGS__) |
| 922 | |
| 923 | #define string_fmt_append_f(g, flgs, fmt, ...) \ |
| 924 | string_fmt_append_f_trc(g, US __FUNCTION__, __LINE__, \ |
| 925 | flgs, fmt, __VA_ARGS__) |
| 926 | |
| 927 | static inline gstring * |
| 928 | string_fmt_append_f_trc(gstring * g, const uschar * func, unsigned line, |
| 929 | unsigned flags, const char *format, ...) |
| 930 | { |
| 931 | va_list ap; |
| 932 | va_start(ap, format); |
| 933 | g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE, |
| 934 | flags, format, ap); |
| 935 | va_end(ap); |
| 936 | return g; |
| 937 | } |
| 938 | |
| 939 | |
| 940 | /* Copy the content of a string to tainted memory */ |
| 941 | |
| 942 | static inline void |
| 943 | gstring_rebuffer(gstring * g) |
| 944 | { |
| 945 | uschar * s = store_get(g->size, TRUE); |
| 946 | memcpy(s, g->s, g->ptr); |
| 947 | g->s = s; |
| 948 | } |
| 949 | |
| 950 | |
| 951 | /******************************************************************************/ |
| 952 | |
| 953 | #define store_get_dns_answer() store_get_dns_answer_trc(CUS __FUNCTION__, __LINE__) |
| 954 | |
| 955 | static inline dns_answer * |
| 956 | store_get_dns_answer_trc(const uschar * func, unsigned line) |
| 957 | { |
| 958 | return store_get_3(sizeof(dns_answer), TRUE, CCS func, line); /* use tainted mem */ |
| 959 | } |
| 960 | |
| 961 | /******************************************************************************/ |
| 962 | /* Routines with knowledge of spool layout */ |
| 963 | |
| 964 | # ifndef COMPILE_UTILITY |
| 965 | static inline void |
| 966 | spool_pname_buf(uschar * buf, int len) |
| 967 | { |
| 968 | snprintf(CS buf, len, "%s/%s/input", spool_directory, queue_name); |
| 969 | } |
| 970 | |
| 971 | static inline uschar * |
| 972 | spool_dname(const uschar * purpose, uschar * subdir) |
| 973 | { |
| 974 | return string_sprintf("%s/%s/%s/%s", |
| 975 | spool_directory, queue_name, purpose, subdir); |
| 976 | } |
| 977 | # endif |
| 978 | |
| 979 | static inline uschar * |
| 980 | spool_q_sname(const uschar * purpose, const uschar * q, uschar * subdir) |
| 981 | { |
| 982 | return string_sprintf("%s%s%s%s%s", |
| 983 | q, *q ? "/" : "", |
| 984 | purpose, |
| 985 | *subdir ? "/" : "", subdir); |
| 986 | } |
| 987 | |
| 988 | static inline uschar * |
| 989 | spool_sname(const uschar * purpose, uschar * subdir) |
| 990 | { |
| 991 | return spool_q_sname(purpose, queue_name, subdir); |
| 992 | } |
| 993 | |
| 994 | static inline uschar * |
| 995 | spool_q_fname(const uschar * purpose, const uschar * q, |
| 996 | const uschar * subdir, const uschar * fname, const uschar * suffix) |
| 997 | { |
| 998 | return string_sprintf("%s/%s/%s/%s/%s%s", |
| 999 | spool_directory, q, purpose, subdir, fname, suffix); |
| 1000 | } |
| 1001 | |
| 1002 | static inline uschar * |
| 1003 | spool_fname(const uschar * purpose, const uschar * subdir, const uschar * fname, |
| 1004 | const uschar * suffix) |
| 1005 | { |
| 1006 | #ifdef COMPILE_UTILITY /* version avoiding string-extension */ |
| 1007 | int len = Ustrlen(spool_directory) + 1 + Ustrlen(queue_name) + 1 + Ustrlen(purpose) + 1 |
| 1008 | + Ustrlen(subdir) + 1 + Ustrlen(fname) + Ustrlen(suffix) + 1; |
| 1009 | uschar * buf = store_get(len, FALSE); |
| 1010 | string_format(buf, len, "%s/%s/%s/%s/%s%s", |
| 1011 | spool_directory, queue_name, purpose, subdir, fname, suffix); |
| 1012 | return buf; |
| 1013 | #else |
| 1014 | return spool_q_fname(purpose, queue_name, subdir, fname, suffix); |
| 1015 | #endif |
| 1016 | } |
| 1017 | |
| 1018 | static inline void |
| 1019 | set_subdir_str(uschar * subdir_str, const uschar * name, |
| 1020 | int search_sequence) |
| 1021 | { |
| 1022 | subdir_str[0] = split_spool_directory == (search_sequence == 0) |
| 1023 | ? name[5] : '\0'; |
| 1024 | subdir_str[1] = '\0'; |
| 1025 | } |
| 1026 | |
| 1027 | /******************************************************************************/ |
| 1028 | /* Time calculations */ |
| 1029 | |
| 1030 | static inline void |
| 1031 | timesince(struct timeval * diff, const struct timeval * then) |
| 1032 | { |
| 1033 | gettimeofday(diff, NULL); |
| 1034 | diff->tv_sec -= then->tv_sec; |
| 1035 | if ((diff->tv_usec -= then->tv_usec) < 0) |
| 1036 | { |
| 1037 | diff->tv_sec--; |
| 1038 | diff->tv_usec += 1000*1000; |
| 1039 | } |
| 1040 | } |
| 1041 | |
| 1042 | static inline uschar * |
| 1043 | string_timediff(const struct timeval * diff) |
| 1044 | { |
| 1045 | static uschar buf[sizeof("0.000s")]; |
| 1046 | |
| 1047 | if (diff->tv_sec >= 5 || !LOGGING(millisec)) |
| 1048 | return readconf_printtime((int)diff->tv_sec); |
| 1049 | |
| 1050 | snprintf(CS buf, sizeof(buf), "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000); |
| 1051 | return buf; |
| 1052 | } |
| 1053 | |
| 1054 | |
| 1055 | static inline uschar * |
| 1056 | string_timesince(const struct timeval * then) |
| 1057 | { |
| 1058 | struct timeval diff; |
| 1059 | timesince(&diff, then); |
| 1060 | return string_timediff(&diff); |
| 1061 | } |
| 1062 | |
| 1063 | static inline void |
| 1064 | report_time_since(const struct timeval * t0, const uschar * where) |
| 1065 | { |
| 1066 | # ifdef MEASURE_TIMING |
| 1067 | struct timeval diff; |
| 1068 | timesince(&diff, t0); |
| 1069 | fprintf(stderr, "%d %s:\t%ld.%06ld\n", |
| 1070 | (uint)getpid(), where, (long)diff.tv_sec, (long)diff.tv_usec); |
| 1071 | # endif |
| 1072 | } |
| 1073 | |
| 1074 | |
| 1075 | static inline void |
| 1076 | testharness_pause_ms(int millisec) |
| 1077 | { |
| 1078 | #ifndef MEASURE_TIMING |
| 1079 | if (f.running_in_test_harness && f.testsuite_delays) millisleep(millisec); |
| 1080 | #endif |
| 1081 | } |
| 1082 | |
| 1083 | /******************************************************************************/ |
| 1084 | /* Taint-checked file opens */ |
| 1085 | |
| 1086 | static inline int |
| 1087 | exim_open2(const char *pathname, int flags) |
| 1088 | { |
| 1089 | if (!is_tainted(pathname)) return open(pathname, flags); |
| 1090 | log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); |
| 1091 | errno = EACCES; |
| 1092 | return -1; |
| 1093 | } |
| 1094 | static inline int |
| 1095 | exim_open(const char *pathname, int flags, mode_t mode) |
| 1096 | { |
| 1097 | if (!is_tainted(pathname)) return open(pathname, flags, mode); |
| 1098 | log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); |
| 1099 | errno = EACCES; |
| 1100 | return -1; |
| 1101 | } |
| 1102 | static inline int |
| 1103 | exim_openat(int dirfd, const char *pathname, int flags) |
| 1104 | { |
| 1105 | if (!is_tainted(pathname)) return openat(dirfd, pathname, flags); |
| 1106 | log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); |
| 1107 | errno = EACCES; |
| 1108 | return -1; |
| 1109 | } |
| 1110 | static inline int |
| 1111 | exim_openat4(int dirfd, const char *pathname, int flags, mode_t mode) |
| 1112 | { |
| 1113 | if (!is_tainted(pathname)) return openat(dirfd, pathname, flags, mode); |
| 1114 | log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); |
| 1115 | errno = EACCES; |
| 1116 | return -1; |
| 1117 | } |
| 1118 | |
| 1119 | static inline FILE * |
| 1120 | exim_fopen(const char *pathname, const char *mode) |
| 1121 | { |
| 1122 | if (!is_tainted(pathname)) return fopen(pathname, mode); |
| 1123 | log_write(0, LOG_MAIN|LOG_PANIC, "Tainted filename '%s'", pathname); |
| 1124 | errno = EACCES; |
| 1125 | return NULL; |
| 1126 | } |
| 1127 | |
| 1128 | static inline DIR * |
| 1129 | exim_opendir(const uschar * name) |
| 1130 | { |
| 1131 | if (!is_tainted(name)) return opendir(CCS name); |
| 1132 | log_write(0, LOG_MAIN|LOG_PANIC, "Tainted dirname '%s'", name); |
| 1133 | errno = EACCES; |
| 1134 | return NULL; |
| 1135 | } |
| 1136 | |
| 1137 | /******************************************************************************/ |
| 1138 | # if !defined(COMPILE_UTILITY) |
| 1139 | /* Process manipulation */ |
| 1140 | |
| 1141 | static inline pid_t |
| 1142 | exim_fork(const unsigned char * purpose) |
| 1143 | { |
| 1144 | pid_t pid; |
| 1145 | DEBUG(D_any) debug_printf("%s forking for %s\n", process_purpose, purpose); |
| 1146 | if ((pid = fork()) == 0) |
| 1147 | { |
| 1148 | process_purpose = purpose; |
| 1149 | DEBUG(D_any) debug_printf("postfork: %s\n", purpose); |
| 1150 | } |
| 1151 | else |
| 1152 | { |
| 1153 | testharness_pause_ms(100); /* let child work */ |
| 1154 | DEBUG(D_any) debug_printf("%s forked for %s: %d\n", process_purpose, purpose, (int)pid); |
| 1155 | } |
| 1156 | return pid; |
| 1157 | } |
| 1158 | |
| 1159 | |
| 1160 | static inline pid_t |
| 1161 | child_open_exim(int * fdptr, const uschar * purpose) |
| 1162 | { return child_open_exim_function(fdptr, purpose); } |
| 1163 | |
| 1164 | static inline pid_t |
| 1165 | child_open_exim2(int * fdptr, uschar * sender, |
| 1166 | uschar * sender_auth, const uschar * purpose) |
| 1167 | { return child_open_exim2_function(fdptr, sender, sender_auth, purpose); } |
| 1168 | |
| 1169 | static inline pid_t |
| 1170 | child_open(uschar **argv, uschar **envp, int newumask, int *infdptr, |
| 1171 | int *outfdptr, BOOL make_leader, const uschar * purpose) |
| 1172 | { return child_open_function(argv, envp, newumask, infdptr, |
| 1173 | outfdptr, make_leader, purpose); |
| 1174 | } |
| 1175 | |
| 1176 | # endif /* !COMPILE_UTILITY */ |
| 1177 | |
| 1178 | /******************************************************************************/ |
| 1179 | #endif /* !MACRO_PREDEF */ |
| 1180 | |
| 1181 | #endif /* _FUNCTIONS_H_ */ |
| 1182 | |
| 1183 | /* vi: aw |
| 1184 | */ |
| 1185 | /* End of functions.h */ |