git.exim.org Git - exim.git/blob

1 /*************************************************

2 * Exim - an Internet mail transport agent *

3 *************************************************/

5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */

6 /* Copyright (c) University of Cambridge 1995 - 2018 */

7 /* See the file NOTICE for conditions of use and distribution. */

8 /* SPDX-License-Identifier: GPL-2.0-or-later */

11 /* Functions for handling string expansion. */

14 #include "exim.h"

16 #ifdef MACRO_PREDEF

17 # include "macro_predef.h"

18 #endif

20 typedef unsigned esi_flags;

21 #define ESI_NOFLAGS 0

22 #define ESI_BRACE_ENDS BIT(0) /* expansion should stop at } */

23 #define ESI_HONOR_DOLLAR BIT(1) /* $ is meaningfull */

24 #define ESI_SKIPPING BIT(2) /* value will not be needed */

25 #define ESI_EXISTS_ONLY BIT(3) /* actual value not needed */

27 #ifdef STAND_ALONE

28 # ifndef SUPPORT_CRYPTEQ

29 # define SUPPORT_CRYPTEQ

30 # endif

31 #endif /*!STAND_ALONE*/

33 #ifdef SUPPORT_CRYPTEQ

34 # ifdef CRYPT_H

35 # include <crypt.h>

36 # endif

37 # ifndef HAVE_CRYPT16

38 extern char* crypt16(char*, char*);

39 # endif

40 #endif

42 /* The handling of crypt16() is a mess. I will record below the analysis of the

43 mess that was sent to me. We decided, however, to make changing this very low

44 priority, because in practice people are moving away from the crypt()

45 algorithms nowadays, so it doesn't seem worth it.

47 <quote>

48 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts

49 the first 8 characters of the password using a 20-round version of crypt

50 (standard crypt does 25 rounds). It then crypts the next 8 characters,

51 or an empty block if the password is less than 9 characters, using a

52 20-round version of crypt and the same salt as was used for the first

53 block. Characters after the first 16 are ignored. It always generates

54 a 16-byte hash, which is expressed together with the salt as a string

55 of 24 base 64 digits. Here are some links to peruse:

57 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2

58 http://seclists.org/bugtraq/1999/Mar/0076.html

60 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,

61 and OSF/1. This is the same as the standard crypt if given a password

62 of 8 characters or less. If given more, it first does the same as crypt

63 using the first 8 characters, then crypts the next 8 (the 9th to 16th)

64 using as salt the first two base 64 digits from the first hash block.

65 If the password is more than 16 characters then it crypts the 17th to 24th

66 characters using as salt the first two base 64 digits from the second hash

67 block. And so on: I've seen references to it cutting off the password at

68 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:

70 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2

71 http://seclists.org/bugtraq/1999/Mar/0109.html

72 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-

73 TET1_html/sec.c222.html#no_id_208

75 Exim has something it calls "crypt16". It will either use a native

76 crypt16 or its own implementation. A native crypt16 will presumably

77 be the one that I called "crypt16" above. The internal "crypt16"

78 function, however, is a two-block-maximum implementation of what I called

79 "bigcrypt". The documentation matches the internal code.

81 I suspect that whoever did the "crypt16" stuff for Exim didn't realise

82 that crypt16 and bigcrypt were different things.

84 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer

85 to whatever it is using under that name. This unfortunately sets a

86 precedent for using "{crypt16}" to identify two incompatible algorithms

87 whose output can't be distinguished. With "{crypt16}" thus rendered

88 ambiguous, I suggest you deprecate it and invent two new identifiers

89 for the two algorithms.

91 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts

92 of the password separately means they can be cracked separately, so

93 the double-length hash only doubles the cracking effort instead of

94 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based

95 bcrypt ({CRYPT}$2a$).

96 </quote>

97 */

100

101 /*************************************************

102 * Local statics and tables *

103 *************************************************/

104

105 /* Table of item names, and corresponding switch numbers. The names must be in

106 alphabetical order. */

107

108 static uschar *item_table[] = {

109 US"acl",

110 US"authresults",

111 US"certextract",

112 US"dlfunc",

113 US"env",

114 US"extract",

115 US"filter",

116 US"hash",

117 US"hmac",

118 US"if",

119 #ifdef SUPPORT_I18N

120 US"imapfolder",

121 #endif

122 US"length",

123 US"listextract",

124 US"listquote",

125 US"lookup",

126 US"map",

127 US"nhash",

128 US"perl",

129 US"prvs",

130 US"prvscheck",

131 US"readfile",

132 US"readsocket",

133 US"reduce",

134 US"run",

135 US"sg",

136 US"sort",

137 #ifdef SUPPORT_SRS

138 US"srs_encode",

139 #endif

140 US"substr",

141 US"tr" };

142

143 enum {

144 EITEM_ACL,

145 EITEM_AUTHRESULTS,

146 EITEM_CERTEXTRACT,

147 EITEM_DLFUNC,

148 EITEM_ENV,

149 EITEM_EXTRACT,

150 EITEM_FILTER,

151 EITEM_HASH,

152 EITEM_HMAC,

153 EITEM_IF,

154 #ifdef SUPPORT_I18N

155 EITEM_IMAPFOLDER,

156 #endif

157 EITEM_LENGTH,

158 EITEM_LISTEXTRACT,

159 EITEM_LISTQUOTE,

160 EITEM_LOOKUP,

161 EITEM_MAP,

162 EITEM_NHASH,

163 EITEM_PERL,

164 EITEM_PRVS,

165 EITEM_PRVSCHECK,

166 EITEM_READFILE,

167 EITEM_READSOCK,

168 EITEM_REDUCE,

169 EITEM_RUN,

170 EITEM_SG,

171 EITEM_SORT,

172 #ifdef SUPPORT_SRS

173 EITEM_SRS_ENCODE,

174 #endif

175 EITEM_SUBSTR,

176 EITEM_TR };

177

178 /* Tables of operator names, and corresponding switch numbers. The names must be

179 in alphabetical order. There are two tables, because underscore is used in some

180 cases to introduce arguments, whereas for other it is part of the name. This is

181 an historical mis-design. */

182

183 static uschar * op_table_underscore[] = {

184 US"from_utf8",

185 US"local_part",

186 US"quote_local_part",

187 US"reverse_ip",

188 US"time_eval",

189 US"time_interval"

190 #ifdef SUPPORT_I18N

191 ,US"utf8_domain_from_alabel",

192 US"utf8_domain_to_alabel",

193 US"utf8_localpart_from_alabel",

194 US"utf8_localpart_to_alabel"

195 #endif

196 };

197

198 enum {

199 EOP_FROM_UTF8,

200 EOP_LOCAL_PART,

201 EOP_QUOTE_LOCAL_PART,

202 EOP_REVERSE_IP,

203 EOP_TIME_EVAL,

204 EOP_TIME_INTERVAL

205 #ifdef SUPPORT_I18N

206 ,EOP_UTF8_DOMAIN_FROM_ALABEL,

207 EOP_UTF8_DOMAIN_TO_ALABEL,

208 EOP_UTF8_LOCALPART_FROM_ALABEL,

209 EOP_UTF8_LOCALPART_TO_ALABEL

210 #endif

211 };

212

213 static uschar *op_table_main[] = {

214 US"address",

215 US"addresses",

216 US"base32",

217 US"base32d",

218 US"base62",

219 US"base62d",

220 US"base64",

221 US"base64d",

222 US"domain",

223 US"escape",

224 US"escape8bit",

225 US"eval",

226 US"eval10",

227 US"expand",

228 US"h",

229 US"hash",

230 US"headerwrap",

231 US"hex2b64",

232 US"hexquote",

233 US"ipv6denorm",

234 US"ipv6norm",

235 US"l",

236 US"lc",

237 US"length",

238 US"listcount",

239 US"listnamed",

240 US"mask",

241 US"md5",

242 US"nh",

243 US"nhash",

244 US"quote",

245 US"randint",

246 US"rfc2047",

247 US"rfc2047d",

248 US"rxquote",

249 US"s",

250 US"sha1",

251 US"sha2",

252 US"sha256",

253 US"sha3",

254 US"stat",

255 US"str2b64",

256 US"strlen",

257 US"substr",

258 US"uc",

259 US"utf8clean",

260 US"xtextd",

261 };

262

263 enum {

264 EOP_ADDRESS = nelem(op_table_underscore),

265 EOP_ADDRESSES,

266 EOP_BASE32,

267 EOP_BASE32D,

268 EOP_BASE62,

269 EOP_BASE62D,

270 EOP_BASE64,

271 EOP_BASE64D,

272 EOP_DOMAIN,

273 EOP_ESCAPE,

274 EOP_ESCAPE8BIT,

275 EOP_EVAL,

276 EOP_EVAL10,

277 EOP_EXPAND,

278 EOP_H,

279 EOP_HASH,

280 EOP_HEADERWRAP,

281 EOP_HEX2B64,

282 EOP_HEXQUOTE,

283 EOP_IPV6DENORM,

284 EOP_IPV6NORM,

285 EOP_L,

286 EOP_LC,

287 EOP_LENGTH,

288 EOP_LISTCOUNT,

289 EOP_LISTNAMED,

290 EOP_MASK,

291 EOP_MD5,

292 EOP_NH,

293 EOP_NHASH,

294 EOP_QUOTE,

295 EOP_RANDINT,

296 EOP_RFC2047,

297 EOP_RFC2047D,

298 EOP_RXQUOTE,

299 EOP_S,

300 EOP_SHA1,

301 EOP_SHA2,

302 EOP_SHA256,

303 EOP_SHA3,

304 EOP_STAT,

305 EOP_STR2B64,

306 EOP_STRLEN,

307 EOP_SUBSTR,

308 EOP_UC,

309 EOP_UTF8CLEAN,

310 EOP_XTEXTD,

311 };

312

313

314 /* Table of condition names, and corresponding switch numbers. The names must

315 be in alphabetical order. */

316

317 static uschar *cond_table[] = {

318 US"<",

319 US"<=",

320 US"=",

321 US"==", /* Backward compatibility */

322 US">",

323 US">=",

324 US"acl",

325 US"and",

326 US"bool",

327 US"bool_lax",

328 US"crypteq",

329 US"def",

330 US"eq",

331 US"eqi",

332 US"exists",

333 US"first_delivery",

334 US"forall",

335 US"forall_json",

336 US"forall_jsons",

337 US"forany",

338 US"forany_json",

339 US"forany_jsons",

340 US"ge",

341 US"gei",

342 US"gt",

343 US"gti",

344 #ifdef SUPPORT_SRS

345 US"inbound_srs",

346 #endif

347 US"inlist",

348 US"inlisti",

349 US"isip",

350 US"isip4",

351 US"isip6",

352 US"ldapauth",

353 US"le",

354 US"lei",

355 US"lt",

356 US"lti",

357 US"match",

358 US"match_address",

359 US"match_domain",

360 US"match_ip",

361 US"match_local_part",

362 US"or",

363 US"pam",

364 US"pwcheck",

365 US"queue_running",

366 US"radius",

367 US"saslauthd"

368 };

369

370 enum {

371 ECOND_NUM_L,

372 ECOND_NUM_LE,

373 ECOND_NUM_E,

374 ECOND_NUM_EE,

375 ECOND_NUM_G,

376 ECOND_NUM_GE,

377 ECOND_ACL,

378 ECOND_AND,

379 ECOND_BOOL,

380 ECOND_BOOL_LAX,

381 ECOND_CRYPTEQ,

382 ECOND_DEF,

383 ECOND_STR_EQ,

384 ECOND_STR_EQI,

385 ECOND_EXISTS,

386 ECOND_FIRST_DELIVERY,

387 ECOND_FORALL,

388 ECOND_FORALL_JSON,

389 ECOND_FORALL_JSONS,

390 ECOND_FORANY,

391 ECOND_FORANY_JSON,

392 ECOND_FORANY_JSONS,

393 ECOND_STR_GE,

394 ECOND_STR_GEI,

395 ECOND_STR_GT,

396 ECOND_STR_GTI,

397 #ifdef SUPPORT_SRS

398 ECOND_INBOUND_SRS,

399 #endif

400 ECOND_INLIST,

401 ECOND_INLISTI,

402 ECOND_ISIP,

403 ECOND_ISIP4,

404 ECOND_ISIP6,

405 ECOND_LDAPAUTH,

406 ECOND_STR_LE,

407 ECOND_STR_LEI,

408 ECOND_STR_LT,

409 ECOND_STR_LTI,

410 ECOND_MATCH,

411 ECOND_MATCH_ADDRESS,

412 ECOND_MATCH_DOMAIN,

413 ECOND_MATCH_IP,

414 ECOND_MATCH_LOCAL_PART,

415 ECOND_OR,

416 ECOND_PAM,

417 ECOND_PWCHECK,

418 ECOND_QUEUE_RUNNING,

419 ECOND_RADIUS,

420 ECOND_SASLAUTHD

421 };

422

423

424 /* Type for entries pointing to address/length pairs. Not currently

425 in use. */

426

427 typedef struct {

428 uschar **address;

429 int *length;

430 } alblock;

431

432 typedef uschar * stringptr_fn_t(void);

433 static uschar * fn_recipients(void);

434 static uschar * fn_recipients_list(void);

435 static uschar * fn_queue_size(void);

436

437 /* This table must be kept in alphabetical order. */

438

439 static var_entry var_table[] = {

440 /* WARNING: Do not invent variables whose names start acl_c or acl_m because

441 they will be confused with user-creatable ACL variables. */

442 { "acl_arg1", vtype_stringptr, &acl_arg[0] },

443 { "acl_arg2", vtype_stringptr, &acl_arg[1] },

444 { "acl_arg3", vtype_stringptr, &acl_arg[2] },

445 { "acl_arg4", vtype_stringptr, &acl_arg[3] },

446 { "acl_arg5", vtype_stringptr, &acl_arg[4] },

447 { "acl_arg6", vtype_stringptr, &acl_arg[5] },

448 { "acl_arg7", vtype_stringptr, &acl_arg[6] },

449 { "acl_arg8", vtype_stringptr, &acl_arg[7] },

450 { "acl_arg9", vtype_stringptr, &acl_arg[8] },

451 { "acl_narg", vtype_int, &acl_narg },

452 { "acl_verify_message", vtype_stringptr, &acl_verify_message },

453 { "address_data", vtype_stringptr, &deliver_address_data },

454 { "address_file", vtype_stringptr, &address_file },

455 { "address_pipe", vtype_stringptr, &address_pipe },

456 #ifdef EXPERIMENTAL_ARC

457 { "arc_domains", vtype_module, US"arc" },

458 { "arc_oldest_pass", vtype_module, US"arc" },

459 { "arc_state", vtype_module, US"arc" },

460 { "arc_state_reason", vtype_module, US"arc" },

461 #endif

462 { "atrn_host", vtype_stringptr, &atrn_host },

463 { "atrn_mode", vtype_stringptr, &atrn_mode },

464 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },

465 { "authenticated_id", vtype_stringptr, &authenticated_id },

466 { "authenticated_sender",vtype_stringptr, &authenticated_sender },

467 { "authentication_failed",vtype_int, &authentication_failed },

468 #ifdef WITH_CONTENT_SCAN

469 { "av_failed", vtype_int, &av_failed },

470 #endif

471 #ifdef EXPERIMENTAL_BRIGHTMAIL

472 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },

473 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },

474 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },

475 { "bmi_deliver", vtype_int, &bmi_deliver },

476 #endif

477 { "body_linecount", vtype_int, &body_linecount },

478 { "body_zerocount", vtype_int, &body_zerocount },

479 { "bounce_recipient", vtype_stringptr, &bounce_recipient },

480 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },

481 { "caller_gid", vtype_gid, &real_gid },

482 { "caller_uid", vtype_uid, &real_uid },

483 { "callout_address", vtype_stringptr, &callout_address },

484 { "compile_date", vtype_stringptr, &version_date },

485 { "compile_number", vtype_stringptr, &version_cnumber },

486 { "config_dir", vtype_stringptr, &config_main_directory },

487 { "config_file", vtype_stringptr, &config_main_filename },

488 { "connection_id", vtype_stringptr, &connection_id },

489 { "csa_status", vtype_stringptr, &csa_status },

490 #ifdef EXPERIMENTAL_DCC

491 { "dcc_header", vtype_stringptr, &dcc_header },

492 { "dcc_result", vtype_stringptr, &dcc_result },

493 #endif

494 #ifndef DISABLE_DKIM

495 { "dkim_algo", vtype_module, US"dkim" },

496 { "dkim_bodylength", vtype_module, US"dkim" },

497 { "dkim_canon_body", vtype_module, US"dkim" },

498 { "dkim_canon_headers", vtype_module, US"dkim" },

499 { "dkim_copiedheaders", vtype_module, US"dkim" },

500 { "dkim_created", vtype_module, US"dkim" },

501 { "dkim_cur_signer", vtype_module, US"dkim" },

502 { "dkim_domain", vtype_module, US"dkim" },

503 { "dkim_expires", vtype_module, US"dkim" },

504 { "dkim_headernames", vtype_module, US"dkim" },

505 { "dkim_identity", vtype_module, US"dkim" },

506 { "dkim_key_granularity",vtype_module, US"dkim" },

507 { "dkim_key_length", vtype_module, US"dkim" },

508 { "dkim_key_nosubdomains",vtype_module, US"dkim" },

509 { "dkim_key_notes", vtype_module, US"dkim" },

510 { "dkim_key_srvtype", vtype_module, US"dkim" },

511 { "dkim_key_testing", vtype_module, US"dkim" },

512 { "dkim_selector", vtype_module, US"dkim" },

513 { "dkim_signers", vtype_module, US"dkim" },

514 { "dkim_verify_reason", vtype_module, US"dkim" },

515 { "dkim_verify_signers", vtype_module, US"dkim" },

516 { "dkim_verify_status", vtype_module, US"dkim" },

517 #endif

518 #ifdef SUPPORT_DMARC

519 { "dmarc_alignment_dkim",vtype_module, US"dmarc" },

520 { "dmarc_alignment_spf", vtype_module, US"dmarc" },

521 { "dmarc_domain_policy", vtype_module, US"dmarc" },

522 { "dmarc_status", vtype_module, US"dmarc" },

523 { "dmarc_status_text", vtype_module, US"dmarc" },

524 { "dmarc_used_domain", vtype_module, US"dmarc" },

525 #endif

526 { "dnslist_domain", vtype_stringptr, &dnslist_domain },

527 { "dnslist_matched", vtype_stringptr, &dnslist_matched },

528 { "dnslist_text", vtype_stringptr, &dnslist_text },

529 { "dnslist_value", vtype_stringptr, &dnslist_value },

530 { "domain", vtype_stringptr, &deliver_domain },

531 { "domain_data", vtype_stringptr, &deliver_domain_data },

532 #ifndef DISABLE_EVENT

533 { "event_data", vtype_stringptr, &event_data },

534

535 /*XXX want to use generic vars for as many of these as possible*/

536 { "event_defer_errno", vtype_int, &event_defer_errno },

537

538 { "event_name", vtype_stringptr, &event_name },

539 #endif

540 { "exim_gid", vtype_gid, &exim_gid },

541 { "exim_path", vtype_stringptr, &exim_path },

542 { "exim_uid", vtype_uid, &exim_uid },

543 { "exim_version", vtype_stringptr, &version_string },

544 { "headers_added", vtype_string_func, (void *) &fn_hdrs_added },

545 { "home", vtype_stringptr, &deliver_home },

546 { "host", vtype_stringptr, &deliver_host },

547 { "host_address", vtype_stringptr, &deliver_host_address },

548 { "host_data", vtype_stringptr, &host_data },

549 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },

550 { "host_lookup_failed", vtype_int, &host_lookup_failed },

551 { "host_port", vtype_int, &deliver_host_port },

552 { "initial_cwd", vtype_stringptr, &initial_cwd },

553 { "inode", vtype_ino, &deliver_inode },

554 { "interface_address", vtype_stringptr, &interface_address },

555 { "interface_port", vtype_int, &interface_port },

556 { "item", vtype_stringptr, &iterate_item },

557 #ifdef LOOKUP_LDAP

558 { "ldap_dn", vtype_stringptr, &eldap_dn },

559 #endif

560 { "load_average", vtype_load_avg, NULL },

561 { "local_part", vtype_stringptr, &deliver_localpart },

562 { "local_part_data", vtype_stringptr, &deliver_localpart_data },

563 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },

564 { "local_part_prefix_v", vtype_stringptr, &deliver_localpart_prefix_v },

565 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },

566 { "local_part_suffix_v", vtype_stringptr, &deliver_localpart_suffix_v },

567 #ifdef HAVE_LOCAL_SCAN

568 { "local_scan_data", vtype_stringptr, &local_scan_data },

569 #endif

570 { "local_user_gid", vtype_gid, &local_user_gid },

571 { "local_user_uid", vtype_uid, &local_user_uid },

572 { "localhost_number", vtype_int, &host_number },

573 { "log_inodes", vtype_pinodes, (void *)FALSE },

574 { "log_space", vtype_pspace, (void *)FALSE },

575 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},

576 { "mailstore_basename", vtype_stringptr, &mailstore_basename },

577 #ifdef WITH_CONTENT_SCAN

578 { "malware_name", vtype_stringptr, &malware_name },

579 #endif

580 { "max_received_linelength", vtype_int, &max_received_linelength },

581 { "message_age", vtype_int, &message_age },

582 { "message_body", vtype_msgbody, &message_body },

583 { "message_body_end", vtype_msgbody_end, &message_body_end },

584 { "message_body_size", vtype_int, &message_body_size },

585 { "message_exim_id", vtype_stringptr, &message_id },

586 { "message_headers", vtype_msgheaders, NULL },

587 { "message_headers_raw", vtype_msgheaders_raw, NULL },

588 { "message_id", vtype_stringptr, &message_id },

589 { "message_linecount", vtype_int, &message_linecount },

590 { "message_size", vtype_int, &message_size },

591 #ifdef SUPPORT_I18N

592 { "message_smtputf8", vtype_bool, &message_smtputf8 },

593 #endif

594 #ifdef WITH_CONTENT_SCAN

595 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },

596 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },

597 { "mime_boundary", vtype_stringptr, &mime_boundary },

598 { "mime_charset", vtype_stringptr, &mime_charset },

599 { "mime_content_description", vtype_stringptr, &mime_content_description },

600 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },

601 { "mime_content_id", vtype_stringptr, &mime_content_id },

602 { "mime_content_size", vtype_int, &mime_content_size },

603 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },

604 { "mime_content_type", vtype_stringptr, &mime_content_type },

605 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },

606 { "mime_filename", vtype_stringptr, &mime_filename },

607 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },

608 { "mime_is_multipart", vtype_int, &mime_is_multipart },

609 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },

610 { "mime_part_count", vtype_int, &mime_part_count },

611 #endif

612 { "n0", vtype_filter_int, &filter_n[0] },

613 { "n1", vtype_filter_int, &filter_n[1] },

614 { "n2", vtype_filter_int, &filter_n[2] },

615 { "n3", vtype_filter_int, &filter_n[3] },

616 { "n4", vtype_filter_int, &filter_n[4] },

617 { "n5", vtype_filter_int, &filter_n[5] },

618 { "n6", vtype_filter_int, &filter_n[6] },

619 { "n7", vtype_filter_int, &filter_n[7] },

620 { "n8", vtype_filter_int, &filter_n[8] },

621 { "n9", vtype_filter_int, &filter_n[9] },

622 { "original_domain", vtype_stringptr, &deliver_domain_orig },

623 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },

624 { "originator_gid", vtype_gid, &originator_gid },

625 { "originator_uid", vtype_uid, &originator_uid },

626 { "parent_domain", vtype_stringptr, &deliver_domain_parent },

627 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },

628 { "pid", vtype_pid, NULL },

629 #ifndef DISABLE_PRDR

630 { "prdr_requested", vtype_bool, &prdr_requested },

631 #endif

632 { "primary_hostname", vtype_stringptr, &primary_hostname },

633 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)

634 { "proxy_external_address",vtype_stringptr, &proxy_external_address },

635 { "proxy_external_port", vtype_int, &proxy_external_port },

636 { "proxy_local_address", vtype_stringptr, &proxy_local_address },

637 { "proxy_local_port", vtype_int, &proxy_local_port },

638 { "proxy_session", vtype_bool, &proxy_session },

639 #endif

640 { "prvscheck_address", vtype_stringptr, &prvscheck_address },

641 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },

642 { "prvscheck_result", vtype_stringptr, &prvscheck_result },

643 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },

644 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },

645 { "queue_name", vtype_stringptr, &queue_name },

646 { "queue_size", vtype_string_func, (void *) &fn_queue_size },

647 { "rcpt_count", vtype_int, &rcpt_count },

648 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },

649 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },

650 { "received_count", vtype_int, &received_count },

651 { "received_for", vtype_stringptr, &received_for },

652 { "received_ip_address", vtype_stringptr, &interface_address },

653 { "received_port", vtype_int, &interface_port },

654 { "received_protocol", vtype_stringptr, &received_protocol },

655 { "received_time", vtype_int, &received_time.tv_sec },

656 { "recipient_data", vtype_stringptr, &recipient_data },

657 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },

658 { "recipients", vtype_string_func, (void *) &fn_recipients },

659 { "recipients_count", vtype_int, &recipients_count },

660 { "recipients_list", vtype_string_func, (void *) &fn_recipients_list },

661 { "regex_cachesize", vtype_int, &regex_cachesize },/* undocumented; devel observability */

662 #ifdef WITH_CONTENT_SCAN

663 { "regex_match_string", vtype_stringptr, &regex_match_string },

664 #endif

665 { "reply_address", vtype_reply, NULL },

666 { "return_path", vtype_stringptr, &return_path },

667 { "return_size_limit", vtype_int, &bounce_return_size_limit },

668 { "router_name", vtype_stringptr, &router_name },

669 { "runrc", vtype_int, &runrc },

670 { "self_hostname", vtype_stringptr, &self_hostname },

671 { "sender_address", vtype_stringptr, &sender_address },

672 { "sender_address_data", vtype_stringptr, &sender_address_data },

673 { "sender_address_domain", vtype_domain, &sender_address },

674 { "sender_address_local_part", vtype_localpart, &sender_address },

675 { "sender_data", vtype_stringptr, &sender_data },

676 { "sender_fullhost", vtype_stringptr, &sender_fullhost },

677 { "sender_helo_dnssec", vtype_bool, &sender_helo_dnssec },

678 { "sender_helo_name", vtype_stringptr, &sender_helo_name },

679 { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },

680 { "sender_host_address", vtype_stringptr, &sender_host_address },

681 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },

682 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },

683 { "sender_host_name", vtype_host_lookup, NULL },

684 { "sender_host_port", vtype_int, &sender_host_port },

685 { "sender_ident", vtype_stringptr, &sender_ident },

686 { "sender_rate", vtype_stringptr, &sender_rate },

687 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },

688 { "sender_rate_period", vtype_stringptr, &sender_rate_period },

689 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },

690 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },

691 { "sending_ip_address", vtype_stringptr, &sending_ip_address },

692 { "sending_port", vtype_int, &sending_port },

693 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },

694 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },

695 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },

696 { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },

697 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },

698 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },

699 { "sn0", vtype_filter_int, &filter_sn[0] },

700 { "sn1", vtype_filter_int, &filter_sn[1] },

701 { "sn2", vtype_filter_int, &filter_sn[2] },

702 { "sn3", vtype_filter_int, &filter_sn[3] },

703 { "sn4", vtype_filter_int, &filter_sn[4] },

704 { "sn5", vtype_filter_int, &filter_sn[5] },

705 { "sn6", vtype_filter_int, &filter_sn[6] },

706 { "sn7", vtype_filter_int, &filter_sn[7] },

707 { "sn8", vtype_filter_int, &filter_sn[8] },

708 { "sn9", vtype_filter_int, &filter_sn[9] },

709 #ifdef WITH_CONTENT_SCAN

710 { "spam_action", vtype_stringptr, &spam_action },

711 { "spam_bar", vtype_stringptr, &spam_bar },

712 { "spam_report", vtype_stringptr, &spam_report },

713 { "spam_score", vtype_stringptr, &spam_score },

714 { "spam_score_int", vtype_stringptr, &spam_score_int },

715 #endif

716 #ifdef SUPPORT_SPF

717 { "spf_guess", vtype_module, US"spf" },

718 { "spf_header_comment", vtype_module, US"spf" },

719 { "spf_received", vtype_module, US"spf" },

720 { "spf_result", vtype_module, US"spf" },

721 { "spf_result_guessed", vtype_module, US"spf" },

722 { "spf_smtp_comment", vtype_module, US"spf" },

723 #endif

724 { "spool_directory", vtype_stringptr, &spool_directory },

725 { "spool_inodes", vtype_pinodes, (void *)TRUE },

726 { "spool_space", vtype_pspace, (void *)TRUE },

727 #ifdef SUPPORT_SRS

728 { "srs_recipient", vtype_stringptr, &srs_recipient },

729 #endif

730 { "thisaddress", vtype_stringptr, &filter_thisaddress },

731

732 /* The non-(in,out) variables are now deprecated */

733 { "tls_bits", vtype_int, &tls_in.bits },

734 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },

735 { "tls_cipher", vtype_stringptr, &tls_in.cipher },

736

737 { "tls_in_bits", vtype_int, &tls_in.bits },

738 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },

739 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },

740 { "tls_in_cipher_std", vtype_stringptr, &tls_in.cipher_stdname },

741 { "tls_in_ocsp", vtype_int, &tls_in.ocsp },

742 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },

743 { "tls_in_peercert", vtype_cert, &tls_in.peercert },

744 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },

745 #ifndef DISABLE_TLS_RESUME

746 { "tls_in_resumption", vtype_int, &tls_in.resumption },

747 #endif

748 #ifndef DISABLE_TLS

749 { "tls_in_sni", vtype_stringptr, &tls_in.sni },

750 #endif

751 { "tls_in_ver", vtype_stringptr, &tls_in.ver },

752 { "tls_out_bits", vtype_int, &tls_out.bits },

753 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },

754 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },

755 { "tls_out_cipher_std", vtype_stringptr, &tls_out.cipher_stdname },

756 #ifdef SUPPORT_DANE

757 { "tls_out_dane", vtype_bool, &tls_out.dane_verified },

758 #endif

759 { "tls_out_ocsp", vtype_int, &tls_out.ocsp },

760 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },

761 { "tls_out_peercert", vtype_cert, &tls_out.peercert },

762 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },

763 #ifndef DISABLE_TLS_RESUME

764 { "tls_out_resumption", vtype_int, &tls_out.resumption },

765 #endif

766 #ifndef DISABLE_TLS

767 { "tls_out_sni", vtype_stringptr, &tls_out.sni },

768 #endif

769 #ifdef SUPPORT_DANE

770 { "tls_out_tlsa_usage", vtype_int, &tls_out.tlsa_usage },

771 #endif

772 { "tls_out_ver", vtype_stringptr, &tls_out.ver },

773

774 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */

775 #ifndef DISABLE_TLS

776 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */

777 #endif

778

779 { "tod_bsdinbox", vtype_todbsdin, NULL },

780 { "tod_epoch", vtype_tode, NULL },

781 { "tod_epoch_l", vtype_todel, NULL },

782 { "tod_full", vtype_todf, NULL },

783 { "tod_log", vtype_todl, NULL },

784 { "tod_logfile", vtype_todlf, NULL },

785 { "tod_zone", vtype_todzone, NULL },

786 { "tod_zulu", vtype_todzulu, NULL },

787 { "transport_name", vtype_stringptr, &transport_name },

788 { "value", vtype_stringptr, &lookup_value },

789 { "verify_mode", vtype_stringptr, &verify_mode },

790 { "version_number", vtype_stringptr, &version_string },

791 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },

792 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },

793 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },

794 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },

795 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },

796 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }

797 };

798

799 #ifdef MACRO_PREDEF

800

801 /* dummies */

802 uschar * fn_arc_domains(void) {return NULL;}

803 uschar * fn_hdrs_added(void) {return NULL;}

804 uschar * fn_queue_size(void) {return NULL;}

805 uschar * fn_recipients(void) {return NULL;}

806 uschar * fn_recipients_list(void) {return NULL;}

807 uschar * sender_helo_verified_boolstr(void) {return NULL;}

808 uschar * smtp_cmd_hist(void) {return NULL;}

809

810

811

812 static void

813 expansion_items(void)

814 {

815 uschar buf[64];

816 for (int i = 0; i < nelem(item_table); i++)

817 {

818 spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);

819 builtin_macro_create(buf);

820 }

821 }

822 static void

823 expansion_operators(void)

824 {

825 uschar buf[64];

826 for (int i = 0; i < nelem(op_table_underscore); i++)

827 {

828 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);

829 builtin_macro_create(buf);

830 }

831 for (int i = 0; i < nelem(op_table_main); i++)

832 {

833 spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);

834 builtin_macro_create(buf);

835 }

836 }

837 static void

838 expansion_conditions(void)

839 {

840 uschar buf[64];

841 for (int i = 0; i < nelem(cond_table); i++)

842 {

843 spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);

844 builtin_macro_create(buf);

845 }

846 }

847 static void

848 expansion_variables(void)

849 {

850 uschar buf[64];

851 for (int i = 0; i < nelem(var_table); i++)

852 {

853 spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);

854 builtin_macro_create(buf);

855 }

856 }

857

858 void

859 expansions(void)

860 {

861 expansion_items();

862 expansion_operators();

863 expansion_conditions();

864 expansion_variables();

865 }

866

867 #else /*!MACRO_PREDEF*/

868

869 static uschar var_buffer[256];

870 static BOOL malformed_header;

871

872 /* For textual hashes */

873

874 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"

875 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"

876 "0123456789";

877

878 enum { HMAC_MD5, HMAC_SHA1 };

879

880 /* For numeric hashes */

881

882 static unsigned int prime[] = {

883 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,

884 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,

885 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};

886

887 /* For printing modes in symbolic form */

888

889 static uschar *mtable_normal[] =

890 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };

891

892 static uschar *mtable_setid[] =

893 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };

894

895 static uschar *mtable_sticky[] =

896 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };

897

898 /* flags for find_header() */

899 #define FH_EXISTS_ONLY BIT(0)

900 #define FH_WANT_RAW BIT(1)

901 #define FH_WANT_LIST BIT(2)

902

903 /* Recursively called function */

904 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);

905 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);

906

907

908 /*************************************************

909 * Tables for UTF-8 support *

910 *************************************************/

911

912 /* Table of the number of extra characters, indexed by the first character

913 masked with 0x3f. The highest number for a valid UTF-8 character is in fact

914 0x3d. */

915

916 static uschar utf8_table1[] = {

917 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,

918 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,

919 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,

920 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };

921

922 /* These are the masks for the data bits in the first byte of a character,

923 indexed by the number of additional bytes. */

924

925 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};

926

927 /* Get the next UTF-8 character, advancing the pointer. */

928

929 #define GETUTF8INC(c, ptr) \

930 c = *ptr++; \

931 if ((c & 0xc0) == 0xc0) \

932 { \

933 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \

934 int s = 6*a; \

935 c = (c & utf8_table2[a]) << s; \

936 while (a-- > 0) \

937 { \

938 s -= 6; \

939 c |= (*ptr++ & 0x3f) << s; \

940 } \

941 }

942

943

944

945 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";

946

947 /*************************************************

948 * Binary chop search on a table *

949 *************************************************/

950

951 /* This is used for matching expansion items and operators.

952

953 Arguments:

954 name the name that is being sought

955 table the table to search

956 table_size the number of items in the table

957

958 Returns: the offset in the table, or -1

959 */

960

961 static int

962 chop_match(uschar *name, uschar **table, int table_size)

963 {

964 uschar **bot = table;

965 uschar **top = table + table_size;

966

967 while (top > bot)

968 {

969 uschar **mid = bot + (top - bot)/2;

970 int c = Ustrcmp(name, *mid);

971 if (c == 0) return mid - table;

972 if (c > 0) bot = mid + 1; else top = mid;

973 }

974

975 return -1;

976 }

977

978

979

980 /*************************************************

981 * Check a condition string *

982 *************************************************/

983

