cmd-redirect.c

/* Copyright (c) 2002-2018 Pigeonhole authors, see the included COPYING file
 */

#include "lib.h"
#include "ioloop.h"
#include "str-sanitize.h"
#include "strfuncs.h"
#include "istream.h"
#include "istream-header-filter.h"
#include "ostream.h"
#include "mail-storage.h"

#include "rfc2822.h"

#include "sieve-common.h"
#include "sieve-limits.h"
#include "sieve-address.h"
#include "sieve-commands.h"
#include "sieve-code.h"
#include "sieve-message.h"
#include "sieve-actions.h"
#include "sieve-validator.h"
#include "sieve-generator.h"
#include "sieve-interpreter.h"
#include "sieve-code-dumper.h"
#include "sieve-result.h"
#include "sieve-smtp.h"
#include "sieve-message.h"

#include <stdio.h>

/*
 * Redirect command
 *
 * Syntax
 *   redirect <address: string>
 */

static bool
cmd_redirect_validate(struct sieve_validator *validator,
		      struct sieve_command *cmd);
static bool
cmd_redirect_generate(const struct sieve_codegen_env *cgenv,
		      struct sieve_command *cmd);

const struct sieve_command_def cmd_redirect = {
	.identifier = "redirect",
	.type = SCT_COMMAND,
	.positional_args = 1,
	.subtests = 0,
	.block_allowed = FALSE,
	.block_required = FALSE,
	.validate = cmd_redirect_validate,
	.generate = cmd_redirect_generate
};

/*
 * Redirect operation
 */

static bool
cmd_redirect_operation_dump(const struct sieve_dumptime_env *denv,
			    sieve_size_t *address);
static int
cmd_redirect_operation_execute(const struct sieve_runtime_env *renv,
			       sieve_size_t *address);

const struct sieve_operation_def cmd_redirect_operation = {
	.mnemonic = "REDIRECT",
	.code = SIEVE_OPERATION_REDIRECT,
	.dump = cmd_redirect_operation_dump,
	.execute = cmd_redirect_operation_execute
};

/*
 * Redirect action
 */

static bool
act_redirect_equals(const struct sieve_script_env *senv,
		    const struct sieve_action *act1,
		    const struct sieve_action *act2);
static int
act_redirect_check_duplicate(const struct sieve_runtime_env *renv,
			     const struct sieve_action *act,
			     const struct sieve_action *act_other);
static void
act_redirect_print(const struct sieve_action *action,
		   const struct sieve_result_print_env *rpenv, bool *keep);

static int
act_redirect_start(const struct sieve_action_exec_env *aenv, void **tr_context);
static int
act_redirect_execute(const struct sieve_action_exec_env *aenv, void *tr_context,
		    bool *keep);
static int
act_redirect_commit(const struct sieve_action_exec_env *aenv, void *tr_context);

const struct sieve_action_def act_redirect = {
	.name = "redirect",
	.flags = SIEVE_ACTFLAG_TRIES_DELIVER,
	.equals = act_redirect_equals,
	.check_duplicate = act_redirect_check_duplicate,
	.print = act_redirect_print,
	.start = act_redirect_start,
	.execute = act_redirect_execute,
	.commit = act_redirect_commit,
};

/*
 * Validation
 */

static bool
cmd_redirect_validate(struct sieve_validator *validator,
		      struct sieve_command *cmd)
{
	struct sieve_instance *svinst = sieve_validator_svinst(validator);
	struct sieve_ast_argument *arg = cmd->first_positional;

	/* Check and activate address argument */

	if (!sieve_validate_positional_argument(validator, cmd, arg, "address",
						1, SAAT_STRING))
		return FALSE;

	if (!sieve_validator_argument_activate(validator, cmd, arg, FALSE))
		return FALSE;

	/* We can only assess the validity of the outgoing address when it is
	 * a string literal. For runtime-generated strings this needs to be
	 * done at runtime.
	 */
	if (sieve_argument_is_string_literal(arg)) {
		string_t *raw_address = sieve_ast_argument_str(arg);
		const char *error;
		bool result;

		T_BEGIN {
			/* Parse the address */
			result = sieve_address_validate_str(raw_address, &error);
			if (!result) {
				sieve_argument_validate_error(
					validator, arg,
					"specified redirect address '%s' is invalid: %s",
					str_sanitize(str_c(raw_address),128),
					error);
			}
		} T_END;

		return result;
	}

