[Response Ops] Add `xpack.actions.email.recipient_allowlist` config by jcger · Pull Request #220058 · elastic/kibana

jcger · 2025-05-05T11:28:00Z

Summary

As this Kibana config contains sensitive data, we moved the validation to the server side only

Release note

Adds xpack.actions.email.recipient_allowlist kibana config.

jcger · 2025-05-05T19:15:27Z

...egration/spaces_only/tests/actions/connector_types/stack/email_recipient_allowlist/config.ts

+
+import { createTestConfig } from '../../../../../../common/config';
+
+export const recipientAllowList = ['*.bar@example.org', '*@test.com'];


I had to create a new config to be able to set the recipientAllowList

x-pack/platform/plugins/shared/actions/common/validate_email_addresses.ts

elasticmachine · 2025-05-06T07:41:59Z

Pinging @elastic/response-ops (Team:ResponseOps)

jbudz · 2025-05-06T14:20:11Z

x-pack/platform/plugins/shared/actions/server/config.ts

+    schema.object(
+      {
+        domain_allowlist: schema.maybe(schema.arrayOf(schema.string())),
+        recipient_allowlist: schema.maybe(schema.arrayOf(schema.string())),


Can we add this to src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker too?

thanks, done in 539585c. I just realised that file is auto generated. Checking...

Actually, that file is NOT auto-generated. See: https://ela.st/docker-file-not-autogenerated - I keep forgetting to delete that line when I get in that file :-). Feel free to delete it yourself!

BTW, we will also want to add this to the cloud allow-list of config keys. We can point you to some example PRs where we've done this - it's fairly simple, but will be another PR since it's a different repo.

I removed the "auto-generated" comment in 9d8c11f

Feel free to share those PRs here or via slack with me whenever you have time :)

example PR where we add the cloud allow-list entrie: https://github.com/elastic/cloud/pull/131284

x-pack/platform/plugins/shared/actions/common/validate_email_addresses.ts

florent-leborgne

Hi, I'm not super familiar yet with this file.

In the new docs (since 9.0), we do not publish a new version of each page for each minor, and instead annotate the same page over time. That means that we need to ensure that anything added at a specific point in time is flagged as such. In this case, if I understand correctly, the setting will be added with 9.2.

I am just not super sure of how this file is processed exactly yet.

If this setting was already available in 9.0 and 9.1 and was just missing, you can ignore my comment.

docs/settings-gen/source/kibana-alert-action-settings.yml

docs/reference/configuration-reference/alerting-settings.md

cnasikas

LGTM! I tested and is working as expected.

x-pack/platform/plugins/shared/actions/server/actions_config.test.ts

cnasikas · 2025-07-07T10:35:10Z

x-pack/platform/plugins/shared/actions/common/validate_email_addresses.ts

  /** treat any address which contains a mustache template as valid */
  treatMustacheTemplatesAsValid?: boolean;
+  // addresses with this option won't be validated against the allowed recipient list
+  isSender?: boolean;


Suggested change

isSender?: boolean;

ignoreReceipentAllowlistValidation?: boolean;

I think it is more explicit about the purpose of the option. The isSender does not convey what the function will do. Wdyt?

I did it this way because next time we need to update the sender field behavior, we won't have to fear missing one of the existing "from" fields. But I don't care, if you feel strong about it, just let me know

I think it is better if you see the function as a standalone one but not a strong opinion either.

x-pack/platform/plugins/shared/actions/common/validate_email_addresses.ts

src/platform/packages/shared/kbn-std/src/match_wildcard_pattern.ts

…no-cache --fix'

kibanamachine · 2025-07-08T13:30:55Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#8554

[✅] x-pack/platform/test/alerting_api_integration/spaces_only/tests/actions/connector_types/stack/email_recipient_allowlist/config.ts: 200/200 tests passed.

see run history

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

…l-recipients-allow-list

elasticmachine · 2025-07-10T17:24:49Z

💚 Build Succeeded

Buildkite Build
Commit: a72150f

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`actions`	13	14	+1

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/std`	74	78	+4
`actions`	336	338	+2
total			+6

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`stackConnectors`	617.7KB	617.7KB	+14.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`actions`	17.2KB	17.8KB	+663.0B
`kbnUiSharedDeps-srcJs`	3.8MB	3.8MB	+345.0B
total			+1008.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/std`	120	124	+4
`actions`	342	344	+2
total			+6

History

💚 Build #317751 succeeded ceaad53
💚 Build #316752 succeeded 4039349
💚 Build #315834 succeeded 0e55dcf
💚 Build #315506 succeeded 495996e
💛 Build #315345 was flaky e553a79
💛 Build #301361 was flaky 6b5b730

…228230) Parent issue #210355 Merged in #220058 --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

…lastic#228230) Parent issue elastic#210355 Merged in elastic#220058 --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

…lastic#220058) ## Summary Closes elastic#210355 As this Kibana config contains sensitive data, we moved the validation to the server side only ## Release note Adds `xpack.actions.email.recipient_allowlist` kibana config. --------- Co-authored-by: lcawl <lcawley@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

…lastic#228230) Parent issue elastic#210355 Merged in elastic#220058 --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

first commit

9532ca6

jcger force-pushed the issue-210355-email-recipients-allow-list branch from 115c28e to cc5de1c Compare May 5, 2025 19:15

jcger commented May 5, 2025

View reviewed changes

use isSender flag + functional test + own solution for pattern matching

5950ac6

jcger force-pushed the issue-210355-email-recipients-allow-list branch from cc5de1c to 5950ac6 Compare May 5, 2025 19:17

jcger commented May 5, 2025

View reviewed changes

x-pack/platform/plugins/shared/actions/common/validate_email_addresses.ts Show resolved Hide resolved