984 /* This function is called to expand a string, and test the result for a "true"

985 or "false" value. Failure of the expansion yields FALSE; logged unless it was a

986 forced fail or lookup defer.

987

988 We used to release all store used, but this is not not safe due

989 to ${dlfunc } and ${acl }. In any case expand_string_internal()

990 is reasonably careful to release what it can.

991

992 The actual false-value tests should be replicated for ECOND_BOOL_LAX.

993

994 Arguments:

995 condition the condition string

996 m1 text to be incorporated in panic error

997 m2 ditto

998

999 Returns: TRUE if condition is met, FALSE if not

1000 */

1001

1002 BOOL

1003 expand_check_condition(const uschar * condition,

1004 const uschar * m1, const uschar * m2)

1005 {

1006 const uschar * ss = expand_cstring(condition);

1007 if (!ss)

1008 {

1009 if (!f.expand_string_forcedfail && !f.search_find_defer)

1010 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "

1011 "for %s %s: %s", condition, m1, m2, expand_string_message);

1012 return FALSE;

1013 }

1014 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&

1015 strcmpic(ss, US"false") != 0;

1016 }

1021 /*************************************************

1022 * Pseudo-random number generation *

1023 *************************************************/

1024

1025 /* Pseudo-random number generation. The result is not "expected" to be

1026 cryptographically strong but not so weak that someone will shoot themselves

1027 in the foot using it as a nonce in some email header scheme or whatever

1028 weirdness they'll twist this into. The result should ideally handle fork().

1029

1030 However, if we're stuck unable to provide this, then we'll fall back to

1031 appallingly bad randomness.

1032

1033 If DISABLE_TLS is not defined then this will not be used except as an emergency

1034 fallback.

1035

1036 Arguments:

1037 max range maximum

1038 Returns a random number in range [0, max-1]

1039 */

1040

1041 #ifndef DISABLE_TLS

1042 # define vaguely_random_number vaguely_random_number_fallback

1043 #endif

1044 int

1045 vaguely_random_number(int max)

1046 {

1047 #ifndef DISABLE_TLS

1048 # undef vaguely_random_number

1049 #endif

1050 static pid_t pid = 0;

1051 pid_t p2;

1052

1053 if ((p2 = getpid()) != pid)

1054 {

1055 if (pid != 0)

1056 {

1057

1058 #ifdef HAVE_ARC4RANDOM

1059 /* cryptographically strong randomness, common on *BSD platforms, not

1060 so much elsewhere. Alas. */

1061 # ifndef NOT_HAVE_ARC4RANDOM_STIR

1062 arc4random_stir();

1063 # endif

1064 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)

1065 # ifdef HAVE_SRANDOMDEV

1066 /* uses random(4) for seeding */

1067 srandomdev();

1068 # else

1069 {

1070 struct timeval tv;

1071 gettimeofday(&tv, NULL);

1072 srandom(tv.tv_sec | tv.tv_usec | getpid());

1073 }

1074 # endif

1075 #else

1076 /* Poor randomness and no seeding here */

1077 #endif

1078

1079 }

1080 pid = p2;

1081 }

1082

1083 #ifdef HAVE_ARC4RANDOM

1084 return arc4random() % max;

1085 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)

1086 return random() % max;

1087 #else

1088 /* This one returns a 16-bit number, definitely not crypto-strong */

1089 return random_number(max);

1090 #endif

1091 }

1096 /*************************************************

1097 * Pick out a name from a string *

1098 *************************************************/

1099

1100 /* If the name is too long, it is silently truncated.

1101

1102 Arguments:

1103 name points to a buffer into which to put the name

1104 max is the length of the buffer

1105 s points to the first alphabetic character of the name

1106 extras chars other than alphanumerics to permit

1107

1108 Returns: pointer to the first character after the name

1109

1110 Note: The test for *s != 0 in the while loop is necessary because

1111 Ustrchr() yields non-NULL if the character is zero (which is not something

1112 I expected). */

1113

1114 static const uschar *

1115 read_name(uschar *name, int max, const uschar *s, uschar *extras)

1116 {

1117 int ptr = 0;

1118 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))

1119 {

1120 if (ptr < max-1) name[ptr++] = *s;

1121 s++;

1122 }

1123 name[ptr] = 0;

1124 return s;

1125 }

1126

1127

1128

1129 /*************************************************

1130 * Pick out the rest of a header name *

1131 *************************************************/

1132

1133 /* A variable name starting $header_ (or just $h_ for those who like

1134 abbreviations) might not be the complete header name because headers can

1135 contain any printing characters in their names, except ':'. This function is

1136 called to read the rest of the name, chop h[eader]_ off the front, and put ':'

1137 on the end, if the name was terminated by white space.

1138

1139 Arguments:

1140 name points to a buffer in which the name read so far exists

1141 max is the length of the buffer

1142 s points to the first character after the name so far, i.e. the

1143 first non-alphameric character after $header_xxxxx

1144

1145 Returns: a pointer to the first character after the header name

1146 */

1147

1148 static const uschar *

1149 read_header_name(uschar *name, int max, const uschar *s)

1150 {

1151 int prelen = Ustrchr(name, '_') - name + 1;

1152 int ptr = Ustrlen(name) - prelen;

1153 if (ptr > 0) memmove(name, name+prelen, ptr);

1154 while (mac_isgraph(*s) && *s != ':')

1155 {

1156 if (ptr < max-1) name[ptr++] = *s;

1157 s++;

1158 }

1159 if (*s == ':') s++;

1160 name[ptr++] = ':';

1161 name[ptr] = 0;

1162 return s;

1163 }

1164

1165

1166

1167 /*************************************************

1168 * Pick out a number from a string *

1169 *************************************************/

1170

1171 /* Arguments:

1172 n points to an integer into which to put the number

1173 s points to the first digit of the number

1174

1175 Returns: a pointer to the character after the last digit

1176 */

1177 /*XXX consider expanding to int_eximarith_t. But the test for

1178 "overbig numbers" in 0002 still needs to overflow it. */

1179

1180 static uschar *

1181 read_number(int *n, uschar *s)

1182 {

1183 *n = 0;

1184 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');

1185 return s;

1186 }

1187

1188 static const uschar *

1189 read_cnumber(int *n, const uschar *s)

1190 {

1191 *n = 0;

1192 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');

1193 return s;

1194 }

1195

1196

1197

1198 /*************************************************

1199 * Extract keyed subfield from a string *

1200 *************************************************/

1201

1202 /* The yield is in dynamic store; NULL means that the key was not found.

1203

1204 Arguments:

1205 key points to the name of the key

1206 s points to the string from which to extract the subfield

1207

1208 Returns: NULL if the subfield was not found, or

1209 a pointer to the subfield's data

1210 */

1211

1212 uschar *

1213 expand_getkeyed(const uschar * key, const uschar * s)

1214 {

1215 int length = Ustrlen(key);

1216 Uskip_whitespace(&s);

1217

1218 /* Loop to search for the key */

1219

1220 while (*s)

1221 {

1222 int dkeylength;

1223 uschar * data;

1224 const uschar * dkey = s;

1225

1226 while (*s && *s != '=' && !isspace(*s)) s++;

1227 dkeylength = s - dkey;

1228 if (Uskip_whitespace(&s) == '=')

1229 while (isspace(*++s)) ;

1230

1231 data = string_dequote(&s);

1232 if (length == dkeylength && strncmpic(key, dkey, length) == 0)

1233 return data;

1234

1235 Uskip_whitespace(&s);

1236 }

1237

1238 return NULL;

1239 }

1240

1241

1242

1243 static var_entry *

1244 find_var_ent(uschar * name, var_entry * table, unsigned nent)

1245 {

1246 int first = 0;

1247 int last = nent;

1248

1249 while (last > first)

1250 {

1251 int middle = (first + last)/2;

1252 int c = Ustrcmp(name, table[middle].name);

1253

1254 if (c > 0) { first = middle + 1; continue; }

1255 if (c < 0) { last = middle; continue; }

1256 return &table[middle];

1257 }

1258 return NULL;

1259 }

1260

1261 /*************************************************

1262 * Extract numbered subfield from string *

1263 *************************************************/

1264

1265 /* Extracts a numbered field from a string that is divided by tokens - for

1266 example a line from /etc/passwd is divided by colon characters. First field is

1267 numbered one. Negative arguments count from the right. Zero returns the whole

1268 string. Returns NULL if there are insufficient tokens in the string

1269

1270 ***WARNING***

1271 Modifies final argument - this is a dynamically generated string, so that's OK.

1272

1273 Arguments:

1274 field number of field to be extracted,

1275 first field = 1, whole string = 0, last field = -1

1276 separators characters that are used to break string into tokens

1277 s points to the string from which to extract the subfield

1278

1279 Returns: NULL if the field was not found,

1280 a pointer to the field's data inside s (modified to add 0)

1281 */

1282

1283 static uschar *

1284 expand_gettokened (int field, uschar *separators, uschar *s)

1285 {

1286 int sep = 1;

1287 int count;

1288 uschar *ss = s;

1289 uschar *fieldtext = NULL;

1290

1291 if (field == 0) return s;

1292

1293 /* Break the line up into fields in place; for field > 0 we stop when we have

1294 done the number of fields we want. For field < 0 we continue till the end of

1295 the string, counting the number of fields. */

1296

1297 count = (field > 0)? field : INT_MAX;

1298

1299 while (count-- > 0)

1300 {

1301 size_t len;

1302

1303 /* Previous field was the last one in the string. For a positive field

1304 number, this means there are not enough fields. For a negative field number,

1305 check that there are enough, and scan back to find the one that is wanted. */

1306

1307 if (sep == 0)

1308 {

1309 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;

1310 if ((-field) == (INT_MAX - count - 1)) return s;

1311 while (field++ < 0)

1312 {

1313 ss--;

1314 while (ss[-1] != 0) ss--;

1315 }

1316 fieldtext = ss;

1317 break;

1318 }

1319

1320 /* Previous field was not last in the string; save its start and put a

1321 zero at its end. */

1322

1323 fieldtext = ss;

1324 len = Ustrcspn(ss, separators);

1325 sep = ss[len];

1326 ss[len] = 0;

1327 ss += len + 1;

1328 }

1329

1330 return fieldtext;

1331 }

1332

1333

1334 static uschar *

1335 expand_getlistele(int field, const uschar * list, int sep)

1336 {

1337 const uschar * tlist = list;

1338 int sep_l = sep;

1339 /* Tainted mem for the throwaway element copies */

1340 uschar * dummy = store_get(2, GET_TAINTED);

1341

1342 if (field < 0)

1343 for (field++; string_nextinlist(&tlist, &sep_l, dummy, 1); ) field++;

1344 if (field == 0) return NULL;

1345 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;

1346 return string_nextinlist(&list, &sep, NULL, 0);

1347 }

1348

1349

1350 /* Certificate fields, by name. Worry about by-OID later */

1351 /* Names are chosen to not have common prefixes */

1352

1353 #ifndef DISABLE_TLS

1354 typedef struct

1355 {

1356 uschar * name;

1357 int namelen;

1358 uschar * (*getfn)(void * cert, uschar * mod);

1359 } certfield;

1360 static certfield certfields[] =

1361 { /* linear search; no special order */

1362 { US"version", 7, &tls_cert_version },

1363 { US"serial_number", 13, &tls_cert_serial_number },

1364 { US"subject", 7, &tls_cert_subject },

1365 { US"notbefore", 9, &tls_cert_not_before },

1366 { US"notafter", 8, &tls_cert_not_after },

1367 { US"issuer", 6, &tls_cert_issuer },

1368 { US"signature", 9, &tls_cert_signature },

1369 { US"sig_algorithm", 13, &tls_cert_signature_algorithm },

1370 { US"subj_altname", 12, &tls_cert_subject_altname },

1371 { US"ocsp_uri", 8, &tls_cert_ocsp_uri },

1372 { US"crl_uri", 7, &tls_cert_crl_uri },

1373 };

1374

1375 static uschar *

1376 expand_getcertele(uschar * field, uschar * certvar)

1377 {

1378 var_entry * vp;

1379

1380 if (!(vp = find_var_ent(certvar, var_table, nelem(var_table))))

1381 {

1382 expand_string_message =

1383 string_sprintf("no variable named \"%s\"", certvar);

1384 return NULL; /* Unknown variable name */

1385 }

1386 /* NB this stops us passing certs around in variable. Might

1387 want to do that in future */

1388 if (vp->type != vtype_cert)

1389 {

1390 expand_string_message =

1391 string_sprintf("\"%s\" is not a certificate", certvar);

1392 return NULL; /* Unknown variable name */

1393 }

1394 if (!*(void **)vp->value)

1395 return NULL;

1396

1397 if (*field >= '0' && *field <= '9')

1398 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);

1399

1400 for (certfield * cp = certfields;

1401 cp < certfields + nelem(certfields);

1402 cp++)

1403 if (Ustrncmp(cp->name, field, cp->namelen) == 0)

1404 {

1405 uschar * modifier = *(field += cp->namelen) == ','

1406 ? ++field : NULL;

1407 return (*cp->getfn)( *(void **)vp->value, modifier );

1408 }

1409

1410 expand_string_message =

1411 string_sprintf("bad field selector \"%s\" for certextract", field);

1412 return NULL;

1413 }

1414 #endif /*DISABLE_TLS*/

1415

1416 /*************************************************

1417 * Extract a substring from a string *

1418 *************************************************/

1419

1420 /* Perform the ${substr or ${length expansion operations.

1421

1422 Arguments:

1423 subject the input string

1424 value1 the offset from the start of the input string to the start of

1425 the output string; if negative, count from the right.

1426 value2 the length of the output string, or negative (-1) for unset

1427 if value1 is positive, unset means "all after"

1428 if value1 is negative, unset means "all before"

1429 len set to the length of the returned string

1430

1431 Returns: pointer to the output string, or NULL if there is an error

1432 */

1433

1434 static uschar *

1435 extract_substr(uschar *subject, int value1, int value2, int *len)

1436 {

1437 int sublen = Ustrlen(subject);

1438

1439 if (value1 < 0) /* count from right */

1440 {

1441 value1 += sublen;

1442

1443 /* If the position is before the start, skip to the start, and adjust the

1444 length. If the length ends up negative, the substring is null because nothing

1445 can precede. This falls out naturally when the length is unset, meaning "all

1446 to the left". */

1447

1448 if (value1 < 0)

1449 {

1450 value2 += value1;

1451 if (value2 < 0) value2 = 0;

1452 value1 = 0;

1453 }

1454

1455 /* Otherwise an unset length => characters before value1 */

1456

1457 else if (value2 < 0)

1458 {

1459 value2 = value1;

1460 value1 = 0;

1461 }

1462 }

1463

1464 /* For a non-negative offset, if the starting position is past the end of the

1465 string, the result will be the null string. Otherwise, an unset length means

1466 "rest"; just set it to the maximum - it will be cut down below if necessary. */

1467

1468 else

1469 {

1470 if (value1 > sublen)

1471 {

1472 value1 = sublen;

1473 value2 = 0;

1474 }

1475 else if (value2 < 0) value2 = sublen;

1476 }

1477

1478 /* Cut the length down to the maximum possible for the offset value, and get

1479 the required characters. */

1480

1481 if (value1 + value2 > sublen) value2 = sublen - value1;

1482 *len = value2;

1483 return subject + value1;

1484 }

1489 /*************************************************

1490 * Old-style hash of a string *

1491 *************************************************/

1492

1493 /* Perform the ${hash expansion operation.

1494

1495 Arguments:

1496 subject the input string (an expanded substring)

1497 value1 the length of the output string; if greater or equal to the

1498 length of the input string, the input string is returned

1499 value2 the number of hash characters to use, or 26 if negative

1500 len set to the length of the returned string

1501

1502 Returns: pointer to the output string, or NULL if there is an error

1503 */

1504

1505 static uschar *

1506 compute_hash(uschar *subject, int value1, int value2, int *len)

1507 {

1508 int sublen = Ustrlen(subject);

1509

1510 if (value2 < 0) value2 = 26;

1511 else if (value2 > Ustrlen(hashcodes))

1512 {

1513 expand_string_message =

1514 string_sprintf("hash count \"%d\" too big", value2);

1515 return NULL;

1516 }

1517

1518 /* Calculate the hash text. We know it is shorter than the original string, so

1519 can safely place it in subject[] (we know that subject is always itself an

1520 expanded substring). */

1521

1522 if (value1 < sublen)

1523 {

1524 int c;

1525 int i = 0;

1526 int j = value1;

1527 while ((c = (subject[j])) != 0)

1528 {

1529 int shift = (c + j++) & 7;

1530 subject[i] ^= (c << shift) | (c >> (8-shift));

1531 if (++i >= value1) i = 0;

1532 }

1533 for (i = 0; i < value1; i++)

1534 subject[i] = hashcodes[(subject[i]) % value2];

1535 }

1536 else value1 = sublen;

1537

1538 *len = value1;

1539 return subject;

1540 }

1545 /*************************************************

1546 * Numeric hash of a string *

1547 *************************************************/

1548

1549 /* Perform the ${nhash expansion operation. The first characters of the

1550 string are treated as most important, and get the highest prime numbers.

1551

1552 Arguments:

1553 subject the input string

1554 value1 the maximum value of the first part of the result

1555 value2 the maximum value of the second part of the result,

1556 or negative to produce only a one-part result

1557 len set to the length of the returned string

1558

1559 Returns: pointer to the output string, or NULL if there is an error.

1560 */

1561

1562 static uschar *

1563 compute_nhash (uschar *subject, int value1, int value2, int *len)

1564 {

1565 uschar *s = subject;

1566 int i = 0;

1567 unsigned long int total = 0; /* no overflow */

1568

1569 while (*s != 0)

1570 {

1571 if (i == 0) i = nelem(prime) - 1;

1572 total += prime[i--] * (unsigned int)(*s++);

1573 }

1574

1575 /* If value2 is unset, just compute one number */

1576

1577 if (value2 < 0)

1578 s = string_sprintf("%lu", total % value1);

1579

1580 /* Otherwise do a div/mod hash */

1581

1582 else

1583 {

1584 total = total % (value1 * value2);

1585 s = string_sprintf("%lu/%lu", total/value2, total % value2);

1586 }

1587

1588 *len = Ustrlen(s);

1589 return s;

1590 }

1596 /*************************************************

1597 * Find the value of a header or headers *

1598 *************************************************/

1599

1600 /* Multiple instances of the same header get concatenated, and this function

1601 can also return a concatenation of all the header lines. When concatenating

1602 specific headers that contain lists of addresses, a comma is inserted between

1603 them. Otherwise we use a straight concatenation. Because some messages can have

1604 pathologically large number of lines, there is a limit on the length that is

1605 returned.

1606

1607 Arguments:

1608 name the name of the header, without the leading $header_ or $h_,

1609 or NULL if a concatenation of all headers is required

1610 newsize return the size of memory block that was obtained; may be NULL

1611 if exists_only is TRUE

1612 flags FH_EXISTS_ONLY

1613 set if called from a def: test; don't need to build a string;

1614 just return a string that is not "" and not "0" if the header

1615 exists

1616 FH_WANT_RAW

1617 set if called for $rh_ or $rheader_ items; no processing,

1618 other than concatenating, will be done on the header. Also used

1619 for $message_headers_raw.

1620 FH_WANT_LIST

1621 Double colon chars in the content, and replace newline with

1622 colon between each element when concatenating; returning a

1623 colon-sep list (elements might contain newlines)

1624 charset name of charset to translate MIME words to; used only if

1625 want_raw is false; if NULL, no translation is done (this is

1626 used for $bh_ and $bheader_)

1627

1628 Returns: NULL if the header does not exist, else a pointer to a new

1629 store block

1630 */

1631

1632 static uschar *

1633 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)

1634 {

1635 BOOL found = !name;

1636 int len = name ? Ustrlen(name) : 0;

1637 BOOL comma = FALSE;

1638 gstring * g = NULL;

1639 uschar * rawhdr;

1640

1641 for (header_line * h = header_list; h; h = h->next)

1642 if (h->type != htype_old && h->text) /* NULL => Received: placeholder */

1643 if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))

1644 {

1645 uschar * s, * t;

1646 size_t inc;

1647

1648 if (flags & FH_EXISTS_ONLY)

1649 return US"1"; /* don't need actual string */

1650

1651 found = TRUE;

1652 s = h->text + len; /* text to insert */

1653 if (!(flags & FH_WANT_RAW)) /* unless wanted raw, */

1654 Uskip_whitespace(&s); /* remove leading white space */

1655 t = h->text + h->slen; /* end-point */

1656

1657 /* Unless wanted raw, remove trailing whitespace, including the

1658 newline. */

1659

1660 if (flags & FH_WANT_LIST)

1661 while (t > s && t[-1] == '\n') t--;

1662 else if (!(flags & FH_WANT_RAW))

1663 {

1664 while (t > s && isspace(t[-1])) t--;

1665

1666 /* Set comma if handling a single header and it's one of those

1667 that contains an address list, except when asked for raw headers. Only

1668 need to do this once. */

1669

1670 if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;

1671 }

1672

1673 /* Trim the header roughly if we're approaching limits */

1674 inc = t - s;

1675 if (gstring_length(g) + inc > header_insert_maxlen)

1676 inc = header_insert_maxlen - gstring_length(g);

1677

1678 /* For raw just copy the data; for a list, add the data as a colon-sep

1679 list-element; for comma-list add as an unchecked comma,newline sep

1680 list-elemment; for other nonraw add as an unchecked newline-sep list (we

1681 stripped trailing WS above including the newline). We ignore the potential

1682 expansion due to colon-doubling, just leaving the loop if the limit is met

1683 or exceeded. */

1684

1685 if (flags & FH_WANT_LIST)

1686 g = string_append_listele_n(g, ':', s, (unsigned)inc);

1687 else if (flags & FH_WANT_RAW)

1688 g = string_catn(g, s, (unsigned)inc);

1689 else if (inc > 0)

1690 g = string_append2_listele_n(g, comma ? US",\n" : US"\n",

1691 s, (unsigned)inc);

1692

1693 if (gstring_length(g) >= header_insert_maxlen) break;

1694 }

1695

1696 if (!found) return NULL; /* No header found */

1697 if (!g) return US"";

1698

1699 /* That's all we do for raw header expansion. */

1700

1701 *newsize = g->size;

1702 rawhdr = string_from_gstring(g);

1703 if (flags & FH_WANT_RAW)

1704 return rawhdr;

1705

1706 /* Otherwise do RFC 2047 decoding, translating the charset if requested.

1707 The rfc2047_decode2() function can return an error with decoded data if the

1708 charset translation fails. If decoding fails, it returns NULL. */

1709

1710 else

1711 {

1712 uschar * error, * decoded = rfc2047_decode2(rawhdr,

1713 check_rfc2047_length, charset, '?', NULL, newsize, &error);

1714 if (error)

1715 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"

1716 " input was: %s\n", error, rawhdr);

1717 return decoded ? decoded : rawhdr;

1718 }

1719 }

1724 /* Append a "local" element to an Authentication-Results: header

1725 if this was a non-smtp message.

1726 */

1727

1728 static gstring *

1729 authres_local(gstring * g, const uschar * sysname)

1730 {

1731 if (!f.authentication_local)

1732 return g;

1733 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");

1734 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);

1735 return g;

1736 }

1737

1738

1739 /* Append an "iprev" element to an Authentication-Results: header

1740 if we have attempted to get the calling host's name.

1741 */

1742

1743 static gstring *

1744 authres_iprev(gstring * g)

1745 {

1746 if (sender_host_name)

1747 g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");

1748 else if (host_lookup_deferred)

1749 g = string_cat(g, US";\n\tiprev=temperror");

1750 else if (host_lookup_failed)

1751 g = string_cat(g, US";\n\tiprev=fail");

1752 else

1753 return g;

1754

1755 if (sender_host_address)

1756 g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);

1757 return g;

1758 }

1759

1760

1761

1762 /*************************************************

1763 * Return list of recipients *

1764 *************************************************/

1765 /* A recipients list is available only during system message filtering,

1766 during ACL processing after DATA, and while expanding pipe commands

1767 generated from a system filter, but not elsewhere. Note that this does

1768 not check for commas in the elements, and uses comma-space as seperator -

1769 so cannot be used as an exim list as-is. */

1770

1771 static uschar *

1772 fn_recipients(void)

1773 {

1774 gstring * g = NULL;

1775

1776 if (!f.enable_dollar_recipients) return NULL;

1777

1778 for (int i = 0; i < recipients_count; i++)

1779 {

1780 const uschar * s = recipients_list[i].address;

1781 g = string_append2_listele_n(g, US", ", s, Ustrlen(s));

1782 }

1783 gstring_release_unused(g);

1784 return string_from_gstring(g);

1785 }

1786

1787 /* Similar, but as a properly-quoted exim list */

1788

1789

1790 static uschar *

1791 fn_recipients_list(void)

1792 {

1793 gstring * g = NULL;

1794

1795 if (!f.enable_dollar_recipients) return NULL;

1796

1797 for (int i = 0; i < recipients_count; i++)

1798 g = string_append_listele(g, ':', recipients_list[i].address);

1799 gstring_release_unused(g);

1800 return string_from_gstring(g);

1801 }

1802

1803

1804 /*************************************************

1805 * Return size of queue *

1806 *************************************************/

1807 /* Ask the daemon for the queue size */

1808

1809 static uschar *

1810 fn_queue_size(void)

1811 {

1812 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};

1813 uschar buf[16];

1814 int fd;

1815 ssize_t len;

1816 const uschar * where;

1817 uschar * sname;

1818

1819 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)

1820 {

1821 DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));

1822 return NULL;

1823 }

1824

1825 len = daemon_client_sockname(&sa_un, &sname);

1826

1827 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)

1828 { where = US"bind"; goto bad; }

1829

1830 #ifdef notdef

1831 debug_printf("local addr '%s%s'\n",

1832 *sa_un.sun_path ? "" : "@",

1833 sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));

1834 #endif

1835

1836 len = daemon_notifier_sockname(&sa_un);

1837 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)

1838 { where = US"connect"; goto bad2; }

1839

1840 buf[0] = NOTIFY_QUEUE_SIZE_REQ;

1841 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }

1842

1843 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)

1844 {

1845 DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");

1846 len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());

1847 }

1848 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)

1849 { where = US"recv"; goto bad2; }

1850

1851 close(fd);

1852 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS

1853 Uunlink(sname);

1854 #endif

1855 return string_copyn(buf, len);

1856

1857 bad2:

1858 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS

1859 Uunlink(sname);

1860 #endif

1861 bad:

1862 close(fd);

1863 DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));

1864 return NULL;

1865 }

1866

1867

1868 /*************************************************

1869 * Find value of a variable *

1870 *************************************************/

1871

1872 /* The table of variables is kept in alphabetic order, so we can search it

1873 using a binary chop. The "choplen" variable is nothing to do with the binary

1874 chop.

1875

1876 Arguments:

1877 name the name of the variable being sought

1878 flags

1879 exists_only TRUE if this is a def: test; passed on to find_header()

1880 skipping TRUE => skip any processing evaluation; this is not the same as

1881 exists_only because def: may test for values that are first

1882 evaluated here

1883 newsize pointer to an int which is initially zero; if the answer is in

1884 a new memory buffer, *newsize is set to its size

1885

1886 Returns: NULL if the variable does not exist, or

1887 a pointer to the variable's contents, or

1888 something non-NULL if exists_only is TRUE

1889 */

1890

1891 static const uschar *

1892 find_variable(uschar * name, esi_flags flags, int * newsize)

1893 {

1894 var_entry * vp;

1895 uschar * s, * domain;

1896 uschar ** ss;

1897 void * val;

1898 var_entry * table = var_table;

1899 unsigned table_count = nelem(var_table);

1900

1901 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.

1902 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from

1903 release 4.64 onwards arbitrary names are permitted, as long as the first 5

1904 characters are acl_c or acl_m and the sixth is either a digit or an underscore

1905 (this gave backwards compatibility at the changeover). There may be built-in

1906 variables whose names start acl_ but they should never start in this way. This

1907 slightly messy specification is a consequence of the history, needless to say.

1908

1909 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is

1910 set, in which case give an error. */

1911

1912 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&

1913 !isalpha(name[5]))

1914 {

1915 tree_node * node =

1916 tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);

1917 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";

1918 }

1919 else if (Ustrncmp(name, "r_", 2) == 0)

1920 {

1921 tree_node * node = tree_search(router_var, name + 2);

1922 return node ? node->data.ptr : strict_acl_vars ? NULL : US"";

1923 }

1924

1925 /* Handle $auth<n>, $regex<n> variables. */

1926

1927 if (Ustrncmp(name, "auth", 4) == 0)

1928 {

1929 uschar *endptr;

1930 int n = Ustrtoul(name + 4, &endptr, 10);

1931 if (!*endptr && n != 0 && n <= AUTH_VARS)

1932 return auth_vars[n-1] ? auth_vars[n-1] : US"";

1933 }

1934 #ifdef WITH_CONTENT_SCAN

1935 else if (Ustrncmp(name, "regex", 5) == 0)

1936 {

1937 uschar *endptr;

1938 int n = Ustrtoul(name + 5, &endptr, 10);

1939 if (!*endptr && n != 0 && n <= REGEX_VARS)

1940 return regex_vars[n-1] ? regex_vars[n-1] : US"";

1941 }

1942 #endif

1943

1944 sublist:

1945

1946 /* For all other variables, search the table */

1947

1948 if (!(vp = find_var_ent(name, table, table_count)))

1949 return NULL; /* Unknown variable name */

1950

1951 /* Found an existing variable. If in skipping state, the value isn't needed,

1952 and we want to avoid processing (such as looking up the host name). */

1953

1954 if (flags & ESI_SKIPPING)

1955 return US"";

1956

1957 val = vp->value;

1958 switch (vp->type)

1959 {

1960 case vtype_filter_int:

1961 if (!f.filter_running) return NULL;

1962 /* Fall through */

1963 /* VVVVVVVVVVVV */

1964 case vtype_int:

1965 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */

1966 return var_buffer;

1967

1968 case vtype_ino:

1969 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */

1970 return var_buffer;

1971

1972 case vtype_gid:

1973 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */

1974 return var_buffer;

1975

1976 case vtype_uid:

1977 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */

1978 return var_buffer;

1979

1980 case vtype_bool:

1981 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */

1982 return var_buffer;

1983

1984 case vtype_stringptr: /* Pointer to string */

1985 return (s = *((uschar **)(val))) ? s : US"";

1986

1987 case vtype_pid:

1988 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */

1989 return var_buffer;

1990

1991 case vtype_load_avg:

1992 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */

1993 return var_buffer;

1994

1995 case vtype_host_lookup: /* Lookup if not done so */

1996 if ( !sender_host_name && sender_host_address

1997 && !host_lookup_failed && host_name_lookup() == OK)

1998 host_build_sender_fullhost();

1999 return sender_host_name ? sender_host_name : US"";

2000

2001 case vtype_localpart: /* Get local part from address */

2002 if (!(s = *((uschar **)(val)))) return US"";

2003 if (!(domain = Ustrrchr(s, '@'))) return s;

2004 if (domain - s > sizeof(var_buffer) - 1)

2005 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT

2006 " in string expansion", sizeof(var_buffer));

2007 return string_copyn(s, domain - s);

2008

2009 case vtype_domain: /* Get domain from address */

2010 if (!(s = *((uschar **)(val)))) return US"";

2011 domain = Ustrrchr(s, '@');

2012 return domain ? domain + 1 : US"";

2013

2014 case vtype_msgheaders:

2015 return find_header(NULL, newsize,

2016 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY : 0, NULL);

2017

2018 case vtype_msgheaders_raw:

2019 return find_header(NULL, newsize,

2020 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,

2021 NULL);

2022

2023 case vtype_msgbody: /* Pointer to msgbody string */

2024 case vtype_msgbody_end: /* Ditto, the end of the msg */

2025 ss = (uschar **)(val);

2026 if (!*ss && deliver_datafile >= 0) /* Read body when needed */

2027 {

2028 uschar * body;

2029 off_t start_offset_o = spool_data_start_offset(message_id);

2030 off_t start_offset = start_offset_o;

2031 int len = message_body_visible;

2032

2033 if (len > message_size) len = message_size;

2034 *ss = body = store_get(len+1, GET_TAINTED);

2035 body[0] = 0;

2036 if (vp->type == vtype_msgbody_end)

2037 {

2038 struct stat statbuf;

2039 if (fstat(deliver_datafile, &statbuf) == 0)

2040 {

2041 start_offset = statbuf.st_size - len;

2042 if (start_offset < start_offset_o)

2043 start_offset = start_offset_o;

2044 }

2045 }

2046 if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)

2047 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",

2048 strerror(errno));

2049 if ((len = read(deliver_datafile, body, len)) > 0)

2050 {

2051 body[len] = 0;

2052 if (message_body_newlines) /* Separate loops for efficiency */

2053 while (len > 0)

2054 { if (body[--len] == 0) body[len] = ' '; }

2055 else

2056 while (len > 0)

2057 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }

2058 }

2059 }

2060 return *ss ? *ss : US"";

2061

2062 case vtype_todbsdin: /* BSD inbox time of day */

2063 return tod_stamp(tod_bsdin);

2064

2065 case vtype_tode: /* Unix epoch time of day */

2066 return tod_stamp(tod_epoch);

2067

2068 case vtype_todel: /* Unix epoch/usec time of day */

2069 return tod_stamp(tod_epoch_l);

2070

2071 case vtype_todf: /* Full time of day */

2072 return tod_stamp(tod_full);

2073

2074 case vtype_todl: /* Log format time of day */

2075 return tod_stamp(tod_log_bare); /* (without timezone) */

2076

2077 case vtype_todzone: /* Time zone offset only */

2078 return tod_stamp(tod_zone);

2079

2080 case vtype_todzulu: /* Zulu time */

2081 return tod_stamp(tod_zulu);

2082

2083 case vtype_todlf: /* Log file datestamp tod */

2084 return tod_stamp(tod_log_datestamp_daily);

2085

2086 case vtype_reply: /* Get reply address */

2087 s = find_header(US"reply-to:", newsize,

2088 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,

2089 headers_charset);

2090 if (s) Uskip_whitespace(&s);

2091 if (!s || !*s)

2092 {

2093 *newsize = 0; /* For the *s==0 case */

2094 s = find_header(US"from:", newsize,

2095 flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,

2096 headers_charset);

2097 }

2098 if (s)

2099 {

2100 uschar *t;

2101 Uskip_whitespace(&s);

2102 for (t = s; *t; t++) if (*t == '\n') *t = ' ';

2103 while (t > s && isspace(t[-1])) t--;

2104 *t = 0;

2105 }

2106 return s ? s : US"";

2107

2108 case vtype_string_func:

2109 {

2110 stringptr_fn_t * fn = (stringptr_fn_t *) val;

2111 uschar * s = fn();

2112 return s ? s : US"";

2113 }

2114

2115 case vtype_pspace:

2116 {

2117 int inodes;

2118 sprintf(CS var_buffer, PR_EXIM_ARITH,

2119 receive_statvfs(val == (void *)TRUE, &inodes));

2120 }

2121 return var_buffer;

2122

2123 case vtype_pinodes:

2124 {

2125 int inodes;

2126 (void) receive_statvfs(val == (void *)TRUE, &inodes);

2127 sprintf(CS var_buffer, "%d", inodes);

2128 }

2129 return var_buffer;

2130

2131 case vtype_cert:

2132 return *(void **)val ? US"<cert>" : US"";

2133

2134 #ifndef DISABLE_DKIM

2135 case vtype_dkim:

2136 {

2137 misc_module_info * mi = misc_mod_findonly(US"dkim");

2138 typedef uschar * (*fn_t)(int);

2139 return mi

2140 ? (((fn_t *) mi->functions)[DKIM_EXPAND_QUERY]) ((int)(long)val)

2141 : US"";

2142 }

2143 #endif

2144

2145 case vtype_module:

2146 {

2147 uschar * errstr;

2148 misc_module_info * mi = misc_mod_find(val, &errstr);

2149 if (mi)

2150 {

2151 table = mi->variables;

2152 table_count = mi->variables_count;

2153 goto sublist;

2154 }

2155 log_write(0, LOG_MAIN|LOG_PANIC,

2156 "failed to find %s module for %s: %s", US val, name, errstr);

2157 return US"";

2158 }

2159 }

2160

2161 return NULL; /* Unknown variable. Silences static checkers. */