	if (svinst->max_redirects == 0) {
		sieve_command_validate_error(validator, cmd,
			"local policy prohibits the use of a redirect action");
		return FALSE;
	}
	return TRUE;
}

/*
 * Code generation
 */

static bool
cmd_redirect_generate(const struct sieve_codegen_env *cgenv,
		      struct sieve_command *cmd)
{
	sieve_operation_emit(cgenv->sblock, NULL,  &cmd_redirect_operation);

	/* Generate arguments */
	return sieve_generate_arguments(cgenv, cmd, NULL);
}

/*
 * Code dump
 */

static bool
cmd_redirect_operation_dump(const struct sieve_dumptime_env *denv,
			    sieve_size_t *address)
{
	sieve_code_dumpf(denv, "REDIRECT");
	sieve_code_descend(denv);

	if (sieve_action_opr_optional_dump(denv, address, NULL) != 0)
		return FALSE;

	return sieve_opr_string_dump(denv, address, "address");
}

/*
 * Code execution
 */

static int
cmd_redirect_operation_execute(const struct sieve_runtime_env *renv,
			       sieve_size_t *address)
{
	const struct sieve_execute_env *eenv = renv->exec_env;
	struct sieve_instance *svinst = eenv->svinst;
	struct sieve_side_effects_list *slist = NULL;
	string_t *redirect;
	const struct smtp_address *to_address;
	const char *error;
	int ret;

	/*
	 * Read data
	 */

	/* Optional operands (side effects only) */
	if (sieve_action_opr_optional_read(renv, address, NULL,
					   &ret, &slist) != 0)
		return ret;

	/* Read the address */
	if ((ret = sieve_opr_string_read(renv, address, "address",
					 &redirect)) <= 0)
		return ret;

	/*
	 * Perform operation
	 */

	/* Parse the address */
	to_address = sieve_address_parse_str(redirect, &error);
	if (to_address == NULL) {
		sieve_runtime_error(renv, NULL,
			"specified redirect address '%s' is invalid: %s",
			str_sanitize(str_c(redirect),128), error);
		return SIEVE_EXEC_FAILURE;
	}

	if (svinst->max_redirects == 0) {
		sieve_runtime_error(renv, NULL,
			"local policy prohibits the use of a redirect action");
		return SIEVE_EXEC_FAILURE;
	}

	if (sieve_runtime_trace_active(renv, SIEVE_TRLVL_ACTIONS)) {
		sieve_runtime_trace(renv, 0, "redirect action");
		sieve_runtime_trace_descend(renv);
		sieve_runtime_trace(renv, 0, "forward message to address %s",
			smtp_address_encode_path(to_address));
	}

	/* Add redirect action to the result */

	return sieve_act_redirect_add_to_result(renv, "redirect", slist,
						to_address);
}

/*
 * Action implementation
 */

struct act_redirect_transaction {
	const char *msg_id, *new_msg_id;
	const char *dupeid;

	bool skip_redirect:1;
};

static bool
act_redirect_equals(const struct sieve_script_env *senv ATTR_UNUSED,
		    const struct sieve_action *act1,
		    const struct sieve_action *act2)
{
	struct act_redirect_context *rd_ctx1 =
		(struct act_redirect_context *)act1->context;
	struct act_redirect_context *rd_ctx2 =
		(struct act_redirect_context *)act2->context;

	/* Address is already normalized */
	return (smtp_address_equals(rd_ctx1->to_address, rd_ctx2->to_address));
}

static int
act_redirect_check_duplicate(const struct sieve_runtime_env *renv,
			     const struct sieve_action *act,
			     const struct sieve_action *act_other)
{
	const struct sieve_execute_env *eenv = renv->exec_env;

	return (act_redirect_equals(eenv->scriptenv, act, act_other) ? 1 : 0);
}

static void
act_redirect_print(const struct sieve_action *action,
		   const struct sieve_result_print_env *rpenv, bool *keep)
{
	struct act_redirect_context *ctx =
		(struct act_redirect_context *)action->context;

	sieve_result_action_printf(rpenv, "redirect message to: %s",
				   smtp_address_encode_path(ctx->to_address));
	*keep = FALSE;
}

