maik 0.2.0

A mock SMTP server library
Documentation
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
use crate::assertion::MailAssertion;
use crate::client_state::{AuthState, ClientState};
use crate::mail::Mail;
use crate::mailbox::Mailbox;
use crate::response;
use crate::stream::Stream;
use base64::{engine::general_purpose::STANDARD, Engine};
use lazy_static::lazy_static;
use native_tls::{Identity, TlsAcceptor};
use rcgen::{generate_simple_self_signed, CertifiedKey};
use regex::bytes::Regex;
use std::io;
use std::net::{IpAddr, SocketAddr, TcpListener};
use std::sync::{Arc, Mutex};
use wg::WaitGroup;

lazy_static! {
    static ref RE_SEP: Regex = Regex::new(r"( |\r\n)").unwrap();
    static ref RE_MAIL_USER: Regex = Regex::new(r".*<(.*?)>").unwrap();
    static ref RE_BODY: Regex = Regex::new(r"(?s)(.*?)(\r\n\.\r\n|\z)").unwrap();
}

enum AuthError {
    InvalidCredentials,
    UnsupportedMethod,
}

/// A mock SMTP server.
///
/// Use [`MockServer::builder()`] to construct instances of this struct via [`MockServerBuilder`]s.
#[derive(Clone)]
pub struct MockServer {
    listener: Arc<TcpListener>,
    host: IpAddr,
    port: u16,
    domain: String,
    tls_acceptor: TlsAcceptor,
    cert_pem: String,
    require_tls: bool,
    mailboxes: Vec<Mailbox>,
    mails: Arc<Mutex<Vec<Mail>>>,
    no_verify_credentials: bool,
    remaining_emails: Option<u8>,
    wg: WaitGroup,
}

/// Builder for configuring and creating [`MockServer`].
///
/// Constructed via [`MockServer::builder()`].
#[derive(Default)]
pub struct MockServerBuilder {
    domain: String,
    require_tls: bool,
    mailboxes: Vec<Mailbox>,
    no_verify_credentials: bool,
    remaining_emails: Option<u8>,
}

impl MockServerBuilder {
    fn new() -> Self {
        Self {
            domain: env!("CARGO_CRATE_NAME").to_string(),
            ..Default::default()
        }
    }

    /// Creates a [`MockServer`] from the configuration of this builder.
    pub fn build(self) -> MockServer {
        let listener = TcpListener::bind("127.0.0.1:0").expect("Failed to bind tcp listener");
        let addr = listener.local_addr().unwrap();
        let host = addr.ip();
        let CertifiedKey { cert, key_pair } = generate_simple_self_signed([host.to_string()])
            .expect("Failed to generate certificate");
        let cert_pem = cert.pem();
        let identity =
            Identity::from_pkcs8(cert_pem.as_bytes(), key_pair.serialize_pem().as_bytes())
                .expect("Failed to create ssl identity");
        MockServer {
            listener: Arc::new(listener),
            host,
            port: addr.port(),
            domain: self.domain,
            tls_acceptor: TlsAcceptor::new(identity).expect("Failed to create tls acceptor"),
            cert_pem,
            require_tls: self.require_tls,
            mailboxes: self.mailboxes,
            mails: Arc::new(Mutex::new(Vec::new())),
            no_verify_credentials: self.no_verify_credentials,
            remaining_emails: self.remaining_emails,
            wg: WaitGroup::new(),
        }
    }

    /// Sets the domain name used in the ready message and the EHLO/HELO replies.
    pub fn domain(mut self, domain: &str) -> Self {
        self.domain = String::from(domain);
        self
    }

    /// Requires clients to use TLS.
    pub fn require_tls(mut self) -> Self {
        self.require_tls = true;
        self
    }

    /// Skips credentials verification during the `AUTH` command.
    ///
    /// **Note**: Clients must still send an `AUTH` command before `MAIL`.
    pub fn no_verify_credentials(mut self) -> Self {
        self.no_verify_credentials = true;
        self
    }