jcger added 3 commits May 5, 2025 21:47

fix linter issue

317315a

Merge branch 'main' into issue-210355-email-recipients-allow-list

ebfd7a2

fix test

e90bade

jcger added backport:skip This PR does not require backporting Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// release_note:feature Makes this part of the condensed release notes v9.1.0 v8.19.0 labels May 6, 2025

Merge branch 'main' into issue-210355-email-recipients-allow-list

b5d7994

jcger marked this pull request as ready for review May 6, 2025 07:41

jcger requested review from a team as code owners May 6, 2025 07:41

Merge branch 'main' into issue-210355-email-recipients-allow-list

8b67afb

jbudz reviewed May 6, 2025

View reviewed changes

jcger requested review from a team and pmuellr May 6, 2025 14:24

add to docker generator + docs

539585c

jcger requested a review from a team as a code owner May 7, 2025 10:43

jbudz approved these changes May 7, 2025

View reviewed changes

pmuellr reviewed May 9, 2025

View reviewed changes

x-pack/platform/plugins/shared/actions/common/validate_email_addresses.ts Outdated Show resolved Hide resolved

jcger added 3 commits May 19, 2025 10:05

remove confusing auto-generated comment

9d8c11f

escape regex with lodash fn

487962a

Merge branch 'main' into issue-210355-email-recipients-allow-list

509d75e

jcger added 3 commits July 3, 2025 12:02

remove regex from wildcard match + improve tests

bc73fd6

fix lint

e553a79

remove public type

495996e

jcger marked this pull request as ready for review July 3, 2025 16:42

jcger requested a review from a team as a code owner July 3, 2025 16:42

florent-leborgne reviewed Jul 4, 2025

View reviewed changes

docs/settings-gen/source/kibana-alert-action-settings.yml Show resolved Hide resolved

florent-leborgne reviewed Jul 4, 2025

View reviewed changes

docs/reference/configuration-reference/alerting-settings.md Outdated Show resolved Hide resolved

Merge branch 'main' into issue-210355-email-recipients-allow-list

0e55dcf

cnasikas approved these changes Jul 7, 2025

View reviewed changes

review

2bc2f46

jcger force-pushed the issue-210355-email-recipients-allow-list branch from 54a50bc to 2bc2f46 Compare July 8, 2025 10:54

jcger and others added 2 commits July 8, 2025 13:55

Merge branch 'main' into issue-210355-email-recipients-allow-list

7940dfc

[CI] Auto-commit changed files from 'node scripts/eslint_all_files --…

4039349

…no-cache --fix'

jcger and others added 2 commits July 10, 2025 15:38

Apply suggestions from code review

8a53696

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>

Merge branch 'main' into issue-210355-email-recipients-allow-list

ceaad53

jcger enabled auto-merge (squash) July 10, 2025 14:02

jcger added 2 commits July 10, 2025 17:33

Merge branch 'main' of github.com:jcger/kibana into issue-210355-emai…

eda5a4a

…l-recipients-allow-list

fix conflict merge error

a72150f

jcger force-pushed the issue-210355-email-recipients-allow-list branch from 3e3ae97 to a72150f Compare July 10, 2025 15:37

jcger merged commit d824ffe into elastic:main Jul 10, 2025
12 checks passed

This was referenced Jul 16, 2025

[Response Ops][Docs] Add missing actions settings in ECH docs #228215

Merged

[Response Ops][Docs] Add recipient_allowlist setting in ECH docs #228230

Merged

tiamliu mentioned this pull request Sep 9, 2025

[Internal]: [ResponseOps] Provide an allow list for email recipient elastic/docs-content#2882

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Response Ops] Add `xpack.actions.email.recipient_allowlist` config#220058

[Response Ops] Add `xpack.actions.email.recipient_allowlist` config#220058
jcger merged 31 commits intoelastic:mainfrom
jcger:issue-210355-email-recipients-allow-list

jcger commented May 5, 2025 •

edited

Loading

jcger May 5, 2025

Uh oh!

elasticmachine commented May 6, 2025

jbudz May 6, 2025

jcger May 7, 2025 •

edited

Loading

pmuellr May 9, 2025

jcger May 19, 2025 •

edited

Loading

pmuellr May 23, 2025

Uh oh!

florent-leborgne left a comment

Uh oh!

Uh oh!

cnasikas left a comment

Uh oh!

cnasikas Jul 7, 2025

jcger Jul 8, 2025

cnasikas Jul 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

kibanamachine commented Jul 8, 2025

Uh oh!

elasticmachine commented Jul 10, 2025

API count

Labels

13 participants


		import { createTestConfig } from '../../../../../../common/config';

		export const recipientAllowList = ['.bar@example.org', '@test.com'];

	isSender?: boolean;
	ignoreReceipentAllowlistValidation?: boolean;

Conversation

jcger commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Release note

jcger May 5, 2025

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented May 6, 2025

jbudz May 6, 2025

Choose a reason for hiding this comment

jcger May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

pmuellr May 9, 2025

Choose a reason for hiding this comment

jcger May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

pmuellr May 23, 2025

Choose a reason for hiding this comment

Uh oh!

florent-leborgne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cnasikas left a comment

Choose a reason for hiding this comment

Uh oh!

cnasikas Jul 7, 2025

Choose a reason for hiding this comment

jcger Jul 8, 2025

Choose a reason for hiding this comment

cnasikas Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented Jul 8, 2025

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#8554

Uh oh!

elasticmachine commented Jul 10, 2025

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

Labels

13 participants

jcger commented May 5, 2025 •

edited

Loading

jcger May 7, 2025 •

edited

Loading

jcger May 19, 2025 •

edited

Loading

cnasikas Jul 8, 2025 •

edited

Loading