static int
act_redirect_send(const struct sieve_action_exec_env *aenv, struct mail *mail,
		  struct act_redirect_context *ctx, const char *new_msg_id)
		  ATTR_NULL(4)
{
	static const char *hide_headers[] = { "Return-Path" };
	const struct sieve_execute_env *eenv = aenv->exec_env;
	struct sieve_instance *svinst = eenv->svinst;
	struct sieve_message_context *msgctx = aenv->msgctx;
	const struct sieve_script_env *senv = eenv->scriptenv;
	struct sieve_address_source env_from = svinst->redirect_from;
	struct istream *input;
	struct ostream *output;
	const struct smtp_address *sender;
	const char *error;
	struct sieve_smtp_context *sctx;
	int ret;

	/* Just to be sure */
	if (!sieve_smtp_available(senv)) {
		sieve_result_global_warning(aenv, "no means to send mail");
		return SIEVE_EXEC_FAILURE;
	}

	if (mail_get_stream(mail, NULL, NULL, &input) < 0) {
		return sieve_result_mail_error(aenv, mail,
					       "failed to read input message");
	}

	/* Determine which sender to use

	   From RFC 5228, Section 4.2:

	   The envelope sender address on the outgoing message is chosen by the
	   sieve implementation. It MAY be copied from the message being
	   processed. However, if the message being processed has an empty
	   envelope sender address the outgoing message MUST also have an empty
	   envelope sender address. This last requirement is imposed to prevent
	   loops in the case where a message is redirected to an invalid address
	   when then returns a delivery status notification that also ends up
	   being redirected to the same invalid address.
	 */
	if ((eenv->flags & SIEVE_EXECUTE_FLAG_NO_ENVELOPE) == 0) {
		/* Envelope available */
		sender = sieve_message_get_sender(msgctx);
		if (sender != NULL &&
		    sieve_address_source_get_address(&env_from, svinst, senv,
						     msgctx, eenv->flags,
						     &sender) < 0)
			sender = NULL;
	} else {
		/* No envelope available */
		ret = sieve_address_source_get_address(&env_from, svinst, senv,
						       msgctx, eenv->flags,
						       &sender);
		if (ret < 0)
			sender = NULL;
		else if (ret == 0)
			sender = svinst->user_email;
	}

	/* Open SMTP transport */
	sctx = sieve_smtp_start_single(senv, ctx->to_address, sender, &output);

	/* Remove unwanted headers */
	input = i_stream_create_header_filter(
		input, HEADER_FILTER_EXCLUDE | HEADER_FILTER_NO_CR,
		hide_headers, N_ELEMENTS(hide_headers),
		*null_header_filter_callback, (void *)NULL);

	T_BEGIN {
		string_t *hdr = t_str_new(256);
		const struct smtp_address *user_email;

		/* Prepend sieve headers (should not affect signatures) */
		rfc2822_header_append(hdr, "X-Sieve", SIEVE_IMPLEMENTATION,
				      FALSE, NULL);
		if (svinst->user_email == NULL &&
		    (eenv->flags & SIEVE_EXECUTE_FLAG_NO_ENVELOPE) == 0)
			user_email = sieve_message_get_final_recipient(msgctx);
		else
			user_email = sieve_get_user_email(svinst);
		if (user_email != NULL) {
			rfc2822_header_append(hdr, "X-Sieve-Redirected-From",
					      smtp_address_encode(user_email),
					      FALSE, NULL);
		}

		/* Add new Message-ID if message doesn't have one */
		if (new_msg_id != NULL)
			rfc2822_header_write(hdr, "Message-ID", new_msg_id);

		o_stream_nsend(output, str_data(hdr), str_len(hdr));
	} T_END;

	o_stream_nsend_istream(output, input);

	if (input->stream_errno != 0) {
		sieve_result_critical(aenv, "failed to read input message",
				      "read(%s) failed: %s",
				      i_stream_get_name(input),
				      i_stream_get_error(input));
		i_stream_unref(&input);
		sieve_smtp_abort(sctx);
		return SIEVE_EXEC_TEMP_FAILURE;
	}
	i_stream_unref(&input);

	/* Close SMTP transport */
	if ((ret = sieve_smtp_finish(sctx, &error)) <= 0) {
		if (ret < 0) {
			sieve_result_global_error(
				aenv, "failed to redirect message to <%s>: %s "
				"(temporary failure)",
				smtp_address_encode(ctx->to_address),
				str_sanitize(error, 512));
			return SIEVE_EXEC_TEMP_FAILURE;
		}

		sieve_result_global_log_error(
			aenv, "failed to redirect message to <%s>: %s "
			"(permanent failure)",
			smtp_address_encode(ctx->to_address),
			str_sanitize(error, 512));
		return SIEVE_EXEC_FAILURE;
	}

	return SIEVE_EXEC_OK;
}