    /// Waits for n emails before triggering [assertion](MockServer::assert).
    /// If unset, [`MockServer::assert`] waits until the client closes the connection,
    /// which could hang forever against long-lived clients that never disconnect.
    ///
    /// # Panics
    ///
    /// Panics if `n` is 0.
    pub fn assert_after_n_emails(mut self, n: u8) -> Self {
        if n == 0 {
            panic!("close_after_n: n must be greater than 0");
        }
        self.remaining_emails = Some(n);
        self
    }

    /// Adds a mailbox with the given user and password to the server for client authentication.
    pub fn add_mailbox(mut self, user: &str, password: &str) -> Self {
        self.mailboxes.push(Mailbox::new(user, password));
        self
    }
}

impl MockServer {
    /// Creates a [`MockServerBuilder`] for creating [`MockServer`].
    pub fn builder() -> MockServerBuilder {
        MockServerBuilder::new()
    }

    /// Returns the local IP address the server runs on.
    pub fn host(&self) -> IpAddr {
        self.host
    }

    /// Returns the TCP port number the server is listening on.
    pub fn port(&self) -> u16 {
        self.port
    }

    /// Returns the PEM encoded TLS certificate of the server.
    pub fn cert_pem(&self) -> &[u8] {
        self.cert_pem.as_bytes()
    }

    /// Asserts the given assertion against the server.
    ///
    /// Blocks until either:
    /// - the client disconnects, or
    /// - the configured number of messages have been received.
    pub fn assert(&self, assertion: MailAssertion) -> bool {
        self.wg.wait();
        assertion.assert(&self.mails.lock().unwrap())
    }

    /// Starts the server in a background thread.
    pub fn start(&self) {
        let server = Arc::new(Mutex::new(self.clone()));
        let server = Arc::clone(&server);
        std::thread::spawn(move || {
            let mut server = server.lock().unwrap();
            while let Ok((stream, socket)) = server.listener.accept() {
                server.wg.add(1);
                server.handle_client(socket, Stream::Plain(stream));
                if server.remaining_emails.is_none() {
                    server.wg.done();
                }
            }
        });
    }

    fn ready_message(&self) -> Vec<u8> {
        format!("220 {} Service ready\r\n", self.domain)
            .as_bytes()
            .to_vec()
    }

    fn handle_client(&mut self, socket: SocketAddr, mut stream: Stream) {
        if let Err(e) = stream.write_all(&self.ready_message()) {
            println!("Failed to send response to {}: {}", socket, e);
        }

        let mut buffer = vec![0; 128];
        let mut client_state = ClientState::new();

        while let Ok(size) = stream.read(&mut buffer) {
            let data = &buffer[..size];
            if let Ok(data_str) = std::str::from_utf8(data) {
                println!("{} sent: {}", socket, data_str);
            } else {
                println!("{} sent invalid UTF-8 data", socket);
            }

            match self.handle_stream(stream, data, &mut client_state) {
                Ok(new_stream) => stream = new_stream,
                Err(e) => {
                    println!("Failed to send response to {}: {}", socket, e);
                    break;
                }
            }
        }
        println!("Connection closed");
    }

    fn handle_stream(
        &mut self,
        mut stream: Stream,
        data: &[u8],
        client_state: &mut ClientState,
    ) -> Result<Stream, io::Error> {
        if data.is_empty() {
            // same client reconnecting after QUIT
            stream.write_all(&self.ready_message())?;
        }

        if client_state.mail_transaction.is_receiving_data {
            let captures = RE_BODY.captures(data).unwrap();
            let body = captures.get(1).unwrap().as_bytes();
            let mut i = 0;
            while i < body.len() {
                if i + 3 < body.len() && body[i..i + 4] == *b"\r\n.." {
                    client_state.mail_transaction.body.extend(b"\r\n.");
                    i += 4;
                } else {
                    client_state.mail_transaction.body.push(body[i]);
                    i += 1;
                }
            }
            if captures.get(2).unwrap().as_bytes() == b"\r\n.\r\n" {
                let mail = Mail::new(
                    client_state.mail_transaction.sender.to_owned().unwrap(),
                    client_state.mail_transaction.recipients.to_owned(),
                    client_state.mail_transaction.body.to_owned(),
                );
                self.mails.lock().unwrap().push(mail);
                client_state.mail_transaction.reset();
                if let Some(remaining) = self.remaining_emails.as_mut() {
                    *remaining -= 1;
                    if *remaining == 0 {
                        self.wg.done();
                    }
                }
            }
            stream.write_all(response::OK)?;
            return Ok(stream);
        }

        if let Ok(user) = match client_state.auth_state {
            AuthState::Plain => self.authenticate_plain(data),
            _ => {
                let (command, arg) = parse_command(data);
                return self.handle_command(stream, command, arg, client_state);
            }
        } {
            client_state.authed_user = Some(user);
            client_state.auth_state = AuthState::Completed;
            stream.write_all(response::AUTH_SUCCESS)?;
        } else {
            stream.write_all(response::AUTH_INVALID_CREDENTIALS)?;
        }
        Ok(stream)
    }

