1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
//! [![Build Status](https://travis-ci.org/breard-r/rust-opensmtpd.svg?branch=main)](https://travis-ci.org/breard-r/rust-opensmtpd)
//! [![Rust-OpenSMTPD on crates.io](https://img.shields.io/crates/v/opensmtpd.svg)](https://crates.io/crates/opensmtpd)
//! [![Rust-OpenSMTPD on docs.rs](https://docs.rs/opensmtpd/badge.svg)](https://docs.rs/opensmtpd/)
//! ![License: MIT or Apache-2.0](https://img.shields.io/crates/l/opensmtpd)
//!
//! # Writing a filter for OpenSMTPD
//!
//! The first step is to define an object (most of the time you want
//! a struct) the implements the [`Filter`] trait. All of this
//! trait's methods have an empty default implementation, so you only
//! have to implement the ones that matters to you. For each method
//! you implement, you must use the [`register`] macro in order to
//! ask OpenSMTPD to send you the corresponding events and filter
//! requests.
//!
//! The second and last step is to call the [`run_filter`] function
//! with a mutable reference of your filter object.
//!
//! # Examples
//!
//! The following filter increments a variable every time a client
//! disconnects.
//!
//! ```
//! use opensmtpd::{register, run_filter, Filter, ReportEntry};
//!
//! struct MyCounter {
//!     nb: u64,
//! }
//!
//! impl Filter for MyCounter {
//!     register!(has_report_link_disconnect);
//!     fn on_report_link_disconnect(&mut self, _entry: &ReportEntry) {
//!         self.nb + 1;
//!     }
//! }
//!
//! fn main() {
//!     let mut my_counter = MyCounter { nb: 0, };
//!     run_filter(&mut my_counter);
//! }
//! ```
//!
//! More examples can be found in the [examples directory](https://github.com/breard-r/rust-opensmtpd/tree/main/examples).

mod data_line;
mod data_structures;
mod error;
mod filter;
mod io;
mod parsers;
mod process;

pub use crate::data_line::return_data_line;
pub use crate::data_structures::address::Address;
pub use crate::data_structures::auth_result::AuthResult;
pub use crate::data_structures::event::Event;
pub use crate::data_structures::filter_kind::FilterKind;
pub use crate::data_structures::filter_phase::FilterPhase;
pub use crate::data_structures::filter_response::FilterResponse;
pub use crate::data_structures::mail_result::MailResult;
pub use crate::data_structures::method::Method;
pub use crate::data_structures::smtp_status::SmtpStatusCode;
pub use crate::data_structures::subsystem::SubSystem;
pub use crate::data_structures::timeval::TimeVal;
pub use crate::filter::Filter;
pub use crate::parsers::entry::{FilterEntry, ReportEntry};

use crate::parsers::handshake::parse_handshake;
use std::sync::mpsc::channel;
use std::thread;

const BUFFER_SIZE: usize = 4096;

#[macro_export]
macro_rules! register {
    ($name: ident) => {
        fn $name(&self) -> bool {
            return true;
        }
    };
}

macro_rules! recv {
    ($rx: ident) => {
        match $rx.recv() {
            Ok(b) => b,
            Err(e) => {
                log::error!("{}", e);
                return;
            }
        }
    };
}

pub fn run_filter<T>(user_object: &mut T)
where
    T: Filter,
{
    // IO init
    let (tx, rx) = channel::<Vec<u8>>();
    thread::spawn(move || {
        io::read_stdin(&tx);
    });

    // Handshake
    let mut handshake_buffer: Vec<u8> = Vec::with_capacity(BUFFER_SIZE);
    let handshake = loop {
        let buffer = recv!(rx);
        handshake_buffer.extend_from_slice(&buffer);
        if let Ok((_, handshake)) = parse_handshake(&handshake_buffer) {
            break handshake;
        }
    };
    handshake_reply(user_object, handshake.subsystem);

    // Read and process input
    loop {
        let buffer = recv!(rx);
        if let Err(msg) = process::line(user_object, &buffer) {
            log::error!("{}", msg);
        }
    }
}

macro_rules! handshake_register {
    ($obj: ident, $func: ident, $subsystem: expr, $type: expr, $name: expr) => {
        if $obj.$func() {
            println!("register|{}|{}|{}", $type, $subsystem.to_string(), $name);
            log::trace!("{} {} for {} registered", $type, $name, $subsystem.to_string());
        }
    };
}

fn handshake_reply<T>(obj: &mut T, ss: SubSystem)
where
    T: Filter,
{
    // Filters
    handshake_register!(obj, has_filter_auth, ss, "report", "auth");
    handshake_register!(obj, has_filter_commit, ss, "report", "commit");
    handshake_register!(obj, has_filter_connect, ss, "report", "connect");
    handshake_register!(obj, has_filter_data, ss, "report", "data");
    handshake_register!(obj, has_filter_data_line, ss, "report", "data-line");
    handshake_register!(obj, has_filter_ehlo, ss, "report", "ehlo");
    handshake_register!(obj, has_filter_helo, ss, "report", "helo");
    handshake_register!(obj, has_filter_mail_from, ss, "report", "mail-from");
    handshake_register!(obj, has_filter_rcpt_to, ss, "report", "rcpt-to");
    handshake_register!(obj, has_filter_starttls, ss, "report", "starttls");

    // Reports
    handshake_register!(obj, has_report_link_auth, ss, "report", "link-auth");
    handshake_register!(obj, has_report_link_connect, ss, "report", "link-connect");
    handshake_register!(
        obj,
        has_report_link_disconnect,
        ss,
        "report",
        "link-disconnect"
    );
    handshake_register!(obj, has_report_link_greeting, ss, "report", "link-greeting");
    handshake_register!(obj, has_report_link_identify, ss, "report", "link-identify");
    handshake_register!(obj, has_report_link_tls, ss, "report", "link-tls");
    handshake_register!(obj, has_report_tx_begin, ss, "report", "tx-begin");
    handshake_register!(obj, has_report_tx_mail, ss, "report", "tx-mail");
    handshake_register!(obj, has_report_tx_reset, ss, "report", "tx-reset");
    handshake_register!(obj, has_report_tx_rcpt, ss, "report", "tx-rcpt");
    handshake_register!(obj, has_report_tx_envelope, ss, "report", "tx-envelope");
    handshake_register!(obj, has_report_tx_data, ss, "report", "tx-data");
    handshake_register!(obj, has_report_tx_commit, ss, "report", "tx-commit");
    handshake_register!(obj, has_report_tx_rollback, ss, "report", "tx-rollback");
    handshake_register!(
        obj,
        has_report_protocol_client,
        ss,
        "report",
        "protocol-client"
    );
    handshake_register!(
        obj,
        has_report_protocol_server,
        ss,
        "report",
        "protocol-server"
    );
    handshake_register!(
        obj,
        has_report_filter_response,
        ss,
        "report",
        "filter-response"
    );
    handshake_register!(obj, has_report_filter_report, ss, "report", "filter-report");
    handshake_register!(obj, has_report_timeout, ss, "report", "timeout");

    // Ready
    println!("register|ready");
    log::trace!("register ready");
}