static int
act_redirect_get_duplicate_id(struct act_redirect_context *ctx,
			      const struct sieve_action_exec_env *aenv,
			      const char *msg_id, const char **dupeid_r)
{
	const struct sieve_execute_env *eenv = aenv->exec_env;
	struct sieve_message_context *msgctx = aenv->msgctx;
	const struct sieve_message_data *msgdata = eenv->msgdata;
	struct mail *mail = msgdata->mail;
	const struct smtp_address *recipient;
	const char *resent_id = NULL, *list_id = NULL;

	/* Read identifying headers */
	if (mail_get_first_header(mail, "resent-message-id", &resent_id) < 0) {
		return sieve_result_mail_error(
			aenv, mail,
			"failed to read header field `resent-message-id'");
	}
	if (resent_id == NULL &&
	    mail_get_first_header(mail, "resent-from", &resent_id) < 0) {
		return sieve_result_mail_error(
			aenv, mail,
			"failed to read header field `resent-from'");
	}
	if (mail_get_first_header(mail, "list-id", &list_id) < 0) {
		return sieve_result_mail_error(
			aenv, mail,
			"failed to read header field `list-id'");
	}

	if ((eenv->flags & SIEVE_EXECUTE_FLAG_NO_ENVELOPE) == 0)
		recipient = sieve_message_get_orig_recipient(msgctx);
	else
		recipient = sieve_get_user_email(eenv->svinst);

	pool_t pool = sieve_result_pool(aenv->result);

	/* Base the duplicate ID on:
	   - the message id
	   - the recipient running this Sieve script
	   - redirect target address
	   - if this message is resent: the message-id or from-address of
		   the original message
	   - if the message came through a mailing list: the mailinglist ID
	 */
	*dupeid_r = p_strdup_printf(
		pool, "%s-%s-%s-%s-%s", msg_id,
		(recipient != NULL ? smtp_address_encode(recipient) : ""),
		smtp_address_encode(ctx->to_address),
		(resent_id != NULL ? resent_id : ""),
		(list_id != NULL ? list_id : ""));
	return SIEVE_EXEC_OK;
}

static int
act_redirect_check_loop_header(const struct sieve_action_exec_env *aenv,
			       struct mail *mail, bool *loop_detected_r)
{
	const struct sieve_execute_env *eenv = aenv->exec_env;
	struct sieve_message_context *msgctx = aenv->msgctx;
	const char *const *headers;
	const char *recipient, *user_email;
	const struct smtp_address *addr;
	int ret;

	*loop_detected_r = FALSE;

	ret = mail_get_headers(mail, "x-sieve-redirected-from", &headers);
	if (ret < 0) {
		return sieve_result_mail_error(
			aenv, mail, "failed to read header field "
			"`x-sieve-redirected-from'");
	}

	if (ret == 0)
		return SIEVE_EXEC_OK;

	recipient = user_email = NULL;
	if ((eenv->flags & SIEVE_EXECUTE_FLAG_NO_ENVELOPE) == 0) {
		addr = sieve_message_get_final_recipient(msgctx);
		if (addr != NULL)
			recipient = smtp_address_encode(addr);
	}
	addr = sieve_get_user_email(eenv->svinst);
	if (addr != NULL)
		user_email = smtp_address_encode(addr);

	while (*headers != NULL) {
		const char *header = t_str_trim(*headers, " \t\r\n");
		if (recipient != NULL && strcmp(header, recipient) == 0) {
			*loop_detected_r = TRUE;
			break;
		}
		if (user_email != NULL && strcmp(header, user_email) == 0) {
			*loop_detected_r = TRUE;
			break;
		}
		headers++;
	}

	return SIEVE_EXEC_OK;
}

static int
act_redirect_start(const struct sieve_action_exec_env *aenv, void **tr_context)
{
	struct act_redirect_transaction *trans;
	pool_t pool = sieve_result_pool(aenv->result);

	/* Create transaction context */
	trans = p_new(pool, struct act_redirect_transaction, 1);
	*tr_context = trans;

	return SIEVE_EXEC_OK;
}