    fn handle_command(
        &mut self,
        mut stream: Stream,
        command: Vec<u8>,
        arg: Vec<u8>,
        client_state: &mut ClientState,
    ) -> Result<Stream, io::Error> {
        if command == b"ehlo" {
            client_state.reset();
            client_state.has_ehloed = true;
            let auth_methods = "AUTH PLAIN";
            let response = if client_state.is_tls_established {
                format!(
                    "250-{}\r\n\
                    250 {}\r\n",
                    self.domain, auth_methods
                )
            } else {
                format!(
                    "250-{}\r\n\
                    250-{}\r\n\
                    250 STARTTLS\r\n",
                    self.domain, auth_methods
                )
            };
            stream.write_all(response.as_bytes())?;
        } else if command == b"helo" {
            client_state.reset();
            client_state.has_ehloed = true;
            stream.write_all(format!("250 {}\r\n", &self.domain).as_bytes())?;
        } else if command == b"quit" {
            stream.write_all(b"221 OK\r\n")?;
            stream.shutdown()?;
        } else if command == b"noop" {
            stream.write_all(response::OK)?;
        } else if command == b"starttls" {
            if arg.is_empty() {
                stream.write_all(b"220 Ready to start TLS\r\n")?;
                let stream = self.upgrade_to_tls(stream)?;
                client_state.is_tls_established = true;
                client_state.has_ehloed = false;
                return Ok(stream);
            } else {
                stream.write_all(b"501 Syntax error (no parameters allowed)\r\n")?;
            }
        } else if self.require_tls && !client_state.is_tls_established {
            stream.write_all(b"530 5.7.0 Must issue a STARTTLS command first\r\n")?;
        } else if command == b"auth" {
            if client_state.authed_user.is_some() {
                stream.write_all(b"503 Already authenticated\r\n")?;
            } else if client_state.mail_transaction.sender.is_some() {
                stream.write_all(b"503 Cannot authenticate during a mail transaction\r\n")?;
            } else {
                let mut parts = arg.splitn(2, |&c| c == b' ');
                let method = parts.next().unwrap_or_default().to_ascii_lowercase();
                let answer = parts.next().unwrap_or_default();
                if answer.is_empty() {
                    if (match method.as_slice() {
                        b"plain" => {
                            client_state.auth_state = AuthState::Plain;
                            Ok(())
                        }
                        _ => Err(stream.write_all(response::AUTH_UNSUPPORTED_METHOD)?),
                    })
                    .is_ok()
                    {
                        stream.write_all(b"334 \r\n")?; // intentional trailing space
                    }
                } else if answer == b"*" {
                    stream.write_all(b"501 Authentication cancelled by client\r\n")?;
                } else {
                    if self.no_verify_credentials {
                        client_state.auth_state = AuthState::Completed;
                    } else {
                        match match method.as_slice() {
                            b"plain" => self.authenticate_plain(answer),
                            _ => Err(AuthError::UnsupportedMethod),
                        } {
                            Ok(user) => {
                                client_state.authed_user = Some(user);
                                client_state.auth_state = AuthState::Completed;
                            }
                            Err(AuthError::UnsupportedMethod) => {
                                stream.write_all(response::AUTH_UNSUPPORTED_METHOD)?
                            }
                            Err(AuthError::InvalidCredentials) => {
                                stream.write_all(response::AUTH_INVALID_CREDENTIALS)?
                            }
                        }
                    }

                    if client_state.auth_state == AuthState::Completed {
                        //client_state.has_ehloed = false; https://github.com/lettre/lettre/issues/970
                        stream.write_all(response::AUTH_SUCCESS)?;
                    }
                }
            }
        } else if command == b"mail" {
            if !client_state.has_ehloed {
                stream.write_all(b"503 Session has not been opened with EHLO/HELO\r\n")?;
            } else if client_state.mail_transaction.sender.is_some() {
                stream.write_all(b"503 A mail transaction is already in progress\r\n")?;
            } else if client_state.auth_state != AuthState::Completed {
                stream.write_all(b"530 5.7.0 Authentication required\r\n")?;
            } else {
                // arg is in format of FROM:optional name <email>
                match RE_MAIL_USER
                    .captures(&arg[5..])
                    .map(|c| c.get(1))
                    .map(|c| c.unwrap().as_bytes())
                {
                    Some(address) => {
                        if self.no_verify_credentials
                            || address == client_state.authed_user.as_ref().unwrap()
                        {
                            client_state.mail_transaction.sender = Some(address.to_vec());
                            stream.write_all(response::OK)?;
                        } else {
                            stream.write_all(response::BAD_MAILBOX_SYNTAX)?;
                        }
                    }
                    None => stream.write_all(response::BAD_MAILBOX_SYNTAX)?,
                }
            }
        } else if command == b"data" {
            if client_state.mail_transaction.sender.is_none() {
                stream.write_all(response::NO_MAIL_TRANSACTION)?;
            } else if client_state.mail_transaction.recipients.is_empty() {
                stream.write_all(b"503 No recipients\r\n")?;
            } else {
                client_state.mail_transaction.is_receiving_data = true;
                stream.write_all(b"354 Start mail input; end with <CRLF>.<CRLF>\r\n")?;
            }
        } else if command == b"rset" {
            client_state.reset();
            stream.write_all(response::OK)?;
        } else if command == b"rcpt" {
            if client_state.mail_transaction.sender.is_none() {
                stream.write_all(response::NO_MAIL_TRANSACTION)?;
            } else {
                // arg is in format of TO:<email>
                match RE_MAIL_USER
                    .captures(&arg[3..])
                    .map(|c| c.get(1))
                    .map(|c| c.unwrap().as_bytes())
                {
                    Some(recipient) => {
                        client_state
                            .mail_transaction
                            .recipients
                            .insert(recipient.to_vec());
                        stream.write_all(response::OK)?;
                    }
                    None => stream.write_all(response::BAD_MAILBOX_SYNTAX)?,
                }
            }
        } else if command == b"vrfy" {
            stream.write_all(b"252\r\n")?;
        } else {
            stream.write_all(b"500 Unrecognized command\r\n")?;
        }
        Ok(stream)
    }