2162 }

2167 void

2168 modify_variable(uschar *name, void * value)

2169 {

2170 var_entry * vp;

2171 if ((vp = find_var_ent(name, var_table, nelem(var_table))))

2172 vp->value = value;

2173 return; /* Unknown variable name, fail silently */

2174 }

2181 /*************************************************

2182 * Read and expand substrings *

2183 *************************************************/

2184

2185 /* This function is called to read and expand argument substrings for various

2186 expansion items. Some have a minimum requirement that is less than the maximum;

2187 in these cases, the first non-present one is set to NULL.

2188

2189 Arguments:

2190 sub points to vector of pointers to set

2191 n maximum number of substrings

2192 m minimum required

2193 sptr points to current string pointer

2194 flags

2195 skipping the skipping flag

2196 check_end if TRUE, check for final '}'

2197 name name of item, for error message

2198 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset

2199 the store

2200 textonly_p if not NULL, pointer to bitmask of which subs were text-only

2201 (did not change when expended)

2202

2203 Returns: -1 OK; string pointer updated, but in "skipping" mode

2204 0 OK; string pointer updated

2205 1 curly bracketing error (too few arguments)

2206 2 too many arguments (only if check_end is set); message set

2207 3 other error (expansion failure)

2208 */

2209

2210 static int

2211 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,

2212 BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)

2213 {

2214 const uschar * s = *sptr;

2215 unsigned textonly_l = 0;

2216

2217 Uskip_whitespace(&s);

2218 for (int i = 0; i < n; i++)

2219 {

2220 BOOL textonly;

2221 if (*s != '{')

2222 {

2223 if (i < m)

2224 {

2225 expand_string_message = string_sprintf("Not enough arguments for '%s' "

2226 "(min is %d)", name, m);

2227 return 1;

2228 }

2229 sub[i] = NULL;

2230 break;

2231 }

2232 if (!(sub[i] = expand_string_internal(s+1,

2233 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,

2234 textonly_p ? &textonly : NULL)))

2235 return 3;

2236 if (*s++ != '}') return 1;

2237 if (textonly_p && textonly) textonly_l |= BIT(i);

2238 Uskip_whitespace(&s);

2239 } /*{*/

2240 if (check_end && *s++ != '}')

2241 {

2242 if (s[-1] == '{')

2243 {

2244 expand_string_message = string_sprintf("Too many arguments for '%s' "

2245 "(max is %d)", name, n);

2246 return 2;

2247 }

2248 expand_string_message = string_sprintf("missing '}' after '%s'", name);

2249 return 1;

2250 }

2251

2252 if (textonly_p) *textonly_p = textonly_l;

2253 *sptr = s;

2254 return flags & ESI_SKIPPING ? -1 : 0;

2255 }

2260 /*************************************************

2261 * Elaborate message for bad variable *

2262 *************************************************/

2263

2264 /* For the "unknown variable" message, take a look at the variable's name, and

2265 give additional information about possible ACL variables. The extra information

2266 is added on to expand_string_message.

2267

2268 Argument: the name of the variable

2269 Returns: nothing

2270 */

2271

2272 static void

2273 check_variable_error_message(uschar *name)

2274 {

2275 if (Ustrncmp(name, "acl_", 4) == 0)

2276 expand_string_message = string_sprintf("%s (%s)", expand_string_message,

2277 (name[4] == 'c' || name[4] == 'm')?

2278 (isalpha(name[5])?

2279 US"6th character of a user-defined ACL variable must be a digit or underscore" :

2280 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */

2281 ) :

2282 US"user-defined ACL variables must start acl_c or acl_m");

2283 }

2284

2285

2286

2287 /*

2288 Load args from sub array to globals, and call acl_check().

2289 Sub array will be corrupted on return.

2290

2291 Returns: OK access is granted by an ACCEPT verb

2292 DISCARD access is (apparently) granted by a DISCARD verb

2293 FAIL access is denied

2294 FAIL_DROP access is denied; drop the connection

2295 DEFER can't tell at the moment

2296 ERROR disaster

2297 */

2298 static int

2299 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)

2300 {

2301 int i;

2302 int sav_narg = acl_narg;

2303 int ret;

2304 uschar * dummy_logmsg;

2305 extern int acl_where;

2306

2307 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);

2308 for (i = 0; i < nsub && sub[i+1]; i++)

2309 {

2310 uschar * tmp = acl_arg[i];

2311 acl_arg[i] = sub[i+1]; /* place callers args in the globals */

2312 sub[i+1] = tmp; /* stash the old args using our caller's storage */

2313 }

2314 acl_narg = i;

2315 while (i < nsub)

2316 {

2317 sub[i+1] = acl_arg[i];

2318 acl_arg[i++] = NULL;

2319 }

2320

2321 DEBUG(D_expand)

2322 debug_printf_indent("expanding: acl: %s arg: %s%s\n",

2323 sub[0],

2324 acl_narg>0 ? acl_arg[0] : US"<none>",

2325 acl_narg>1 ? " +more" : "");

2326

2327 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);

2328

2329 for (i = 0; i < nsub; i++)

2330 acl_arg[i] = sub[i+1]; /* restore old args */

2331 acl_narg = sav_narg;

2332

2333 return ret;

2334 }

2339 /* Return pointer to dewrapped string, with enclosing specified chars removed.

2340 The given string is modified on return. Leading whitespace is skipped while

2341 looking for the opening wrap character, then the rest is scanned for the trailing

2342 (non-escaped) wrap character. A backslash in the string will act as an escape.

2343

2344 A nul is written over the trailing wrap, and a pointer to the char after the

2345 leading wrap is returned.

2346

2347 Arguments:

2348 s String for de-wrapping

2349 wrap Two-char string, the first being the opener, second the closer wrapping

2350 character

2351 Return:

2352 Pointer to de-wrapped string, or NULL on error (with expand_string_message set).

2353 */

2354

2355 static uschar *

2356 dewrap(uschar * s, const uschar * wrap)

2357 {

2358 uschar * p = s;

2359 unsigned depth = 0;

2360 BOOL quotesmode = wrap[0] == wrap[1];

2361

2362 if (Uskip_whitespace(&p) == *wrap)

2363 {

2364 s = ++p;

2365 wrap++;

2366 while (*p)

2367 {

2368 if (*p == '\\') p++;

2369 else if (!quotesmode && *p == wrap[-1]) depth++;

2370 else if (*p == *wrap)

2371 if (depth == 0)

2372 {

2373 *p = '\0';

2374 return s;

2375 }

2376 else

2377 depth--;

2378 p++;

2379 }

2380 }

2381 expand_string_message = string_sprintf("missing '%c'", *wrap);

2382 return NULL;

2383 }

2384

2385

2386 /* Pull off the leading array or object element, returning

2387 a copy in an allocated string. Update the list pointer.

2388

2389 The element may itself be an abject or array.

2390 Return NULL when the list is empty.

2391 */

2392

2393 static uschar *

2394 json_nextinlist(const uschar ** list)

2395 {

2396 unsigned array_depth = 0, object_depth = 0;

2397 BOOL quoted = FALSE;

2398 const uschar * s = *list, * item;

2399

2400 skip_whitespace(&s);

2401

2402 for (item = s;

2403 *s && (*s != ',' || array_depth != 0 || object_depth != 0 || quoted);

2404 s++)

2405 if (!quoted) switch (*s)

2406 {

2407 case '[': array_depth++; break;

2408 case ']': array_depth--; break;

2409 case '{': object_depth++; break;

2410 case '}': object_depth--; break;

2411 case '"': quoted = TRUE;

2412 }

2413 else switch(*s)

2414 {

2415 case '\\': s++; break; /* backslash protects one char */

2416 case '"': quoted = FALSE; break;

2417 }

2418 *list = *s ? s+1 : s;

2419 if (item == s) return NULL;

2420 item = string_copyn(item, s - item);

2421 DEBUG(D_expand) debug_printf_indent(" json ele: '%s'\n", item);

2422 return US item;

2423 }

2424

2425

2426

2427 /************************************************/

2428 /* Return offset in ops table, or -1 if not found.

2429 Repoint to just after the operator in the string.

2430

2431 Argument:

2432 ss string representation of operator

2433 opname split-out operator name

2434 */

2435

2436 static int

2437 identify_operator(const uschar ** ss, uschar ** opname)

2438 {

2439 const uschar * s = *ss;

2440 uschar name[256];

2441

2442 /* Numeric comparisons are symbolic */

2443

2444 if (*s == '=' || *s == '>' || *s == '<')

2445 {

2446 int p = 0;

2447 name[p++] = *s++;

2448 if (*s == '=')

2449 {

2450 name[p++] = '=';

2451 s++;

2452 }

2453 name[p] = 0;

2454 }

2455

2456 /* All other conditions are named */

2457

2458 else

2459 s = read_name(name, sizeof(name), s, US"_");

2460 *ss = s;

2461

2462 /* If we haven't read a name, it means some non-alpha character is first. */

2463

2464 if (!name[0])

2465 {

2466 expand_string_message = string_sprintf("condition name expected, "

2467 "but found \"%.16s\"", s);

2468 return -1;

2469 }

2470 DEBUG(D_expand) debug_printf_indent("cond: %s\n", name);

2471 if (opname)

2472 *opname = string_copy(name);

2473

2474 return chop_match(name, cond_table, nelem(cond_table));

2475 }

2476

2477

2478 /*************************************************

2479 * Handle MD5 or SHA-1 computation for HMAC *

2480 *************************************************/

2481

2482 /* These are some wrapping functions that enable the HMAC code to be a bit

2483 cleaner. A good compiler will spot the tail recursion.

2484

2485 Arguments:

2486 type HMAC_MD5 or HMAC_SHA1

2487 remaining are as for the cryptographic hash functions

2488

2489 Returns: nothing

2490 */

2491

2492 static void

2493 chash_start(int type, void * base)

2494 {

2495 if (type == HMAC_MD5)

2496 md5_start((md5 *)base);

2497 else

2498 sha1_start((hctx *)base);

2499 }

2500

2501 static void

2502 chash_mid(int type, void * base, const uschar * string)

2503 {

2504 if (type == HMAC_MD5)

2505 md5_mid((md5 *)base, string);

2506 else

2507 sha1_mid((hctx *)base, string);

2508 }

2509

2510 static void

2511 chash_end(int type, void * base, const uschar * string, int length,

2512 uschar * digest)

2513 {

2514 if (type == HMAC_MD5)

2515 md5_end((md5 *)base, string, length, digest);

2516 else

2517 sha1_end((hctx *)base, string, length, digest);

2518 }

2523 #ifdef SUPPORT_SRS

2524 /* Do an hmac_md5. The result is _not_ nul-terminated, and is sized as

2525 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.

2526

2527 Arguments:

2528 key encoding key, nul-terminated

2529 src data to be hashed, nul-terminated

2530 buf output buffer

2531 len size of output buffer

2532 */

2533

2534 static void

2535 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)

2536 {

2537 md5 md5_base;

2538 const uschar * keyptr;

2539 uschar * p;

2540 unsigned int keylen;

2541

2542 #define MD5_HASHLEN 16

2543 #define MD5_HASHBLOCKLEN 64

2544

2545 uschar keyhash[MD5_HASHLEN];

2546 uschar innerhash[MD5_HASHLEN];

2547 uschar finalhash[MD5_HASHLEN];

2548 uschar innerkey[MD5_HASHBLOCKLEN];

2549 uschar outerkey[MD5_HASHBLOCKLEN];

2550

2551 keyptr = key;

2552 keylen = Ustrlen(keyptr);

2553

2554 /* If the key is longer than the hash block length, then hash the key

2555 first */

2556

2557 if (keylen > MD5_HASHBLOCKLEN)

2558 {

2559 chash_start(HMAC_MD5, &md5_base);

2560 chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);

2561 keyptr = keyhash;

2562 keylen = MD5_HASHLEN;

2563 }

2564

2565 /* Now make the inner and outer key values */

2566

2567 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);

2568 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);

2569

2570 for (int i = 0; i < keylen; i++)

2571 {

2572 innerkey[i] ^= keyptr[i];

2573 outerkey[i] ^= keyptr[i];

2574 }

2575

2576 /* Now do the hashes */

2577

2578 chash_start(HMAC_MD5, &md5_base);

2579 chash_mid(HMAC_MD5, &md5_base, innerkey);

2580 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);

2581

2582 chash_start(HMAC_MD5, &md5_base);

2583 chash_mid(HMAC_MD5, &md5_base, outerkey);

2584 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);

2585

2586 /* Encode the final hash as a hex string, limited by output buffer size */

2587

2588 p = buf;

2589 for (int i = 0, j = len; i < MD5_HASHLEN; i++)

2590 {

2591 if (j-- <= 0) break;

2592 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];

2593 if (j-- <= 0) break;

2594 *p++ = hex_digits[finalhash[i] & 0x0f];

2595 }

2596 return;

2597 }

2598 #endif /*SUPPORT_SRS*/

2599

2600

2601 /*************************************************

2602 * Read and evaluate a condition *

2603 *************************************************/

2604

2605 /*

2606 Arguments:

2607 s points to the start of the condition text

2608 resetok points to a BOOL which is written false if it is unsafe to

2609 free memory. Certain condition types (acl) may have side-effect

2610 allocation which must be preserved.

2611 yield points to a BOOL to hold the result of the condition test;

2612 if NULL, we are just reading through a condition that is

2613 part of an "or" combination to check syntax, or in a state

2614 where the answer isn't required

2615

2616 Returns: a pointer to the first character after the condition, or

2617 NULL after an error

2618 */

2619

2620 static const uschar *

2621 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)

2622 {

2623 BOOL testfor = TRUE, tempcond, combined_cond;

2624 BOOL * subcondptr;

2625 BOOL sub2_honour_dollar = TRUE, is_forany, is_json, is_jsons;

2626 int rc, cond_type;

2627 int_eximarith_t num[2];

2628 struct stat statbuf;

2629 uschar * opname;

2630 uschar name[256];

2631 const uschar * sub[10], * next;

2632 unsigned sub_textonly = 0;

2633

2634 expand_level++;

2635 for (;;)

2636 if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;

2637

2638 switch(cond_type = identify_operator(&s, &opname))

2639 {

2640 /* def: tests for a non-empty variable, or for the existence of a header. If

2641 yield == NULL we are in a skipping state, and don't care about the answer. */

2642

2643 case ECOND_DEF:

2644 {

2645 const uschar * t;

2646

2647 if (*s != ':')

2648 {

2649 expand_string_message = US"\":\" expected after \"def\"";

2650 goto failout;

2651 }

2652

2653 s = read_name(name, sizeof(name), s+1, US"_");

2654

2655 /* Test for a header's existence. If the name contains a closing brace

2656 character, this may be a user error where the terminating colon has been

2657 omitted. Set a flag to adjust a subsequent error message in this case. */

2658

2659 if ( ( *(t = name) == 'h'

2660 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'

2661 )

2662 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)

2663 )

2664 {

2665 s = read_header_name(name, sizeof(name), s);

2666 /* {-for-text-editors */

2667 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;

2668 if (yield) *yield =

2669 (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;

2670 }

2671

2672 /* Test for a variable's having a non-empty value. A non-existent variable

2673 causes an expansion failure. */

2674

2675 else

2676 {

2677 if (!(t = find_variable(name,

2678 yield ? ESI_EXISTS_ONLY : ESI_EXISTS_ONLY | ESI_SKIPPING, NULL)))

2679 {

2680 expand_string_message = name[0]

2681 ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)

2682 : US"variable name omitted after \"def:\"";

2683 check_variable_error_message(name);

2684 goto failout;

2685 }

2686 if (yield) *yield = (t[0] != 0) == testfor;

2687 }

2688

2689 next = s; goto out;

2690 }

2691

2692

2693 /* first_delivery tests for first delivery attempt */

2694

2695 case ECOND_FIRST_DELIVERY:

2696 if (yield) *yield = f.deliver_firsttime == testfor;

2697 next = s; goto out;

2698

2699

2700 /* queue_running tests for any process started by a queue runner */

2701

2702 case ECOND_QUEUE_RUNNING:

2703 if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;

2704 next = s; goto out;

2705

2706

2707 /* exists: tests for file existence

2708 isip: tests for any IP address

2709 isip4: tests for an IPv4 address

2710 isip6: tests for an IPv6 address

2711 pam: does PAM authentication

2712 radius: does RADIUS authentication

2713 ldapauth: does LDAP authentication

2714 pwcheck: does Cyrus SASL pwcheck authentication

2715 */

2716

2717 case ECOND_EXISTS:

2718 case ECOND_ISIP:

2719 case ECOND_ISIP4:

2720 case ECOND_ISIP6:

2721 case ECOND_PAM:

2722 case ECOND_RADIUS:

2723 case ECOND_LDAPAUTH:

2724 case ECOND_PWCHECK:

2725

2726 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */

2727

2728 {

2729 BOOL textonly;

2730 sub[0] = expand_string_internal(s+1,

2731 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),

2732 &s, resetok, &textonly);

2733 if (!sub[0]) goto failout;

2734 if (textonly) sub_textonly |= BIT(0);

2735 }

2736 /* {-for-text-editors */

2737 if (*s++ != '}') goto COND_FAILED_CURLY_END;

2738

2739 if (!yield) { next = s; goto out; } /* No need to run the test if skipping */

2740

2741 switch(cond_type)

2742 {

2743 case ECOND_EXISTS:

2744 if ((expand_forbid & RDO_EXISTS) != 0)

2745 {

2746 expand_string_message = US"File existence tests are not permitted";

2747 goto failout;

2748 }

2749 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;

2750 break;

2751

2752 case ECOND_ISIP:

2753 case ECOND_ISIP4:

2754 case ECOND_ISIP6:

2755 {

2756 const uschar *errp;

2757 const uschar **errpp;

2758 DEBUG(D_expand) errpp = &errp; else errpp = 0;

2759 if (0 == (rc = string_is_ip_addressX(sub[0], NULL, errpp)))

2760 DEBUG(D_expand) debug_printf("failed: %s\n", errp);

2761

2762 *yield = ( cond_type == ECOND_ISIP ? rc != 0 :

2763 cond_type == ECOND_ISIP4 ? rc == 4 : rc == 6) == testfor;

2764 }

2765

2766 break;

2767

2768 /* Various authentication tests - all optionally compiled */

2769

2770 case ECOND_PAM:

2771 #ifdef SUPPORT_PAM

2772 {

2773 const misc_module_info * mi = misc_mod_find(US"pam", NULL);

2774 typedef int (*fn_t)(const uschar *, uschar **);

2775 if (!mi)

2776 goto COND_FAILED_NOT_COMPILED;

2777 rc = (((fn_t *) mi->functions)[PAM_AUTH_CALL])

2778 (sub[0], &expand_string_message);

2779 goto END_AUTH;

2780 }

2781 #else

2782 goto COND_FAILED_NOT_COMPILED;

2783 #endif /* SUPPORT_PAM */

2784

2785 case ECOND_RADIUS:

2786 #ifdef RADIUS_CONFIG_FILE

2787 {

2788 const misc_module_info * mi = misc_mod_find(US"radius", NULL);

2789 typedef int (*fn_t)(const uschar *, uschar **);

2790 if (!mi)

2791 goto COND_FAILED_NOT_COMPILED;

2792 rc = (((fn_t *) mi->functions)[RADIUS_AUTH_CALL])

2793 (sub[0], &expand_string_message);

2794 goto END_AUTH;

2795 }

2796 #else

2797 goto COND_FAILED_NOT_COMPILED;

2798 #endif /* RADIUS_CONFIG_FILE */

2799

2800 case ECOND_LDAPAUTH:

2801 #ifdef LOOKUP_LDAP

2802 {

2803 int expand_setup = -1;

2804 const lookup_info * li = search_findtype(US"ldapauth", 8);

2805 void * handle;

2806

2807 if (li && (handle = search_open(NULL, li, 0, NULL, NULL)))

2808 rc = search_find(handle, NULL, sub[0],

2809 -1, NULL, 0, 0, &expand_setup, NULL)

2810 ? OK : f.search_find_defer ? DEFER : FAIL;

2811 else

2812 { expand_string_message = search_error_message; rc = FAIL; }

2813 }

2814 goto END_AUTH;

2815 #else

2816 goto COND_FAILED_NOT_COMPILED;

2817 #endif /* LOOKUP_LDAP */

2818

2819 case ECOND_PWCHECK:

2820 #ifdef CYRUS_PWCHECK_SOCKET

2821 rc = auth_call_pwcheck(sub[0], &expand_string_message);

2822 goto END_AUTH;

2823 #else

2824 goto COND_FAILED_NOT_COMPILED;

2825 #endif /* CYRUS_PWCHECK_SOCKET */

2826

2827 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \

2828 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)

2829 END_AUTH:

2830 if (rc == ERROR || rc == DEFER) goto failout;

2831 *yield = (rc == OK) == testfor;

2832 #endif

2833 }

2834 next = s; goto out;

2835

2836

2837 /* call ACL (in a conditional context). Accept true, deny false.

2838 Defer is a forced-fail. Anything set by message= goes to $value.

2839 Up to ten parameters are used; we use the braces round the name+args

2840 like the saslauthd condition does, to permit a variable number of args.

2841 See also the expansion-item version EITEM_ACL and the traditional

2842 acl modifier ACLC_ACL.

2843 Since the ACL may allocate new global variables, tell our caller to not

2844 reclaim memory.

2845 */

2846

2847 case ECOND_ACL:

2848 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */

2849 {

2850 uschar *sub[10];

2851 uschar *user_msg;

2852 BOOL cond = FALSE;

2853

2854 Uskip_whitespace(&s);

2855 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/

2856

2857 switch(read_subs(sub, nelem(sub), 1, &s,

2858 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))

2859 {

2860 case 1: expand_string_message = US"too few arguments or bracketing "

2861 "error for acl";

2862 case 2:

2863 case 3: goto failout;

2864 }

2865

2866 if (yield)

2867 {

2868 int rc;

2869 *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */

2870 switch(rc = eval_acl(sub, nelem(sub), &user_msg))

2871 {

2872 case OK:

2873 cond = TRUE;

2874 case FAIL:

2875 lookup_value = NULL;

2876 if (user_msg)

2877 lookup_value = string_copy(user_msg);

2878 *yield = cond == testfor;

2879 break;

2880

2881 case DEFER:

2882 f.expand_string_forcedfail = TRUE;

2883 /*FALLTHROUGH*/

2884 default:

2885 expand_string_message = string_sprintf("%s from acl \"%s\"",

2886 rc_names[rc], sub[0]);

2887 goto failout;

2888 }

2889 }

2890 next = s; goto out;

2891 }

2892

2893

2894 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:

2895

2896 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}

2897

2898 However, the last two are optional. That is why the whole set is enclosed

2899 in their own set of braces. */

2900

2901 case ECOND_SASLAUTHD:

2902 #ifndef CYRUS_SASLAUTHD_SOCKET

2903 goto COND_FAILED_NOT_COMPILED;

2904 #else

2905 {

2906 uschar *sub[4];

2907 Uskip_whitespace(&s);

2908 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */

2909 switch(read_subs(sub, nelem(sub), 2, &s,

2910 yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))

2911 {

2912 case 1: expand_string_message = US"too few arguments or bracketing "

2913 "error for saslauthd";

2914 case 2:

2915 case 3: goto failout;

2916 }

2917 if (!sub[2]) sub[3] = NULL; /* realm if no service */

2918 if (yield)

2919 {

2920 int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],

2921 &expand_string_message);

2922 if (rc == ERROR || rc == DEFER) goto failout;

2923 *yield = (rc == OK) == testfor;

2924 }

2925 next = s; goto out;

2926 }

2927 #endif /* CYRUS_SASLAUTHD_SOCKET */

2928

2929

2930 /* symbolic operators for numeric and string comparison, and a number of

2931 other operators, all requiring two arguments.

2932

2933 crypteq: encrypts plaintext and compares against an encrypted text,

2934 using crypt(), crypt16(), MD5 or SHA-1

2935 inlist/inlisti: checks if first argument is in the list of the second

2936 match: does a regular expression match and sets up the numerical

2937 variables if it succeeds

2938 match_address: matches in an address list

2939 match_domain: matches in a domain list

2940 match_ip: matches a host list that is restricted to IP addresses

2941 match_local_part: matches in a local part list

2942 */

2943

2944 case ECOND_MATCH_ADDRESS:

2945 case ECOND_MATCH_DOMAIN:

2946 case ECOND_MATCH_IP:

2947 case ECOND_MATCH_LOCAL_PART:

2948 sub2_honour_dollar = FALSE;

2949 /* FALLTHROUGH */

2950

2951 case ECOND_CRYPTEQ:

2952 case ECOND_INLIST:

2953 case ECOND_INLISTI:

2954 case ECOND_MATCH:

2955

2956 case ECOND_NUM_L: /* Numerical comparisons */

2957 case ECOND_NUM_LE:

2958 case ECOND_NUM_E:

2959 case ECOND_NUM_EE:

2960 case ECOND_NUM_G:

2961 case ECOND_NUM_GE:

2962

2963 case ECOND_STR_LT: /* String comparisons */

2964 case ECOND_STR_LTI:

2965 case ECOND_STR_LE:

2966 case ECOND_STR_LEI:

2967 case ECOND_STR_EQ:

2968 case ECOND_STR_EQI:

2969 case ECOND_STR_GT:

2970 case ECOND_STR_GTI:

2971 case ECOND_STR_GE:

2972 case ECOND_STR_GEI:

2973

2974 for (int i = 0; i < 2; i++)

2975 {

2976 BOOL textonly;

2977 /* Sometimes, we don't expand substrings; too many insecure configurations

2978 created using match_address{}{} and friends, where the second param

2979 includes information from untrustworthy sources. */

2980 /*XXX is this moot given taint-tracking? */

2981

2982 esi_flags flags = ESI_BRACE_ENDS;

2983

2984 if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;

2985 if (!yield) flags |= ESI_SKIPPING;

2986

2987 if (Uskip_whitespace(&s) != '{')

2988 {

2989 if (i == 0) goto COND_FAILED_CURLY_START;

2990 expand_string_message = string_sprintf("missing 2nd string in {} "

2991 "after \"%s\"", opname);

2992 goto failout;

2993 }

2994 if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))

2995 goto failout;

2996 if (textonly) sub_textonly |= BIT(i);

2997 DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))

2998 debug_printf_indent("WARNING: the second arg is NOT expanded,"

2999 " for security reasons\n");

3000 if (*s++ != '}') goto COND_FAILED_CURLY_END;

3001

3002 /* Convert to numerical if required; we know that the names of all the

3003 conditions that compare numbers do not start with a letter. This just saves

3004 checking for them individually. */

3005

3006 if (!isalpha(opname[0]) && yield)

3007 if (sub[i][0] == 0)

3008 {

3009 num[i] = 0;

3010 DEBUG(D_expand)

3011 debug_printf_indent("empty string cast to zero for numerical comparison\n");

3012 }

3013 else

3014 {

3015 num[i] = expanded_string_integer(sub[i], FALSE);

3016 if (expand_string_message) goto failout;

3017 }

3018 }

3019

3020 /* Result not required */

3021

3022 if (!yield) { next = s; goto out; }

3023

3024 /* Do an appropriate comparison */

3025

3026 switch(cond_type)

3027 {

3028 case ECOND_NUM_E:

3029 case ECOND_NUM_EE:

3030 tempcond = (num[0] == num[1]); break;

3031

3032 case ECOND_NUM_G:

3033 tempcond = (num[0] > num[1]); break;

3034

3035 case ECOND_NUM_GE:

3036 tempcond = (num[0] >= num[1]); break;

3037

3038 case ECOND_NUM_L:

3039 tempcond = (num[0] < num[1]); break;

3040

3041 case ECOND_NUM_LE:

3042 tempcond = (num[0] <= num[1]); break;

3043

3044 case ECOND_STR_LT:

3045 tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;

3046

3047 case ECOND_STR_LTI:

3048 tempcond = (strcmpic(sub[0], sub[1]) < 0); break;

3049

3050 case ECOND_STR_LE:

3051 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;

3052

3053 case ECOND_STR_LEI:

3054 tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;

3055

3056 case ECOND_STR_EQ:

3057 tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;

3058

3059 case ECOND_STR_EQI:

3060 tempcond = (strcmpic(sub[0], sub[1]) == 0); break;

3061

3062 case ECOND_STR_GT:

3063 tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;

3064

3065 case ECOND_STR_GTI:

3066 tempcond = (strcmpic(sub[0], sub[1]) > 0); break;

3067

3068 case ECOND_STR_GE:

3069 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;

3070

3071 case ECOND_STR_GEI:

3072 tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;

3073

3074 case ECOND_MATCH: /* Regular expression match */

3075 {

3076 const pcre2_code * re = regex_compile(sub[1],

3077 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,

3078 &expand_string_message, pcre_gen_cmp_ctx);

3079 if (!re)

3080 goto failout;

3081

3082 tempcond = regex_match_and_setup(re, sub[0], 0, -1);

3083 break;

3084 }

3085

3086 case ECOND_MATCH_ADDRESS: /* Match in an address list */

3087 rc = match_address_list(sub[0], TRUE,

3088 #ifdef EXPAND_LISTMATCH_RHS

3089 TRUE,

3090 #else

3091 FALSE,

3092 #endif

3093 &(sub[1]), NULL, -1, 0,

3094 CUSS &lookup_value);

3095 goto MATCHED_SOMETHING;

3096

3097 case ECOND_MATCH_DOMAIN: /* Match in a domain list */

3098 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,

3099 #ifdef EXPAND_LISTMATCH_RHS

3100 MCL_DOMAIN,

3101 #else

3102 MCL_DOMAIN + MCL_NOEXPAND,

3103 #endif

3104 TRUE, CUSS &lookup_value);

3105 goto MATCHED_SOMETHING;

3106

3107 case ECOND_MATCH_IP: /* Match IP address in a host list */

3108 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)

3109 {

3110 expand_string_message = string_sprintf("\"%s\" is not an IP address",

3111 sub[0]);

3112 goto failout;

3113 }

3114 else

3115 {

3116 unsigned int *nullcache = NULL;

3117 check_host_block cb;

3118

3119 cb.host_name = US"";

3120 cb.host_address = sub[0];

3121

3122 /* If the host address starts off ::ffff: it is an IPv6 address in

3123 IPv4-compatible mode. Find the IPv4 part for checking against IPv4

3124 addresses. */

3125

3126 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?

3127 cb.host_address + 7 : cb.host_address;

3128

3129 rc = match_check_list(

3130 &sub[1], /* the list */

3131 0, /* separator character */

3132 &hostlist_anchor, /* anchor pointer */

3133 &nullcache, /* cache pointer */

3134 check_host, /* function for testing */

3135 &cb, /* argument for function */

3136 #ifdef EXPAND_LISTMATCH_RHS

3137 MCL_HOST,

3138 #else

3139 MCL_HOST + MCL_NOEXPAND,/* type of check */

3140 #endif

3141 sub[0], /* text for debugging */

3142 CUSS &lookup_value); /* where to pass back data */

3143 }

3144 goto MATCHED_SOMETHING;

3145

3146 case ECOND_MATCH_LOCAL_PART:

3147 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,

3148 #ifdef EXPAND_LISTMATCH_RHS

3149 MCL_LOCALPART,

3150 #else

3151 MCL_LOCALPART+ MCL_NOEXPAND,

3152 #endif

3153 TRUE, CUSS &lookup_value);

3154 /* Fall through */

3155 /* VVVVVVVVVVVV */

3156 MATCHED_SOMETHING:

3157 switch(rc)

3158 {

3159 case OK: tempcond = TRUE; break;

3160 case FAIL: tempcond = FALSE; break;

3161

3162 case DEFER:

3163 expand_string_message = string_sprintf("unable to complete match "

3164 "against \"%s\": %s", sub[1], search_error_message);

3165 goto failout;

3166 }

3167

3168 break;

3169

3170 /* Various "encrypted" comparisons. If the second string starts with

3171 "{" then an encryption type is given. Default to crypt() or crypt16()

3172 (build-time choice). */

3173 /* }-for-text-editors */

3174

3175 case ECOND_CRYPTEQ:

3176 #ifndef SUPPORT_CRYPTEQ

3177 goto COND_FAILED_NOT_COMPILED;

3178 #else

3179 if (strncmpic(sub[1], US"{md5}", 5) == 0)

3180 {

3181 int sublen = Ustrlen(sub[1]+5);

3182 md5 base;

3183 uschar digest[16];

3184

3185 md5_start(&base);

3186 md5_end(&base, sub[0], Ustrlen(sub[0]), digest);

3187

3188 /* If the length that we are comparing against is 24, the MD5 digest

3189 is expressed as a base64 string. This is the way LDAP does it. However,

3190 some other software uses a straightforward hex representation. We assume

3191 this if the length is 32. Other lengths fail. */

3192

3193 if (sublen == 24)

3194 {

3195 uschar *coded = b64encode(CUS digest, 16);

3196 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"

3197 " subject=%s\n crypted=%s\n", coded, sub[1]+5);

3198 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);

3199 }

3200 else if (sublen == 32)

3201 {

3202 uschar coded[36];

3203 for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);

3204 coded[32] = 0;

3205 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"

3206 " subject=%s\n crypted=%s\n", coded, sub[1]+5);

3207 tempcond = (strcmpic(coded, sub[1]+5) == 0);

3208 }

3209 else

3210 {

3211 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "

3212 "fail\n crypted=%s\n", sub[1]+5);

3213 tempcond = FALSE;

3214 }

3215 }

3216

3217 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)

3218 {

3219 int sublen = Ustrlen(sub[1]+6);

3220 hctx h;

3221 uschar digest[20];

3222

3223 sha1_start(&h);

3224 sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);

3225

3226 /* If the length that we are comparing against is 28, assume the SHA1

3227 digest is expressed as a base64 string. If the length is 40, assume a

3228 straightforward hex representation. Other lengths fail. */

3229

3230 if (sublen == 28)

3231 {

3232 uschar *coded = b64encode(CUS digest, 20);

3233 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"

3234 " subject=%s\n crypted=%s\n", coded, sub[1]+6);

3235 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);

3236 }

3237 else if (sublen == 40)

3238 {

3239 uschar coded[44];

3240 for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);

3241 coded[40] = 0;

3242 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"

3243 " subject=%s\n crypted=%s\n", coded, sub[1]+6);

3244 tempcond = (strcmpic(coded, sub[1]+6) == 0);

3245 }

3246 else

3247 {

3248 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "

3249 "fail\n crypted=%s\n", sub[1]+6);

3250 tempcond = FALSE;

3251 }

3252 }

3253

3254 else /* {crypt} or {crypt16} and non-{ at start */

3255 /* }-for-text-editors */

3256 {

3257 int which = 0;

3258 uschar *coded;

3259

3260 if (strncmpic(sub[1], US"{crypt}", 7) == 0)

3261 {

3262 sub[1] += 7;

3263 which = 1;

3264 }

3265 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)

3266 {

3267 sub[1] += 9;

3268 which = 2;

3269 }

3270 else if (sub[1][0] == '{') /* }-for-text-editors */

3271 {

3272 expand_string_message = string_sprintf("unknown encryption mechanism "

3273 "in \"%s\"", sub[1]);

3274 goto failout;

3275 }

3276

3277 switch(which)

3278 {

3279 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;

3280 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;

3281 default: coded = US crypt16(CS sub[0], CS sub[1]); break;

3282 }

3283

3284 #define STR(s) # s

3285 #define XSTR(s) STR(s)

3286 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"

3287 " subject=%s\n crypted=%s\n",

3288 which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",

3289 coded, sub[1]);

3290 #undef STR

3291 #undef XSTR

3292

3293 /* If the encrypted string contains fewer than two characters (for the

3294 salt), force failure. Otherwise we get false positives: with an empty

3295 string the yield of crypt() is an empty string! */

3296

3297 if (coded)

3298 tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;

3299 else if (errno == EINVAL)

3300 tempcond = FALSE;

3301 else

3302 {

3303 expand_string_message = string_sprintf("crypt error: %s\n",

3304 US strerror(errno));

3305 goto failout;

3306 }

3307 }

3308 break;

3309 #endif /* SUPPORT_CRYPTEQ */

3310

3311 case ECOND_INLIST:

3312 case ECOND_INLISTI:

3313 {

3314 const uschar * list = sub[1];

3315 int sep;

3316 uschar *save_iterate_item = iterate_item;

3317 int (*compare)(const uschar *, const uschar *);

3318

3319 DEBUG(D_expand) debug_printf_indent("condition: %s item: %s\n", opname, sub[0]);

3320

3321 /* grab any listsep spec, then expand the list */

3322

3323 sep = matchlist_parse_sep(&list);

3324 if (!(list = expand_cstring(list)))

3325 goto failout;

3326

3327 tempcond = FALSE;

3328 compare = cond_type == ECOND_INLISTI

3329 ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;

3330

3331 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))

3332 {

3333 DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);

3334 if (compare(sub[0], iterate_item) == 0)

3335 {

3336 tempcond = TRUE;

3337 lookup_value = iterate_item;

3338 break;

3339 }

3340 }

3341 iterate_item = save_iterate_item;

3342 }

3343

3344 } /* Switch for comparison conditions */

3345

3346 *yield = tempcond == testfor;

3347 next = s; goto out; /* End of comparison conditions */

3348

3349

3350 /* and/or: computes logical and/or of several conditions */

3351

3352 case ECOND_AND:

3353 case ECOND_OR:

3354 subcondptr = (yield == NULL) ? NULL : &tempcond;

3355 combined_cond = (cond_type == ECOND_AND);

3356

3357 Uskip_whitespace(&s);

3358 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */

3359

3360 for (;;)

3361 {

3362 /* {-for-text-editors */

3363 if (Uskip_whitespace(&s) == '}') break;

3364 if (*s != '{') /* }-for-text-editors */

3365 {

3366 expand_string_message = string_sprintf("each subcondition "

3367 "inside an \"%s{...}\" condition must be in its own {}", opname);

3368 goto failout;

3369 }

3370

3371 if (!(s = eval_condition(s+1, resetok, subcondptr)))

3372 {

3373 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",

3374 expand_string_message, opname);

3375 goto failout;

3376 }

3377 Uskip_whitespace(&s);

3378

3379 /* {-for-text-editors */

3380 if (*s++ != '}')

3381 {

3382 /* {-for-text-editors */

3383 expand_string_message = string_sprintf("missing } at end of condition "

3384 "inside \"%s\" group", opname);

3385 goto failout;

3386 }

3387

3388 if (yield)

3389 if (cond_type == ECOND_AND)

3390 {

3391 combined_cond &= tempcond;

3392 if (!combined_cond) subcondptr = NULL; /* once false, don't */

3393 } /* evaluate any more */

3394 else

3395 {

3396 combined_cond |= tempcond;

3397 if (combined_cond) subcondptr = NULL; /* once true, don't */

3398 } /* evaluate any more */

3399 }

3400

3401 if (yield) *yield = (combined_cond == testfor);

3402 next = ++s; goto out;

3403

3404

3405 /* forall/forany: iterates a condition with different values */

3406

3407 case ECOND_FORALL: is_forany = FALSE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;

3408 case ECOND_FORANY: is_forany = TRUE; is_json = FALSE; is_jsons = FALSE; goto FORMANY;

3409 case ECOND_FORALL_JSON: is_forany = FALSE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;

3410 case ECOND_FORANY_JSON: is_forany = TRUE; is_json = TRUE; is_jsons = FALSE; goto FORMANY;

3411 case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;

3412 case ECOND_FORANY_JSONS: is_forany = TRUE; is_json = TRUE; is_jsons = TRUE; goto FORMANY;

3413

3414 FORMANY:

3415 {

3416 const uschar * list;

3417 int sep;

3418 uschar *save_iterate_item = iterate_item;

3419

3420 DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);

3421

3422 /* First expand the list, apart from a leading change-of-separator

3423 on non-json lists */

3424

3425 Uskip_whitespace(&s);

3426 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */

3427

3428 sep = is_json ? 0 : matchlist_parse_sep(&s);

3429

3430 if (!(sub[0] = expand_string_internal(s,

3431 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),

3432 &s, resetok, NULL)))

3433 goto failout;

3434 /* {-for-text-editors */

3435 if (*s++ != '}') goto COND_FAILED_CURLY_END;

3436

3437 Uskip_whitespace(&s);

3438 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */

3439

3440 sub[1] = s;

3441

3442 /* Call eval_condition once, with result discarded (as if scanning a

3443 "false" part). This allows us to find the end of the condition, because if

3444 the list is empty, we won't actually evaluate the condition for real. */

3445

3446 if (!(s = eval_condition(sub[1], resetok, NULL)))

3447 {

3448 expand_string_message = string_sprintf("%s inside \"%s\" condition",

3449 expand_string_message, opname);

3450 goto failout;

3451 }

3452 Uskip_whitespace(&s);

3453

3454 /* {-for-text-editors */

3455 if (*s++ != '}')

3456 {

3457 /* {-for-text-editors */

3458 expand_string_message = string_sprintf("missing } at end of condition "

3459 "inside \"%s\"", opname);

3460 goto failout;

3461 }

3462

3463 /* Now scan the list, checking the condition for each item */

3464

3465 if (yield) *yield = !testfor;

3466 list = sub[0];

3467 if (is_json) list = dewrap(string_copy(list), US"[]");

3468 while ((iterate_item = is_json

3469 ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))

3470 {

3471 if (is_jsons)

3472 if (!(iterate_item = dewrap(iterate_item, US"\"\"")))

3473 {

3474 expand_string_message =

3475 string_sprintf("%s wrapping string result for extract jsons",

3476 expand_string_message);

3477 iterate_item = save_iterate_item;

3478 goto failout;

3479 }

3480

3481 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);

3482 if (!eval_condition(sub[1], resetok, &tempcond))

3483 {

3484 expand_string_message = string_sprintf("%s inside \"%s\" condition",

3485 expand_string_message, opname);

3486 iterate_item = save_iterate_item;

3487 goto failout;

3488 }

3489 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,

3490 tempcond? "true":"false");

3491

3492 if (yield) *yield = (tempcond == testfor);

3493 if (tempcond == is_forany) break;

3494 }

3495

3496 iterate_item = save_iterate_item;

3497 next = s; goto out;

3498 }

3499

3500

3501 /* The bool{} expansion condition maps a string to boolean.

3502 The values supported should match those supported by the ACL condition

3503 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas

3504 of true/false. Note that Router "condition" rules have a different

3505 interpretation, where general data can be used and only a few values

3506 map to FALSE.

3507 Note that readconf.c boolean matching, for boolean configuration options,

3508 only matches true/yes/false/no.

3509 The bool_lax{} condition matches the Router logic, which is much more

3510 liberal. */

3511 case ECOND_BOOL:

3512 case ECOND_BOOL_LAX:

3513 {

3514 uschar *sub_arg[1];

3515 uschar *t, *t2;

3516 uschar *ourname;

3517 size_t len;

3518 BOOL boolvalue = FALSE;

3519

3520 if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */

3521 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";

3522 switch(read_subs(sub_arg, 1, 1, &s,

3523 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))

3524 {

3525 case 1: expand_string_message = string_sprintf(

3526 "too few arguments or bracketing error for %s",

3527 ourname);

3528 /*FALLTHROUGH*/

3529 case 2:

3530 case 3: goto failout;

3531 }

3532 t = sub_arg[0];

3533 Uskip_whitespace(&t);

3534 if ((len = Ustrlen(t)))

3535 {

3536 /* trailing whitespace: seems like a good idea to ignore it too */

3537 t2 = t + len - 1;

3538 while (isspace(*t2)) t2--;

3539 if (t2 != (t + len))

3540 {

3541 *++t2 = '\0';

3542 len = t2 - t;

3543 }

3544 }

3545 DEBUG(D_expand)

3546 debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");

3547 /* logic for the lax case from expand_check_condition(), which also does

3548 expands, and the logic is both short and stable enough that there should

3549 be no maintenance burden from replicating it. */

3550 if (len == 0)

3551 boolvalue = FALSE;

3552 else if (*t == '-'

3553 ? Ustrspn(t+1, "0123456789") == len-1

3554 : Ustrspn(t, "0123456789") == len)

3555 {

3556 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;

3557 /* expand_check_condition only does a literal string "0" check */

3558 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))

3559 boolvalue = TRUE;

3560 }

3561 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)

3562 boolvalue = TRUE;

3563 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)

3564 boolvalue = FALSE;

3565 else if (cond_type == ECOND_BOOL_LAX)

3566 boolvalue = TRUE;

3567 else

3568 {

3569 expand_string_message = string_sprintf("unrecognised boolean "

3570 "value \"%s\"", t);

3571 goto failout;

3572 }

3573 DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,

3574 boolvalue? "true":"false");

3575 if (yield) *yield = (boolvalue == testfor);

3576 next = s; goto out;

3577 }

3578

3579 #ifdef SUPPORT_SRS

3580 case ECOND_INBOUND_SRS:

3581 /* ${if inbound_srs {local_part}{secret} {yes}{no}} */

3582 {

3583 uschar * sub[2];

3584 const pcre2_code * re;

3585 pcre2_match_data * md;

3586 PCRE2_SIZE * ovec;

3587 int quoting = 0;

3588 uschar cksum[4];

3589 BOOL boolvalue = FALSE;

3590

3591 switch(read_subs(sub, 2, 2, CUSS &s,

3592 yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))

3593 {

3594 case 1: expand_string_message = US"too few arguments or bracketing "

3595 "error for inbound_srs";

3596 case 2:

3597 case 3: goto failout;

3598 }

3599

3600 /* Match the given local_part against the SRS-encoded pattern */

3601

3602 re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]{2})=([^=]*)=(.*)$",

3603 MCS_CASELESS | MCS_CACHEABLE, FALSE);

3604 md = pcre2_match_data_create(4+1, pcre_gen_ctx);

3605 if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,

3606 md, pcre_gen_mtc_ctx) < 0)

3607 {

3608 DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");

3609 goto srs_result;

3610 }

3611 ovec = pcre2_get_ovector_pointer(md);

3612

3613 if (sub[0][0] == '"')

3614 quoting = 1;

3615 else for (uschar * s = sub[0]; *s; s++)

3616 if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)

3617 { quoting = 1; break; }

3618 if (quoting)

3619 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");

3620

3621 /* Record the (quoted, if needed) decoded recipient as $srs_recipient */

3622

3623 srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S", /* lowercased */

3624 quoting, "\"",

3625 (int) (ovec[9]-ovec[8]), sub[0] + ovec[8], /* substr 4 */

3626 quoting, "\"",

3627 (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */

3628

3629 /* If a zero-length secret was given, we're done. Otherwise carry on

3630 and validate the given SRS local_part againt our secret. */

3631

3632 if (*sub[1])

3633 {

3634 /* check the timestamp */

3635 {

3636 struct timeval now;

3637 uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */

3638 long d;

3639 int n;

3640

3641 gettimeofday(&now, NULL);

3642 now.tv_sec /= 86400; /* days since epoch */

3643

3644 /* Decode substring 2 from base32 to a number */

3645

3646 for (d = 0, n = ovec[5]-ovec[4]; n; n--)

3647 {

3648 uschar * t = Ustrchr(base32_chars, *ss++);

3649 d = d * 32 + (t - base32_chars);

3650 }

3651

3652 if (((now.tv_sec - d) & 0x3ff) > 10) /* days since SRS generated */

3653 {

3654 DEBUG(D_expand) debug_printf("SRS too old\n");

3655 goto srs_result;

3656 }

3657 }

3658

3659 /* check length of substring 1, the offered checksum */

3660

3661 if (ovec[3]-ovec[2] != 4)

3662 {

3663 DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");

3664 goto srs_result;

3665 }

3666

3667 /* Hash the address with our secret, and compare that computed checksum

3668 with the one extracted from the arg */

3669

3670 hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));

3671 if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)

3672 {

3673 DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");

3674 goto srs_result;

3675 }

3676 }

3677 boolvalue = TRUE;

3678

3679 srs_result:

3680 /* pcre2_match_data_free(md); gen ctx needs no free */

3681 if (yield) *yield = (boolvalue == testfor);

3682 next = s; goto out;

3683 }

3684 #endif /*SUPPORT_SRS*/

3685

3686 /* Unknown condition */

3687

3688 default:

3689 if (!expand_string_message || !*expand_string_message)

3690 expand_string_message = string_sprintf("unknown condition \"%s\"", opname);

3691 goto failout;

3692 } /* End switch on condition type */

3693

3694 /* Missing braces at start and end of data */

3695

3696 COND_FAILED_CURLY_START:

3697 expand_string_message = string_sprintf("missing { after \"%s\"", opname);

3698 goto failout;

3699

3700 COND_FAILED_CURLY_END:

3701 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",

3702 opname);

3703 goto failout;

3704

3705 /* A condition requires code that is not compiled */

3706

3707 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \

3708 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \

3709 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)

3710 COND_FAILED_NOT_COMPILED:

3711 expand_string_message = string_sprintf("support for \"%s\" not compiled",

3712 opname);

3713 goto failout;

3714 #endif

3715

3716 failout:

3717 next = NULL;

3718 out:

3719 expand_level--;

3720 return next;

3721 }

3726 /*************************************************

3727 * Save numerical variables *

3728 *************************************************/

3729

3730 /* This function is called from items such as "if" that want to preserve and

3731 restore the numbered variables.

3732

3733 Arguments:

3734 save_expand_string points to an array of pointers to set

3735 save_expand_nlength points to an array of ints for the lengths

3736

3737 Returns: the value of expand max to save

3738 */

3739

3740 static int

3741 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)

3742 {

3743 for (int i = 0; i <= expand_nmax; i++)

3744 {

3745 save_expand_nstring[i] = expand_nstring[i];

3746 save_expand_nlength[i] = expand_nlength[i];

3747 }

3748 return expand_nmax;

3749 }

3750

3751

3752

3753 /*************************************************

3754 * Restore numerical variables *

3755 *************************************************/

3756

3757 /* This function restored saved values of numerical strings.

3758

3759 Arguments:

3760 save_expand_nmax the number of strings to restore

3761 save_expand_string points to an array of pointers

3762 save_expand_nlength points to an array of ints

3763

3764 Returns: nothing

3765 */

3766

3767 static void

3768 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,

3769 int *save_expand_nlength)

3770 {

3771 expand_nmax = save_expand_nmax;

3772 for (int i = 0; i <= expand_nmax; i++)

3773 {

3774 expand_nstring[i] = save_expand_nstring[i];

3775 expand_nlength[i] = save_expand_nlength[i];

3776 }

3777 }

3783 /*************************************************

3784 * Handle yes/no substrings *

3785 *************************************************/

3786

3787 /* This function is used by ${if}, ${lookup} and ${extract} to handle the

3788 alternative substrings that depend on whether or not the condition was true,

3789 or the lookup or extraction succeeded. The substrings always have to be

3790 expanded, to check their syntax, but "skipping" is set when the result is not

3791 needed - this avoids unnecessary nested lookups.

3792

3793 Arguments:

3794 flags

3795 skipping TRUE if we were skipping when this item was reached

3796 yes TRUE if the first string is to be used, else use the second

3797 save_lookup a value to put back into lookup_value before the 2nd expansion

3798 sptr points to the input string pointer

3799 yieldptr points to the output growable-string pointer

3800 type "lookup", "if", "extract", "run", "env", "listextract" or

3801 "certextract" for error message

3802 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset

3803 the store.

3804

3805 Returns: 0 OK; lookup_value has been reset to save_lookup

3806 1 expansion failed

3807 2 expansion failed because of bracketing error

3808 */

3809

3810 static int

3811 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,

3812 gstring ** yieldptr, uschar *type, BOOL *resetok)

3813 {

3814 int rc = 0;

3815 const uschar *s = *sptr; /* Local value */

3816 uschar *sub1, *sub2;

3817 const uschar * errwhere;

3818

3819 flags &= ESI_SKIPPING; /* Ignore all buf the skipping flag */

3820

3821 /* If there are no following strings, we substitute the contents of $value for

3822 lookups and for extractions in the success case. For the ${if item, the string

3823 "true" is substituted. In the fail case, nothing is substituted for all three

3824 items. */

3825

3826 if (skip_whitespace(&s) == '}')

3827 {

3828 if (type[0] == 'i')

3829 {

3830 if (yes && !(flags & ESI_SKIPPING))

3831 *yieldptr = string_catn(*yieldptr, US"true", 4);

3832 }

3833 else

3834 {

3835 if (yes && lookup_value && !(flags & ESI_SKIPPING))

3836 *yieldptr = string_cat(*yieldptr, lookup_value);

3837 lookup_value = save_lookup;

3838 }

3839 s++;

3840 goto RETURN;

3841 }

3842

3843 /* The first following string must be braced. */

3844

3845 if (*s++ != '{')

3846 {

3847 errwhere = US"'yes' part did not start with '{'"; /*}}*/

3848 goto FAILED_CURLY;

3849 }

3850

3851 /* Expand the first substring. Forced failures are noticed only if we actually

3852 want this string. Set skipping in the call in the fail case (this will always

3853 be the case if we were already skipping). */

3854

3855 sub1 = expand_string_internal(s,

3856 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),

3857 &s, resetok, NULL);

3858 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;

3859 f.expand_string_forcedfail = FALSE;

3860 /*{{*/

3861 if (*s++ != '}')

3862 {

3863 errwhere = US"'yes' part did not end with '}'";

3864 goto FAILED_CURLY;

3865 }

3866

3867 /* If we want the first string, add it to the output */

3868

3869 if (yes)

3870 *yieldptr = string_cat(*yieldptr, sub1);

3871

3872 /* If this is called from a lookup/env or a (cert)extract, we want to restore

3873 $value to what it was at the start of the item, so that it has this value

3874 during the second string expansion. For the call from "if" or "run" to this

3875 function, save_lookup is set to lookup_value, so that this statement does

3876 nothing. */

3877

3878 lookup_value = save_lookup;

3879

3880 /* There now follows either another substring, or "fail", or nothing. This

3881 time, forced failures are noticed only if we want the second string. We must

3882 set skipping in the nested call if we don't want this string, or if we were

3883 already skipping. */

3884

3885 if (skip_whitespace(&s) == '{') /*}*/

3886 {

3887 esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;

3888 if (yes) s_flags |= ESI_SKIPPING;

3889 sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);

3890 if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;

3891 f.expand_string_forcedfail = FALSE; /*{*/

3892 if (*s++ != '}')

3893 {

3894 errwhere = US"'no' part did not start with '{'"; /*}*/

3895 goto FAILED_CURLY;

3896 }

3897

3898 /* If we want the second string, add it to the output */

3899

3900 if (!yes)

3901 *yieldptr = string_cat(*yieldptr, sub2);

3902 }

3903 /*{{*/

3904 /* If there is no second string, but the word "fail" is present when the use of

3905 the second string is wanted, set a flag indicating it was a forced failure

3906 rather than a syntactic error. Swallow the terminating } in case this is nested

3907 inside another lookup or if or extract. */

3908

3909 else if (*s != '}')

3910 {

3911 uschar name[256];

3912 /* deconst cast ok here as source is s anyway */

3913 s = US read_name(name, sizeof(name), s, US"_");

3914 if (Ustrcmp(name, "fail") == 0)

3915 {

3916 if (!yes && !(flags & ESI_SKIPPING))

3917 {

3918 Uskip_whitespace(&s); /*{{*/

3919 if (*s++ != '}')

3920 {

3921 errwhere = US"did not close with '}' after forcedfail";

3922 goto FAILED_CURLY;

3923 }

3924 expand_string_message =

3925 string_sprintf("\"%s\" failed and \"fail\" requested", type);

3926 f.expand_string_forcedfail = TRUE;

3927 goto FAILED;

3928 }

3929 }

3930 else

3931 {

3932 expand_string_message =

3933 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);

3934 goto FAILED;

3935 }

3936 }

3937

3938 /* All we have to do now is to check on the final closing brace. */

3939

3940 skip_whitespace(&s); /*{{*/

3941 if (*s++ != '}')

3942 {

3943 errwhere = US"did not close with '}'";

3944 goto FAILED_CURLY;

3945 }

3946

3947

3948 RETURN:

3949 /* Update the input pointer value before returning */

3950 *sptr = s;

3951 return rc;

3952

3953 FAILED_CURLY:

3954 /* Get here if there is a bracketing failure */

3955 expand_string_message = string_sprintf(

3956 "curly-bracket problem in conditional yes/no parsing: %s\n"

3957 " remaining string is '%s'", errwhere, --s);

3958 rc = 2;

3959 goto RETURN;

3960

3961 FAILED:

3962 /* Get here for other failures */

3963 rc = 1;

3964 goto RETURN;

3965 }

3970 /********************************************************

3971 * prvs: Get last three digits of days since Jan 1, 1970 *

3972 ********************************************************/

3973

3974 /* This is needed to implement the "prvs" BATV reverse

3975 path signing scheme

3976

3977 Argument: integer "days" offset to add or substract to

3978 or from the current number of days.

3979

3980 Returns: pointer to string containing the last three

3981 digits of the number of days since Jan 1, 1970,

3982 modified by the offset argument, NULL if there

3983 was an error in the conversion.

3984

3985 */

3986

3987 static uschar *

3988 prvs_daystamp(int day_offset)

3989 {

3990 uschar * days = store_get(32, GET_UNTAINTED); /* Need at least 24 for cases */

3991 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */

3992 (time(NULL) + day_offset*86400)/86400);

3993 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";

3994 }

3995

3996

3997

3998 /********************************************************

3999 * prvs: perform HMAC-SHA1 computation of prvs bits *

4000 ********************************************************/

4001

4002 /* This is needed to implement the "prvs" BATV reverse

4003 path signing scheme

4004

4005 Arguments:

4006 address RFC2821 Address to use

4007 key The key to use (must be less than 64 characters

4008 in size)

4009 key_num Single-digit key number to use. Defaults to

4010 '0' when NULL.

4011

4012 Returns: pointer to string containing the first three

4013 bytes of the final hash in hex format, NULL if

4014 there was an error in the process.

4015 */

4016

4017 static uschar *

4018 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)

4019 {

4020 gstring * hash_source;

4021 uschar * p;

4022 hctx h;

4023 uschar innerhash[20];

4024 uschar finalhash[20];

4025 uschar innerkey[64];

4026 uschar outerkey[64];

4027 uschar *finalhash_hex;

4028

4029 if (!key_num)

4030 key_num = US"0";

4031

4032 if (Ustrlen(key) > 64)

4033 return NULL;

4034

4035 hash_source = string_catn(NULL, key_num, 1);

4036 hash_source = string_catn(hash_source, daystamp, 3);

4037 hash_source = string_cat(hash_source, address);

4038

4039 DEBUG(D_expand)

4040 debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);

4041

4042 memset(innerkey, 0x36, 64);

4043 memset(outerkey, 0x5c, 64);

4044

4045 for (int i = 0; i < Ustrlen(key); i++)

4046 {

4047 innerkey[i] ^= key[i];

4048 outerkey[i] ^= key[i];

4049 }

4050

4051 chash_start(HMAC_SHA1, &h);

4052 chash_mid(HMAC_SHA1, &h, innerkey);

4053 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);

4054

4055 chash_start(HMAC_SHA1, &h);

4056 chash_mid(HMAC_SHA1, &h, outerkey);

4057 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);

4058

4059 /* Hashing is deemed sufficient to de-taint any input data */

4060

4061 p = finalhash_hex = store_get(40, GET_UNTAINTED);

4062 for (int i = 0; i < 3; i++)

4063 {

4064 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];

4065 *p++ = hex_digits[finalhash[i] & 0x0f];

4066 }

4067 *p = '\0';

4068

4069 return finalhash_hex;

4070 }

4075 /*************************************************

4076 * Join a file onto the output string *

4077 *************************************************/

4078

4079 /* This is used for readfile/readsock and after a run expansion.

4080 It joins the contents of a file onto the output string, globally replacing

4081 newlines with a given string (optionally).

4082

4083 Arguments:

4084 f the FILE

4085 yield pointer to the expandable string struct

4086 eol newline replacement string, or NULL

4087

4088 Returns: new pointer for expandable string, terminated if non-null

4089 */

4090

4091 gstring *

4092 cat_file(FILE * f, gstring * yield, uschar * eol)

4093 {

4094 uschar buffer[1024];

4095

4096 while (Ufgets(buffer, sizeof(buffer), f))

4097 {

4098 int len = Ustrlen(buffer);

4099 if (eol && buffer[len-1] == '\n') len--;

4100 yield = string_catn(yield, buffer, len);

4101 if (eol && buffer[len])

4102 yield = string_cat(yield, eol);

4103 }

4104 return yield;

4105 }

4106

4107

4108 #ifndef DISABLE_TLS

4109 gstring *

4110 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)

4111 {

4112 int rc;

4113 uschar buffer[1024];

4114

4115 /*XXX could we read direct into a pre-grown string? */

4116

4117 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)

4118 for (uschar * s = buffer; rc--; s++)

4119 yield = eol && *s == '\n'

4120 ? string_cat(yield, eol) : string_catn(yield, s, 1);

4121

4122 /* We assume that all errors, and any returns of zero bytes,

4123 are actually EOF. */

4124

4125 return yield;

4126 }

4127 #endif

4128

4129

4130 /*************************************************

4131 * Evaluate numeric expression *

4132 *************************************************/

4133

4134 /* This is a set of mutually recursive functions that evaluate an arithmetic

4135 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of

4136 these functions that is called from elsewhere is eval_expr, whose interface is:

4137

4138 Arguments:

4139 sptr pointer to the pointer to the string - gets updated

4140 decimal TRUE if numbers are to be assumed decimal

4141 error pointer to where to put an error message - must be NULL on input

4142 endket TRUE if ')' must terminate - FALSE for external call

4143

4144 Returns: on success: the value of the expression, with *error still NULL

4145 on failure: an undefined value, with *error = a message

4146 */

4147

4148 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);

4149

4150

4151 static int_eximarith_t

4152 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)

4153 {

4154 uschar *s = *sptr;

4155 int_eximarith_t x = eval_op_or(&s, decimal, error);

4156

4157 if (!*error)

4158 if (endket)

4159 if (*s != ')')

4160 *error = US"expecting closing parenthesis";

4161 else

4162 while (isspace(*++s)) ;

4163 else if (*s)

4164 *error = US"expecting operator";

4165 *sptr = s;

4166 return x;

4167 }

4168

4169

4170 static int_eximarith_t

4171 eval_number(uschar **sptr, BOOL decimal, uschar **error)

4172 {

4173 int c;

4174 int_eximarith_t n;

4175 uschar *s = *sptr;

4176

4177 if (isdigit((c = Uskip_whitespace(&s))))

4178 {

4179 int count;

4180 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);

4181 s += count;

4182 switch (tolower(*s))

4183 {

4184 default: break;

4185 case 'k': n *= 1024; s++; break;

4186 case 'm': n *= 1024*1024; s++; break;

4187 case 'g': n *= 1024*1024*1024; s++; break;

4188 }

4189 Uskip_whitespace(&s);

4190 }

4191 else if (c == '(')

4192 {

4193 s++;

4194 n = eval_expr(&s, decimal, error, 1);

4195 }

4196 else

4197 {

4198 *error = US"expecting number or opening parenthesis";

4199 n = 0;

4200 }

4201 *sptr = s;

4202 return n;

4203 }

4204

4205

4206 static int_eximarith_t

4207 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)

4208 {

4209 uschar *s = *sptr;

4210 int_eximarith_t x;

4211 Uskip_whitespace(&s);

4212 if (*s == '+' || *s == '-' || *s == '~')

4213 {

4214 int op = *s++;

4215 x = eval_op_unary(&s, decimal, error);

4216 if (op == '-') x = -x;

4217 else if (op == '~') x = ~x;

4218 }

4219 else

4220 x = eval_number(&s, decimal, error);

4221

4222 *sptr = s;

4223 return x;

4224 }

4225

4226

4227 static int_eximarith_t

4228 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)

4229 {

4230 uschar *s = *sptr;

4231 int_eximarith_t x = eval_op_unary(&s, decimal, error);

4232 if (!*error)

4233 {

4234 while (*s == '*' || *s == '/' || *s == '%')

4235 {

4236 int op = *s++;

4237 int_eximarith_t y = eval_op_unary(&s, decimal, error);

4238 if (*error) break;

4239 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give

4240 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which

4241 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where

4242 * -N*M is INT_MIN will yield INT_MIN.

4243 * Since we don't support floating point, this is somewhat simpler.

4244 * Ideally, we'd return an error, but since we overflow for all other

4245 * arithmetic, consistency suggests otherwise, but what's the correct value

4246 * to use? There is none.

4247 * The C standard guarantees overflow for unsigned arithmetic but signed

4248 * overflow invokes undefined behaviour; in practice, this is overflow

4249 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee

4250 * that long/longlong larger than int are available, or we could just work

4251 * with larger types. We should consider whether to guarantee 32bit eval

4252 * and 64-bit working variables, with errors returned. For now ...

4253 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we

4254 * can just let the other invalid results occur otherwise, as they have

4255 * until now. For this one case, we can coerce.

4256 */

4257 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')

4258 {

4259 DEBUG(D_expand)

4260 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",

4261 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);

4262 x = EXIM_ARITH_MAX;

4263 continue;

4264 }

4265 if (op == '*')

4266 x *= y;

4267 else

4268 {

4269 if (y == 0)

4270 {

4271 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";

4272 x = 0;

4273 break;

4274 }

4275 if (op == '/')

4276 x /= y;

4277 else

4278 x %= y;

4279 }

4280 }

4281 }

4282 *sptr = s;

4283 return x;

4284 }

4285

4286

4287 static int_eximarith_t

4288 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)

4289 {

4290 uschar *s = *sptr;

4291 int_eximarith_t x = eval_op_mult(&s, decimal, error);

4292 if (!*error)

4293 {

4294 while (*s == '+' || *s == '-')

4295 {

4296 int op = *s++;

4297 int_eximarith_t y = eval_op_mult(&s, decimal, error);

4298 if (*error) break;

4299 if ( (x >= EXIM_ARITH_MAX/2 && x >= EXIM_ARITH_MAX/2)

4300 || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))

4301 { /* over-conservative check */

4302 *error = op == '+'

4303 ? US"overflow in sum" : US"overflow in difference";

4304 break;

4305 }

4306 if (op == '+') x += y; else x -= y;

4307 }

4308 }

4309 *sptr = s;

4310 return x;

4311 }

4312

4313

4314 static int_eximarith_t

4315 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)

4316 {

4317 uschar *s = *sptr;

4318 int_eximarith_t x = eval_op_sum(&s, decimal, error);

4319 if (!*error)

4320 {

4321 while ((*s == '<' || *s == '>') && s[1] == s[0])

4322 {

4323 int_eximarith_t y;

4324 int op = *s++;

4325 s++;

4326 y = eval_op_sum(&s, decimal, error);

4327 if (*error) break;

4328 if (op == '<') x <<= y; else x >>= y;

4329 }

4330 }

4331 *sptr = s;

4332 return x;

4333 }

4334

4335

4336 static int_eximarith_t

4337 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)

4338 {

4339 uschar *s = *sptr;

4340 int_eximarith_t x = eval_op_shift(&s, decimal, error);

4341 if (!*error)

4342 {

4343 while (*s == '&')

4344 {

4345 int_eximarith_t y;

4346 s++;

4347 y = eval_op_shift(&s, decimal, error);

4348 if (*error) break;

4349 x &= y;

4350 }

4351 }

4352 *sptr = s;

4353 return x;

4354 }

4355

4356

4357 static int_eximarith_t

4358 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)

4359 {

4360 uschar *s = *sptr;

4361 int_eximarith_t x = eval_op_and(&s, decimal, error);

4362 if (!*error)

4363 {

4364 while (*s == '^')

4365 {

4366 int_eximarith_t y;

4367 s++;

4368 y = eval_op_and(&s, decimal, error);

4369 if (*error) break;

4370 x ^= y;

4371 }

4372 }

4373 *sptr = s;

4374 return x;

4375 }

4376

4377

4378 static int_eximarith_t

4379 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)

4380 {

4381 uschar *s = *sptr;

4382 int_eximarith_t x = eval_op_xor(&s, decimal, error);

4383 if (!*error)

4384 {

4385 while (*s == '|')

4386 {

4387 int_eximarith_t y;

4388 s++;

4389 y = eval_op_xor(&s, decimal, error);

4390 if (*error) break;

4391 x |= y;

4392 }

4393 }

4394 *sptr = s;

4395 return x;

4396 }

4397

4398

4399

4400 /************************************************/

4401 /* Comparison operation for sort expansion. We need to avoid

4402 re-expanding the fields being compared, so need a custom routine.

4403

4404 Arguments:

4405 cond_type Comparison operator code

4406 leftarg, rightarg Arguments for comparison

4407

4408 Return true iff (leftarg compare rightarg)

4409 */

4410

4411 static BOOL

4412 sortsbefore(int cond_type, BOOL alpha_cond,

4413 const uschar * leftarg, const uschar * rightarg)

4414 {

4415 int_eximarith_t l_num, r_num;

4416

4417 if (!alpha_cond)

4418 {

4419 l_num = expanded_string_integer(leftarg, FALSE);

4420 if (expand_string_message) return FALSE;

4421 r_num = expanded_string_integer(rightarg, FALSE);

4422 if (expand_string_message) return FALSE;

4423

4424 switch (cond_type)

4425 {

4426 case ECOND_NUM_G: return l_num > r_num;

4427 case ECOND_NUM_GE: return l_num >= r_num;

4428 case ECOND_NUM_L: return l_num < r_num;

4429 case ECOND_NUM_LE: return l_num <= r_num;

4430 default: break;

4431 }

4432 }

4433 else

4434 switch (cond_type)

4435 {

4436 case ECOND_STR_LT: return Ustrcmp (leftarg, rightarg) < 0;

4437 case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) < 0;

4438 case ECOND_STR_LE: return Ustrcmp (leftarg, rightarg) <= 0;

4439 case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;

4440 case ECOND_STR_GT: return Ustrcmp (leftarg, rightarg) > 0;

4441 case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) > 0;

4442 case ECOND_STR_GE: return Ustrcmp (leftarg, rightarg) >= 0;

4443 case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;

4444 default: break;

4445 }

4446 return FALSE; /* should not happen */

4447 }

4448

4449

4450 /* Expand a named list. Return false on failure. */

4451 static gstring *

4452 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)

4453 {

4454 tree_node *t = NULL;

4455 const uschar * list;

4456 int sep = 0;

4457 uschar * item;

4458 BOOL needsep = FALSE;

4459 #define LISTNAMED_BUF_SIZE 256

4460 uschar b[LISTNAMED_BUF_SIZE];

4461 uschar * buffer = b;

4462

4463 if (*name == '+') name++;

4464 if (!listtype) /* no-argument version */

4465 {

4466 if ( !(t = tree_search(addresslist_anchor, name))

4467 && !(t = tree_search(domainlist_anchor, name))

4468 && !(t = tree_search(hostlist_anchor, name)))

4469 t = tree_search(localpartlist_anchor, name);

4470 }

4471 else switch(*listtype) /* specific list-type version */

4472 {

4473 case 'a': t = tree_search(addresslist_anchor, name); break;

4474 case 'd': t = tree_search(domainlist_anchor, name); break;

4475 case 'h': t = tree_search(hostlist_anchor, name); break;

4476 case 'l': t = tree_search(localpartlist_anchor, name); break;

4477 default:

4478 expand_string_message = US"bad suffix on \"list\" operator";

4479 return yield;

4480 }

4481

4482 if(!t)

4483 {

4484 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",

4485 name, !listtype?""

4486 : *listtype=='a'?"address "

4487 : *listtype=='d'?"domain "

4488 : *listtype=='h'?"host "

4489 : *listtype=='l'?"localpart "

4490 : 0);

4491 return yield;

4492 }

4493

4494 list = ((namedlist_block *)(t->data.ptr))->string;

4495

4496 /* The list could be quite long so we (re)use a buffer for each element

4497 rather than getting each in new memory */

4498

4499 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);

4500 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))

