-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
EOP-164: add support pages for MTA-STS in Momentum #760
Open
juliebin
wants to merge
14
commits into
main
Choose a base branch
from
EOP-164
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
158b14d
add support pages for MTA-STS in Momentum
juliebin 30f2f6b
update
juliebin b34fc8b
update debug_flags for MTA-STS
juliebin 07da5a2
minor format
juliebin fd65939
mta_sts ec_console commands
juliebin 43de084
more minor changes
juliebin 0b767dc
minor update
juliebin 68aac62
minor update
juliebin 57d115d
add mta-sts config options and control commands into summaries
juliebin ea735d4
review comments
juliebin 25360eb
link to mta-sts config options
juliebin d4fcc78
add new file
juliebin e3f70dd
update link
juliebin c1c29b3
typos
juliebin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
lastUpdated: "06/01/2024" | ||
title: "enable_mta_sts" | ||
description: "config option to enable MTA-STS policy application for outbound mails" | ||
--- | ||
|
||
<a name="config.enable-mta-sts"></a> | ||
## Name | ||
|
||
enable_mta_sts — specify whether Momentum should apply MTA-STS policies for outbound emails | ||
|
||
## Synopsis | ||
|
||
`enable_mta_sts = "true|false"` | ||
|
||
## Description | ||
|
||
This option is only effective when [use_mta_sts](/momentum/4/config/mta-sts/use-mta-sts) is `true` | ||
for a recipient domain. | ||
This option specifies whether Momentum should try to apply the retrieved MTA-STS policy when sending | ||
emails to a remote site. See [MTA-STS support in Momentum](/momentum/4/mta-sts) for more details. | ||
|
||
|
||
When this option is `true`, the MTA-STS policy mode will be considered along with the configuration | ||
values for [TLS](/momentum/4/config/ref-tls) and [TLS_Verify](/momentum/4/config/tls-verify). | ||
The more strict policy will apply. E.g. When the MTA-STS policy mode is `enforce`, regardless of the | ||
values for `TLS` and `TLS_Verify`, Momentum will enforce TLS (equivalent to `TLS = required`) and | ||
will fail the delivery upon a failed certificate validation (equivalent to `TLS_Verify = host`). | ||
|
||
When the MTA-STS policy mode is `testing`, Momentum will apply `TLS = ifavailable` (unless | ||
`TLS = required` is specified) and `TLS_Verify = optional` (unless `TLS_Verify = host` is | ||
specified). | ||
|
||
When the MTA-STS policy mode is `none`, the policy will be ignored and the configuration values for | ||
`TLS` and `TLS_Verify` will be respected. | ||
|
||
The default value is `true` when `use_mta_sts` is `true` for a domain. | ||
|
||
|
||
## Scope | ||
|
||
`enable_mta_sts` is valid in the binding, binding_group, domain and global scopes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
lastUpdated: "06/01/2024" | ||
title: "Category File" | ||
type: "custom" | ||
name: "MTA-STS Configuration Options Reference" | ||
description: "MTA-STS configuration Options index" | ||
--- | ||
|
||
- [use_mta_sts](/momentum/4/config/mta-sts/use-mta-sts) | ||
- [enable_mta_sts](/momentum/4/config/mta-sts/enable-mta-sts) | ||
- [mta_sts_dns_cname_max_depth](/momentum/4/config/mta-sts/mta-sts-dns-cname-max-depth) | ||
- [mta_sts_policy_store](/momentum/4/config/mta-sts/mta-sts-policy-store) | ||
|
||
|
31 changes: 31 additions & 0 deletions
31
content/momentum/4/config/mta-sts/mta-sts-dns-cname-max-depth.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
lastUpdated: "06/01/2024" | ||
title: "mta_sts_dns_cname_max_depth" | ||
description: "config option on how many continous cname lookups are allowed when doing MTA-STS TXT | ||
record lookup for a domain" | ||
--- | ||
|
||
<a name="config.mta-sts-dns-cname-max-depth"></a> | ||
## Name | ||
|
||
mta_sts_dns_cname_max_depth — specifies how many continous cname lookups are allowed when doing DNS | ||
lookups for MTA-STS TXT record for a domain. Exceeding the configured value will be treated as a DNS | ||
lookup failure, which will be further treated as no MTA-STS policy available. | ||
|
||
## Synopsis | ||
|
||
`mta_sts_dns_cname_max_depth = 5` | ||
|
||
## Description | ||
|
||
Momentum supports MTA-STS policy delegation, which points the `_mta-sts` TXT record for the policy | ||
domain via `CNAME` (to the `_mta-sts` record maintained by the provider). Momentum's DNS lookup | ||
will follow the `CNAME`s. To avoid a DNS lookup loop, Momentum uses this config option to limit how | ||
many continuous `CNAME` lookups can happen before claiming a lookup failure. | ||
|
||
The default value is `5`. | ||
|
||
|
||
## Scope | ||
|
||
`mta_sts_dns_cname_max_depth` is valid in the domain and global scopes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
lastUpdated: "06/01/2024" | ||
title: "mta_sts_policy_store" | ||
description: "the location to store the MTA-STS policy" | ||
--- | ||
|
||
<a name="config.mta-sts-policy-store"></a> | ||
## Name | ||
|
||
mta_sts_policy_store — specifies the location to keep the MTA-STS policy details for the domains. | ||
|
||
## Synopsis | ||
|
||
`mta_sts_policy_store = "/var/spool/ecelerity/mtasts"` | ||
|
||
## Description | ||
|
||
Momentum stores MTA-STS policy for a domain in a file on disk, and accesses the HTTPS endpoint to refresh the | ||
policy once every 24 hours. This config option specifies the directory where the policies are stored | ||
on the disk. | ||
|
||
The default value is `/var/spool/ecelerity/mtasts`. | ||
|
||
|
||
## Scope | ||
|
||
`mta_sts_policy_store` is valid in the global scope. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
lastUpdated: "06/01/2024" | ||
title: "use_mta_sts" | ||
description: "config option to enable MTA-STS policy fetching for a domain" | ||
--- | ||
|
||
<a name="config.use-mta-sts"></a> | ||
## Name | ||
|
||
use_mta_sts — specify whether Momentum should do MTA-STS policy fetching for a domain | ||
|
||
## Synopsis | ||
|
||
`use_mta_sts = "true|false"` | ||
|
||
## Description | ||
|
||
This option specifies whether Momentum shall attempt to discover the recipient domain's MTA-STS | ||
policy (via a DNS TXT lookup to retrieve the MTA-STS policy ID and a HTTPS lookup to retrieve the | ||
MTA-STS policy) | ||
|
||
The default value is `false`. | ||
|
||
|
||
## Scope | ||
|
||
`use_mta_sts` is valid in the domain and global scopes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
lastUpdated: "02/09/2021" | ||
lastUpdated: "06/01/2024" | ||
title: "Category File" | ||
type: "custom" | ||
name: "Non-Module-Specific Console Commands" | ||
|
@@ -44,6 +44,7 @@ description: "This section documents all the non module specific console command | |
| [message fail quiet](/momentum/4/console-commands/message-fail-quiet) | fail a message and do not create a non-delivery receipt (NDR) | | ||
| [message retry](/momentum/4/console-commands/message-retry) | perform an immediate delivery attempt on a message | | ||
| [module](/momentum/4/console-commands/4-module) | manage loaded modules online | | ||
| [mta_sts](/momentum/4/console-commands/mta_sts) | commands to display and manage MTA-STS policy for a domain | | ||
| [\pager](/momentum/4/console-commands/pager) | Page output of long console commands in the console. | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Isn't this duplicated? |
||
| [paniclog](/momentum/4/console-commands/paniclog) | show last several entries written to paniclog | | ||
| [pid](/momentum/4/console-commands/pid) | show process id of Momentum | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
lastUpdated: "06/01/2024" | ||
title: "mta_sts" | ||
description: "mta_sts ec_console commands" | ||
--- | ||
|
||
<a name="console_commands.mta-sts"></a> | ||
## Name | ||
|
||
mta_sts - commands for MTA-STS related data | ||
|
||
## Synopsis | ||
|
||
`mta_sts list all` | ||
|
||
`mta_sts show domain {domain name}` | ||
|
||
`mta_sts refresh policy {domain name}` | ||
|
||
## Description | ||
|
||
**mta_sts list all** - lists all the active domains which have MTA-STS policies | ||
|
||
``` | ||
15:42:38 /tmp/2025> mta_sts list all | ||
gmail.com | ||
Total domains: 1 | ||
``` | ||
|
||
**mta-sts show domain { domain name }** - shows MTA-STS TXT record and policy details of a given domain. | ||
The same content will be shown in [domain](/momentum/4/console-commands/domain) command output also if | ||
available. | ||
|
||
|
||
``` | ||
18:13:43 /tmp/2025> mta_sts show domain gmail.com | ||
Domain 'gmail.com' has MTA-STS TXT and a TTL of 185 seconds | ||
id: 20190429T010101 | ||
max_age: 86400 seconds; refresh in 86375 seconds | ||
mode: enforce | ||
mxlist: | ||
gmail-smtp-in.l.google.com | ||
*.gmail-smtp-in.l.google.com | ||
``` | ||
|
||
**mta-sts refresh policy {domain name}** - forces MTA-STS policy refresh by fetching the policy | ||
from the HTTPS endpoint for a given domain | ||
|
||
|
||
``` | ||
18:14:41 /tmp/2025> mta_sts refresh policy gmail.com | ||
MTA-STS policy for gmail.com refreshed. | ||
``` |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On this page, clicking the
mta-sts
link in the breadcrumb gives me a 404. Can we fix it? Please review breadcrumbs in all new pages.