Git Product home page Git Product logo

howto-opensmtpd-filters-and-reports's Introduction

Howto use filters / reports in OpenSmtpd

Since release 6.4.0 OpenSmtpd has support for external filters.
It takes some time to understand its concept.
Here is a small showcase about it.

Quickstart

  1. Install OpenSMTPD
  2. Create a simple smtpd.conf
filter afilter proc-exec "/usr/bin/python3 /tmp/afilter/afilter.py"
listen on eth0 port smtp filter { afilter } 
action "inbound" mbox
action "outbound" relay filter {afilter}
match from any for local action "inbound"
match from local for any action "outbound"
  1. Copy afilter.py and afilter_utils.py to the right location.
  2. Start smtpd: smtpd -f smtpd.conf -d
  3. Test your SMTP server: swaks -f [email protected] -t [email protected] -s localhost -ehlo home.local
  4. Watch your output:
  • Request: OpenSmtpd -> Filter color is purple
  • Response: OpenSmtpd <- Filter color is green 6See results complete log in /tmp/opensmtpd_afilter.log

How does it work?

alt text

See also: ./sample_log.txt

Some ideas

  1. Implement abstract methods like FilterSmtpIn->mail_from(ctx, address)
class ReportSmtpIn(IReportSmtpIn):
    @staticmethod
    def link_connect(ctx, rdns, fcrdns, src, dest):
        # your implementation
        pass
  1. Listen only for special reports / filters
hooks = [
    ReportSmtpIn.link_connect, ...
]

Further links:

howto-opensmtpd-filters-and-reports's People

Contributors

beutlin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.