4501 {

4502 uschar * buf = US" : ";

4503 if (needsep)

4504 yield = string_catn(yield, buf, 3);

4505 else

4506 needsep = TRUE;

4507

4508 if (*item == '+') /* list item is itself a named list */

4509 {

4510 yield = expand_listnamed(yield, item, listtype);

4511 if (expand_string_message)

4512 return yield;

4513 }

4514

4515 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */

4516 {

4517 char tok[3];

4518 tok[0] = sep; tok[1] = ':'; tok[2] = 0;

4519

4520 for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)

4521 {

4522 yield = string_catn(yield, item, cp - CS item);

4523 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */

4524 yield = string_catn(yield, US"::", 2);

4525 else /* sep in item; should already be doubled; emit once */

4526 {

4527 yield = string_catn(yield, US tok, 1);

4528 if (*cp == sep) cp++;

4529 }

4530 }

4531 yield = string_cat(yield, item);

4532 }

4533 else

4534 yield = string_cat(yield, item);

4535 }

4536 return yield;

4537 }

4538

4539

4540

4541 /************************************************/

4542 static void

4543 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,

4544 esi_flags flags)

4545 {

4546 debug_printf_indent("%V", "K");

4547

4548 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)

4549 debug_printf("%V", "-");

4550

4551 debug_printf("%s: %.*W\n", what, nchar, value);

4552 if (nchar > 0 && is_tainted(value))

4553 debug_printf_indent("%V %V(tainted)\n",

4554 flags & ESI_SKIPPING ? "|" : " ", "\\__");

4555 }

4556

4557

4558 /*************************************************

4559 * Expand string *

4560 *************************************************/

4561

4562 /* Returns either an unchanged string, or the expanded string in stacking pool

4563 store. Interpreted sequences are:

4564

4565 \... normal escaping rules

4566 $name substitutes the variable

4567 ${name} ditto

4568 ${op:string} operates on the expanded string value

4569 ${item{arg1}{arg2}...} expands the args and then does the business

4570 some literal args are not enclosed in {}

4571

4572 There are now far too many operators and item types to make it worth listing

4573 them here in detail any more.

4574

4575 We use an internal routine recursively to handle embedded substrings. The

4576 external function follows. The yield is NULL if the expansion failed, and there

4577 are two cases: if something collapsed syntactically, or if "fail" was given

4578 as the action on a lookup failure. These can be distinguished by looking at the

4579 variable expand_string_forcedfail, which is TRUE in the latter case.

4580

4581 The skipping flag is set true when expanding a substring that isn't actually

4582 going to be used (after "if" or "lookup") and it prevents lookups from

4583 happening lower down.

4584

4585 Store usage: At start, a store block of the length of the input plus 64

4586 is obtained. This is expanded as necessary by string_cat(), which might have to

4587 get a new block, or might be able to expand the original. At the end of the

4588 function we can release any store above that portion of the yield block that

4589 was actually used. In many cases this will be optimal.

4590

4591 However: if the first item in the expansion is a variable name or header name,

4592 we reset the store before processing it; if the result is in fresh store, we

4593 use that without copying. This is helpful for expanding strings like

4594 $message_headers which can get very long.

4595

4596 There's a problem if a ${dlfunc item has side-effects that cause allocation,

4597 since resetting the store at the end of the expansion will free store that was

4598 allocated by the plugin code as well as the slop after the expanded string. So

4599 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }

4600 and, given the acl condition, ${if }. This is an unfortunate consequence of

4601 string expansion becoming too powerful.

4602

4603 Arguments:

4604 string the string to be expanded

4605 flags

4606 brace_ends expansion is to stop at }

4607 honour_dollar TRUE if $ is to be expanded,

4608 FALSE if it's just another character

4609 skipping TRUE for recursive calls when the value isn't actually going

4610 to be used (to allow for optimisation)

4611 left if not NULL, a pointer to the first character after the

4612 expansion is placed here (typically used with brace_ends)

4613 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset

4614 the store.

4615 textonly_p if not NULL, pointer to flag - write bool for only-met-text

4616

4617 Returns: NULL if expansion fails:

4618 expand_string_forcedfail is set TRUE if failure was forced

4619 expand_string_message contains a textual error message

4620 a pointer to the expanded string on success

4621 */

4622

4623 static uschar *

4624 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,

4625 BOOL *resetok_p, BOOL * textonly_p)

4626 {

4627 rmark reset_point = store_mark();

4628 gstring * yield = string_get(Ustrlen(string) + 64);

4629 int item_type;

4630 const uschar * s = string;

4631 const uschar * save_expand_nstring[EXPAND_MAXN+1];

4632 int save_expand_nlength[EXPAND_MAXN+1];

4633 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;

4634

4635 expand_level++;

4636 f.expand_string_forcedfail = FALSE;

4637 expand_string_message = US"";

4638

4639 if (is_tainted(string))

4640 {

4641 expand_string_message =

4642 string_sprintf("attempt to expand tainted string '%s'", s);

4643 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);

4644 goto EXPAND_FAILED;

4645 }

4646

4647 while (*s)

4648 {

4649 uschar name[256];

4650

4651 DEBUG(D_expand)

4652 {

4653 debug_printf_indent("%V%V%s: %W\n",

4654 first ? "/" : "K",

4655 flags & ESI_SKIPPING ? "---" : "",

4656 flags & ESI_SKIPPING ? "scanning" : "considering", s);

4657 first = FALSE;

4658 }

4659

4660 /* \ escapes the next character, which must exist, or else

4661 the expansion fails. There's a special escape, \N, which causes

4662 copying of the subject verbatim up to the next \N. Otherwise,

4663 the escapes are the standard set. */

4664

4665 if (*s == '\\')

4666 {

4667 if (s[1] == 0)

4668 {

4669 expand_string_message = US"\\ at end of string";

4670 goto EXPAND_FAILED;

4671 }

4672

4673 if (s[1] == 'N')

4674 {

4675 const uschar * t = s + 2;

4676 for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;

4677

4678 DEBUG(D_expand)

4679 debug_expansion_interim(US"protected", t, (int)(s - t), flags);

4680 if (!(flags & ESI_SKIPPING))

4681 yield = string_catn(yield, t, s - t);

4682 if (*s) s += 2;

4683 }

4684 else

4685 {

4686 uschar ch[1];

4687 DEBUG(D_expand)

4688 debug_printf_indent("%Vbackslashed: '\\%c'\n", "K", s[1]);

4689 ch[0] = string_interpret_escape(&s);

4690 if (!(flags & ESI_SKIPPING))

4691 yield = string_catn(yield, ch, 1);

4692 s++;

4693 }

4694 continue;

4695 }

4696

4697 /*{{*/

4698 /* Anything other than $ is just copied verbatim, unless we are

4699 looking for a terminating } character. */

4700

4701 if (flags & ESI_BRACE_ENDS && *s == '}') break;

4702

4703 if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))

4704 {

4705 int i = 1; /*{*/

4706 for (const uschar * t = s+1;

4707 *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;

4708

4709 DEBUG(D_expand) debug_expansion_interim(US"text", s, i, flags);

4710

4711 if (!(flags & ESI_SKIPPING))

4712 yield = string_catn(yield, s, i);

4713 s += i;

4714 continue;

4715 }

4716 textonly = FALSE;

4717

4718 /* No { after the $ - must be a plain name or a number for string

4719 match variable. There has to be a fudge for variables that are the

4720 names of header fields preceded by "$header_" because header field

4721 names can contain any printing characters except space and colon.

4722 For those that don't like typing this much, "$h_" is a synonym for

4723 "$header_". A non-existent header yields a NULL value; nothing is

4724 inserted. */ /*}*/

4725

4726 if (isalpha(*++s))

4727 {

4728 const uschar * value;

4729 int newsize = 0, len;

4730 gstring * g = NULL;

4731 uschar * t;

4732

4733 s = read_name(name, sizeof(name), s, US"_");

4734

4735 /* If this is the first thing to be expanded, release the pre-allocated

4736 buffer. */

4737

4738 if (!(flags & ESI_SKIPPING))

4739 if (!yield)

4740 g = store_get(sizeof(gstring), GET_UNTAINTED);

4741 else if (yield->ptr == 0)

4742 {

4743 if (resetok) reset_point = store_reset(reset_point);

4744 yield = NULL;

4745 reset_point = store_mark();

4746 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */

4747 }

4748

4749 /* Header */

4750

4751 if ( ( *(t = name) == 'h'

4752 || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'

4753 )

4754 && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)

4755 )

4756 {

4757 unsigned flags = *name == 'r' ? FH_WANT_RAW

4758 : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST

4759 : 0;

4760 const uschar * charset = *name == 'b' ? NULL : headers_charset;

4761

4762 s = read_header_name(name, sizeof(name), s);

4763 value = find_header(name, &newsize, flags, charset);

4764

4765 /* If we didn't find the header, and the header contains a closing brace

4766 character, this may be a user error where the terminating colon

4767 has been omitted. Set a flag to adjust the error message in this case.

4768 But there is no error here - nothing gets inserted. */

4769

4770 if (!value)

4771 { /*{*/

4772 if (Ustrchr(name, '}')) malformed_header = TRUE;

4773 continue;

4774 }

4775 }

4776

4777 /* Variable */

4778

4779 else if (!(value = find_variable(name, flags, &newsize)))

4780 {

4781 expand_string_message =

4782 string_sprintf("unknown variable name \"%s\"", name);

4783 check_variable_error_message(name);

4784 goto EXPAND_FAILED;

4785 }

4786

4787 /* If the data is known to be in a new buffer, newsize will be set to the

4788 size of that buffer. If this is the first thing in an expansion string,

4789 yield will be NULL; just point it at the new store instead of copying. Many

4790 expansion strings contain just one reference, so this is a useful

4791 optimization, especially for humungous headers. We need to use a gstring

4792 structure that is not allocated after that new-buffer, else a later store

4793 reset in the middle of the buffer will make it inaccessible. */

4794

4795 len = Ustrlen(value);

4796 DEBUG(D_expand) debug_expansion_interim(US"value", value, len, flags);

4797 if (!(flags & ESI_SKIPPING))

4798 if (!yield && newsize != 0)

4799 {

4800 yield = g;

4801 yield->size = newsize;

4802 yield->ptr = len;

4803 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */

4804 }

4805 else

4806 yield = string_catn(yield, value, len);

4807

4808 continue;

4809 }

4810

4811 if (isdigit(*s)) /* A $<n> variable */

4812 {

4813 int n;

4814 s = read_cnumber(&n, s);

4815 if (n >= 0 && n <= expand_nmax)

4816 {

4817 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);

4818 if (!(flags & ESI_SKIPPING))

4819 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);

4820 }

4821 continue;

4822 }

4823

4824 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/

4825

4826 if (*s != '{') /*}*/

4827 {

4828 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/

4829 goto EXPAND_FAILED;

4830 }

4831

4832 /* After { there can be various things, but they all start with

4833 an initial word, except for a number for a string match variable. */ /*}*/

4834

4835 if (isdigit(*++s))

4836 {

4837 int n;

4838 s = read_cnumber(&n, s); /*{{*/

4839 if (*s++ != '}')

4840 {

4841 expand_string_message = US"} expected after number";

4842 goto EXPAND_FAILED;

4843 }

4844 if (n >= 0 && n <= expand_nmax)

4845 {

4846 DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);

4847 if (!(flags & ESI_SKIPPING))

4848 yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);

4849 }

4850 continue;

4851 }

4852

4853 if (!isalpha(*s))

4854 {

4855 expand_string_message = US"letter or digit expected after ${"; /*}*/

4856 goto EXPAND_FAILED;

4857 }

4858

4859 /* Allow "-" in names to cater for substrings with negative

4860 arguments. Since we are checking for known names after { this is

4861 OK. */ /*}*/

4862

4863 s = read_name(name, sizeof(name), s, US"_-");

4864 item_type = chop_match(name, item_table, nelem(item_table));

4865

4866 /* Switch on item type. All nondefault choices should "continue* when

4867 skipping, but "break" otherwise so we get debug output for the item

4868 expansion. */

4869 {

4870 int expansion_start = gstring_length(yield);

4871 switch(item_type)

4872 {

4873 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.

4874 If the ACL returns accept or reject we return content set by "message ="

4875 There is currently no limit on recursion; this would have us call

4876 acl_check_internal() directly and get a current level from somewhere.

4877 See also the acl expansion condition ECOND_ACL and the traditional

4878 acl modifier ACLC_ACL.

4879 Assume that the function has side-effects on the store that must be preserved.

4880 */

4881

4882 case EITEM_ACL:

4883 /* ${acl {name} {arg1}{arg2}...} */

4884 {

4885 uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */

4886 uschar * user_msg;

4887 int rc;

4888

4889 switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))

4890 {

4891 case -1: continue; /* skipping */

4892 case 1: goto EXPAND_FAILED_CURLY;

4893 case 2:

4894 case 3: goto EXPAND_FAILED;

4895 }

4896

4897 resetok = FALSE;

4898 switch(rc = eval_acl(sub, nelem(sub), &user_msg))

4899 {

4900 case OK:

4901 case FAIL:

4902 DEBUG(D_expand)

4903 debug_printf_indent("acl expansion yield: %s\n", user_msg);

4904 if (user_msg)

4905 yield = string_cat(yield, user_msg);

4906 break;

4907

4908 case DEFER:

4909 f.expand_string_forcedfail = TRUE;

4910 /*FALLTHROUGH*/

4911 default:

4912 expand_string_message = string_sprintf("%s from acl \"%s\"",

4913 rc_names[rc], sub[0]);

4914 goto EXPAND_FAILED;

4915 }

4916 break;

4917 }

4918

4919 case EITEM_AUTHRESULTS:

4920 /* ${authresults {mysystemname}} */

4921 {

4922 uschar * sub_arg[1];

4923

4924 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))

4925 {

4926 case -1: continue; /* If skipping, we don't actually do anything */

4927 case 1: goto EXPAND_FAILED_CURLY;

4928 case 2:

4929 case 3: goto EXPAND_FAILED;

4930 }

4931

4932 yield = string_append(yield, 3,

4933 US"Authentication-Results: ", sub_arg[0], US"; none");

4934 yield->ptr -= 6; /* ignore tha ": none" for now */

4935

4936 yield = authres_local(yield, sub_arg[0]);

4937 yield = authres_iprev(yield);

4938 yield = authres_smtpauth(yield);

4939 yield = misc_mod_authres(yield);

4940 break;

4941 }

4942

4943 /* Handle conditionals - preserve the values of the numerical expansion

4944 variables in case they get changed by a regular expression match in the

4945 condition. If not, they retain their external settings. At the end

4946 of this "if" section, they get restored to their previous values. */

4947

4948 case EITEM_IF:

4949 {

4950 BOOL cond = FALSE;

4951 const uschar *next_s;

4952 int save_expand_nmax =

4953 save_expand_strings(save_expand_nstring, save_expand_nlength);

4954 uschar * save_lookup_value = lookup_value;

4955

4956 Uskip_whitespace(&s);

4957 if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))

4958 goto EXPAND_FAILED; /* message already set */

4959

4960 DEBUG(D_expand)

4961 {

4962 debug_expansion_interim(US"condition", s, (int)(next_s - s), flags);

4963 debug_expansion_interim(US"result",

4964 cond ? US"true" : US"false", cond ? 4 : 5, flags);

4965 }

4966

4967 s = next_s;

4968

4969 /* The handling of "yes" and "no" result strings is now in a separate

4970 function that is also used by ${lookup} and ${extract} and ${run}. */

4971

4972 switch(process_yesno(

4973 flags, /* were previously skipping */

4974 cond, /* success/failure indicator */

4975 lookup_value, /* value to reset for string2 */

4976 &s, /* input pointer */

4977 &yield, /* output pointer */

4978 US"if", /* condition type */

4979 &resetok))

4980 {

4981 case 1: goto EXPAND_FAILED; /* when all is well, the */

4982 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

4983 }

4984

4985 /* Restore external setting of expansion variables for continuation

4986 at this level. */

4987

4988 lookup_value = save_lookup_value;

4989 restore_expand_strings(save_expand_nmax, save_expand_nstring,

4990 save_expand_nlength);

4991 break;

4992 }

4993

4994 #ifdef SUPPORT_I18N

4995 case EITEM_IMAPFOLDER:

4996 { /* ${imapfolder {name}{sep}{specials}} */

4997 uschar *sub_arg[3];

4998 uschar *encoded;

4999

5000 switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))

5001 {

5002 case 1: goto EXPAND_FAILED_CURLY;

5003 case 2:

5004 case 3: goto EXPAND_FAILED;

5005 }

5006

5007 if (!sub_arg[1]) /* One argument */

5008 {

5009 sub_arg[1] = US"/"; /* default separator */

5010 sub_arg[2] = NULL;

5011 }

5012 else if (Ustrlen(sub_arg[1]) != 1)

5013 {

5014 expand_string_message =

5015 string_sprintf(

5016 "IMAP folder separator must be one character, found \"%s\"",

5017 sub_arg[1]);

5018 goto EXPAND_FAILED;

5019 }

5020

5021 if (flags & ESI_SKIPPING) continue;

5022

5023 if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,

5024 sub_arg[1][0], sub_arg[2], &expand_string_message)))

5025 goto EXPAND_FAILED;

5026 yield = string_cat(yield, encoded);

5027 break;

5028 }

5029 #endif

5030

5031 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are

5032 expanding an internal string that isn't actually going to be used. All we

5033 need to do is check the syntax, so don't do a lookup at all. Preserve the

5034 values of the numerical expansion variables in case they get changed by a

5035 partial lookup. If not, they retain their external settings. At the end

5036 of this "lookup" section, they get restored to their previous values. */

5037

5038 case EITEM_LOOKUP:

5039 {

5040 int expand_setup = 0, nameptr = 0;

5041 int partial, affixlen, starflags;

5042 const lookup_info * li;

5043 uschar * key, * filename;

5044 const uschar * affix, * opts;

5045 uschar * save_lookup_value = lookup_value;

5046 int save_expand_nmax =

5047 save_expand_strings(save_expand_nstring, save_expand_nlength);

5048

5049 if (expand_forbid & RDO_LOOKUP)

5050 {

5051 expand_string_message = US"lookup expansions are not permitted";

5052 goto EXPAND_FAILED;

5053 }

5054

5055 /* Get the key we are to look up for single-key+file style lookups.

5056 Otherwise set the key NULL pro-tem. */

5057

5058 if (Uskip_whitespace(&s) == '{') /*}*/

5059 {

5060 key = expand_string_internal(s+1,

5061 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

5062 if (!key) goto EXPAND_FAILED; /*{{*/

5063 if (*s++ != '}')

5064 {

5065 expand_string_message = US"missing '}' after lookup key";

5066 goto EXPAND_FAILED_CURLY;

5067 }

5068 Uskip_whitespace(&s);

5069 }

5070 else key = NULL;

5071

5072 /* Find out the type of database */

5073

5074 if (!isalpha(*s))

5075 {

5076 expand_string_message = US"missing lookup type";

5077 goto EXPAND_FAILED;

5078 }

5079

5080 /* The type is a string that may contain special characters of various

5081 kinds. Allow everything except space or { to appear; the actual content

5082 is checked by search_findtype_partial. */ /*}*/

5083

5084 while (*s && *s != '{' && !isspace(*s)) /*}*/

5085 {

5086 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;

5087 s++;

5088 }

5089 name[nameptr] = '\0';

5090 Uskip_whitespace(&s);

5091

5092 /* Now check for the individual search type and any partial or default

5093 options. Only those types that are actually in the binary are valid. */

5094

5095 if (!(li = search_findtype_partial(name, &partial, &affix, &affixlen,

5096 &starflags, &opts)))

5097 {

5098 expand_string_message = search_error_message;

5099 goto EXPAND_FAILED;

5100 }

5101

5102 /* Check that a key was provided for those lookup types that need it,

5103 and was not supplied for those that use the query style. */

5104

5105 if (!mac_islookup(li, lookup_querystyle|lookup_absfilequery))

5106 {

5107 if (!key)

5108 {

5109 expand_string_message = string_sprintf("missing {key} for single-"

5110 "key \"%s\" lookup", name);

5111 goto EXPAND_FAILED;

5112 }

5113 }

5114 else if (key)

5115 {

5116 expand_string_message = string_sprintf("a single key was given for "

5117 "lookup type \"%s\", which is not a single-key lookup type", name);

5118 goto EXPAND_FAILED;

5119 }

5120

5121 /* Get the next string in brackets and expand it. It is the file name for

5122 single-key+file lookups, and the whole query otherwise. In the case of

5123 queries that also require a file name (e.g. sqlite), the file name comes

5124 first. */

5125

5126 if (*s != '{')

5127 {

5128 expand_string_message = US"missing '{' for lookup file-or-query arg";

5129 goto EXPAND_FAILED_CURLY; /*}}*/

5130 }

5131 if (!(filename = expand_string_internal(s+1,

5132 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))

5133 goto EXPAND_FAILED;

5134 /*{{*/

5135 if (*s++ != '}')

5136 {

5137 expand_string_message = US"missing '}' closing lookup file-or-query arg";

5138 goto EXPAND_FAILED_CURLY;

5139 }

5140 Uskip_whitespace(&s);

5141

5142 /* If this isn't a single-key+file lookup, re-arrange the variables

5143 to be appropriate for the search_ functions. For query-style lookups,

5144 there is just a "key", and no file name. For the special query-style +

5145 file types, the query (i.e. "key") starts with a file name. */

5146

5147 if (!key)

5148 key = search_args(li, name, filename, &filename, opts);

5149

5150 /* If skipping, don't do the next bit - just lookup_value == NULL, as if

5151 the entry was not found. Note that there is no search_close() function.

5152 Files are left open in case of re-use. At suitable places in higher logic,

5153 search_tidyup() is called to tidy all open files. This can save opening

5154 the same file several times. However, files may also get closed when

5155 others are opened, if too many are open at once. The rule is that a

5156 handle should not be used after a second search_open().

5157

5158 Request that a partial search sets up $1 and maybe $2 by passing

5159 expand_setup containing zero. If its value changes, reset expand_nmax,

5160 since new variables will have been set. Note that at the end of this

5161 "lookup" section, the old numeric variables are restored. */

5162

5163 if (flags & ESI_SKIPPING)

5164 lookup_value = NULL;

5165 else

5166 {

5167 void * handle = search_open(filename, li, 0, NULL, NULL);

5168 if (!handle)

5169 {

5170 expand_string_message = search_error_message;

5171 goto EXPAND_FAILED;

5172 }

5173 lookup_value = search_find(handle, filename, key, partial, affix,

5174 affixlen, starflags, &expand_setup, opts);

5175 if (f.search_find_defer)

5176 {

5177 expand_string_message =

5178 string_sprintf("lookup of \"%s\" gave DEFER: %s",

5179 string_printing2(key, SP_TAB), search_error_message);

5180 goto EXPAND_FAILED;

5181 }

5182 if (expand_setup > 0) expand_nmax = expand_setup;

5183 }

5184

5185 /* The handling of "yes" and "no" result strings is now in a separate

5186 function that is also used by ${if} and ${extract}. */

5187

5188 switch(process_yesno(

5189 flags, /* were previously skipping */

5190 lookup_value != NULL, /* success/failure indicator */

5191 save_lookup_value, /* value to reset for string2 */

5192 &s, /* input pointer */

5193 &yield, /* output pointer */

5194 US"lookup", /* condition type */

5195 &resetok))

5196 {

5197 case 1: goto EXPAND_FAILED; /* when all is well, the */

5198 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

5199 }

5200

5201 /* Restore external setting of expansion variables for carrying on

5202 at this level, and continue. */

5203

5204 restore_expand_strings(save_expand_nmax, save_expand_nstring,

5205 save_expand_nlength);

5206

5207 if (flags & ESI_SKIPPING) continue; else break;

5208 }

5209

5210 /* If Perl support is configured, handle calling embedded perl subroutines,

5211 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}

5212 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS

5213 arguments (defined below). */

5214

5215 #define EXIM_PERL_MAX_ARGS 8

5216

5217 case EITEM_PERL:

5218 #ifndef EXIM_PERL

5219 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/

5220 "is not included in this binary";

5221 goto EXPAND_FAILED;

5222

5223 #else /* EXIM_PERL */

5224 {

5225 uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];

5226 gstring * new_yield;

5227 const misc_module_info * mi;

5228 uschar * errstr;

5229

5230 if (expand_forbid & RDO_PERL)

5231 {

5232 expand_string_message = US"Perl calls are not permitted";

5233 goto EXPAND_FAILED;

5234 }

5235

5236 if (!(mi = misc_mod_find(US"perl", &errstr)))

5237 {

5238 expand_string_message =

5239 string_sprintf("failed to locate perl module: %s", errstr);

5240 goto EXPAND_FAILED;

5241 }

5242

5243 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,

5244 name, &resetok, NULL))

5245 {

5246 case -1: continue; /* If skipping, we don't actually do anything */

5247 case 1: goto EXPAND_FAILED_CURLY;

5248 case 2:

5249 case 3: goto EXPAND_FAILED;

5250 }

5251

5252 /* Start the interpreter if necessary */

5253

5254 if (!opt_perl_started)

5255 {

5256 uschar * initerror;

5257 typedef uschar * (*fn_t)(uschar *);

5258

5259 if (!opt_perl_startup)

5260 {

5261 expand_string_message = US"A setting of perl_startup is needed when "

5262 "using the Perl interpreter";

5263 goto EXPAND_FAILED;

5264 }

5265 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");

5266 initerror = (((fn_t *) mi->functions)[PERL_STARTUP]) (opt_perl_startup);

5267 if (initerror)

5268 {

5269 expand_string_message =

5270 string_sprintf("error in perl_startup code: %s\n", initerror);

5271 goto EXPAND_FAILED;

5272 }

5273 opt_perl_started = TRUE;

5274 }

5275

5276 /* Call the function */

5277

5278 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;

5279 {

5280 typedef gstring * (*fn_t)(gstring *, uschar **, uschar *, uschar **);

5281 new_yield = (((fn_t *) mi->functions)[PERL_CAT])

5282 (yield, &expand_string_message,

5283 sub_arg[0], sub_arg + 1);

5284 }

5285

5286 /* NULL yield indicates failure; if the message pointer has been set to

5287 NULL, the yield was undef, indicating a forced failure. Otherwise the

5288 message will indicate some kind of Perl error. */

5289

5290 if (!new_yield)

5291 {

5292 if (!expand_string_message)

5293 {

5294 expand_string_message =

5295 string_sprintf("Perl subroutine \"%s\" returned undef to force "

5296 "failure", sub_arg[0]);

5297 f.expand_string_forcedfail = TRUE;

5298 }

5299 goto EXPAND_FAILED;

5300 }

5301

5302 /* Yield succeeded. Ensure forcedfail is unset, just in case it got

5303 set during a callback from Perl. */

5304

5305 f.expand_string_forcedfail = FALSE;

5306 yield = new_yield;

5307 break;

5308 }

5309 #endif /* EXIM_PERL */

5310

5311 /* Transform email address to "prvs" scheme to use

5312 as BATV-signed return path */

5313

5314 case EITEM_PRVS:

5315 {

5316 uschar * sub_arg[3], * p, * domain;

5317

5318 switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))

5319 {

5320 case -1: continue; /* If skipping, we don't actually do anything */

5321 case 1: goto EXPAND_FAILED_CURLY;

5322 case 2:

5323 case 3: goto EXPAND_FAILED;

5324 }

5325

5326 /* sub_arg[0] is the address */

5327 if ( !(domain = Ustrrchr(sub_arg[0],'@'))

5328 || domain == sub_arg[0] || Ustrlen(domain) == 1)

5329 {

5330 expand_string_message = US"prvs first argument must be a qualified email address";

5331 goto EXPAND_FAILED;

5332 }

5333

5334 /* Calculate the hash. The third argument must be a single-digit

5335 key number, or unset. */

5336

5337 if ( sub_arg[2]

5338 && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))

5339 {

5340 expand_string_message = US"prvs third argument must be a single digit";

5341 goto EXPAND_FAILED;

5342 }

5343

5344 p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));

5345 if (!p)

5346 {

5347 expand_string_message = US"prvs hmac-sha1 conversion failed";

5348 goto EXPAND_FAILED;

5349 }

5350

5351 /* Now separate the domain from the local part */

5352 *domain++ = '\0';

5353

5354 yield = string_catn(yield, US"prvs=", 5);

5355 yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);

5356 yield = string_catn(yield, prvs_daystamp(7), 3);

5357 yield = string_catn(yield, p, 6);

5358 yield = string_catn(yield, US"=", 1);

5359 yield = string_cat (yield, sub_arg[0]);

5360 yield = string_catn(yield, US"@", 1);

5361 yield = string_cat (yield, domain);

5362

5363 break;

5364 }

5365

5366 /* Check a prvs-encoded address for validity */

5367

5368 case EITEM_PRVSCHECK:

5369 {

5370 uschar * sub_arg[3], * p;

5371 gstring * g;

5372 const pcre2_code * re;

5373

5374 /* Reset expansion variables */

5375 prvscheck_result = NULL;

5376 prvscheck_address = NULL;

5377 prvscheck_keynum = NULL;

5378

5379 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))

5380 {

5381 case 1: goto EXPAND_FAILED_CURLY;

5382 case 2:

5383 case 3: goto EXPAND_FAILED;

5384 }

5385

5386 re = regex_must_compile(

5387 US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",

5388 MCS_CASELESS | MCS_CACHEABLE, FALSE);

5389

5390 if (regex_match_and_setup(re,sub_arg[0],0,-1))

5391 {

5392 uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);

5393 uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);

5394 uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);

5395 uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);

5396 uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);

5397

5398 DEBUG(D_expand)

5399 {

5400 debug_printf_indent("prvscheck localpart: %s\n", local_part);

5401 debug_printf_indent("prvscheck key number: %s\n", key_num);

5402 debug_printf_indent("prvscheck daystamp: %s\n", daystamp);

5403 debug_printf_indent("prvscheck hash: %s\n", hash);

5404 debug_printf_indent("prvscheck domain: %s\n", domain);

5405 }

5406

5407 /* Set up expansion variables */

5408 g = string_cat (NULL, local_part);

5409 g = string_catn(g, US"@", 1);

5410 g = string_cat (g, domain);

5411 prvscheck_address = string_from_gstring(g);

5412 prvscheck_keynum = string_copy(key_num);

5413

5414 /* Now expand the second argument */

5415 switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))

5416 {

5417 case 1: goto EXPAND_FAILED_CURLY;

5418 case 2:

5419 case 3: goto EXPAND_FAILED;

5420 }

5421

5422 /* Now we have the key and can check the address. */

5423

5424 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,

5425 daystamp);

5426 if (!p)

5427 {

5428 expand_string_message = US"hmac-sha1 conversion failed";

5429 goto EXPAND_FAILED;

5430 }

5431

5432 DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);

5433 DEBUG(D_expand) debug_printf_indent("prvscheck: own hash is %s\n", p);

5434

5435 if (Ustrcmp(p,hash) == 0)

5436 {

5437 /* Success, valid BATV address. Now check the expiry date. */

5438 uschar *now = prvs_daystamp(0);

5439 unsigned int inow = 0,iexpire = 1;

5440

5441 (void)sscanf(CS now,"%u",&inow);

5442 (void)sscanf(CS daystamp,"%u",&iexpire);

5443

5444 /* When "iexpire" is < 7, a "flip" has occurred.

5445 Adjust "inow" accordingly. */

5446 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;

5447

5448 if (iexpire >= inow)

5449 {

5450 prvscheck_result = US"1";

5451 DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");

5452 }

5453 else

5454 {

5455 prvscheck_result = NULL;

5456 DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");

5457 }

5458 }

5459 else

5460 {

5461 prvscheck_result = NULL;

5462 DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");

5463 }

5464

5465 /* Now expand the final argument. We leave this till now so that

5466 it can include $prvscheck_result. */

5467

5468 switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))

5469 {

5470 case 1: goto EXPAND_FAILED_CURLY;

5471 case 2:

5472 case 3: goto EXPAND_FAILED;

5473 }

5474

5475 yield = string_cat(yield,

5476 !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);

5477

5478 /* Reset the "internal" variables afterwards, because they are in

5479 dynamic store that will be reclaimed if the expansion succeeded. */

5480

5481 prvscheck_address = NULL;

5482 prvscheck_keynum = NULL;

5483 }

5484 else

5485 /* Does not look like a prvs encoded address, return the empty string.

5486 We need to make sure all subs are expanded first, so as to skip over

5487 the entire item. */

5488

5489 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))

5490 {

5491 case 1: goto EXPAND_FAILED_CURLY;

5492 case 2:

5493 case 3: goto EXPAND_FAILED;

5494 }

5495

5496 if (flags & ESI_SKIPPING) continue;

5497 break;

5498 }

5499

5500 /* Handle "readfile" to insert an entire file */

5501

5502 case EITEM_READFILE:

5503 {

5504 FILE * f;

5505 uschar * sub_arg[2];

5506

5507 if (expand_forbid & RDO_READFILE)

5508 {

5509 expand_string_message = US"file insertions are not permitted";

5510 goto EXPAND_FAILED;

5511 }

5512

5513 switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))

5514 {

5515 case -1: continue; /* If skipping, we don't actually do anything */

5516 case 1: goto EXPAND_FAILED_CURLY;

5517 case 2:

5518 case 3: goto EXPAND_FAILED;

5519 }

5520

5521 /* Open the file and read it */

5522

5523 if (!(f = Ufopen(sub_arg[0], "rb")))

5524 {

5525 expand_string_message = string_open_failed("%s", sub_arg[0]);

5526 goto EXPAND_FAILED;

5527 }

5528

5529 yield = cat_file(f, yield, sub_arg[1]);

5530 (void)fclose(f);

5531 break;

5532 }

5533

5534 /* Handle "readsocket" to insert data from a socket, either

5535 Inet or Unix domain */

5536

5537 case EITEM_READSOCK:

5538 {

5539 uschar * arg;

5540 uschar * sub_arg[4];

5541

5542 if (expand_forbid & RDO_READSOCK)

5543 {

5544 expand_string_message = US"socket insertions are not permitted";

5545 goto EXPAND_FAILED;

5546 }

5547

5548 /* Read up to 4 arguments, but don't do the end of item check afterwards,

5549 because there may be a string for expansion on failure. */

5550

5551 switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))

5552 {

5553 case 1: goto EXPAND_FAILED_CURLY;

5554 case 2: /* Won't occur: no end check */

5555 case 3: goto EXPAND_FAILED;

5556 }

5557

5558 /* If skipping, we don't actually do anything. Otherwise, arrange to

5559 connect to either an IP or a Unix socket. */

5560

5561 if (!(flags & ESI_SKIPPING))

5562 {

5563 const lookup_info * li = search_findtype(US"readsock", 8);

5564 gstring * g = NULL;

5565 void * handle;

5566 int expand_setup = -1;

5567 uschar * s;

5568

5569 if (!li)

5570 {

5571 expand_string_message = search_error_message;

5572 goto EXPAND_FAILED;

5573 }

5574

5575 /* If the reqstr is empty, flag that and set a dummy */

5576

5577 if (!sub_arg[1][0])

5578 {

5579 g = string_append_listele(g, ',', US"send=no");

5580 sub_arg[1] = US"DUMMY";

5581 }

5582

5583 /* Re-marshall the options */

5584

5585 if (sub_arg[2])

5586 {

5587 const uschar * list = sub_arg[2];

5588 uschar * item;

5589 int sep = 0;

5590

5591 /* First option has no tag and is timeout */

5592 if ((item = string_nextinlist(&list, &sep, NULL, 0)))

5593 g = string_append_listele_fmt(g, ',', TRUE, "timeout=%s", item);

5594

5595 /* The rest of the options from the expansion */

5596 while ((item = string_nextinlist(&list, &sep, NULL, 0)))

5597 g = string_append_listele(g, ',', item);

5598

5599 /* possibly plus an EOL string. Process with escapes, to protect

5600 from list-processing. The only current user of eol= in search

5601 options is the readsock expansion. */

5602

5603 if (sub_arg[3] && *sub_arg[3])

5604 g = string_append_listele_fmt(g, ',', TRUE,

5605 "eol=%s", string_printing2(sub_arg[3], SP_TAB|SP_SPACE));

5606 }

5607

5608 /* Gat a (possibly cached) handle for the connection */

5609

5610 if (!(handle = search_open(sub_arg[0], li, 0, NULL, NULL)))

5611 {

5612 if (*expand_string_message) goto EXPAND_FAILED;

5613 expand_string_message = search_error_message;

5614 search_error_message = NULL;

5615 goto SOCK_FAIL;

5616 }

5617

5618 /* Get (possibly cached) results for the lookup */

5619 /* sspec: sub_arg[0] req: sub_arg[1] opts: g */

5620

5621 if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,

5622 &expand_setup, string_from_gstring(g))))

