1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
|
/* Copyright (c) 2002-2010 Dovecot Sieve authors, see the included COPYING file
*/
/* Extension envelope
* ------------------
*
* Authors: Stephan Bosch
* Specification: RFC 5228
* Implementation: full
* Status: testing
*
*/
#include "lib.h"
#include "str-sanitize.h"
#include "array.h"
#include "sieve-common.h"
#include "sieve-extensions.h"
#include "sieve-commands.h"
#include "sieve-code.h"
#include "sieve-address.h"
#include "sieve-comparators.h"
#include "sieve-match-types.h"
#include "sieve-address-parts.h"
#include "sieve-message.h"
#include "sieve-validator.h"
#include "sieve-generator.h"
#include "sieve-interpreter.h"
#include "sieve-dump.h"
#include "sieve-match.h"
/*
* Forward declarations
*/
static const struct sieve_command_def envelope_test;
const struct sieve_operation_def envelope_operation;
const struct sieve_extension_def envelope_extension;
/*
* Extension
*/
static bool ext_envelope_validator_load
(const struct sieve_extension *ext, struct sieve_validator *valdtr);
const struct sieve_extension_def envelope_extension = {
"envelope",
NULL, NULL,
ext_envelope_validator_load,
NULL, NULL, NULL, NULL, NULL,
SIEVE_EXT_DEFINE_OPERATION(envelope_operation),
SIEVE_EXT_DEFINE_NO_OPERANDS
};
static bool ext_envelope_validator_load
(const struct sieve_extension *ext, struct sieve_validator *valdtr)
{
/* Register new test */
sieve_validator_register_command(valdtr, ext, &envelope_test);
return TRUE;
}
/*
* Envelope test
*
* Syntax
* envelope [COMPARATOR] [ADDRESS-PART] [MATCH-TYPE]
* <envelope-part: string-list> <key-list: string-list>
*/
static bool tst_envelope_registered
(struct sieve_validator *valdtr, const struct sieve_extension *ext,
struct sieve_command_registration *cmd_reg);
static bool tst_envelope_validate
(struct sieve_validator *valdtr, struct sieve_command *tst);
static bool tst_envelope_generate
(const struct sieve_codegen_env *cgenv, struct sieve_command *ctx);
static const struct sieve_command_def envelope_test = {
"envelope",
SCT_TEST,
2, 0, FALSE, FALSE,
tst_envelope_registered,
NULL,
tst_envelope_validate,
tst_envelope_generate,
NULL
};
/*
* Envelope operation
*/
static bool ext_envelope_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address);
static int ext_envelope_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address);
const struct sieve_operation_def envelope_operation = {
"ENVELOPE",
&envelope_extension,
0,
ext_envelope_operation_dump,
ext_envelope_operation_execute
};
/*
* Envelope parts
*
* FIXME: not available to extensions
*/
struct sieve_envelope_part {
const char *identifier;
const struct sieve_address *const *(*get_addresses)
(const struct sieve_runtime_env *renv);
const char * const *(*get_values)
(const struct sieve_runtime_env *renv);
};
static const struct sieve_address *const *_from_part_get_addresses
(const struct sieve_runtime_env *renv);
static const char *const *_from_part_get_values
(const struct sieve_runtime_env *renv);
static const struct sieve_address *const *_to_part_get_addresses
(const struct sieve_runtime_env *renv);
static const char *const *_to_part_get_values
(const struct sieve_runtime_env *renv);
static const char *const *_auth_part_get_values
(const struct sieve_runtime_env *renv);
static const struct sieve_envelope_part _from_part = {
"from",
_from_part_get_addresses,
_from_part_get_values,
};
static const struct sieve_envelope_part _to_part = {
"to",
_to_part_get_addresses,
_to_part_get_values,
};
static const struct sieve_envelope_part _auth_part = {
"auth",
NULL,
_auth_part_get_values,
};
static const struct sieve_envelope_part *_envelope_parts[] = {
/* Required */
&_from_part, &_to_part,
/* Non-standard */
&_auth_part
};
static unsigned int _envelope_part_count = N_ELEMENTS(_envelope_parts);
static const struct sieve_envelope_part *_envelope_part_find
(const char *identifier)
{
unsigned int i;
for ( i = 0; i < _envelope_part_count; i++ ) {
if ( strcasecmp( _envelope_parts[i]->identifier, identifier ) == 0 ) {
return _envelope_parts[i];
}
}
return NULL;
}
/*
* Command Registration
*/
static bool tst_envelope_registered
(struct sieve_validator *valdtr, const struct sieve_extension *ext ATTR_UNUSED,
struct sieve_command_registration *cmd_reg)
{
/* The order of these is not significant */
sieve_comparators_link_tag(valdtr, cmd_reg, SIEVE_AM_OPT_COMPARATOR);
sieve_address_parts_link_tags(valdtr, cmd_reg, SIEVE_AM_OPT_ADDRESS_PART);
sieve_match_types_link_tags(valdtr, cmd_reg, SIEVE_AM_OPT_MATCH_TYPE);
return TRUE;
}
/*
* Validation
*/
static int _envelope_part_is_supported
(void *context, struct sieve_ast_argument *arg)
{
const struct sieve_envelope_part **not_address =
(const struct sieve_envelope_part **) context;
if ( sieve_argument_is_string_literal(arg) ) {
const struct sieve_envelope_part *epart;
if ( (epart=_envelope_part_find(sieve_ast_strlist_strc(arg))) != NULL ) {
if ( epart->get_addresses == NULL ) {
if ( *not_address == NULL )
*not_address = epart;
}
return TRUE;
}
return FALSE;
}
return TRUE; /* Can't check at compile time */
}
static bool tst_envelope_validate
(struct sieve_validator *valdtr, struct sieve_command *tst)
{
struct sieve_ast_argument *arg = tst->first_positional;
struct sieve_ast_argument *epart;
struct sieve_comparator cmp_default =
SIEVE_COMPARATOR_DEFAULT(i_ascii_casemap_comparator);
struct sieve_match_type mcht_default =
SIEVE_MATCH_TYPE_DEFAULT(is_match_type);
const struct sieve_envelope_part *not_address = NULL;
if ( !sieve_validate_positional_argument
(valdtr, tst, arg, "envelope part", 1, SAAT_STRING_LIST) ) {
return FALSE;
}
if ( !sieve_validator_argument_activate(valdtr, tst, arg, FALSE) )
return FALSE;
/* Check whether supplied envelope parts are supported
* FIXME: verify dynamic envelope parts at runtime
*/
epart = arg;
if ( !sieve_ast_stringlist_map(&epart, (void *) ¬_address,
_envelope_part_is_supported) ) {
sieve_argument_validate_error(valdtr, epart,
"specified envelope part '%s' is not supported by the envelope test",
str_sanitize(sieve_ast_strlist_strc(epart), 64));
return FALSE;
}
if ( not_address != NULL ) {
struct sieve_ast_argument *addrp_arg =
sieve_command_find_argument(tst, &address_part_tag);
if ( addrp_arg != NULL ) {
sieve_argument_validate_error(valdtr, addrp_arg,
"address part ':%s' specified while non-address envelope part '%s' "
"is tested with the envelope test",
sieve_ast_argument_tag(addrp_arg), not_address->identifier);
return FALSE;
}
}
arg = sieve_ast_argument_next(arg);
if ( !sieve_validate_positional_argument
(valdtr, tst, arg, "key list", 2, SAAT_STRING_LIST) ) {
return FALSE;
}
if ( !sieve_validator_argument_activate(valdtr, tst, arg, FALSE) )
return FALSE;
/* Validate the key argument to a specified match type */
return sieve_match_type_validate
(valdtr, tst, arg, &mcht_default, &cmp_default);
}
/*
* Code generation
*/
static bool tst_envelope_generate
(const struct sieve_codegen_env *cgenv, struct sieve_command *cmd)
{
(void)sieve_operation_emit(cgenv->sbin, cmd->ext, &envelope_operation);
/* Generate arguments */
if ( !sieve_generate_arguments(cgenv, cmd, NULL) )
return FALSE;
return TRUE;
}
/*
* Code dump
*/
static bool ext_envelope_operation_dump
(const struct sieve_dumptime_env *denv, sieve_size_t *address)
{
sieve_code_dumpf(denv, "ENVELOPE");
sieve_code_descend(denv);
/* Handle any optional arguments */
if ( !sieve_addrmatch_default_dump_optionals(denv, address) )
return FALSE;
return
sieve_opr_stringlist_dump(denv, address, "envelope part") &&
sieve_opr_stringlist_dump(denv, address, "key list");
}
/*
* Interpretation
*/
static const struct sieve_address *const *_from_part_get_addresses
(const struct sieve_runtime_env *renv)
{
ARRAY_DEFINE(envelope_values, const struct sieve_address *);
const struct sieve_address *address =
sieve_message_get_sender_address(renv->msgctx);
if ( address != NULL ) {
t_array_init(&envelope_values, 2);
array_append(&envelope_values, &address, 1);
(void)array_append_space(&envelope_values);
return array_idx(&envelope_values, 0);
}
return NULL;
}
static const char *const *_from_part_get_values
(const struct sieve_runtime_env *renv)
{
ARRAY_DEFINE(envelope_values, const char *);
t_array_init(&envelope_values, 2);
if ( renv->msgdata->return_path != NULL ) {
array_append(&envelope_values, &renv->msgdata->return_path, 1);
}
(void)array_append_space(&envelope_values);
return array_idx(&envelope_values, 0);
}
static const struct sieve_address *const *_to_part_get_addresses
(const struct sieve_runtime_env *renv)
{
ARRAY_DEFINE(envelope_values, const struct sieve_address *);
const struct sieve_address *address =
sieve_message_get_recipient_address(renv->msgctx);
if ( address != NULL && address->local_part != NULL ) {
t_array_init(&envelope_values, 2);
array_append(&envelope_values, &address, 1);
(void)array_append_space(&envelope_values);
return array_idx(&envelope_values, 0);
}
return NULL;
}
static const char *const *_to_part_get_values
(const struct sieve_runtime_env *renv)
{
ARRAY_DEFINE(envelope_values, const char *);
t_array_init(&envelope_values, 2);
if ( renv->msgdata->to_address != NULL ) {
array_append(&envelope_values, &renv->msgdata->to_address, 1);
}
(void)array_append_space(&envelope_values);
return array_idx(&envelope_values, 0);
}
static const char *const *_auth_part_get_values
(const struct sieve_runtime_env *renv)
{
ARRAY_DEFINE(envelope_values, const char *);
t_array_init(&envelope_values, 2);
if ( renv->msgdata->auth_user != NULL )
array_append(&envelope_values, &renv->msgdata->auth_user, 1);
(void)array_append_space(&envelope_values);
return array_idx(&envelope_values, 0);
}
static int ext_envelope_operation_execute
(const struct sieve_runtime_env *renv, sieve_size_t *address)
{
bool result = TRUE;
struct sieve_comparator cmp =
SIEVE_COMPARATOR_DEFAULT(i_ascii_casemap_comparator);
struct sieve_match_type mcht =
SIEVE_MATCH_TYPE_DEFAULT(is_match_type);
struct sieve_address_part addrp =
SIEVE_ADDRESS_PART_DEFAULT(all_address_part);
struct sieve_match_context *mctx;
struct sieve_coded_stringlist *envp_list;
struct sieve_coded_stringlist *key_list;
string_t *envp_item;
bool matched;
int ret;
/*
* Read operands
*/
sieve_runtime_trace(renv, "ENVELOPE test");
if ( (ret=sieve_addrmatch_default_get_optionals
(renv, address, &addrp, &mcht, &cmp)) <= 0 )
return ret;
/* Read envelope-part */
if ( (envp_list=sieve_opr_stringlist_read(renv, address)) == NULL ) {
sieve_runtime_trace_error(renv, "invalid envelope-part operand");
return SIEVE_EXEC_BIN_CORRUPT;
}
/* Read key-list */
if ( (key_list=sieve_opr_stringlist_read(renv, address)) == NULL ) {
sieve_runtime_trace_error(renv, "invalid key-list operand");
return SIEVE_EXEC_BIN_CORRUPT;
}
/* Initialize match */
mctx = sieve_match_begin(renv->interp, &mcht, &cmp, NULL, key_list);
/* Iterate through all requested headers to match */
envp_item = NULL;
matched = FALSE;
while ( result && !matched &&
(result=sieve_coded_stringlist_next_item(envp_list, &envp_item))
&& envp_item != NULL ) {
const struct sieve_envelope_part *epart;
if ( (epart=_envelope_part_find(str_c(envp_item))) != NULL ) {
const struct sieve_address * const *addresses = NULL;
int i;
if ( epart->get_addresses != NULL ) {
/* Field contains addresses */
addresses = epart->get_addresses(renv);
if ( addresses != NULL ) {
for ( i = 0; !matched && addresses[i] != NULL; i++ ) {
if ( addresses[i]->local_part == NULL ) {
/* Null path <> */
ret = sieve_match_value(mctx, "", 0);
} else {
const char *part = NULL;
if ( addrp.def != NULL && addrp.def->extract_from != NULL )
part = addrp.def->extract_from(&addrp, addresses[i]);
if ( part != NULL )
ret = sieve_match_value(mctx, part, strlen(part));
else
ret = 0;
}
if ( ret < 0 ) {
result = FALSE;
break;
}
matched = ret > 0;
}
}
}
if ( epart->get_values != NULL && addresses == NULL &&
sieve_address_part_is(&addrp, all_address_part) ) {
/* Field contains something else */
const char *const *values = epart->get_values(renv);
if ( values == NULL ) continue;
for ( i = 0; !matched && values[i] != NULL; i++ ) {
if ( (ret=sieve_match_value
(mctx, values[i], strlen(values[i]))) < 0 ) {
result = FALSE;
break;
}
matched = ret > 0;
}
}
}
}
/* Finish match */
if ( (ret=sieve_match_end(&mctx)) < 0 )
result = FALSE;
else
matched = ( ret > 0 || matched );
if ( result ) {
/* Set test result for subsequent conditional jump */
sieve_interpreter_set_test_result(renv->interp, matched);
return SIEVE_EXEC_OK;
}
sieve_runtime_trace_error(renv, "invalid string-list item");
return SIEVE_EXEC_BIN_CORRUPT;
}
|