mirror of
https://github.com/mailscope/kumomta.git
synced 2026-09-05 10:08:56 +00:00
Wez Furlong
42bf5c5e61
We've been hoping that mkdocs-material will ship the much anticipated search enhancements for some time, but it's time to recognize that we need to do something to improve the search results with how things work right now. This is a big commit that changes the titles of the various pages from the code-annotated synopsis to just the name of the function. This makes it much easier now to match things like `kumo.reject` directly, but `reject` remains awkward to find. I think this is the best that we can do at this time. A few functions have been annotated with the `status: deprecated` to show as deprecated in the toc/nav (shows with a little trash can next to the name).
60 lines
1.6 KiB
Markdown
60 lines
1.6 KiB
Markdown
# add_authentication_results
|
|
|
|
```lua
|
|
message:add_authentication_results(server_id, results)
|
|
```
|
|
|
|
{{since('2023.11.28-b5252a41')}}
|
|
|
|
This method will prepend an `Authentication-Results` header to the message, as
|
|
specified by [RFC 8601](https://datatracker.ietf.org/doc/html/rfc8601).
|
|
|
|
The parameters are:
|
|
|
|
* `server_id` - the *authserv-id*. It is suggested to use
|
|
`msg:get_meta('hostname')` to obtain the hostname that was configured in
|
|
the corresponding SMTP listener.
|
|
* `results` - an array of [authenticationresult](../authenticationresult.md)
|
|
objects holding the results of various authentication methods.
|
|
|
|
## Example: obtaining DKIM authentication results
|
|
|
|
```lua
|
|
kumo.on('smtp_server_message_received', function(msg, conn_meta)
|
|
-- Verify the dkim signature and return the results.
|
|
-- Note that this example isn't making any policy decisions;
|
|
-- it is only annotating the message with the results and
|
|
-- allowing it to be relayed
|
|
local auth_results = msg:dkim_verify()
|
|
|
|
local spf_result = kumo.spf.check_host(
|
|
msg:sender().domain,
|
|
conn_meta,
|
|
tostring(msg:sender())
|
|
)
|
|
|
|
-- add the spf authentication result to our collection of results
|
|
table.insert(auth_results, spf_result.result)
|
|
|
|
-- Add the results to the message
|
|
msg:add_authentication_results(msg:get_meta 'hostname', auth_results)
|
|
end)
|
|
```
|
|
|
|
might produce an `Authentication-Results` header like this:
|
|
|
|
```
|
|
Authentication-Results: hostname.example.com;
|
|
dkim=pass
|
|
header.a=rsa-sha256
|
|
header.b=jo0EO4dX
|
|
header.d=github.com
|
|
header.i=@github.com
|
|
header.s=pf2023
|
|
spf=pass
|
|
```
|
|
|
|
## See Also:
|
|
|
|
* [msg:dkim_verify()](dkim_verify.md)
|