    fn upgrade_to_tls(&self, stream: Stream) -> Result<Stream, io::Error> {
        match stream {
            Stream::Plain(plain_stream) => Ok(Stream::Tls(
                self.tls_acceptor
                    .accept(plain_stream)
                    .expect("Failed to accept stream"),
            )),
            Stream::Tls(_) => Err(io::Error::new(
                io::ErrorKind::AlreadyExists,
                "Connection is already tls",
            )),
        }
    }

    fn authenticate_plain(&self, token: &[u8]) -> Result<Vec<u8>, AuthError> {
        let creds = STANDARD
            .decode(token)
            .map_err(|_| AuthError::InvalidCredentials)?;
        // creds is in format of \0username\0password
        let mut parts = creds.split(|&b| b == 0).skip(1);
        let user = parts.next().unwrap_or_default();
        let password = parts.next().unwrap_or_default();
        for mailbox in &self.mailboxes {
            if mailbox.authenticate(user, password) {
                return Ok(user.to_vec());
            }
        }
        Err(AuthError::InvalidCredentials)
    }
}

fn parse_command(command: &[u8]) -> (Vec<u8>, Vec<u8>) {
    let mut parts = RE_SEP.splitn(&command[..command.len() - 2], 2); // trim the \r\n
    let verb = parts.next().unwrap().to_ascii_lowercase();
    let arg = parts.next().unwrap_or_default().to_vec();
    (verb, arg)
}