Haraka 3.0.2 → 3.0.4

package/test/server.js

@@ -0,0 +1,491 @@
+const assert = require('node:assert')
+const path = require('node:path');
+
+const endpoint = require('../endpoint');
+const message = require('haraka-email-message')
+
+const _set_up = (done) => {
+    this.config = require('haraka-config');
+    this.server = require('../server');
+    done();
+}
+
+const _setupServer = (ip_port, done) => {
+    process.env.YES_REALLY_DO_DISCARD=1;   // for queue/discard plugin
+    process.env.HARAKA_TEST_DIR=path.resolve('test');
+
+    // test sets the default path for plugin instances to the test dir
+    const test_cfg_path=path.resolve('test');
+
+    this.server = require('../server');
+    this.config = require('haraka-config').module_config(test_cfg_path);
+    this.server.logger.loglevel = 6;  // INFO
+
+    // set the default path for the plugin loader
+    this.server.config = this.config.module_config(test_cfg_path);
+    this.server.plugins.config = this.config.module_config(test_cfg_path);
+    // this.server.outbound.config = this.config.module_config(this_cfg_path);
+
+    this.server.load_smtp_ini();
+    this.server.cfg.main.listen = ip_port;
+    this.server.cfg.main.smtps_port = 2465;
+
+    this.server.load_default_tls_config(() => {
+        this.server.createServer({});
+        setTimeout(() => {
+            done();
+        }, 200);
+    })
+}
+
+const _tearDownServer = (done) => {
+    delete process.env.YES_REALLY_DO_DISCARD;
+    delete process.env.HARAKA_TEST_DIR;
+    this.server.stopListeners();
+    this.server.plugins.registered_hooks = {};
+    setTimeout(() => {
+        done();
+    }, 200);
+}
+
+describe('server', () => {
+
+    describe('get_listen_addrs', () => {
+        beforeEach(_set_up)
+
+        it('IPv4 fully qualified', () => {
+            const listeners = this.server.get_listen_addrs({listen: '127.0.0.1:25'});
+            assert.deepEqual(['127.0.0.1:25'], listeners);
+        })
+
+        it('IPv4, default port', () => {
+            const listeners = this.server.get_listen_addrs({listen: '127.0.0.1'});
+            assert.deepEqual(['127.0.0.1:25'], listeners);
+        })
+
+        it('IPv4, custom port', () => {
+            const listeners = this.server.get_listen_addrs({ listen: '127.0.0.1'}, 250);
+            assert.deepEqual(['127.0.0.1:250'], listeners);
+        })
+
+        it('IPv6 fully qualified', () => {
+            const listeners = this.server.get_listen_addrs({listen: '[::1]:25'});
+            assert.deepEqual(['[::1]:25'], listeners);
+        })
+
+        it('IPv6, default port', () => {
+            const listeners = this.server.get_listen_addrs({listen: '[::1]'});
+            assert.deepEqual(['[::1]:25'], listeners);
+        })
+
+        it('IPv6, custom port', () => {
+            const listeners = this.server.get_listen_addrs({listen: '[::1]'}, 250);
+            assert.deepEqual(['[::1]:250'], listeners);
+        })
+
+        it('IPv4 & IPv6 fully qualified', () => {
+            const listeners = this.server.get_listen_addrs({
+                listen: '127.0.0.1:25,[::1]:25'
+            });
+            assert.deepEqual(['127.0.0.1:25','[::1]:25'], listeners);
+        })
+
+        it('IPv4 & IPv6, default port', () => {
+            const listeners = this.server.get_listen_addrs({
+                listen: '127.0.0.1:25,[::1]'
+            });
+            assert.deepEqual(['127.0.0.1:25','[::1]:25'], listeners);
+        })
+
+        it('IPv4 & IPv6, custom port', () => {
+            const listeners = this.server.get_listen_addrs({
+                listen: '127.0.0.1,[::1]'
+            }, 250);
+            assert.deepEqual(['127.0.0.1:250','[::1]:250'], listeners);
+        })
+    })
+
+    describe('load_smtp_ini', () => {
+        beforeEach(_set_up)
+
+        it('saves settings to Server.cfg', () => {
+            this.server.load_smtp_ini();
+            // console.log(this.server.cfg);
+            const c = this.server.cfg.main;
+            assert.notEqual(c.daemonize, undefined);
+            assert.notEqual(c.daemon_log_file, undefined);
+            assert.notEqual(c.daemon_pid_file, undefined);
+        })
+    })
+
+    describe('get_smtp_server', () => {
+        beforeEach((done) => {
+            this.config = require('haraka-config');
+            this.config = this.config.module_config(path.resolve('test'));
+
+            this.server = require('../server');
+            this.server.config = this.config;
+            this.server.plugins.config = this.config;
+
+            this.server.load_default_tls_config(() => {
+                setTimeout(() => {
+                    done();
+                }, 200);
+            });
+        })
+
+        it('gets a net server object', (done) => {
+            this.server.get_smtp_server(endpoint('0.0.0.0:2501'), 10).then(server => {
+                if (!server) {
+                    console.error('unable to bind to 0.0.0.0:2501');
+                    if (process.env.CI) return // can't bind to IP/port (fails on Travis)
+                }
+                assert.ok(server);
+                assert.equal(server.has_tls, false);
+                server.getConnections((err, count) => {
+                    assert.equal(0, count);
+                    done()
+                })
+            })
+        })
+
+        it('gets a TLS net server object', (done) => {
+            this.server.cfg.main.smtps_port = 2502;
+            this.server.get_smtp_server(endpoint('0.0.0.0:2502'), 10).then((server) => {
+                if (!server) {
+                    console.error('unable to bind to 0.0.0.0:2502');
+                    if (process.env.CI) return // can't bind to IP/port (fails on Travis)
+                }
+                assert.ok(server);
+                assert.equal(server.has_tls, true);
+                server.getConnections((err, count) => {
+                    assert.equal(0, count);
+                    done()
+                });
+            });
+        })
+    })
+
+    describe('get_http_docroot', () => {
+        beforeEach(_set_up)
+
+        it('gets a fs path', () => {
+            assert.ok(this.server.get_http_docroot());
+        })
+    })
+
+    describe('smtp_client', () => {
+        beforeEach((done) => {
+            _setupServer('localhost:2500', done)
+        })
+
+        afterEach(_tearDownServer)
+
+        it('accepts SMTP message', () => {
+
+            const server = { notes: { } };
+            const cfg = {
+                connect_timeout: 2,
+            }
+
+            const smtp_client   = require('../smtp_client');
+
+            smtp_client.get_client(server, (client) => {
+
+                client
+                    .on('greeting', command => {
+                        client.send_command('HELO', 'haraka.local');
+                    })
+                    .on('helo', () => {
+                        client.send_command('MAIL', 'FROM:<test@haraka.local>');
+                    })
+                    .on('mail', () => {
+                        client.send_command('RCPT', 'TO:<nobody-will-see-this@haraka.local>');
+                    })
+                    .on('rcpt', () => {
+                        client.send_command('DATA');
+                    })
+                    .on('data', () => {
+                        const message_stream = new message.stream(
+                            { main : { spool_after : 1024 } }, "theMessageId"
+                        );
+
+                        message_stream.on('end', () => {
+                            client.socket.write('.\r\n');
+                        })
+                        message_stream.add_line('Header: test\r\n');
+                        message_stream.add_line('\r\n');
+                        message_stream.add_line('I am body text\r\n');
+                        message_stream.add_line_end();
+
+                        client.start_data(message_stream);
+                    })
+                    .on('dot', () => {
+                        assert.ok(1);
+                        client.release();
+                    })
+                    .on('bad_code', (code, msg) => {
+                        client.release();
+                    });
+
+            }, { port: 2500, host: 'localhost', cfg });
+        })
+    })
+
+    describe('nodemailer', () => {
+        beforeEach((done) => {
+            _setupServer('127.0.0.1:2503', done)
+        })
+
+        afterEach(_tearDownServer)
+
+        it('accepts SMTP message', (done) => {
+
+            const nodemailer = require('nodemailer');
+            const transporter = nodemailer.createTransport({
+                host: '127.0.0.1',
+                port: 2503,
+                tls: {
+                    // do not fail on invalid certs
+                    rejectUnauthorized: false
+                }
+            });
+            transporter.sendMail({
+                from: '"Testalicious Matt" <harakamail@gmail.com>',
+                to:   'nobody-will-see-this@haraka.local',
+                envelope: {
+                    from: 'Haraka Test <test@haraka.local>',
+                    to:   'Discard Queue <discard@haraka.local>',
+                },
+                subject: 'Hello ✔',
+                text: 'Hello world ?',
+                html: '<b>Hello world ?</b>',
+            },
+            (error, info) => {
+                if (error){
+                    console.log(error);
+                    return;
+                }
+                assert.deepEqual(info.accepted, [ 'discard@haraka.local' ]);
+                console.log(`Message sent: ${info.response}`);
+                done()
+            })
+        })
+
+        it('accepts authenticated SMTP', (done) => {
+
+            const nodemailer = require('nodemailer');
+            const transporter = nodemailer.createTransport({
+                host: '127.0.0.1',
+                port: 2503,
+                auth: {
+                    user: 'matt',
+                    pass: 'goodPass'
+                },
+                requireTLS: true,
+                tls: {
+                    // do not fail on invalid certs
+                    rejectUnauthorized: false
+                }
+            })
+
+            transporter.sendMail({
+                from: '"Testalicious Matt" <harakamail@gmail.com>',
+                to:   'nobody-will-see-this@haraka.local',
+                envelope: {
+                    from: 'Haraka Test <test@haraka.local>',
+                    to:   'Discard Queue <discard@haraka.local>',
+                },
+                subject: 'Hello ✔',
+                text: 'Hello world ?',
+                html: '<b>Hello world ?</b>',
+            },
+            (error, info) => {
+                if (error){
+                    console.log(error);
+                    return;
+                }
+                assert.deepEqual(info.accepted, [ 'discard@haraka.local' ]);
+                console.log(`Message sent: ${info.response}`);
+                done()
+            })
+        })
+
+        it('rejects invalid auth', (done) => {
+
+            const nodemailer = require('nodemailer');
+            const transporter = nodemailer.createTransport({
+                host: '127.0.0.1',
+                port: 2503,
+                auth: {
+                    user: 'matt',
+                    pass: 'badPass'
+                },
+                tls: {
+                    // do not fail on invalid certs
+                    rejectUnauthorized: false
+                }
+            })
+
+            transporter.sendMail({
+                from: '"Testalicious Matt" <harakamail@gmail.com>',
+                to:   'nobody-will-see-this@haraka.local',
+                envelope: {
+                    from: 'Haraka Test <test@haraka.local>',
+                    to:   'Discard Queue <discard@haraka.local>',
+                },
+                subject: 'Hello ✔',
+                text: 'Hello world ?',
+                html: '<b>Hello world ?</b>',
+            },
+            (error, info) => {
+                if (error){
+                    assert.equal(error.code, 'EAUTH');
+                    // console.log(error);
+                    return done();
+                }
+                console.log(info.response);
+                done()
+            })
+        })
+
+        it('DKIM validates signed message', (done) => {
+
+            const nodemailer = require('nodemailer');
+            const transporter = nodemailer.createTransport({
+                host: '127.0.0.1',
+                port: 2503,
+                tls: {
+                    // do not fail on invalid certs
+                    rejectUnauthorized: false
+                }
+            })
+
+            transporter.sendMail({
+                from: '"Testalicious Matt" <harakamail@gmail.com>',
+                to:   'nobody-will-see-this@haraka.local',
+                envelope: {
+                    from: 'Haraka Test <test@haraka.local>',
+                    to:   'Discard Queue <discard@haraka.local>',
+                },
+                subject: 'Hello ✔',
+                text: 'Hello world ?',
+                html: '<b>Hello world ?</b>',
+                dkim: {
+                    domainName: "test.simerson.com",
+                    keySelector: "harakatest2017",
+                    privateKey: '-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAxqoUAnQ9GB3iNnkS7coj0Iggd0nyryW062tpK95NC5UXmmAwIpUMfkYdiHY2o2duWYGF0Bp237M/QXKhJYTXfsgkwP/bq9OGWtRZxHPHhbhdjbiI\nqObi6zvYcxrI77gpWDDvruhMeS9Hwa1R99pLUWd4PsuYTzbV/jwu2pz+XZXXXNEU\nVxzDAAj0yF7mwxHMLzQfR+hdhWcrgN0stUP0o7hm7hoOP8IWgcSW3JiQYavIKoI4\nm4+I9I1LzDJN2rHVnQvmjUrqqpG7X6SyFVFtuTWGaMqf1Cj/t8eSvU9VdgLFllS8\ntThqUZHq5S5hm8M8VzLuQLG9U0dtFolcFmJkbQIDAQABAoIBAB4fUbNhjpXmihM6\nXm1htfZ7fXi45Kw76me7vJGjPklgTNjidsn3kZJf7UBwtC4ok6nMos6ABMA8fH3e\n9KIst0QI8tG0ucke5INHKWlJKNqUrtK7RTVe9M84HsStLgRzBwnRObZqkJXbXmT2\nc7RCDCOGrcvPsQNpzB6lX3FUVpk3x24RXpQV1qSgH8yuHSPc1C6rssXwPAgnESfS\nK3MHRx2CLZvTTkq/YCsT+wS/O9RWPCVOYuWaa5DDDAIp3Yw1wYq9Upoh0BdIFC3U\nWm+5Cr3o9wxcvS6+W2RA6I51eymzvCU5ZakWt/bnUDb6/ByxsWOn5rL4WfPpCwE4\nnuC72v0CgYEA9imEq6a0GoaEsMoR7cxT7uXKimQH+Jaq3CGkuh0iN32F4FXhuUKz\nLYKSLCZzpb1MiDJv6BBchV6uSQ6ATo1cZ8WzYQISikk175bf0SPom591OZElvKA2\nSOrTrXtbl33YbWZEgyEcpTgelVi5ys9rj4eKkMvM0lwRmW6gctEFXRcCgYEAzpqc\nR/wqPjgPhpF1CZtdEwOZg4kkOig8CBcuQ7o/hDG7N69A9ZbeJO8eD+gKDrHRfkYr\nTH/UdkZGjilBk/lxnpIZpyBLxQ6UdhNPuwtxXKAvuSN+aQ0pdJn8tg03OSj2OzTK\nJ4hMsO/wt1xM8EDRobLZEosMadaYZUHzx8VU5RsCgYEAvFZbuXEcT0cocpLIUOaK\nOTf7VRLfvmSYaUAcZoEv0sDpExDiWPodWO6To8/vn5lL2tCsKiOKhkhAlIjRxkgF\nsSfj7I7HXKJS7/LBX6RXrem8qMTS2JTDs9pnBk5hb3DLjDg4pxNIdWiQjbeKvw8f\nvnr3m30yQqhKlte7Tt15exUCgYBzq7RbyR6Nfy2SFdYE7usJPjawohOaS/RwQyov\n2RK+nGlJH+GqnjD5VLbsCOm4mG3F2NtdFSSKo4XVCdwhUMMAGKQsIbTKOwN7qAw3\nmIx7Y2PUr76SakAPfDc0ZenJItnZBBE6WOE3Ht8Siaa5zFCRy2QlMZxdlTv1VRt7\neUuyiQKBgQDdXJO5+3h1HPxbYZcmNm/2CJUNw2ehU8vCiBXCcWPn7JukayHx+TXy\nyj0j/b1SvmKgjB+4JWluiqIU+QBjRjvb397QY1YoCEaGZd0zdFjTZwQksQ5AFst9\nCiD9OFXe/kkmIUQQra6aw1CoppyAfvAblp8uevLWb57xU3VUB3xeGg==\n-----END RSA PRIVATE KEY-----\n',
+                }
+            },
+            (error, info) => {
+                // console.log(info);
+                if (error){
+                    console.log(error);
+                    return;
+                }
+                assert.deepEqual(info.accepted, [ 'discard@haraka.local' ]);
+                console.log(`Message sent: ${info.response}`);
+                done()
+            })
+        })
+    })
+
+    describe('requireAuthorized_SMTPS', () => {
+        beforeEach((done) => {
+            _setupServer('127.0.0.1:2465', done)
+        })
+
+        afterEach(_tearDownServer)
+
+        it('rejects non-validated SMTPS connection', (done) => {
+
+            const nodemailer = require('nodemailer');
+            const transporter = nodemailer.createTransport({
+                host: '127.0.0.1',
+                port: 2465,
+                secure: true,
+                tls: {
+                    // do not fail on invalid certs
+                    rejectUnauthorized: false
+                }
+            })
+
+            // give the SMTPS listener a second to start listening
+            setTimeout(() => {
+                transporter.sendMail({
+                    from: '"Testalicious Matt" <harakamail@gmail.com>',
+                    to:   'nobody-will-see-this@haraka.local',
+                    envelope: {
+                        from: 'Haraka Test <test@haraka.local>',
+                        to:   'Discard Queue <discard@haraka.local>',
+                    },
+                    subject: 'Hello ✔',
+                    text: 'Hello world ?',
+                    html: '<b>Hello world ?</b>',
+                },
+                (error, info) => {
+                    if (error) {
+                        // console.log(error);
+                        if (error.message === 'socket hang up') {   // node 6 & 8
+                            assert.equal(error.message, 'socket hang up');
+                        }
+                        else if (/alert certificate required/.test(error.message)) {  // node 18
+                            assert.ok(/alert certificate required/.test(error.message))
+                        }
+                        else {     // node 10+
+                            assert.equal(error.message, 'Client network socket disconnected before secure TLS connection was established');
+                        }
+                    }
+                    done()
+                })
+            }, 500);
+        })
+    })
+
+    describe('requireAuthorized_STARTTLS', () => {
+        beforeEach((done) => {
+            _setupServer('127.0.0.1:2587', done)
+        })
+
+        it('rejects non-validated STARTTLS connection', (done) => {
+
+            const nodemailer = require('nodemailer');
+            const transporter = nodemailer.createTransport({
+                host: '127.0.0.1',
+                port: 2587,
+                secure: false,
+                tls: {
+                    // do not fail on invalid certs
+                    rejectUnauthorized: false
+                }
+            });
+
+            // give the SMTPS listener a half second to start listening
+            setTimeout(() => {
+                transporter.sendMail({
+                    from: '"Testalicious Matt" <harakamail@gmail.com>',
+                    to:   'nobody-will-see-this@haraka.local',
+                    envelope: {
+                        from: 'Haraka Test <test@haraka.local>',
+                        to:   'Discard Queue <discard@haraka.local>',
+                    },
+                    subject: 'Hello ✔',
+                    text: 'Hello world ?',
+                    html: '<b>Hello world ?</b>',
+                },
+                (error, info) => {
+                    if (error) {
+                        // console.log(error);
+                        if (/alert certificate required/.test(error.message)) {  // node 18
+                            assert.ok(/alert certificate required/.test(error.message))
+                        }
+                        else {
+                            assert.equal(error.message, 'Client network socket disconnected before secure TLS connection was established');
+                        }
+                    }
+                    done()
+                })
+            }, 500);
+        })
+    })
+})