5623 yield = string_cat(yield, s);

5624 else if (f.search_find_defer)

5625 {

5626 expand_string_message = search_error_message;

5627 search_error_message = NULL;

5628 goto SOCK_FAIL;

5629 }

5630 else

5631 { /* should not happen, at present */

5632 expand_string_message = search_error_message;

5633 search_error_message = NULL;

5634 goto SOCK_FAIL;

5635 }

5636 }

5637

5638 /* The whole thing has worked (or we were skipping). If there is a

5639 failure string following, we need to skip it. */

5640

5641 if (*s == '{') /*}*/

5642 {

5643 if (!expand_string_internal(s+1,

5644 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))

5645 goto EXPAND_FAILED; /*{*/

5646 if (*s++ != '}')

5647 { /*{*/

5648 expand_string_message = US"missing '}' closing failstring for readsocket";

5649 goto EXPAND_FAILED_CURLY;

5650 }

5651 Uskip_whitespace(&s);

5652 }

5653

5654 READSOCK_DONE: /*{*/

5655 if (*s++ != '}')

5656 { /*{*/

5657 expand_string_message = US"missing '}' closing readsocket";

5658 goto EXPAND_FAILED_CURLY;

5659 }

5660 if (flags & ESI_SKIPPING) continue; else break;

5661

5662 /* Come here on failure to create socket, connect socket, write to the

5663 socket, or timeout on reading. If another substring follows, expand and

5664 use it. Otherwise, those conditions give expand errors. */

5665

5666 SOCK_FAIL:

5667 if (*s != '{') goto EXPAND_FAILED; /*}*/

5668 DEBUG(D_any) debug_printf("%s\n", expand_string_message);

5669 if (!(arg = expand_string_internal(s+1,

5670 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))

5671 goto EXPAND_FAILED;

5672 yield = string_cat(yield, arg); /*{*/

5673 if (*s++ != '}')

5674 { /*{*/

5675 expand_string_message = US"missing '}' closing failstring for readsocket";

5676 goto EXPAND_FAILED_CURLY;

5677 }

5678 Uskip_whitespace(&s);

5679 goto READSOCK_DONE;

5680 }

5681

5682 /* Handle "run" to execute a program. */

5683

5684 case EITEM_RUN:

5685 {

5686 FILE * f;

5687 const uschar * arg, ** argv;

5688 unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;

5689

5690 if (expand_forbid & RDO_RUN)

5691 {

5692 expand_string_message = US"running a command is not permitted";

5693 goto EXPAND_FAILED;

5694 }

5695

5696 /* Handle options to the "run" */

5697

5698 while (*s == ',')

5699 if (Ustrncmp(++s, "preexpand", 9) == 0)

5700 { late_expand = 0; s += 9; }

5701 else

5702 {

5703 const uschar * t = s;

5704 while (isalpha(*++t)) ;

5705 expand_string_message = string_sprintf("bad option '%.*s' for run",

5706 (int)(t-s), s);

5707 goto EXPAND_FAILED;

5708 }

5709 Uskip_whitespace(&s);

5710

5711 if (*s != '{') /*}*/

5712 {

5713 expand_string_message = US"missing '{' for command arg of run";

5714 goto EXPAND_FAILED_CURLY; /*"}*/

5715 }

5716 s++;

5717

5718 if (late_expand) /* this is the default case */

5719 {

5720 int n;

5721 const uschar * t;

5722 /* Locate the end of the args */

5723 (void) expand_string_internal(s,

5724 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);

5725 n = t - s;

5726 arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);

5727 s += n;

5728 }

5729 else

5730 {

5731 DEBUG(D_expand)

5732 debug_printf_indent("args string for ${run} expand before split\n");

5733 if (!(arg = expand_string_internal(s,

5734 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))

5735 goto EXPAND_FAILED;

5736 Uskip_whitespace(&s);

5737 }

5738 /*{*/

5739 if (*s++ != '}')

5740 { /*{*/

5741 expand_string_message = US"missing '}' closing command arg of run";

5742 goto EXPAND_FAILED_CURLY;

5743 }

5744

5745 if (flags & ESI_SKIPPING) /* Just pretend it worked when we're skipping */

5746 {

5747 runrc = 0;

5748 lookup_value = NULL;

5749 }

5750 else

5751 {

5752 int fd_in, fd_out;

5753 pid_t pid;

5754

5755 if (!transport_set_up_command(&argv, /* anchor for arg list */

5756 arg, /* raw command */

5757 late_expand, /* expand args if not already done */

5758 0, /* not relevant when... */

5759 NULL, /* no transporting address */

5760 US"${run} expansion", /* for error messages */

5761 &expand_string_message)) /* where to put error message */

5762 goto EXPAND_FAILED;

5763

5764 /* Create the child process, making it a group leader. */

5765

5766 if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,

5767 US"expand-run")) < 0)

5768 {

5769 expand_string_message =

5770 string_sprintf("couldn't create child process: %s", strerror(errno));

5771 goto EXPAND_FAILED;

5772 }

5773

5774 /* Nothing is written to the standard input. */

5775

5776 (void)close(fd_in);

5777

5778 /* Read the pipe to get the command's output into $value (which is kept

5779 in lookup_value). Read during execution, so that if the output exceeds

5780 the OS pipe buffer limit, we don't block forever. Remember to not release

5781 memory just allocated for $value. */

5782

5783 resetok = FALSE;

5784 f = fdopen(fd_out, "rb");

5785 sigalrm_seen = FALSE;

5786 ALARM(60);

5787 lookup_value = string_from_gstring(cat_file(f, NULL, NULL));

5788 ALARM_CLR(0);

5789 (void)fclose(f);

5790

5791 /* Wait for the process to finish, applying the timeout, and inspect its

5792 return code for serious disasters. Simple non-zero returns are passed on.

5793 */

5794

5795 if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)

5796 {

5797 if (sigalrm_seen || runrc == -256)

5798 {

5799 expand_string_message = US"command timed out";

5800 killpg(pid, SIGKILL); /* Kill the whole process group */

5801 }

5802

5803 else if (runrc == -257)

5804 expand_string_message = string_sprintf("wait() failed: %s",

5805 strerror(errno));

5806

5807 else

5808 expand_string_message = string_sprintf("command killed by signal %d",

5809 -runrc);

5810

5811 goto EXPAND_FAILED;

5812 }

5813 }

5814

5815 /* Process the yes/no strings; $value may be useful in both cases */

5816

5817 switch(process_yesno(

5818 flags, /* were previously skipping */

5819 runrc == 0, /* success/failure indicator */

5820 lookup_value, /* value to reset for string2 */

5821 &s, /* input pointer */

5822 &yield, /* output pointer */

5823 US"run", /* condition type */

5824 &resetok))

5825 {

5826 case 1: goto EXPAND_FAILED; /* when all is well, the */

5827 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

5828 }

5829

5830 if (flags & ESI_SKIPPING) continue; else break;

5831 }

5832

5833 /* Handle character translation for "tr" */

5834

5835 case EITEM_TR:

5836 {

5837 int oldptr = gstring_length(yield);

5838 int o2m;

5839 uschar * sub[3];

5840

5841 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))

5842 {

5843 case -1: continue; /* skipping */

5844 case 1: goto EXPAND_FAILED_CURLY;

5845 case 2:

5846 case 3: goto EXPAND_FAILED;

5847 }

5848

5849 if ( (yield = string_cat(yield, sub[0]))

5850 && (o2m = Ustrlen(sub[2]) - 1) >= 0)

5851 for (; oldptr < yield->ptr; oldptr++)

5852 {

5853 uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);

5854 if (m)

5855 {

5856 int o = m - sub[1];

5857 yield->s[oldptr] = sub[2][o < o2m ? o : o2m];

5858 }

5859 }

5860

5861 break;

5862 }

5863

5864 /* Handle "hash", "length", "nhash", and "substr" when they are given with

5865 expanded arguments. */

5866

5867 case EITEM_HASH:

5868 case EITEM_LENGTH:

5869 case EITEM_NHASH:

5870 case EITEM_SUBSTR:

5871 {

5872 int len;

5873 uschar *ret;

5874 int val[2] = { 0, -1 };

5875 uschar * sub[3];

5876

5877 /* "length" takes only 2 arguments whereas the others take 2 or 3.

5878 Ensure that sub[2] is set in the ${length } case. */

5879

5880 sub[2] = NULL;

5881 switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,

5882 TRUE, name, &resetok, NULL))

5883 {

5884 case -1: continue; /* skipping */

5885 case 1: goto EXPAND_FAILED_CURLY;

5886 case 2:

5887 case 3: goto EXPAND_FAILED;

5888 }

5889

5890 /* Juggle the arguments if there are only two of them: always move the

5891 string to the last position and make ${length{n}{str}} equivalent to

5892 ${substr{0}{n}{str}}. See the defaults for val[] above. */

5893

5894 if (!sub[2])

5895 {

5896 sub[2] = sub[1];

5897 sub[1] = NULL;

5898 if (item_type == EITEM_LENGTH)

5899 {

5900 sub[1] = sub[0];

5901 sub[0] = NULL;

5902 }

5903 }

5904

5905 for (int i = 0; i < 2; i++) if (sub[i])

5906 {

5907 val[i] = (int)Ustrtol(sub[i], &ret, 10);

5908 if (*ret != 0 || (i != 0 && val[i] < 0))

5909 {

5910 expand_string_message = string_sprintf("\"%s\" is not a%s number "

5911 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);

5912 goto EXPAND_FAILED;

5913 }

5914 }

5915

5916 ret =

5917 item_type == EITEM_HASH

5918 ? compute_hash(sub[2], val[0], val[1], &len)

5919 : item_type == EITEM_NHASH

5920 ? compute_nhash(sub[2], val[0], val[1], &len)

5921 : extract_substr(sub[2], val[0], val[1], &len);

5922 if (!ret)

5923 goto EXPAND_FAILED;

5924 yield = string_catn(yield, ret, len);

5925 break;

5926 }

5927

5928 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}

5929 This code originally contributed by Steve Haslam. It currently supports

5930 the use of MD5 and SHA-1 hashes.

5931

5932 We need some workspace that is large enough to handle all the supported

5933 hash types. Use macros to set the sizes rather than be too elaborate. */

5934

5935 #define MAX_HASHLEN 20

5936 #define MAX_HASHBLOCKLEN 64

5937

5938 case EITEM_HMAC:

5939 {

5940 uschar * sub[3];

5941 md5 md5_base;

5942 hctx sha1_ctx;

5943 void * use_base;

5944 int type;

5945 int hashlen; /* Number of octets for the hash algorithm's output */

5946 int hashblocklen; /* Number of octets the hash algorithm processes */

5947 uschar * keyptr, * p;

5948 unsigned int keylen;

5949

5950 uschar keyhash[MAX_HASHLEN];

5951 uschar innerhash[MAX_HASHLEN];

5952 uschar finalhash[MAX_HASHLEN];

5953 uschar finalhash_hex[2*MAX_HASHLEN];

5954 uschar innerkey[MAX_HASHBLOCKLEN];

5955 uschar outerkey[MAX_HASHBLOCKLEN];

5956

5957 switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))

5958 {

5959 case -1: continue; /* skipping */

5960 case 1: goto EXPAND_FAILED_CURLY;

5961 case 2:

5962 case 3: goto EXPAND_FAILED;

5963 }

5964

5965 if (Ustrcmp(sub[0], "md5") == 0)

5966 {

5967 type = HMAC_MD5;

5968 use_base = &md5_base;

5969 hashlen = 16;

5970 hashblocklen = 64;

5971 }

5972 else if (Ustrcmp(sub[0], "sha1") == 0)

5973 {

5974 type = HMAC_SHA1;

5975 use_base = &sha1_ctx;

5976 hashlen = 20;

5977 hashblocklen = 64;

5978 }

5979 else

5980 {

5981 expand_string_message =

5982 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);

5983 goto EXPAND_FAILED;

5984 }

5985

5986 keyptr = sub[1];

5987 keylen = Ustrlen(keyptr);

5988

5989 /* If the key is longer than the hash block length, then hash the key

5990 first */

5991

5992 if (keylen > hashblocklen)

5993 {

5994 chash_start(type, use_base);

5995 chash_end(type, use_base, keyptr, keylen, keyhash);

5996 keyptr = keyhash;

5997 keylen = hashlen;

5998 }

5999

6000 /* Now make the inner and outer key values */

6001

6002 memset(innerkey, 0x36, hashblocklen);

6003 memset(outerkey, 0x5c, hashblocklen);

6004

6005 for (int i = 0; i < keylen; i++)

6006 {

6007 innerkey[i] ^= keyptr[i];

6008 outerkey[i] ^= keyptr[i];

6009 }

6010

6011 /* Now do the hashes */

6012

6013 chash_start(type, use_base);

6014 chash_mid(type, use_base, innerkey);

6015 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);

6016

6017 chash_start(type, use_base);

6018 chash_mid(type, use_base, outerkey);

6019 chash_end(type, use_base, innerhash, hashlen, finalhash);

6020

6021 /* Encode the final hash as a hex string */

6022

6023 p = finalhash_hex;

6024 for (int i = 0; i < hashlen; i++)

6025 {

6026 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];

6027 *p++ = hex_digits[finalhash[i] & 0x0f];

6028 }

6029

6030 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",

6031 sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);

6032

6033 yield = string_catn(yield, finalhash_hex, hashlen*2);

6034 break;

6035 }

6036

6037 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.

6038 We have to save the numerical variables and restore them afterwards. */

6039

6040 case EITEM_SG:

6041 {

6042 const pcre2_code * re;

6043 int moffset, moffsetextra, slen;

6044 pcre2_match_data * md;

6045 int emptyopt;

6046 uschar * subject, * sub[3];

6047 int save_expand_nmax =

6048 save_expand_strings(save_expand_nstring, save_expand_nlength);

6049 unsigned sub_textonly = 0;

6050

6051 switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))

6052 {

6053 case -1: continue; /* skipping */

6054 case 1: goto EXPAND_FAILED_CURLY;

6055 case 2:

6056 case 3: goto EXPAND_FAILED;

6057 }

6058

6059 /* Compile the regular expression */

6060

6061 re = regex_compile(sub[1],

6062 sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,

6063 &expand_string_message, pcre_gen_cmp_ctx);

6064 if (!re)

6065 goto EXPAND_FAILED;

6066

6067 md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);

6068

6069 /* Now run a loop to do the substitutions as often as necessary. It ends

6070 when there are no more matches. Take care over matches of the null string;

6071 do the same thing as Perl does. */

6072

6073 subject = sub[0];

6074 slen = Ustrlen(sub[0]);

6075 moffset = moffsetextra = 0;

6076 emptyopt = 0;

6077

6078 for (;;)

6079 {

6080 PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);

6081 int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,

6082 PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);

6083 uschar * insert;

6084

6085 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this

6086 is not necessarily the end. We want to repeat the match from one

6087 character further along, but leaving the basic offset the same (for

6088 copying below). We can't be at the end of the string - that was checked

6089 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are

6090 finished; copy the remaining string and end the loop. */

6091

6092 if (n < 0)

6093 {

6094 if (emptyopt != 0)

6095 {

6096 moffsetextra = 1;

6097 emptyopt = 0;

6098 continue;

6099 }

6100 yield = string_catn(yield, subject+moffset, slen-moffset);

6101 break;

6102 }

6103

6104 /* Match - set up for expanding the replacement. */

6105 DEBUG(D_expand) debug_printf_indent("%s: match\n", name);

6106

6107 if (n == 0) n = EXPAND_MAXN + 1;

6108 expand_nmax = 0;

6109 for (int nn = 0; nn < n*2; nn += 2)

6110 {

6111 expand_nstring[expand_nmax] = subject + ovec[nn];

6112 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];

6113 }

6114 expand_nmax--;

6115

6116 /* Copy the characters before the match, plus the expanded insertion. */

6117

6118 yield = string_catn(yield, subject + moffset, ovec[0] - moffset);

6119

6120 if (!(insert = expand_string(sub[2])))

6121 goto EXPAND_FAILED;

6122 yield = string_cat(yield, insert);

6123

6124 moffset = ovec[1];

6125 moffsetextra = 0;

6126 emptyopt = 0;

6127

6128 /* If we have matched an empty string, first check to see if we are at

6129 the end of the subject. If so, the loop is over. Otherwise, mimic

6130 what Perl's /g options does. This turns out to be rather cunning. First

6131 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty

6132 string at the same point. If this fails (picked up above) we advance to

6133 the next character. */

6134

6135 if (ovec[0] == ovec[1])

6136 {

6137 if (ovec[0] == slen) break;

6138 emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;

6139 }

6140 }

6141

6142 /* All done - restore numerical variables. */

6143

6144 /* pcre2_match_data_free(md); gen ctx needs no free */

6145 restore_expand_strings(save_expand_nmax, save_expand_nstring,

6146 save_expand_nlength);

6147 break;

6148 }

6149

6150 /* Handle keyed and numbered substring extraction. If the first argument

6151 consists entirely of digits, then a numerical extraction is assumed. */

6152

6153 case EITEM_EXTRACT:

6154 {

6155 int field_number = 1;

6156 BOOL field_number_set = FALSE;

6157 uschar * save_lookup_value = lookup_value, * sub[3];

6158 int save_expand_nmax =

6159 save_expand_strings(save_expand_nstring, save_expand_nlength);

6160

6161 /* On reflection the original behaviour of extract-json for a string

6162 result, leaving it quoted, was a mistake. But it was already published,

6163 hence the addition of jsons. In a future major version, make json

6164 work like josons, and withdraw jsons. */

6165

6166 enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;

6167

6168 /* Check for a format-variant specifier */

6169

6170 if (Uskip_whitespace(&s) != '{') /*}*/

6171 if (Ustrncmp(s, "json", 4) == 0)

6172 if (*(s += 4) == 's')

6173 {fmt = extract_jsons; s++;}

6174 else

6175 fmt = extract_json;

6176

6177 /* While skipping we cannot rely on the data for expansions being

6178 available (eg. $item) hence cannot decide on numeric vs. keyed.

6179 Read a maximum of 5 arguments (including the yes/no) */

6180

6181 if (flags & ESI_SKIPPING)

6182 {

6183 for (int j = 5; j > 0 && *s == '{'; j--) /*'}'*/

6184 {

6185 if (!expand_string_internal(s+1,

6186 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))

6187 goto EXPAND_FAILED; /*'{'*/

6188 if (*s++ != '}')

6189 {

6190 expand_string_message = US"missing '{' for arg of extract";

6191 goto EXPAND_FAILED_CURLY;

6192 }

6193 Uskip_whitespace(&s);

6194 }

6195 if ( Ustrncmp(s, "fail", 4) == 0 /*'{'*/

6196 && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])

6197 )

6198 {

6199 s += 4;

6200 Uskip_whitespace(&s);

6201 } /*'{'*/

6202 if (*s != '}')

6203 {

6204 expand_string_message = US"missing '}' closing extract";

6205 goto EXPAND_FAILED_CURLY;

6206 }

6207 }

6208

6209 else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */

6210 {

6211 if (Uskip_whitespace(&s) == '{') /*'}'*/

6212 {

6213 if (!(sub[i] = expand_string_internal(s+1,

6214 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))

6215 goto EXPAND_FAILED; /*'{'*/

6216 if (*s++ != '}')

6217 {

6218 expand_string_message = string_sprintf(

6219 "missing '}' closing arg %d of extract", i+1);

6220 goto EXPAND_FAILED_CURLY;

6221 }

6222

6223 /* After removal of leading and trailing white space, the first

6224 argument must not be empty; if it consists entirely of digits

6225 (optionally preceded by a minus sign), this is a numerical

6226 extraction, and we expect 3 arguments (normal) or 2 (json). */

6227

6228 if (i == 0)

6229 {

6230 int len;

6231 int x = 0;

6232 uschar * p = sub[0];

6233

6234 Uskip_whitespace(&p);

6235 sub[0] = p;

6236

6237 len = Ustrlen(p);

6238 while (len > 0 && isspace(p[len-1])) len--;

6239 p[len] = 0;

6240

6241 if (!*p)

6242 {

6243 expand_string_message = US"first argument of \"extract\" must "

6244 "not be empty";

6245 goto EXPAND_FAILED;

6246 }

6247

6248 if (*p == '-')

6249 {

6250 field_number = -1;

6251 p++;

6252 }

6253 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';

6254 if (!*p)

6255 {

6256 field_number *= x;

6257 if (fmt == extract_basic) j = 3; /* Need 3 args */

6258 field_number_set = TRUE;

6259 }

6260 }

6261 }

6262 else

6263 {

6264 expand_string_message = string_sprintf(

6265 "missing '{' for arg %d of extract", i+1);

6266 goto EXPAND_FAILED_CURLY;

6267 }

6268 }

6269

6270 /* Extract either the numbered or the keyed substring into $value. If

6271 skipping, just pretend the extraction failed. */

6272

6273 if (flags & ESI_SKIPPING)

6274 lookup_value = NULL;

6275 else switch (fmt)

6276 {

6277 case extract_basic:

6278 lookup_value = field_number_set

6279 ? expand_gettokened(field_number, sub[1], sub[2])

6280 : expand_getkeyed(sub[0], sub[1]);

6281 break;

6282

6283 case extract_json:

6284 case extract_jsons:

6285 {

6286 uschar * s, * item;

6287 const uschar * list;

6288

6289 /* Array: Bracket-enclosed and comma-separated.

6290 Object: Brace-enclosed, comma-sep list of name:value pairs */

6291

6292 if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))

6293 {

6294 expand_string_message =

6295 string_sprintf("%s wrapping %s for extract json",

6296 expand_string_message,

6297 field_number_set ? "array" : "object");

6298 goto EXPAND_FAILED_CURLY;

6299 }

6300

6301 list = s;

6302 if (field_number_set)

6303 {

6304 if (field_number <= 0)

6305 {

6306 expand_string_message = US"first argument of \"extract\" must "

6307 "be greater than zero";

6308 goto EXPAND_FAILED;

6309 }

6310 while (field_number > 0 && (item = json_nextinlist(&list)))

6311 field_number--;

6312 if ((lookup_value = s = item))

6313 {

6314 while (*s) s++;

6315 while (--s >= lookup_value && isspace(*s)) *s = '\0';

6316 }

6317 }

6318 else

6319 {

6320 lookup_value = NULL;

6321 while ((item = json_nextinlist(&list)))

6322 {

6323 /* Item is: string name-sep value. string is quoted.

6324 Dequote the string and compare with the search key. */

6325

6326 if (!(item = dewrap(item, US"\"\"")))

6327 {

6328 expand_string_message =

6329 string_sprintf("%s wrapping string key for extract json",

6330 expand_string_message);

6331 goto EXPAND_FAILED_CURLY;

6332 }

6333 if (Ustrcmp(item, sub[0]) == 0) /*XXX should be a UTF8-compare */

6334 {

6335 s = item + Ustrlen(item) + 1;

6336 if (Uskip_whitespace(&s) != ':')

6337 {

6338 expand_string_message =

6339 US"missing object value-separator for extract json";

6340 goto EXPAND_FAILED_CURLY;

6341 }

6342 s++;

6343 Uskip_whitespace(&s);

6344 lookup_value = s;

6345 break;

6346 }

6347 }

6348 }

6349 }

6350

6351 if ( fmt == extract_jsons

6352 && lookup_value

6353 && !(lookup_value = dewrap(lookup_value, US"\"\"")))

6354 {

6355 expand_string_message =

6356 string_sprintf("%s wrapping string result for extract jsons",

6357 expand_string_message);

6358 goto EXPAND_FAILED_CURLY;

6359 }

6360 break; /* json/s */

6361 }

6362

6363 /* If no string follows, $value gets substituted; otherwise there can

6364 be yes/no strings, as for lookup or if. */

6365

6366 switch(process_yesno(

6367 flags, /* were previously skipping */

6368 lookup_value != NULL, /* success/failure indicator */

6369 save_lookup_value, /* value to reset for string2 */

6370 &s, /* input pointer */

6371 &yield, /* output pointer */

6372 US"extract", /* condition type */

6373 &resetok))

6374 {

6375 case 1: goto EXPAND_FAILED; /* when all is well, the */

6376 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

6377 }

6378

6379 /* All done - restore numerical variables. */

6380

6381 restore_expand_strings(save_expand_nmax, save_expand_nstring,

6382 save_expand_nlength);

6383

6384 if (flags & ESI_SKIPPING) continue; else break;

6385 }

6386

6387 /* return the Nth item from a list */

6388

6389 case EITEM_LISTEXTRACT:

6390 {

6391 int field_number = 1, sep = 0;

6392 uschar * save_lookup_value = lookup_value, * sub[2];

6393 int save_expand_nmax =

6394 save_expand_strings(save_expand_nstring, save_expand_nlength);

6395

6396 /* Read the field & list arguments */

6397 /*XXX Could we use read_subs here (and get better efficiency for skipping)? */

6398

6399 for (int i = 0; i < 2; i++)

6400 {

6401 if (Uskip_whitespace(&s) != '{') /*}*/

6402 {

6403 expand_string_message = string_sprintf(

6404 "missing '{' for arg %d of listextract", i+1); /*}*/

6405 goto EXPAND_FAILED_CURLY;

6406 }

6407

6408 s++;

6409 if (i == 1) sep = matchlist_parse_sep(&s);

6410

6411 sub[i] = expand_string_internal(s,

6412 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

6413 if (!sub[i]) goto EXPAND_FAILED; /*{{*/

6414 if (*s++ != '}')

6415 {

6416 expand_string_message = string_sprintf(

6417 "missing '}' closing arg %d of listextract", i+1);

6418 goto EXPAND_FAILED_CURLY;

6419 }

6420

6421 /* After removal of leading and trailing white space, the first

6422 argument must be numeric and nonempty. */

6423

6424 if (i == 0)

6425 {

6426 int len;

6427 int x = 0;

6428 uschar *p = sub[0];

6429

6430 Uskip_whitespace(&p);

6431 sub[0] = p;

6432

6433 len = Ustrlen(p);

6434 while (len > 0 && isspace(p[len-1])) len--;

6435 p[len] = 0;

6436

6437 if (!*p && !(flags & ESI_SKIPPING))

6438 {

6439 expand_string_message = US"first argument of \"listextract\" must "

6440 "not be empty";

6441 goto EXPAND_FAILED;

6442 }

6443

6444 if (*p == '-')

6445 {

6446 field_number = -1;

6447 p++;

6448 }

6449 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';

6450 if (*p)

6451 {

6452 expand_string_message = US"first argument of \"listextract\" must "

6453 "be numeric";

6454 goto EXPAND_FAILED;

6455 }

6456 field_number *= x;

6457 }

6458 }

6459

6460 /* Extract the numbered element into $value. If

6461 skipping, just pretend the extraction failed. */

6462

6463 lookup_value = flags & ESI_SKIPPING

6464 ? NULL : expand_getlistele(field_number, sub[1], sep);

6465

6466 /* If no string follows, $value gets substituted; otherwise there can

6467 be yes/no strings, as for lookup or if. */

6468

6469 switch(process_yesno(

6470 flags, /* were previously skipping */

6471 lookup_value != NULL, /* success/failure indicator */

6472 save_lookup_value, /* value to reset for string2 */

6473 &s, /* input pointer */

6474 &yield, /* output pointer */

6475 US"listextract", /* condition type */

6476 &resetok))

6477 {

6478 case 1: goto EXPAND_FAILED; /* when all is well, the */

6479 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

6480 }

6481

6482 /* All done - restore numerical variables. */

6483

6484 restore_expand_strings(save_expand_nmax, save_expand_nstring,

6485 save_expand_nlength);

6486

6487 if (flags & ESI_SKIPPING) continue; else break;

6488 }

6489

6490 case EITEM_LISTQUOTE:

6491 {

6492 uschar * sub[2];

6493 switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))

6494 {

6495 case -1: continue; /* skipping */

6496 case 1: goto EXPAND_FAILED_CURLY;

6497 case 2:

6498 case 3: goto EXPAND_FAILED;

6499 }

6500 if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)

6501 {

6502 if (c == sep) yield = string_catn(yield, sub[1], 1);

6503 yield = string_catn(yield, sub[1], 1);

6504 }

6505 else yield = string_catn(yield, US" ", 1);

6506 break;

6507 }

6508

6509 #ifndef DISABLE_TLS

6510 case EITEM_CERTEXTRACT:

6511 {

6512 uschar * save_lookup_value = lookup_value, * sub[2];

6513 int save_expand_nmax =

6514 save_expand_strings(save_expand_nstring, save_expand_nlength);

6515

6516 /* Read the field argument */

6517 if (Uskip_whitespace(&s) != '{') /*}*/

6518 {

6519 expand_string_message = US"missing '{' for field arg of certextract";

6520 goto EXPAND_FAILED_CURLY; /*}*/

6521 }

6522 sub[0] = expand_string_internal(s+1,

6523 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

6524 if (!sub[0]) goto EXPAND_FAILED; /*{{*/

6525 if (*s++ != '}')

6526 {

6527 expand_string_message = US"missing '}' closing field arg of certextract";

6528 goto EXPAND_FAILED_CURLY;

6529 }

6530 /* strip spaces fore & aft */

6531 {

6532 int len;

6533 uschar *p = sub[0];

6534

6535 Uskip_whitespace(&p);

6536 sub[0] = p;

6537

6538 len = Ustrlen(p);

6539 while (len > 0 && isspace(p[len-1])) len--;

6540 p[len] = 0;

6541 }

6542

6543 /* inspect the cert argument */

6544 if (Uskip_whitespace(&s) != '{') /*}*/

6545 {

6546 expand_string_message = US"missing '{' for cert variable arg of certextract";

6547 goto EXPAND_FAILED_CURLY; /*}*/

6548 }

6549 if (*++s != '$')

6550 {

6551 expand_string_message = US"second argument of \"certextract\" must "

6552 "be a certificate variable";

6553 goto EXPAND_FAILED;

6554 }

6555 sub[1] = expand_string_internal(s+1,

6556 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);

6557 if (!sub[1]) goto EXPAND_FAILED; /*{{*/

6558 if (*s++ != '}')

6559 {

6560 expand_string_message = US"missing '}' closing cert variable arg of certextract";

6561 goto EXPAND_FAILED_CURLY;

6562 }

6563

6564 if (flags & ESI_SKIPPING)

6565 lookup_value = NULL;

6566 else

6567 {

6568 lookup_value = expand_getcertele(sub[0], sub[1]);

6569 if (*expand_string_message) goto EXPAND_FAILED;

6570 }

6571 switch(process_yesno(

6572 flags, /* were previously skipping */

6573 lookup_value != NULL, /* success/failure indicator */

6574 save_lookup_value, /* value to reset for string2 */

6575 &s, /* input pointer */

6576 &yield, /* output pointer */

6577 US"certextract", /* condition type */

6578 &resetok))

6579 {

6580 case 1: goto EXPAND_FAILED; /* when all is well, the */

6581 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

6582 }

6583

6584 restore_expand_strings(save_expand_nmax, save_expand_nstring,

6585 save_expand_nlength);

6586 if (flags & ESI_SKIPPING) continue; else break;

6587 }

6588 #endif /*DISABLE_TLS*/

6589

6590 /* Handle list operations */

6591

6592 case EITEM_FILTER:

6593 case EITEM_MAP:

6594 case EITEM_REDUCE:

6595 {

6596 int sep, save_ptr = gstring_length(yield);

6597 uschar outsep[2] = { '\0', '\0' };

6598 const uschar *list, *expr, *temp;

6599 uschar * save_iterate_item = iterate_item;

6600 uschar * save_lookup_value = lookup_value;

6601

6602 Uskip_whitespace(&s);

6603 if (*s++ != '{') /*}*/

6604 {

6605 expand_string_message =

6606 string_sprintf("missing '{' for first arg of %s", name);

6607 goto EXPAND_FAILED_CURLY; /*}*/

6608 }

6609

6610 DEBUG(D_expand) debug_printf_indent("%s: evaluate input list list\n", name);

6611 /* Check for a list-sep spec before expansion */

6612 sep = matchlist_parse_sep(&s);

6613

6614 if (!(list = expand_string_internal(s,

6615 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))

6616 goto EXPAND_FAILED; /*{{*/

6617 if (*s++ != '}')

6618 {

6619 expand_string_message =

6620 string_sprintf("missing '}' closing first arg of %s", name);

6621 goto EXPAND_FAILED_CURLY;

6622 }

6623

6624 if (item_type == EITEM_REDUCE)

6625 {

6626 uschar * t;

6627 Uskip_whitespace(&s);

6628 if (*s++ != '{') /*}*/

6629 {

6630 expand_string_message = US"missing '{' for second arg of reduce";

6631 goto EXPAND_FAILED_CURLY; /*}*/

6632 }

6633 DEBUG(D_expand) debug_printf_indent("reduce: initial result list\n");

6634 t = expand_string_internal(s,

6635 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

6636 if (!t) goto EXPAND_FAILED;

6637 lookup_value = t; /*{{*/

6638 if (*s++ != '}')

6639 {

6640 expand_string_message = US"missing '}' closing second arg of reduce";

6641 goto EXPAND_FAILED_CURLY;

6642 }

6643 }

6644

6645 Uskip_whitespace(&s);

6646 if (*s++ != '{') /*}*/

6647 {

6648 expand_string_message =

6649 string_sprintf("missing '{' for last arg of %s", name); /*}*/

6650 goto EXPAND_FAILED_CURLY;

6651 }

6652

6653 expr = s;

6654

6655 /* For EITEM_FILTER, call eval_condition once, with result discarded (as

6656 if scanning a "false" part). This allows us to find the end of the

6657 condition, because if the list is empty, we won't actually evaluate the

6658 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using

6659 the normal internal expansion function. */

6660

6661 DEBUG(D_expand) debug_printf_indent("%s: find end of conditionn\n", name);

6662 if (item_type != EITEM_FILTER)

6663 temp = expand_string_internal(s,

6664 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);

6665 else

6666 if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;

6667

6668 if (!temp)

6669 {

6670 expand_string_message = string_sprintf("%s inside \"%s\" item",

6671 expand_string_message, name);

6672 goto EXPAND_FAILED;

6673 }

6674

6675 Uskip_whitespace(&s); /*{{{*/

6676 if (*s++ != '}')

6677 {

6678 expand_string_message = string_sprintf("missing } at end of condition "

6679 "or expression inside \"%s\"; could be an unquoted } in the content",

6680 name);

6681 goto EXPAND_FAILED;

6682 }

6683

6684 Uskip_whitespace(&s); /*{{*/

6685 if (*s++ != '}')

6686 {

6687 expand_string_message = string_sprintf("missing } at end of \"%s\"",

6688 name);

6689 goto EXPAND_FAILED;

6690 }

6691

6692 /* If we are skipping, we can now just move on to the next item. When

6693 processing for real, we perform the iteration. */

6694

6695 if (flags & ESI_SKIPPING) continue;

6696 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))

6697 {

6698 *outsep = (uschar)sep; /* Separator as a string */

6699

6700 DEBUG(D_expand) debug_printf_indent("%s: $item = '%s' $value = '%s'\n",

6701 name, iterate_item, lookup_value);

6702

6703 if (item_type == EITEM_FILTER)

6704 {

6705 BOOL condresult;

6706 /* the condition could modify $value, as a side-effect */

6707 uschar * save_value = lookup_value;

6708

6709 if (!eval_condition(expr, &resetok, &condresult))

6710 {

6711 iterate_item = save_iterate_item;

6712 lookup_value = save_lookup_value;

6713 expand_string_message = string_sprintf("%s inside \"%s\" condition",

6714 expand_string_message, name);

6715 goto EXPAND_FAILED;

6716 }

6717 lookup_value = save_value;

6718 DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,

6719 condresult? "true":"false");

6720 if (condresult)

6721 temp = iterate_item; /* TRUE => include this item */

6722 else

6723 continue; /* FALSE => skip this item */

6724 }

6725

6726 else /* EITEM_MAP and EITEM_REDUCE */

6727 {

6728 /* the expansion could modify $value, as a side-effect */

6729 uschar * t = expand_string_internal(expr,

6730 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);

6731 if (!(temp = t))

6732 {

6733 iterate_item = save_iterate_item;

6734 expand_string_message = string_sprintf("%s inside \"%s\" item",

6735 expand_string_message, name);

6736 goto EXPAND_FAILED;

6737 }

6738 if (item_type == EITEM_REDUCE)

6739 {

6740 lookup_value = t; /* Update the value of $value */

6741 continue; /* and continue the iteration */

6742 }

6743 }

6744

6745 /* We reach here for FILTER if the condition is true, always for MAP,

6746 and never for REDUCE. The value in "temp" is to be added to the output

6747 list that is being created, ensuring that any occurrences of the

6748 separator character are doubled. Unless we are dealing with the first

6749 item of the output list, add in a space if the new item begins with the

6750 separator character, or is an empty string. */

6751

6752 /*XXX is there not a standard support function for this, appending to a list? */

6753 /* yes, string_append_listele(), but it depends on lack of text before the list */

6754

6755 if ( yield && yield->ptr != save_ptr

6756 && (temp[0] == *outsep || temp[0] == 0))

6757 yield = string_catn(yield, US" ", 1);

6758

6759 /* Add the string in "temp" to the output list that we are building,

6760 This is done in chunks by searching for the separator character. */

6761

6762 for (;;)

6763 {

6764 size_t seglen = Ustrcspn(temp, outsep);

6765

6766 yield = string_catn(yield, temp, seglen + 1);

6767

6768 /* If we got to the end of the string we output one character

6769 too many; backup and end the loop. Otherwise arrange to double the

6770 separator. */

6771

6772 if (!temp[seglen]) { yield->ptr--; break; }

6773 yield = string_catn(yield, outsep, 1);

6774 temp += seglen + 1;

6775 }

6776

6777 /* Output a separator after the string: we will remove the redundant

6778 final one at the end. */

6779

6780 yield = string_catn(yield, outsep, 1);

6781 } /* End of iteration over the list loop */

6782

6783 /* REDUCE has generated no output above: output the final value of

6784 $value. */

6785

6786 if (item_type == EITEM_REDUCE)

6787 {

6788 yield = string_cat(yield, lookup_value);

6789 lookup_value = save_lookup_value; /* Restore $value */

6790 }

6791

6792 /* FILTER and MAP generate lists: if they have generated anything, remove

6793 the redundant final separator. Even though an empty item at the end of a

6794 list does not count, this is tidier. */

6795

6796 else if (yield && yield->ptr != save_ptr) yield->ptr--;

6797

6798 /* Restore preserved $item */

6799

6800 iterate_item = save_iterate_item;

6801 if (flags & ESI_SKIPPING) continue; else break;

6802 }

