kumomta

Debugging/Tracing

This will launch the server using the policy defined in simple_policy.lua:

KUMOD_LOG=kumod=trace cargo run -p kumod -- --policy simple_policy.lua

Metrics

If the http listener is enabled, the /metrics endpoint will return a set of metrics for prometheus to scrape.

You can manually review them with curl:

$ curl 'http://127.0.0.1:8000/metrics'
# HELP connection_count connection_count
# TYPE connection_count gauge
connection_count{service="esmtp_listener"} 1
connection_count{service="smtp_client:(alt1|alt2|alt3|alt4)?.gmail-smtp-in.l.google.com."} 0
# HELP delayed_count delayed_count
# TYPE delayed_count gauge
delayed_count{queue="gmail.com"} 1

Contributing

To contribute to this project, fork it, make your edits, test and then submit a PR from the fork.

Please make one change request per PR to make it easier to approve.

Document your PR clearly with an explanation of your reasons and the changes requested.

If you include or link to any 3rd party code, fully document the source and the reason.

Code Formatting

Ensure that the code is formatted before submitting a PR. We use the following utilities to keep code formatting consistent:

StyLua to format lua
Black to format python
nightly rustfmt for Rust

Install those deps:

$ rustup toolchain install nightly
$ cargo install stylua --features lua54
$ sudo apt install black
$ # OR:
$ pip install black

Then you can format the code:

$ make fmt

Documentation Changes

Please include appropriate documentation to go along with any changes that you propose. The documentation files can be found under docs.

Remember to update the Navigation menus in docs/generate-toc.py if pages were added or deleted.

Build the new docs by running ./docs/build.sh from the root of the repo. Run ./docs/build.sh serve to run a local http server that will regenerate pages as you make edits.

Docker build

To build a lightweight alpine-based docker image:

$ ./docker/kumod/build-docker-image.sh
...
$ docker image ls kumomta/kumod
REPOSITORY      TAG       IMAGE ID       CREATED         SIZE
kumomta/kumod   latest    bbced15ff4d1   3 minutes ago   116MB

You can then run that image; this invocation mounts the kumo src dir at /config and then the KUMO_POLICY environment variable is used to override the default /config/policy.lua path to use the SMTP sink policy script sink.lua, which will accept and discard all mail:

$ sudo docker run --rm -p 2025:25 \
    -v .:/config \
    --name kumo-sink \
    --env KUMO_POLICY="/config/sink.lua" \
    kumomta/kumod

Fuzzing

Some components have fuzzer coverage. To run it, follow the setup from the Rust Fuzz Book

Then:

$ cd crates/rfc5321/
$ cargo +nightly fuzz run parser

3.0 KiB Raw Blame History