static int
act_redirect_execute(const struct sieve_action_exec_env *aenv,
		     void *tr_context, bool *keep)
{
	const struct sieve_action *action = aenv->action;
	const struct sieve_execute_env *eenv = aenv->exec_env;
	struct sieve_instance *svinst = eenv->svinst;
	struct act_redirect_context *ctx =
		(struct act_redirect_context *)action->context;
	struct act_redirect_transaction *trans = tr_context;
	struct sieve_message_context *msgctx = aenv->msgctx;
	struct mail *mail = (action->mail != NULL ?
			     action->mail : sieve_message_get_mail(msgctx));
	const struct sieve_message_data *msgdata = eenv->msgdata;
	bool duplicate, loop_detected = FALSE;
	int ret;

	/*
	 * Prevent mail loops
	 */

	/* Create Message-ID for the message if it has none */
	trans->msg_id = msgdata->id;
	if (trans->msg_id == NULL) {
		pool_t pool = sieve_result_pool(aenv->result);
		trans->msg_id = trans->new_msg_id =
			p_strdup(pool, sieve_message_get_new_id(svinst));
	}

	/* Create ID for duplicate database lookup */
	ret = act_redirect_get_duplicate_id(ctx, aenv, trans->msg_id,
					    &trans->dupeid);
	if (ret != SIEVE_EXEC_OK)
		return ret;
	i_assert(trans->dupeid != NULL);

	/* Check whether we've seen this message before */
	ret = sieve_action_duplicate_check(aenv, trans->dupeid,
					   strlen(trans->dupeid),
					   &duplicate);
	if (ret < SIEVE_EXEC_OK) {
		sieve_result_critical(
			aenv, "failed to check for duplicate forward",
			"failed to check for duplicate forward to <%s>%s",
			smtp_address_encode(ctx->to_address),
			(ret == SIEVE_EXEC_TEMP_FAILURE ?
			 " (temporaty failure)" : ""));
		return ret;
	}
	if (duplicate) {
		sieve_result_global_log(
			aenv, "discarded duplicate forward to <%s>",
			smtp_address_encode(ctx->to_address));
		trans->skip_redirect = TRUE;
		return SIEVE_EXEC_OK;
	}

	/* Check whether we've seen this message before based on added headers
	 */
	ret = act_redirect_check_loop_header(aenv, mail, &loop_detected);
	if (ret != SIEVE_EXEC_OK)
		return ret;
	if (loop_detected) {
		sieve_result_global_log(
			aenv, "not forwarding message to <%s>: "
			"the `x-sieve-redirected-from' header indicates a mail loop",
			smtp_address_encode(ctx->to_address));
		trans->skip_redirect = TRUE;
		return SIEVE_EXEC_OK;
	}

	/* Cancel implicit keep */
	*keep = FALSE;

	return SIEVE_EXEC_OK;
}

static int
act_redirect_commit(const struct sieve_action_exec_env *aenv, void *tr_context)
{
	const struct sieve_action *action = aenv->action;
	const struct sieve_execute_env *eenv = aenv->exec_env;
	struct sieve_instance *svinst = eenv->svinst;
	struct act_redirect_context *ctx =
		(struct act_redirect_context *)action->context;
	struct sieve_message_context *msgctx = aenv->msgctx;
	struct mail *mail = (action->mail != NULL ?
			     action->mail : sieve_message_get_mail(msgctx));
	struct act_redirect_transaction *trans = tr_context;
	int ret;

	if (trans->skip_redirect)
		return SIEVE_EXEC_OK;

	/*
	 * Try to forward the message
	 */

	ret = act_redirect_send(aenv, mail, ctx, trans->new_msg_id);
	if (ret == SIEVE_EXEC_OK) {
		/* Mark this message id as forwarded to the specified
		   destination */
		sieve_action_duplicate_mark(
			aenv, trans->dupeid, strlen(trans->dupeid),
			ioloop_time + svinst->redirect_duplicate_period);

		eenv->exec_status->significant_action_executed = TRUE;

		struct event_passthrough *e =
			sieve_action_create_finish_event(aenv)->
			add_str("redirect_target",
				smtp_address_encode(ctx->to_address));

		sieve_result_event_log(aenv, e->event(),
				       "forwarded to <%s>",
				       smtp_address_encode(ctx->to_address));

		/* Indicate that message was successfully forwarded */
		eenv->exec_status->message_forwarded = TRUE;

		return SIEVE_EXEC_OK;
	}

	return ret;
}