6803

6804 case EITEM_SORT:

6805 {

6806 int sep, cond_type;

6807 const uschar * srclist, * cmp, * xtract;

6808 uschar * opname, * srcitem;

6809 const uschar * dstlist = NULL, * dstkeylist = NULL;

6810 uschar * tmp, * save_iterate_item = iterate_item;

6811

6812 Uskip_whitespace(&s);

6813 if (*s++ != '{') /*}*/

6814 {

6815 expand_string_message = US"missing '{' for list arg of sort";

6816 goto EXPAND_FAILED_CURLY; /*}*/

6817 }

6818

6819 sep = matchlist_parse_sep(&s);

6820 srclist = expand_string_internal(s,

6821 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

6822 if (!srclist) goto EXPAND_FAILED; /*{{*/

6823 if (*s++ != '}')

6824 {

6825 expand_string_message = US"missing '}' closing list arg of sort";

6826 goto EXPAND_FAILED_CURLY;

6827 }

6828

6829 Uskip_whitespace(&s);

6830 if (*s++ != '{') /*}*/

6831 {

6832 expand_string_message = US"missing '{' for comparator arg of sort";

6833 goto EXPAND_FAILED_CURLY; /*}*/

6834 }

6835

6836 cmp = expand_string_internal(s,

6837 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);

6838 if (!cmp) goto EXPAND_FAILED; /*{{*/

6839 if (*s++ != '}')

6840 {

6841 expand_string_message = US"missing '}' closing comparator arg of sort";

6842 goto EXPAND_FAILED_CURLY;

6843 }

6844

6845 if ((cond_type = identify_operator(&cmp, &opname)) == -1)

6846 {

6847 if (!expand_string_message)

6848 expand_string_message = string_sprintf("unknown condition \"%s\"", s);

6849 goto EXPAND_FAILED;

6850 }

6851 switch(cond_type)

6852 {

6853 case ECOND_NUM_L: case ECOND_NUM_LE:

6854 case ECOND_NUM_G: case ECOND_NUM_GE:

6855 case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:

6856 case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:

6857 break;

6858

6859 default:

6860 expand_string_message = US"comparator not handled for sort";

6861 goto EXPAND_FAILED;

6862 }

6863

6864 Uskip_whitespace(&s);

6865 if (*s++ != '{') /*}*/

6866 {

6867 expand_string_message = US"missing '{' for extractor arg of sort";

6868 goto EXPAND_FAILED_CURLY; /*}*/

6869 }

6870

6871 xtract = s;

6872 if (!(tmp = expand_string_internal(s,

6873 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))

6874 goto EXPAND_FAILED;

6875 xtract = string_copyn(xtract, s - xtract);

6876 /*{{*/

6877 if (*s++ != '}')

6878 {

6879 expand_string_message = US"missing '}' closing extractor arg of sort";

6880 goto EXPAND_FAILED_CURLY;

6881 }

6882 /*{{*/

6883 if (*s++ != '}')

6884 {

6885 expand_string_message = US"missing } at end of \"sort\"";

6886 goto EXPAND_FAILED;

6887 }

6888

6889 if (flags & ESI_SKIPPING) continue;

6890

6891 while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))

6892 {

6893 uschar * srcfield, * dstitem;

6894 gstring * newlist = NULL, * newkeylist = NULL;

6895

6896 DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);

6897

6898 /* extract field for comparisons */

6899 iterate_item = srcitem;

6900 if ( !(srcfield = expand_string_internal(xtract,

6901 ESI_HONOR_DOLLAR, NULL, &resetok, NULL))

6902 || !*srcfield)

6903 {

6904 expand_string_message = string_sprintf(

6905 "field-extract in sort: \"%s\"", xtract);

6906 goto EXPAND_FAILED;

6907 }

6908

6909 /* Insertion sort */

6910

6911 /* copy output list until new-item < list-item */

6912 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))

6913 {

6914 uschar * dstfield;

6915

6916 /* field for comparison */

6917 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))

6918 goto SORT_MISMATCH;

6919

6920 /* String-comparator names start with a letter; numeric names do not */

6921

6922 if (sortsbefore(cond_type, isalpha(opname[0]),

6923 srcfield, dstfield))

6924 {

6925 /* New-item sorts before this dst-item. Append new-item,

6926 then dst-item, then remainder of dst list. */

6927

6928 newlist = string_append_listele(newlist, sep, srcitem);

6929 newkeylist = string_append_listele(newkeylist, sep, srcfield);

6930 srcitem = NULL;

6931

6932 newlist = string_append_listele(newlist, sep, dstitem);

6933 newkeylist = string_append_listele(newkeylist, sep, dstfield);

6934

6935 /*XXX why field-at-a-time copy? Why not just dup the rest of the list? */

6936 while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))

6937 {

6938 if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))

6939 goto SORT_MISMATCH;

6940 newlist = string_append_listele(newlist, sep, dstitem);

6941 newkeylist = string_append_listele(newkeylist, sep, dstfield);

6942 }

6943

6944 break;

6945 }

6946

6947 newlist = string_append_listele(newlist, sep, dstitem);

6948 newkeylist = string_append_listele(newkeylist, sep, dstfield);

6949 }

6950

6951 /* If we ran out of dstlist without consuming srcitem, append it */

6952 if (srcitem)

6953 {

6954 newlist = string_append_listele(newlist, sep, srcitem);

6955 newkeylist = string_append_listele(newkeylist, sep, srcfield);

6956 }

6957

6958 dstlist = newlist->s;

6959 dstkeylist = newkeylist->s;

6960

6961 DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);

6962 DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);

6963 }

6964

6965 if (dstlist)

6966 yield = string_cat(yield, dstlist);

6967

6968 /* Restore preserved $item */

6969 iterate_item = save_iterate_item;

6970 break;

6971

6972 SORT_MISMATCH:

6973 expand_string_message = US"Internal error in sort (list mismatch)";

6974 goto EXPAND_FAILED;

6975 }

6976

6977

6978 /* If ${dlfunc } support is configured, handle calling dynamically-loaded

6979 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}

6980 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to

6981 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */

6982

6983 #define EXPAND_DLFUNC_MAX_ARGS 8

6984

6985 case EITEM_DLFUNC:

6986 #ifndef EXPAND_DLFUNC

6987 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/

6988 "is not included in this binary";

6989 goto EXPAND_FAILED;

6990

6991 #else /* EXPAND_DLFUNC */

6992 {

6993 tree_node * t;

6994 exim_dlfunc_t * func;

6995 uschar * result;

6996 int status, argc;

6997 uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];

6998

6999 if (expand_forbid & RDO_DLFUNC)

7000 {

7001 expand_string_message =

7002 US"dynamically-loaded functions are not permitted";

7003 goto EXPAND_FAILED;

7004 }

7005

7006 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,

7007 TRUE, name, &resetok, NULL))

7008 {

7009 case -1: continue; /* skipping */

7010 case 1: goto EXPAND_FAILED_CURLY;

7011 case 2:

7012 case 3: goto EXPAND_FAILED;

7013 }

7014

7015 /* Look up the dynamically loaded object handle in the tree. If it isn't

7016 found, dlopen() the file and put the handle in the tree for next time. */

7017

7018 if (!(t = tree_search(dlobj_anchor, argv[0])))

7019 {

7020 void * handle = dlopen(CS argv[0], RTLD_LAZY);

7021 if (!handle)

7022 {

7023 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",

7024 argv[0], dlerror());

7025 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);

7026 goto EXPAND_FAILED;

7027 }

7028 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);

7029 Ustrcpy(t->name, argv[0]);

7030 t->data.ptr = handle;

7031 (void)tree_insertnode(&dlobj_anchor, t);

7032 }

7033

7034 /* Having obtained the dynamically loaded object handle, look up the

7035 function pointer. */

7036

7037 if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))

7038 {

7039 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "

7040 "%s", argv[1], argv[0], dlerror());

7041 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);

7042 goto EXPAND_FAILED;

7043 }

7044

7045 /* Call the function and work out what to do with the result. If it

7046 returns OK, we have a replacement string; if it returns DEFER then

7047 expansion has failed in a non-forced manner; if it returns FAIL then

7048 failure was forced; if it returns ERROR or any other value there's a

7049 problem, so panic slightly. In any case, assume that the function has

7050 side-effects on the store that must be preserved. */

7051

7052 resetok = FALSE;

7053 result = NULL;

7054 for (argc = 0; argv[argc]; argc++) ;

7055

7056 if ((status = func(&result, argc - 2, &argv[2])) != OK)

7057 {

7058 expand_string_message = result ? result : US"(no message)";

7059 if (status == FAIL_FORCED)

7060 f.expand_string_forcedfail = TRUE;

7061 else if (status != FAIL)

7062 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",

7063 argv[0], argv[1], status, expand_string_message);

7064 goto EXPAND_FAILED;

7065 }

7066

7067 if (result) yield = string_cat(yield, result);

7068 break;

7069 }

7070 #endif /* EXPAND_DLFUNC */

7071

7072 case EITEM_ENV: /* ${env {name} {val_if_found} {val_if_unfound}} */

7073 {

7074 uschar * key;

7075 uschar *save_lookup_value = lookup_value;

7076

7077 if (Uskip_whitespace(&s) != '{') /*}*/

7078 goto EXPAND_FAILED;

7079

7080 key = expand_string_internal(s+1,

7081 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

7082 if (!key) goto EXPAND_FAILED; /*{{*/

7083 if (*s++ != '}')

7084 {

7085 expand_string_message = US"missing '}' for name arg of env";

7086 goto EXPAND_FAILED_CURLY;

7087 }

7088

7089 lookup_value = US getenv(CS key);

7090

7091 switch(process_yesno(

7092 flags, /* were previously skipping */

7093 lookup_value != NULL, /* success/failure indicator */

7094 save_lookup_value, /* value to reset for string2 */

7095 &s, /* input pointer */

7096 &yield, /* output pointer */

7097 US"env", /* condition type */

7098 &resetok))

7099 {

7100 case 1: goto EXPAND_FAILED; /* when all is well, the */

7101 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */

7102 }

7103 if (flags & ESI_SKIPPING) continue; else break;

7104 }

7105

7106 #ifdef SUPPORT_SRS

7107 case EITEM_SRS_ENCODE:

7108 /* ${srs_encode {secret} {return_path} {orig_domain}} */

7109 {

7110 uschar * sub[3];

7111 uschar cksum[4];

7112 gstring * g = NULL;

7113 BOOL quoted = FALSE;

7114

7115 switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))

7116 {

7117 case -1: continue; /* skipping */

7118 case 1: goto EXPAND_FAILED_CURLY;

7119 case 2:

7120 case 3: goto EXPAND_FAILED;

7121 }

7122 if (flags & ESI_SKIPPING) continue;

7123

7124 if (sub[1] && *(sub[1]))

7125 {

7126 g = string_catn(g, US"SRS0=", 5);

7127

7128 /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */

7129 hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));

7130 g = string_catn(g, cksum, sizeof(cksum));

7131 g = string_catn(g, US"=", 1);

7132

7133 /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */

7134 {

7135 struct timeval now;

7136 unsigned long i;

7137

7138 gettimeofday(&now, NULL);

7139 i = (now.tv_sec / 86400) & 0x3ff;

7140 g = string_catn(g, &base32_chars[i >> 5], 1);

7141 g = string_catn(g, &base32_chars[i & 0x1f], 1);

7142 }

7143 g = string_catn(g, US"=", 1);

7144

7145 /* ${domain:$return_path}=${local_part:$return_path} */

7146 {

7147 int start, end, domain;

7148 uschar * t = parse_extract_address(sub[1], &expand_string_message,

7149 &start, &end, &domain, FALSE);

7150 uschar * s;

7151

7152 if (!t)

7153 goto EXPAND_FAILED;

7154

7155 if (domain > 0) g = string_cat(g, t + domain);

7156 g = string_catn(g, US"=", 1);

7157

7158 s = domain > 0 ? string_copyn(t, domain - 1) : t;

7159 if ((quoted = Ustrchr(s, '"') != NULL))

7160 {

7161 gstring * h = NULL;

7162 DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");

7163 while (*s) /* de-quote */

7164 {

7165 while (*s && *s != '"') h = string_catn(h, s++, 1);

7166 if (*s) s++;

7167 while (*s && *s != '"') h = string_catn(h, s++, 1);

7168 if (*s) s++;

7169 }

7170 gstring_release_unused(h);

7171 s = string_from_gstring(h);

7172 }

7173 if (s) g = string_cat(g, s);

7174 }

7175

7176 /* Assume that if the original local_part had quotes

7177 it was for good reason */

7178

7179 if (quoted) yield = string_catn(yield, US"\"", 1);

7180 yield = gstring_append(yield, g);

7181 if (quoted) yield = string_catn(yield, US"\"", 1);

7182

7183 /* @$original_domain */

7184 yield = string_catn(yield, US"@", 1);

7185 yield = string_cat(yield, sub[2]);

7186 }

7187 else

7188 DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");

7189

7190 break;

7191 }

7192 #endif /*SUPPORT_SRS*/

7193

7194 default:

7195 goto NOT_ITEM;

7196 } /* EITEM_* switch */

7197 /*NOTREACHED*/

7198

7199 DEBUG(D_expand) /* only if not the sole expansion of the line */

7200 if (yield && (expansion_start > 0 || *s))

7201 debug_expansion_interim(US"item-res",

7202 yield->s + expansion_start, yield->ptr - expansion_start,

7203 flags);

7204 continue;

7205

7206 NOT_ITEM: ;

7207 }

7208

7209 /* Control reaches here if the name is not recognized as one of the more

7210 complicated expansion items. Check for the "operator" syntax (name terminated

7211 by a colon). Some of the operators have arguments, separated by _ from the

7212 name. */

7213

7214 if (*s == ':')

7215 {

7216 int c;

7217 uschar * arg = NULL, * sub;

7218 #ifndef DISABLE_TLS

7219 var_entry * vp = NULL;

7220 #endif

7221

7222 /* Owing to an historical mis-design, an underscore may be part of the

7223 operator name, or it may introduce arguments. We therefore first scan the

7224 table of names that contain underscores. If there is no match, we cut off

7225 the arguments and then scan the main table. */

7226

7227 if ((c = chop_match(name, op_table_underscore,

7228 nelem(op_table_underscore))) < 0)

7229 {

7230 if ((arg = Ustrchr(name, '_')))

7231 *arg = 0;

7232 if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)

7233 c += nelem(op_table_underscore);

7234 if (arg) *arg++ = '_'; /* Put back for error messages */

7235 }

7236

7237 /* Deal specially with operators that might take a certificate variable

7238 as we do not want to do the usual expansion. For most, expand the string.*/

7239

7240 switch(c)

7241 {

7242 #ifndef DISABLE_TLS

7243 case EOP_MD5:

7244 case EOP_SHA1:

7245 case EOP_SHA256:

7246 case EOP_BASE64:

7247 if (s[1] == '$')

7248 {

7249 const uschar * s1 = s;

7250 sub = expand_string_internal(s+2,

7251 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);

7252 if (!sub) goto EXPAND_FAILED; /*{*/

7253 if (*s1 != '}')

7254 { /*{*/

7255 expand_string_message =

7256 string_sprintf("missing '}' closing cert arg of %s", name);

7257 goto EXPAND_FAILED_CURLY;

7258 }

7259 if ( (vp = find_var_ent(sub, var_table, nelem(var_table)))

7260 && vp->type == vtype_cert)

7261 {

7262 s = s1+1;

7263 break;

7264 }

7265 vp = NULL;

7266 }

7267 /*FALLTHROUGH*/

7268 #endif

7269 default:

7270 sub = expand_string_internal(s+1,

7271 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);

7272 if (!sub) goto EXPAND_FAILED;

7273 s++;

7274 break;

7275 }

7276

7277 /* If we are skipping, we don't need to perform the operation at all.

7278 This matters for operations like "mask", because the data may not be

7279 in the correct format when skipping. For example, the expression may test

7280 for the existence of $sender_host_address before trying to mask it. For

7281 other operations, doing them may not fail, but it is a waste of time. */

7282

7283 if (flags & ESI_SKIPPING && c >= 0) continue;

7284

7285 /* Otherwise, switch on the operator type. After handling go back

7286 to the main loop top. */

7287

7288 {

7289 unsigned expansion_start = gstring_length(yield);

7290 switch(c)

7291 {

7292 case EOP_BASE32:

7293 {

7294 uschar * t;

7295 unsigned long int n = Ustrtoul(sub, &t, 10);

7296 gstring * g = NULL;

7297

7298 if (*t)

7299 {

7300 expand_string_message = string_sprintf("argument for base32 "

7301 "operator is \"%s\", which is not a decimal number", sub);

7302 goto EXPAND_FAILED;

7303 }

7304 for ( ; n; n >>= 5)

7305 g = string_catn(g, &base32_chars[n & 0x1f], 1);

7306

7307 if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);

7308 break;

7309 }

7310

7311 case EOP_BASE32D:

7312 {

7313 uschar *tt = sub;

7314 unsigned long int n = 0;

7315 while (*tt)

7316 {

7317 uschar * t = Ustrchr(base32_chars, *tt++);

7318 if (!t)

7319 {

7320 expand_string_message = string_sprintf("argument for base32d "

7321 "operator is \"%s\", which is not a base 32 number", sub);

7322 goto EXPAND_FAILED;

7323 }

7324 n = n * 32 + (t - base32_chars);

7325 }

7326 yield = string_fmt_append(yield, "%ld", n);

7327 break;

7328 }

7329

7330 case EOP_BASE62:

7331 {

7332 uschar *t;

7333 unsigned long int n = Ustrtoul(sub, &t, 10);

7334 if (*t)

7335 {

7336 expand_string_message = string_sprintf("argument for base62 "

7337 "operator is \"%s\", which is not a decimal number", sub);

7338 goto EXPAND_FAILED;

7339 }

7340 yield = string_cat(yield, string_base62_32(n)); /*XXX only handles 32b input range. Need variants? */

7341 break;

7342 }

7343

7344 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */

7345

7346 case EOP_BASE62D:

7347 {

7348 uschar *tt = sub;

7349 unsigned long int n = 0;

7350 while (*tt)

7351 {

7352 uschar *t = Ustrchr(base62_chars, *tt++);

7353 if (!t)

7354 {

7355 expand_string_message = string_sprintf("argument for base62d "

7356 "operator is \"%s\", which is not a base %d number", sub,

7357 BASE_62);

7358 goto EXPAND_FAILED;

7359 }

7360 n = n * BASE_62 + (t - base62_chars);

7361 }

7362 yield = string_fmt_append(yield, "%ld", n);

7363 break;

7364 }

7365

7366 case EOP_EXPAND:

7367 {

7368 uschar *expanded = expand_string_internal(sub,

7369 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);

7370 if (!expanded)

7371 {

7372 expand_string_message =

7373 string_sprintf("internal expansion of \"%s\" failed: %s", sub,

7374 expand_string_message);

7375 goto EXPAND_FAILED;

7376 }

7377 yield = string_cat(yield, expanded);

7378 break;

7379 }

7380

7381 case EOP_LC:

7382 {

7383 uschar * t = sub - 1;

7384 while (*++t) *t = tolower(*t);

7385 yield = string_catn(yield, sub, t-sub);

7386 break;

7387 }

7388

7389 case EOP_UC:

7390 {

7391 uschar * t = sub - 1;

7392 while (*++t) *t = toupper(*t);

7393 yield = string_catn(yield, sub, t-sub);

7394 break;

7395 }

7396

7397 case EOP_MD5:

7398 #ifndef DISABLE_TLS

7399 if (vp && *(void **)vp->value)

7400 {

7401 uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);

7402 yield = string_cat(yield, cp);

7403 }

7404 else

7405 #endif

7406 {

7407 md5 base;

7408 uschar digest[16];

7409 md5_start(&base);

7410 md5_end(&base, sub, Ustrlen(sub), digest);

7411 for (int j = 0; j < 16; j++)

7412 yield = string_fmt_append(yield, "%02x", digest[j]);

7413 }

7414 break;

7415

7416 case EOP_SHA1:

7417 #ifndef DISABLE_TLS

7418 if (vp && *(void **)vp->value)

7419 {

7420 uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);

7421 yield = string_cat(yield, cp);

7422 }

7423 else

7424 #endif

7425 {

7426 hctx h;

7427 uschar digest[20];

7428 sha1_start(&h);

7429 sha1_end(&h, sub, Ustrlen(sub), digest);

7430 for (int j = 0; j < 20; j++)

7431 yield = string_fmt_append(yield, "%02X", digest[j]);

7432 }

7433 break;

7434

7435 case EOP_SHA2:

7436 case EOP_SHA256:

7437 #ifdef EXIM_HAVE_SHA2

7438 if (vp && *(void **)vp->value)

7439 if (c == EOP_SHA256)

7440 yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));

7441 else

7442 expand_string_message = US"sha2_N not supported with certificates";

7443 else

7444 {

7445 hctx h;

7446 blob b;

7447 hashmethod m = !arg ? HASH_SHA2_256

7448 : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256

7449 : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384

7450 : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512

7451 : HASH_BADTYPE;

7452

7453 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))

7454 {

7455 expand_string_message = US"unrecognised sha2 variant";

7456 goto EXPAND_FAILED;

7457 }

7458

7459 exim_sha_update_string(&h, sub);

7460 exim_sha_finish(&h, &b);

7461 while (b.len-- > 0)

7462 yield = string_fmt_append(yield, "%02X", *b.data++);

7463 }

7464 #else

7465 expand_string_message = US"sha256 only supported with TLS";

7466 #endif

7467 break;

7468

7469 case EOP_SHA3:

7470 #ifdef EXIM_HAVE_SHA3

7471 {

7472 hctx h;

7473 blob b;

7474 hashmethod m = !arg ? HASH_SHA3_256

7475 : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224

7476 : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256

7477 : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384

7478 : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512

7479 : HASH_BADTYPE;

7480

7481 if (m == HASH_BADTYPE || !exim_sha_init(&h, m))

7482 {

7483 expand_string_message = US"unrecognised sha3 variant";

7484 goto EXPAND_FAILED;

7485 }

7486

7487 exim_sha_update_string(&h, sub);

7488 exim_sha_finish(&h, &b);

7489 while (b.len-- > 0)

7490 yield = string_fmt_append(yield, "%02X", *b.data++);

7491 }

7492 break;

7493 #else

7494 expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";

7495 goto EXPAND_FAILED;

7496 #endif

7497

7498 /* Line-wrap a string as if it is a header line */

7499

7500 case EOP_HEADERWRAP:

7501 {

7502 unsigned col = 80, lim = 998;

7503 uschar * s;

7504

7505 if (arg)

7506 {

7507 const uschar * list = arg;

7508 int sep = '_';

7509 if ((s = string_nextinlist(&list, &sep, NULL, 0)))

7510 {

7511 col = atoi(CS s);

7512 if ((s = string_nextinlist(&list, &sep, NULL, 0)))

7513 lim = atoi(CS s);

7514 }

7515 }

7516 if ((s = wrap_header(sub, col, lim, US"\t", 8)))

7517 yield = string_cat(yield, s);

7518 }

7519 break;

7520

7521 /* Convert hex encoding to base64 encoding */

7522

7523 case EOP_HEX2B64:

7524 {

7525 int c = 0;

7526 int b = -1;

7527 uschar *in = sub;

7528 uschar *out = sub;

7529 uschar *enc;

7530

7531 for (enc = sub; *enc; enc++)

7532 {

7533 if (!isxdigit(*enc))

7534 {

7535 expand_string_message = string_sprintf("\"%s\" is not a hex "

7536 "string", sub);

7537 goto EXPAND_FAILED;

7538 }

7539 c++;

7540 }

7541

7542 if ((c & 1) != 0)

7543 {

7544 expand_string_message = string_sprintf("\"%s\" contains an odd "

7545 "number of characters", sub);

7546 goto EXPAND_FAILED;

7547 }

7548

7549 while ((c = *in++) != 0)

7550 {

7551 if (isdigit(c)) c -= '0';

7552 else c = toupper(c) - 'A' + 10;

7553 if (b == -1)

7554 b = c << 4;

7555 else

7556 {

7557 *out++ = b | c;

7558 b = -1;

7559 }

7560 }

7561

7562 enc = b64encode(CUS sub, out - sub);

7563 yield = string_cat(yield, enc);

7564 break;

7565 }

7566

7567 /* Convert octets outside 0x21..0x7E to \xXX form */

7568

7569 case EOP_HEXQUOTE:

7570 {

7571 uschar *t = sub - 1;

7572 while (*(++t) != 0)

7573 {

7574 if (*t < 0x21 || 0x7E < *t)

7575 yield = string_fmt_append(yield, "\\x%02x", *t);

7576 else

7577 yield = string_catn(yield, t, 1);

7578 }

7579 break;

7580 }

7581

7582 /* count the number of list elements */

7583

7584 case EOP_LISTCOUNT:

7585 {

7586 int cnt = 0, sep;

7587 uschar * buf = store_get(2, sub);

7588

7589 sep = matchlist_parse_sep(CUSS &sub);

7590 while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;

7591 yield = string_fmt_append(yield, "%d", cnt);

7592 break;

7593 }

7594

7595 /* expand a named list given the name */

7596 /* handles nested named lists; requotes as colon-sep list */

7597

7598 case EOP_LISTNAMED:

7599 expand_string_message = NULL;

7600 yield = expand_listnamed(yield, sub, arg);

7601 if (expand_string_message)

7602 goto EXPAND_FAILED;

7603 break;

7604

7605 /* quote a list-item for the given list-separator */

7606

7607 /* mask applies a mask to an IP address; for example the result of

7608 ${mask:131.111.10.206/28} is 131.111.10.192/28. */

7609

7610 case EOP_MASK:

7611 {

7612 int count;

7613 uschar *endptr;

7614 int binary[4];

7615 int type, mask, maskoffset;

7616 BOOL normalised;

7617 uschar buffer[64];

7618

7619 if ((type = string_is_ip_address(sub, &maskoffset)) == 0)

7620 {

7621 expand_string_message = string_sprintf("\"%s\" is not an IP address",

7622 sub);

7623 goto EXPAND_FAILED;

7624 }

7625

7626 if (maskoffset == 0)

7627 {

7628 expand_string_message = string_sprintf("missing mask value in \"%s\"",

7629 sub);

7630 goto EXPAND_FAILED;

7631 }

7632

7633 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);

7634

7635 if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))

7636 {

7637 expand_string_message = string_sprintf("mask value too big in \"%s\"",

7638 sub);

7639 goto EXPAND_FAILED;

7640 }

7641

7642 /* If an optional 'n' was given, ipv6 gets normalised output:

7643 colons rather than dots, and zero-compressed. */

7644

7645 normalised = arg && *arg == 'n';

7646

7647 /* Convert the address to binary integer(s) and apply the mask */

7648

7649 sub[maskoffset] = 0;

7650 count = host_aton(sub, binary);

7651 host_mask(count, binary, mask);

7652

7653 /* Convert to masked textual format and add to output. */

7654

7655 if (type == 4 || !normalised)

7656 yield = string_catn(yield, buffer,

7657 host_nmtoa(count, binary, mask, buffer, '.'));

7658 else

7659 {

7660 ipv6_nmtoa(binary, buffer);

7661 yield = string_fmt_append(yield, "%s/%d", buffer, mask);

7662 }

7663 break;

7664 }

7665

7666 case EOP_IPV6NORM:

7667 case EOP_IPV6DENORM:

7668 {

7669 int type = string_is_ip_address(sub, NULL);

7670 int binary[4];

7671 uschar buffer[44];

7672

7673 switch (type)

7674 {

7675 case 6:

7676 (void) host_aton(sub, binary);

7677 break;

7678

7679 case 4: /* convert to IPv4-mapped IPv6 */

7680 binary[0] = binary[1] = 0;

7681 binary[2] = 0x0000ffff;

7682 (void) host_aton(sub, binary+3);

7683 break;

7684

7685 case 0:

7686 expand_string_message =

7687 string_sprintf("\"%s\" is not an IP address", sub);

7688 goto EXPAND_FAILED;

7689 }

7690

7691 yield = string_catn(yield, buffer, c == EOP_IPV6NORM

7692 ? ipv6_nmtoa(binary, buffer)

7693 : host_nmtoa(4, binary, -1, buffer, ':')

7694 );

7695 break;

7696 }

7697

7698 case EOP_ADDRESS:

7699 case EOP_LOCAL_PART:

7700 case EOP_DOMAIN:

7701 {

7702 uschar * error;

7703 int start, end, domain;

7704 uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,

7705 FALSE);

7706 if (t)

7707 if (c != EOP_DOMAIN)

7708 yield = c == EOP_LOCAL_PART && domain > 0

7709 ? string_catn(yield, t, domain - 1)

7710 : string_cat(yield, t);

7711 else if (domain > 0)

7712 yield = string_cat(yield, t + domain);

7713 break;

7714 }

7715

7716 case EOP_ADDRESSES:

7717 {

7718 uschar outsep[2] = { ':', '\0' };

7719 uschar *address, *error;

7720 int save_ptr = gstring_length(yield);

7721 int start, end, domain; /* Not really used */

7722

7723 if (Uskip_whitespace(&sub) == '>')

7724 if (*outsep = *++sub) ++sub;

7725 else

7726 {

7727 expand_string_message = string_sprintf("output separator "

7728 "missing in expanding ${addresses:%s}", --sub);

7729 goto EXPAND_FAILED;

7730 }

7731 f.parse_allow_group = TRUE;

7732

7733 for (;;)

7734 {

7735 uschar * p = parse_find_address_end(sub, FALSE);

7736 uschar saveend = *p;

7737 *p = '\0';

7738 address = parse_extract_address(sub, &error, &start, &end, &domain,

7739 FALSE);

7740 *p = saveend;

7741

7742 /* Add the address to the output list that we are building. This is

7743 done in chunks by searching for the separator character. At the

7744 start, unless we are dealing with the first address of the output

7745 list, add in a space if the new address begins with the separator

7746 character, or is an empty string. */

7747

7748 if (address)

7749 {

7750 if (yield && yield->ptr != save_ptr && address[0] == *outsep)

7751 yield = string_catn(yield, US" ", 1);

7752

7753 for (;;)

7754 {

7755 size_t seglen = Ustrcspn(address, outsep);

7756 yield = string_catn(yield, address, seglen + 1);

7757

7758 /* If we got to the end of the string we output one character

7759 too many. */

7760

7761 if (address[seglen] == '\0') { yield->ptr--; break; }

7762 yield = string_catn(yield, outsep, 1);

7763 address += seglen + 1;

7764 }

7765

7766 /* Output a separator after the string: we will remove the

7767 redundant final one at the end. */

7768

7769 yield = string_catn(yield, outsep, 1);

7770 }

7771

7772 if (saveend == '\0') break;

7773 sub = p + 1;

7774 }

7775

7776 /* If we have generated anything, remove the redundant final

7777 separator. */

7778

7779 if (yield && yield->ptr != save_ptr) yield->ptr--;

7780 f.parse_allow_group = FALSE;

7781 break;

7782 }

7783

7784

7785 /* quote puts a string in quotes if it is empty or contains anything

7786 other than alphamerics, underscore, dot, or hyphen.

7787

7788 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to

7789 be quoted in order to be a valid local part.

7790

7791 In both cases, newlines and carriage returns are converted into \n and \r

7792 respectively */

7793

7794 case EOP_QUOTE:

7795 case EOP_QUOTE_LOCAL_PART:

7796 if (!arg)

7797 {

7798 BOOL needs_quote = (!*sub); /* TRUE for empty string */

7799 uschar *t = sub - 1;

7800

7801 if (c == EOP_QUOTE)

7802 while (!needs_quote && *++t)

7803 needs_quote = !isalnum(*t) && !strchr("_-.", *t);

7804

7805 else /* EOP_QUOTE_LOCAL_PART */

7806 while (!needs_quote && *++t)

7807 needs_quote = !isalnum(*t)

7808 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL

7809 && (*t != '.' || t == sub || !t[1]);

7810

7811 if (needs_quote)

7812 {

7813 yield = string_catn(yield, US"\"", 1);

7814 t = sub - 1;

7815 while (*++t)

7816 if (*t == '\n')

7817 yield = string_catn(yield, US"\\n", 2);

7818 else if (*t == '\r')

7819 yield = string_catn(yield, US"\\r", 2);

7820 else

7821 {

7822 if (*t == '\\' || *t == '"')

7823 yield = string_catn(yield, US"\\", 1);

7824 yield = string_catn(yield, t, 1);

7825 }

7826 yield = string_catn(yield, US"\"", 1);

7827 }

7828 else

7829 yield = string_cat(yield, sub);

7830 }

7831

7832 /* quote_lookuptype does lookup-specific quoting */

7833

7834 else

7835 {

7836 const lookup_info * li;

7837 uschar * opt = Ustrchr(arg, '_');

7838

7839 if (opt) *opt++ = 0;

7840

7841 if (!(li = search_findtype(arg, Ustrlen(arg))))

7842 {

7843 expand_string_message = search_error_message;

7844 goto EXPAND_FAILED;

7845 }

7846

7847 if (li->quote)

7848 sub = (li->quote)(sub, opt, li->acq_num);

7849 else if (opt)

7850 sub = NULL;

7851

7852 if (!sub)

7853 {

7854 expand_string_message = string_sprintf(

7855 "\"%s\" unrecognized after \"${quote_%s\"", /*}*/

7856 opt, arg);

7857 goto EXPAND_FAILED;

7858 }

7859

7860 yield = string_cat(yield, sub);

7861 }

7862 break;

7863

7864 /* rx quote sticks in \ before any non-alphameric character so that

7865 the insertion works in a regular expression. */

7866

7867 case EOP_RXQUOTE:

7868 {

7869 uschar *t = sub - 1;

7870 while (*(++t) != 0)

7871 {

7872 if (!isalnum(*t))

7873 yield = string_catn(yield, US"\\", 1);

7874 yield = string_catn(yield, t, 1);

7875 }

7876 break;

7877 }

7878

7879 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as

7880 prescribed by the RFC, if there are characters that need to be encoded */

7881

7882 case EOP_RFC2047:

7883 yield = string_cat(yield,

7884 parse_quote_2047(sub, Ustrlen(sub), headers_charset,

7885 FALSE));

7886 break;

7887

7888 /* RFC 2047 decode */

7889

7890 case EOP_RFC2047D:

7891 {

7892 int len;

7893 uschar *error;

7894 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,

7895 headers_charset, '?', &len, &error);

7896 if (error)

7897 {

7898 expand_string_message = error;

7899 goto EXPAND_FAILED;

7900 }

7901 yield = string_catn(yield, decoded, len);

7902 break;

7903 }

7904

7905 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into

7906 underscores */

7907

7908 case EOP_FROM_UTF8:

7909 {

7910 uschar * buff = store_get(4, sub);

7911 while (*sub)

7912 {

7913 int c;

7914 GETUTF8INC(c, sub);

7915 if (c > 255) c = '_';

7916 buff[0] = c;

7917 yield = string_catn(yield, buff, 1);

7918 }

7919 break;

7920 }

7921

7922 /* replace illegal UTF-8 sequences by replacement character */

7923

7924 #define UTF8_REPLACEMENT_CHAR US"?"

7925

7926 case EOP_UTF8CLEAN:

7927 {

7928 int seq_len = 0, index = 0, bytes_left = 0, complete;

7929 u_long codepoint = (u_long)-1;

7930 uschar seq_buff[4]; /* accumulate utf-8 here */

7931

7932 /* Manually track tainting, as we deal in individual chars below */

7933

7934 if (!yield)

7935 yield = string_get_tainted(Ustrlen(sub), sub);

7936 else if (!yield->s || !yield->ptr)

7937 {

7938 yield->s = store_get(yield->size = Ustrlen(sub), sub);

7939 gstring_reset(yield);

7940 }

7941 else if (is_incompatible(yield->s, sub))

7942 gstring_rebuffer(yield, sub);

7943

7944 /* Check the UTF-8, byte-by-byte */

7945

7946 while (*sub)

7947 {

7948 complete = 0;

7949 uschar c = *sub++;

7950

7951 if (bytes_left)

7952 {

7953 if ((c & 0xc0) != 0x80)

7954 /* wrong continuation byte; invalidate all bytes */

7955 complete = 1; /* error */

7956 else

7957 {

7958 codepoint = (codepoint << 6) | (c & 0x3f);

7959 seq_buff[index++] = c;

7960 if (--bytes_left == 0) /* codepoint complete */

7961 if(codepoint > 0x10FFFF) /* is it too large? */

7962 complete = -1; /* error (RFC3629 limit) */

7963 else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */

7964 /* A UTF-16 surrogate (which should be one of a pair that

7965 encode a Unicode codepoint that is outside the Basic

7966 Multilingual Plane). Error, not UTF8.

7967 RFC2279.2 is slightly unclear on this, but

7968 https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder

7969 says "Surrogates characters are also invalid in UTF-8:

7970 characters in U+D800—U+DFFF have to be rejected." */

7971 complete = -1;

7972 else

7973 { /* finished; output utf-8 sequence */

7974 yield = string_catn(yield, seq_buff, seq_len);

7975 index = 0;

7976 }

7977 }

7978 }

7979 else /* no bytes left: new sequence */

7980 {

7981 if (!(c & 0x80)) /* 1-byte sequence, US-ASCII, keep it */

7982 {

7983 yield = string_catn(yield, &c, 1);

7984 continue;

7985 }

7986 if ((c & 0xe0) == 0xc0) /* 2-byte sequence */

7987 if (c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */

7988 complete = -1;

7989 else

7990 {

7991 bytes_left = 1;

7992 codepoint = c & 0x1f;

7993 }

7994 else if ((c & 0xf0) == 0xe0) /* 3-byte sequence */

7995 {

7996 bytes_left = 2;

7997 codepoint = c & 0x0f;

7998 }

7999 else if ((c & 0xf8) == 0xf0) /* 4-byte sequence */

8000 {

8001 bytes_left = 3;

8002 codepoint = c & 0x07;

8003 }

8004 else /* invalid or too long (RFC3629 allows only 4 bytes) */

8005 complete = -1;

8006

8007 seq_buff[index++] = c;

8008 seq_len = bytes_left + 1;

8009 } /* if(bytes_left) */

8010

8011 if (complete != 0)

8012 {

8013 bytes_left = index = 0;

8014 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);

8015 }

8016 if ((complete == 1) && ((c & 0x80) == 0))

8017 /* ASCII character follows incomplete sequence */

8018 yield = string_catn(yield, &c, 1);

8019 }

8020 /* If given a sequence truncated mid-character, we also want to report ?

8021 Eg, ${length_1:フィル} is one byte, not one character, so we expect

8022 ${utf8clean:${length_1:フィル}} to yield '?' */

8023

8024 if (bytes_left != 0)

8025 yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);

8026

8027 break;

8028 }

8029

8030 #ifdef SUPPORT_I18N

8031 case EOP_UTF8_DOMAIN_TO_ALABEL:

8032 {

8033 uschar * error = NULL;

8034 uschar * s = string_domain_utf8_to_alabel(sub, &error);

8035 if (error)

8036 {

8037 expand_string_message = string_sprintf(

8038 "error converting utf8 (%s) to alabel: %s",

8039 string_printing(sub), error);

8040 goto EXPAND_FAILED;

8041 }

8042 yield = string_cat(yield, s);

8043 break;

8044 }

8045

8046 case EOP_UTF8_DOMAIN_FROM_ALABEL:

8047 {

8048 uschar * error = NULL;

8049 uschar * s = string_domain_alabel_to_utf8(sub, &error);

8050 if (error)

8051 {

8052 expand_string_message = string_sprintf(

8053 "error converting alabel (%s) to utf8: %s",

8054 string_printing(sub), error);

8055 goto EXPAND_FAILED;

8056 }

8057 yield = string_cat(yield, s);

8058 break;

8059 }

8060

8061 case EOP_UTF8_LOCALPART_TO_ALABEL:

8062 {

8063 uschar * error = NULL;

8064 uschar * s = string_localpart_utf8_to_alabel(sub, &error);

8065 if (error)

8066 {

8067 expand_string_message = string_sprintf(

8068 "error converting utf8 (%s) to alabel: %s",

8069 string_printing(sub), error);

8070 goto EXPAND_FAILED;

8071 }

8072 yield = string_cat(yield, s);

8073 DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);

8074 break;

8075 }

8076

8077 case EOP_UTF8_LOCALPART_FROM_ALABEL:

8078 {

8079 uschar * error = NULL;

8080 uschar * s = string_localpart_alabel_to_utf8(sub, &error);

8081 if (error)

8082 {

8083 expand_string_message = string_sprintf(

8084 "error converting alabel (%s) to utf8: %s",

8085 string_printing(sub), error);

8086 goto EXPAND_FAILED;

8087 }

8088 yield = string_cat(yield, s);

8089 break;

8090 }

8091 #endif /* EXPERIMENTAL_INTERNATIONAL */

8092

8093 /* escape turns all non-printing characters into escape sequences. */

8094

8095 case EOP_ESCAPE:

8096 {

8097 const uschar * t = string_printing(sub);

8098 yield = string_cat(yield, t);

8099 break;

8100 }

8101

8102 case EOP_ESCAPE8BIT:

8103 {

8104 uschar c;

8105

8106 for (const uschar * s = sub; (c = *s); s++)

8107 yield = c < 127 && c != '\\'

8108 ? string_catn(yield, s, 1)

8109 : string_fmt_append(yield, "\\%03o", c);

8110 break;

8111 }

8112

8113 /* Handle numeric expression evaluation */

8114

8115 case EOP_EVAL:

8116 case EOP_EVAL10:

8117 {

8118 uschar *save_sub = sub;

8119 uschar *error = NULL;

8120 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);

8121 if (error)

8122 {

8123 expand_string_message = string_sprintf("error in expression "

8124 "evaluation: %s (after processing \"%.*s\")", error,

8125 (int)(sub-save_sub), save_sub);

8126 goto EXPAND_FAILED;

8127 }

8128 yield = string_fmt_append(yield, PR_EXIM_ARITH, n);

8129 break;

8130 }

8131

8132 /* Handle time period formatting */

8133

8134 case EOP_TIME_EVAL:

8135 {

8136 int n = readconf_readtime(sub, 0, FALSE);

8137 if (n < 0)

8138 {

8139 expand_string_message = string_sprintf("string \"%s\" is not an "

8140 "Exim time interval in \"%s\" operator", sub, name);

8141 goto EXPAND_FAILED;

8142 }

8143 yield = string_fmt_append(yield, "%d", n);

8144 break;

8145 }

8146

8147 case EOP_TIME_INTERVAL:

8148 {

8149 int n;

8150 uschar *t = read_number(&n, sub);

8151 if (*t != 0) /* Not A Number*/

8152 {

8153 expand_string_message = string_sprintf("string \"%s\" is not a "

8154 "positive number in \"%s\" operator", sub, name);

8155 goto EXPAND_FAILED;

8156 }

8157 t = readconf_printtime(n);

8158 yield = string_cat(yield, t);

8159 break;

8160 }

8161

8162 /* Convert string to base64 encoding */

8163

8164 case EOP_STR2B64:

8165 case EOP_BASE64:

8166 {

8167 #ifndef DISABLE_TLS

8168 uschar * s = vp && *(void **)vp->value

8169 ? tls_cert_der_b64(*(void **)vp->value)

8170 : b64encode(CUS sub, Ustrlen(sub));

8171 #else

8172 uschar * s = b64encode(CUS sub, Ustrlen(sub));

8173 #endif

8174 yield = string_cat(yield, s);

8175 break;

8176 }

8177

8178 case EOP_BASE64D:

8179 {

8180 uschar * s;

8181 int len = b64decode(sub, &s, sub);

8182 if (len < 0)

8183 {

8184 expand_string_message = string_sprintf("string \"%s\" is not "

8185 "well-formed for \"%s\" operator", sub, name);

8186 goto EXPAND_FAILED;

8187 }

8188 yield = string_cat(yield, s);

8189 break;

8190 }

8191

8192 /* strlen returns the length of the string */

8193

8194 case EOP_STRLEN:

8195 yield = string_fmt_append(yield, "%d", Ustrlen(sub));

8196 break;

8197

8198 /* length_n or l_n takes just the first n characters or the whole string,

8199 whichever is the shorter;

8200

8201 substr_m_n, and s_m_n take n characters from offset m; negative m take

8202 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it

8203 takes the rest, either to the right or to the left.

8204

8205 hash_n or h_n makes a hash of length n from the string, yielding n

8206 characters from the set a-z; hash_n_m makes a hash of length n, but

8207 uses m characters from the set a-zA-Z0-9.

8208

8209 nhash_n returns a single number between 0 and n-1 (in text form), while

8210 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies

8211 between 0 and n-1 and the second between 0 and m-1. */

8212

8213 case EOP_LENGTH:

8214 case EOP_L:

8215 case EOP_SUBSTR:

8216 case EOP_S:

8217 case EOP_HASH:

8218 case EOP_H:

8219 case EOP_NHASH:

8220 case EOP_NH:

8221 {

8222 int sign = 1;

8223 int value1 = 0;

8224 int value2 = -1;

8225 int *pn;

8226 int len;

8227 uschar *ret;

8228

8229 if (!arg)

8230 {

8231 expand_string_message = string_sprintf("missing values after %s",

8232 name);

8233 goto EXPAND_FAILED;

8234 }

8235

8236 /* "length" has only one argument, effectively being synonymous with

8237 substr_0_n. */

8238

8239 if (c == EOP_LENGTH || c == EOP_L)

8240 {

8241 pn = &value2;

8242 value2 = 0;

8243 }

8244

8245 /* The others have one or two arguments; for "substr" the first may be

8246 negative. The second being negative means "not supplied". */

8247

8248 else

8249 {

8250 pn = &value1;

8251 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }

8252 }

8253

8254 /* Read up to two numbers, separated by underscores */

8255

8256 ret = arg;

8257 while (*arg != 0)

8258 {

8259 if (arg != ret && *arg == '_' && pn == &value1)

8260 {

8261 pn = &value2;

8262 value2 = 0;

8263 if (arg[1] != 0) arg++;

8264 }

8265 else if (!isdigit(*arg))

8266 {

8267 expand_string_message =

8268 string_sprintf("non-digit after underscore in \"%s\"", name);

8269 goto EXPAND_FAILED;

8270 }

8271 else *pn = (*pn)*10 + *arg++ - '0';

8272 }

8273 value1 *= sign;

8274

8275 /* Perform the required operation */

8276

8277 ret = c == EOP_HASH || c == EOP_H

8278 ? compute_hash(sub, value1, value2, &len)

8279 : c == EOP_NHASH || c == EOP_NH

8280 ? compute_nhash(sub, value1, value2, &len)

8281 : extract_substr(sub, value1, value2, &len);

8282 if (!ret) goto EXPAND_FAILED;

8283

8284 yield = string_catn(yield, ret, len);

8285 break;

8286 }

8287

8288 /* Stat a path */

8289

8290 case EOP_STAT:

8291 {

8292 uschar smode[12];

8293 uschar **modetable[3];

8294 mode_t mode;

8295 struct stat st;

8296

8297 if (expand_forbid & RDO_EXISTS)

8298 {

8299 expand_string_message = US"Use of the stat() expansion is not permitted";

8300 goto EXPAND_FAILED;

8301 }

8302

8303 if (stat(CS sub, &st) < 0)

8304 {

8305 expand_string_message = string_sprintf("stat(%s) failed: %s",

8306 sub, strerror(errno));

8307 goto EXPAND_FAILED;

8308 }

8309 mode = st.st_mode;

8310 switch (mode & S_IFMT)

8311 {

8312 case S_IFIFO: smode[0] = 'p'; break;

8313 case S_IFCHR: smode[0] = 'c'; break;

8314 case S_IFDIR: smode[0] = 'd'; break;

8315 case S_IFBLK: smode[0] = 'b'; break;

8316 case S_IFREG: smode[0] = '-'; break;

8317 default: smode[0] = '?'; break;

8318 }

8319

8320 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;

8321 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;

8322 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;

8323

8324 for (int i = 0; i < 3; i++)

8325 {

8326 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);

8327 mode >>= 3;

8328 }

8329

8330 smode[10] = 0;

8331 yield = string_fmt_append(yield,

8332 "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "

8333 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",

8334 (long)(st.st_mode & 077777), smode, (long)st.st_ino,

8335 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,

8336 (long)st.st_gid, st.st_size, (long)st.st_atime,

8337 (long)st.st_mtime, (long)st.st_ctime);

8338 break;

8339 }

8340

8341 /* vaguely random number less than N */

8342

8343 case EOP_RANDINT:

8344 {

8345 int_eximarith_t max = expanded_string_integer(sub, TRUE);

8346

8347 if (expand_string_message)

8348 goto EXPAND_FAILED;

8349 yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));

8350 break;

8351 }

8352

8353 /* Reverse IP, including IPv6 to dotted-nibble */

8354

8355 case EOP_REVERSE_IP:

8356 {

8357 int family, maskptr;

8358 uschar reversed[128];

8359

8360 family = string_is_ip_address(sub, &maskptr);

8361 if (family == 0)

8362 {

8363 expand_string_message = string_sprintf(

8364 "reverse_ip() not given an IP address [%s]", sub);

8365 goto EXPAND_FAILED;

8366 }

8367 invert_address(reversed, sub);

8368 yield = string_cat(yield, reversed);

8369 break;

8370 }

8371

8372 case EOP_XTEXTD:

8373 {

8374 uschar * s;

8375 int len = xtextdecode(sub, &s);

8376 yield = string_catn(yield, s, len);

8377 break;

8378 }

8379

8380 /* Unknown operator */

8381 default:

8382 expand_string_message =

8383 string_sprintf("unknown expansion operator \"%s\"", name);

8384 goto EXPAND_FAILED;

8385 } /* EOP_* switch */

8386

8387 DEBUG(D_expand)

8388 {

8389 const uschar * res = string_from_gstring(yield);

8390 const uschar * s = res + expansion_start;

8391 int i = gstring_length(yield) - expansion_start;

8392 BOOL tainted = is_tainted(s);

8393

8394 debug_printf_indent("%Vop-res: %.*s\n", "K-----", i, s);

8395 if (tainted)

8396 {

8397 debug_printf_indent("%V %V",

8398 flags & ESI_SKIPPING ? "|" : " ",

8399 "\\__");

8400 debug_print_taint(res);

8401 }

8402 }

8403 continue;

8404 }

8405 }

8406

8407 /* Not an item or an operator */

8408 /* Handle a plain name. If this is the first thing in the expansion, release

8409 the pre-allocated buffer. If the result data is known to be in a new buffer,

8410 newsize will be set to the size of that buffer, and we can just point at that

8411 store instead of copying. Many expansion strings contain just one reference,

8412 so this is a useful optimization, especially for humungous headers

8413 ($message_headers). */

8414 /*{*/

8415 if (*s++ == '}')

8416 {

8417 const uschar * value;

8418 int len;

8419 int newsize = 0;

8420 gstring * g = NULL;

8421

8422 if (!yield)

8423 g = store_get(sizeof(gstring), GET_UNTAINTED);

8424 else if (yield->ptr == 0)

8425 {

8426 if (resetok) reset_point = store_reset(reset_point);

8427 yield = NULL;

8428 reset_point = store_mark();

8429 g = store_get(sizeof(gstring), GET_UNTAINTED); /* alloc _before_ calling find_variable() */

8430 }

8431 if (!(value = find_variable(name, flags, &newsize)))

8432 {

8433 expand_string_message =

8434 string_sprintf("unknown variable in \"${%s}\"", name);

8435 check_variable_error_message(name);

8436 goto EXPAND_FAILED;

8437 }

8438 len = Ustrlen(value);

8439 if (!yield && newsize)

8440 {

8441 yield = g;

8442 yield->size = newsize;

8443 yield->ptr = len;

8444 yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */

8445 }

8446 else

8447 yield = string_catn(yield, value, len);

8448 continue;

8449 }

8450

8451 /* Else there's something wrong */

8452

8453 expand_string_message =

8454 string_sprintf("\"${%s\" is not a known operator (or a } is missing "

8455 "in a variable reference)", name);

8456 goto EXPAND_FAILED;

8457 }

8458

8459 /* If we hit the end of the string when brace_ends is set, there is a missing

8460 terminating brace. */

8461

8462 if (flags & ESI_BRACE_ENDS && !*s)

8463 { /*{{*/

8464 expand_string_message = malformed_header

8465 ? US"missing } at end of string - could be header name not terminated by colon"

8466 : US"missing } at end of string";

8467 goto EXPAND_FAILED;

8468 }

8469

8470 /* Expansion succeeded; yield may still be NULL here if nothing was actually

8471 added to the string. If so, set up an empty string. Add a terminating zero. If

8472 left != NULL, return a pointer to the terminator. */

8473

8474 {

8475 uschar * res;

8476

8477 if (!yield)

8478 yield = string_get(1);

8479 res = string_from_gstring(yield);

8480 if (left) *left = s;

8481

8482 /* Any stacking store that was used above the final string is no longer needed.

8483 In many cases the final string will be the first one that was got and so there

8484 will be optimal store usage. */

8485

8486 if (resetok) gstring_release_unused(yield);

8487 else if (resetok_p) *resetok_p = FALSE;

8488

8489 DEBUG(D_expand)

8490 {

8491 BOOL tainted = is_tainted(res);

8492 debug_printf_indent("%Vexpanded: %.*W\n",

8493 "K---",

8494 (int)(s - string), string);

8495 debug_printf_indent("%Vresult: ",

8496 flags & ESI_SKIPPING ? "K-----" : "\\_____");

8497 if (*res || !(flags & ESI_SKIPPING))

8498 debug_printf("%W\n", res);

8499 else

8500 debug_printf(" %Vskipped%V\n", "<", ">");

8501 if (tainted)

8502 {

8503 debug_printf_indent("%V %V",

8504 flags & ESI_SKIPPING ? "|" : " ",

8505 "\\__"

8506 );

8507 debug_print_taint(res);

8508 }

8509 if (flags & ESI_SKIPPING)

8510 debug_printf_indent("%Vskipping: result is not used\n", "\\___");

8511 }

8512 if (textonly_p) *textonly_p = textonly;

8513 expand_level--;

8514 return res;

8515 }

8516

8517 /* This is the failure exit: easiest to program with a goto. We still need

8518 to update the pointer to the terminator, for cases of nested calls with "fail".

8519 */

8520

8521 EXPAND_FAILED_CURLY:

8522 if (malformed_header)

8523 expand_string_message =

8524 US"missing or misplaced { or } - could be header name not terminated by colon";

8525

8526 else if (!expand_string_message || !*expand_string_message)

8527 expand_string_message = US"missing or misplaced { or }";

8528

8529 /* At one point, Exim reset the store to yield (if yield was not NULL), but

8530 that is a bad idea, because expand_string_message is in dynamic store. */

8531

8532 EXPAND_FAILED:

8533 if (left) *left = s;

8534 DEBUG(D_expand)

8535 {

8536 debug_printf_indent("%Vfailed to expand: %s\n", "K", string);

8537 debug_printf_indent("%Verror message: %s\n",

8538 f.expand_string_forcedfail ? "K---" : "\\___", expand_string_message);

8539 if (f.expand_string_forcedfail)

8540 debug_printf_indent("%Vfailure was forced\n", "\\");

8541 }

8542 if (resetok_p && !resetok) *resetok_p = FALSE;

8543 expand_level--;

8544 return NULL;

8545 }

8546

8547

8548

8549 /* This is the external function call. Do a quick check for any expansion

8550 metacharacters, and if there are none, just return the input string.

8551

8552 Arguments

8553 the string to be expanded

8554 optional pointer for return boolean indicating no-dynamic-expansions

8555

8556 Returns: the expanded string, or NULL if expansion failed; if failure was

8557 due to a lookup deferring, search_find_defer will be TRUE

8558 */

8559

8560 const uschar *

8561 expand_string_2(const uschar * string, BOOL * textonly_p)

8562 {

8563 f.expand_string_forcedfail = f.search_find_defer = malformed_header = FALSE;

8564 if (Ustrpbrk(string, "$\\") != NULL)

8565 {

8566 int old_pool = store_pool;

8567 uschar * s;

8568

8569 store_pool = POOL_MAIN;

8570 s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);

8571 store_pool = old_pool;

8572 return s;

8573 }

8574 if (textonly_p) *textonly_p = TRUE;

8575 return string;

8576 }

8577

8578 const uschar *

8579 expand_cstring(const uschar * string)

8580 { return expand_string_2(string, NULL); }

8581

8582 uschar *

8583 expand_string(uschar * string)

8584 { return US expand_string_2(CUS string, NULL); }

8591 /*************************************************

8592 * Expand and copy *

8593 *************************************************/

8594

8595 /* Now and again we want to expand a string and be sure that the result is in a

8596 new bit of store. This function does that.

8597 Since we know it has been copied, the de-const cast is safe.

8598

8599 Argument: the string to be expanded

8600 Returns: the expanded string, always in a new bit of store, or NULL

8601 */

8602

8603 uschar *

8604 expand_string_copy(const uschar *string)

8605 {

8606 const uschar *yield = expand_cstring(string);

8607 if (yield == string) yield = string_copy(string);

8608 return US yield;

8609 }

8610

8611

8612

8613 /*************************************************

8614 * Expand and interpret as an integer *

8615 *************************************************/

8616

8617 /* Expand a string, and convert the result into an integer.

8618

8619 Arguments:

8620 string the string to be expanded

8621 isplus TRUE if a non-negative number is expected

8622

8623 Returns: the integer value, or

8624 -1 for an expansion error ) in both cases, message in

8625 -2 for an integer interpretation error ) expand_string_message

8626 expand_string_message is set NULL for an OK integer

8627 */

8628

8629 int_eximarith_t

8630 expand_string_integer(uschar *string, BOOL isplus)

8631 {

8632 return expanded_string_integer(expand_string(string), isplus);

8633 }

8634

8635

8636 /*************************************************

8637 * Interpret string as an integer *

8638 *************************************************/

8639

8640 /* Convert a string (that has already been expanded) into an integer.

8641

8642 This function is used inside the expansion code.

8643

8644 Arguments:

8645 s the string to be expanded

8646 isplus TRUE if a non-negative number is expected

8647

8648 Returns: the integer value, or

8649 -1 if string is NULL (which implies an expansion error)

8650 -2 for an integer interpretation error

8651 expand_string_message is set NULL for an OK integer

8652 */

8653

8654 static int_eximarith_t

8655 expanded_string_integer(const uschar *s, BOOL isplus)

8656 {

8657 int_eximarith_t value;

8658 uschar *msg = US"invalid integer \"%s\"";

8659 uschar *endptr;

8660

8661 /* If expansion failed, expand_string_message will be set. */

8662

8663 if (!s) return -1;

8664

8665 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno

8666 to ERANGE. When there isn't an overflow, errno is not changed, at least on some

8667 systems, so we set it zero ourselves. */

8668

8669 errno = 0;

8670 expand_string_message = NULL; /* Indicates no error */

8671

8672 /* Before Exim 4.64, strings consisting entirely of whitespace compared

8673 equal to 0. Unfortunately, people actually relied upon that, so preserve

8674 the behaviour explicitly. Stripping leading whitespace is a harmless

8675 noop change since strtol skips it anyway (provided that there is a number

8676 to find at all). */

8677 if (isspace(*s))

8678 if (Uskip_whitespace(&s) == '\0')

8679 {

8680 DEBUG(D_expand)

8681 debug_printf_indent("treating blank string as number 0\n");

8682 return 0;

8683 }

8684

8685 value = strtoll(CS s, CSS &endptr, 10);

8686

8687 if (endptr == s)

8688 msg = US"integer expected but \"%s\" found";

8689 else if (value < 0 && isplus)

8690 msg = US"non-negative integer expected but \"%s\" found";

8691 else

8692 {

8693 switch (tolower(*endptr))

8694 {

8695 default:

8696 break;

8697 case 'k':

8698 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;

8699 else value *= 1024;

8700 endptr++;

8701 break;

8702 case 'm':

8703 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;

8704 else value *= 1024*1024;

8705 endptr++;

8706 break;

8707 case 'g':

8708 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;

8709 else value *= 1024*1024*1024;

8710 endptr++;

8711 break;

8712 }

8713 if (errno == ERANGE)

8714 msg = US"absolute value of integer \"%s\" is too large (overflow)";

8715 else

8716 if (Uskip_whitespace(&endptr) == 0) return value;

8717 }

8718

8719 expand_string_message = string_sprintf(CS msg, s);

8720 return -2;

8721 }

8722

8723

8724 /* These values are usually fixed boolean values, but they are permitted to be

8725 expanded strings.

8726

8727 Arguments:

8728 addr address being routed

8729 mtype the module type

8730 mname the module name

8731 dbg_opt debug selectors

8732 oname the option name

8733 bvalue the router's boolean value

8734 svalue the router's string value

8735 rvalue where to put the returned value

8736

8737 Returns: OK value placed in rvalue

8738 DEFER expansion failed

8739 */

8740

8741 int

8742 exp_bool(address_item * addr,

8743 const uschar * mtype, const uschar * mname, unsigned dbg_opt,

8744 uschar * oname, BOOL bvalue,

8745 const uschar * svalue, BOOL * rvalue)

8746 {

8747 const uschar * expanded;

8748

8749 DEBUG(D_expand) debug_printf("try option %s\n", oname);

8750 if (!svalue) { *rvalue = bvalue; return OK; }

8751

8752 if (!(expanded = expand_cstring(svalue)))

8753 {

8754 if (f.expand_string_forcedfail)

8755 {

8756 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);

8757 *rvalue = bvalue;

8758 return OK;

8759 }

8760 addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",

8761 oname, mname, mtype, expand_string_message);

8762 DEBUG(dbg_opt) debug_printf("%s\n", addr->message);

8763 return DEFER;

8764 }

8765

8766 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,

8767 expanded);

8768

8769 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)

8770 *rvalue = TRUE;

8771 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)

8772 *rvalue = FALSE;

8773 else

8774 {

8775 addr->message = string_sprintf("\"%s\" is not a valid value for the "

8776 "\"%s\" option in the %s %s", expanded, oname, mname, mtype);

8777 return DEFER;

8778 }

8779

8780 return OK;

8781 }

8782

8783

8784

8785 /* Avoid potentially exposing a password in a string about to be logged */

8786

8787 uschar *

8788 expand_hide_passwords(uschar * s)

8789 {

8790 return ( ( Ustrstr(s, "failed to expand") != NULL

8791 || Ustrstr(s, "expansion of ") != NULL

8792 )

8793 && ( Ustrstr(s, "mysql") != NULL

8794 || Ustrstr(s, "pgsql") != NULL

8795 || Ustrstr(s, "redis") != NULL

8796 || Ustrstr(s, "sqlite") != NULL

8797 || Ustrstr(s, "ldap:") != NULL

8798 || Ustrstr(s, "ldaps:") != NULL

8799 || Ustrstr(s, "ldapi:") != NULL

8800 || Ustrstr(s, "ldapdn:") != NULL

8801 || Ustrstr(s, "ldapm:") != NULL

8802 ) )

8803 ? US"Temporary internal error" : s;

8804 }

8805

8806

8807 /* Read given named file into big_buffer. Use for keying material etc.

8808 The content will have an ascii NUL appended.

8809

8810 Arguments:

8811 filename as it says

8812

8813 Return: pointer to buffer, or NULL on error.

8814 */

8815

8816 uschar *

8817 expand_file_big_buffer(const uschar * filename)

8818 {

8819 int fd, off = 0, len;

8820

8821 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)

8822 {

8823 log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file '%s' for reading: %s",

8824 filename, strerror(errno));

8825 return NULL;

8826 }

8827

8828 do

8829 {

8830 if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)

8831 {

8832 (void) close(fd);

8833 log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);

8834 return NULL;

8835 }

8836 off += len;

8837 }

8838 while (len > 0);

8839

8840 (void) close(fd);

8841 big_buffer[off] = '\0';

8842 return big_buffer;

8843 }

8844

8845

8846

8847 /*************************************************

8848 * Error-checking for testsuite *

8849 *************************************************/

8850 typedef struct {

8851 uschar * region_start;

8852 uschar * region_end;

8853 const uschar *var_name;

8854 const uschar *var_data;

8855 } err_ctx;

8856

8857 /* Called via tree_walk, which allows nonconst name/data. Our usage is const. */

8858 static void

8859 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)

8860 {

8861 err_ctx * e = ctx;

8862 if (var_data >= e->region_start && var_data < e->region_end)

8863 {

8864 e->var_name = CUS var_name;

8865 e->var_data = CUS var_data;

8866 }

8867 }

8868

8869 void

8870 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)

8871 {

8872 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,

8873 .var_name = NULL, .var_data = NULL };

8874

8875 /* check acl_ variables */

8876 tree_walk(acl_var_c, assert_variable_notin, &e);

8877 tree_walk(acl_var_m, assert_variable_notin, &e);

8878

8879 /* check auth<n> variables.

8880 assert_variable_notin() treats as const, so deconst is safe. */

8881 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])

8882 assert_variable_notin(US"auth<n>", US auth_vars[i], &e);

8883

8884 #ifdef WITH_CONTENT_SCAN

8885 /* check regex<n> variables. assert_variable_notin() treats as const. */

8886 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])

8887 assert_variable_notin(US"regex<n>", US regex_vars[i], &e);

8888 #endif

8889

8890 /* check known-name variables */

8891 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)

8892 if (v->type == vtype_stringptr)

8893 assert_variable_notin(US v->name, *(USS v->value), &e);

8894

8895 /* check dns and address trees */

8896 tree_walk(tree_dns_fails, assert_variable_notin, &e);

8897 tree_walk(tree_duplicates, assert_variable_notin, &e);

8898 tree_walk(tree_nonrecipients, assert_variable_notin, &e);

8899 tree_walk(tree_unusable, assert_variable_notin, &e);

8900

8901 if (e.var_name)

8902 log_write(0, LOG_MAIN|LOG_PANIC_DIE,

8903 "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",

8904 e.var_name, filename, linenumber, e.var_data);

8905 }

8906

8907

8908

8909 /*************************************************

8910 **************************************************

8911 * Stand-alone test program *

8912 **************************************************

8913 *************************************************/

8914

8915 #ifdef STAND_ALONE

8916

8917

8918 BOOL

8919 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)

8920 {

8921 int ovec[3*(EXPAND_MAXN+1)];

8922 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,

8923 ovec, nelem(ovec));

8924 BOOL yield = n >= 0;

8925 if (n == 0) n = EXPAND_MAXN + 1;

8926 if (yield)

8927 {

8928 expand_nmax = setup < 0 ? 0 : setup + 1;

8929 for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)

8930 {

8931 expand_nstring[expand_nmax] = subject + ovec[nn];

8932 expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];

8933 }

8934 expand_nmax--;

8935 }

8936 return yield;

8937 }

8938

8939

8940 int main(int argc, uschar **argv)

8941 {

8942 uschar buffer[1024];

8943

8944 debug_selector = D_v;

8945 debug_file = stderr;

8946 debug_fd = fileno(debug_file);

8947 big_buffer = malloc(big_buffer_size);

8948 store_init();

8949

8950 for (int i = 1; i < argc; i++)

8951 {

8952 if (argv[i][0] == '+')

8953 {

8954 debug_trace_memory = 2;

8955 argv[i]++;

8956 }

8957 if (isdigit(argv[i][0]))

8958 debug_selector = Ustrtol(argv[i], NULL, 0);

8959 else

8960 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==

8961 Ustrlen(argv[i]))

8962 {

8963 #ifdef LOOKUP_LDAP

8964 eldap_default_servers = argv[i];

8965 #endif

8966 #ifdef LOOKUP_MYSQL

8967 mysql_servers = argv[i];

8968 #endif

8969 #ifdef LOOKUP_PGSQL

8970 pgsql_servers = argv[i];

8971 #endif

8972 #ifdef LOOKUP_REDIS

8973 redis_servers = argv[i];

8974 #endif

8975 }

8976 #ifdef EXIM_PERL

8977 else opt_perl_startup = argv[i];

8978 #endif

8979 }

8980

8981 printf("Testing string expansion: debug_level = %d\n\n", debug_level);

8982

8983 expand_nstring[1] = US"string 1....";

8984 expand_nlength[1] = 8;

8985 expand_nmax = 1;

8986

8987 #ifdef EXIM_PERL

8988 if (opt_perl_startup != NULL)

8989 {

8990 uschar *errstr;

8991 printf("Starting Perl interpreter\n");

8992 errstr = init_perl(opt_perl_startup);

8993 if (errstr)

8994 {

8995 printf("** error in perl_startup code: %s\n", errstr);

8996 return EXIT_FAILURE;

8997 }

8998 }

8999 #endif /* EXIM_PERL */

9000

9001 /* Thie deliberately regards the input as untainted, so that it can be

9002 expanded; only reasonable since this is a test for string-expansions. */

9003

9004 while (fgets(buffer, sizeof(buffer), stdin) != NULL)

9005 {

9006 rmark reset_point = store_mark();

9007 uschar *yield = expand_string(buffer);

9008 if (yield)

9009 printf("%s\n", yield);

9010 else

9011 {

9012 if (f.search_find_defer) printf("search_find deferred\n");

9013 printf("Failed: %s\n", expand_string_message);

9014 if (f.expand_string_forcedfail) printf("Forced failure\n");

9015 printf("\n");

9016 }

9017 store_reset(reset_point);

9018 }

9019

9020 search_tidyup();

9021

9022 return 0;

9023 }

9024

9025 #endif /*STAND_ALONE*/

9026

9027 #endif /*!MACRO_PREDEF*/

9028 /* vi: aw ai sw=2

9029 */

9030 /* End of expand.c */