Haraka 3.0.2 → 3.0.4

package/test/plugins/mail_from.is_resolvable.js

@@ -0,0 +1,35 @@
+'use strict';
+const assert = require('node:assert')
+const dns = require('node:dns');
+
+const fixtures  = require('haraka-test-fixtures');
+const Address   = require('address-rfc2821').Address
+
+const _set_up = (done) => {
+
+    this.plugin = new fixtures.plugin('mail_from.is_resolvable');
+    this.plugin.register();
+
+    this.connection = fixtures.connection.createConnection();
+    this.connection.init_transaction()
+
+    done();
+}
+
+describe('mail_from.is_resolvable', () => {
+    beforeEach(_set_up)
+
+    describe('hook_mail', () => {
+        it('any.com, no err code', (done) => {
+            const txn = this.connection.transaction;
+            this.plugin.hook_mail((code, msg) => {
+                // console.log()
+                assert.deepEqual(txn.results.get('mail_from.is_resolvable').pass, ['has_fwd_dns']);
+                done();
+            },
+            this.connection, 
+            [new Address('<test@any.com>')]
+            )
+        })
+    })
+})

package/test/plugins/queue/smtp_forward.js

@@ -0,0 +1,206 @@
+'use strict';
+const assert = require('node:assert')
+const path = require('node:path');
+
+const { Address } = require('address-rfc2821');
+const fixtures    = require('haraka-test-fixtures');
+const Notes       = require('haraka-notes')
+
+const OK = 906;
+
+const _setup = (done) => {
+    this.plugin = new fixtures.plugin('queue/smtp_forward');
+
+    // switch config directory to 'test/config'
+    this.plugin.config = this.plugin.config.module_config(path.resolve('test'));
+
+    this.plugin.register();
+    this.hmail = { todo: { notes: new Notes() } };
+
+    this.connection = new fixtures.connection.createConnection();
+    this.connection.init_transaction();
+
+    done();
+}
+
+describe('smtp_forward', () => {
+    describe('tls config', () => {
+        it('TLS enabled but no outbound config in tls.ini', () => {
+            const plugin = new fixtures.plugin('queue/smtp_forward');
+            plugin.register();
+
+            assert.equal(plugin.tls_options, undefined);
+            assert.equal(plugin.register_hook.called, true);
+        })
+    })
+
+    describe('register', () => {
+        beforeEach(_setup)
+
+        it('register', () => {
+            this.plugin.register();
+            assert.ok(this.plugin.cfg.main);
+        })
+    })
+
+    describe('get_config', () => {
+        beforeEach(_setup)
+
+        it('no recipient', () => {
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(cfg.host, 'localhost');
+            assert.equal(cfg.enable_tls, true);
+            assert.equal(cfg.one_message_per_rcpt, true);
+        })
+
+        it('null recipient', () => {
+            this.connection.transaction.rcpt_to.push(new Address('<>'));
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(cfg.host, 'localhost');
+            assert.equal(cfg.enable_tls, true);
+            assert.equal(cfg.one_message_per_rcpt, true);
+        })
+
+        it('valid recipient', () => {
+            this.connection.transaction.rcpt_to.push(
+                new Address('<matt@example.com>')
+            );
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(cfg.enable_tls, true);
+            assert.equal(cfg.one_message_per_rcpt, true);
+            assert.equal(cfg.host, 'localhost');
+        })
+
+        it('valid recipient with route', () => {
+            this.connection.transaction.rcpt_to.push(
+                new Address('<matt@test.com>')
+            );
+            assert.deepEqual(this.plugin.get_config(this.connection), {
+                host: '1.2.3.4',
+                enable_tls: true,
+                auth_user: 'postmaster@test.com',
+                auth_pass: 'superDuperSecret',
+            });
+        })
+
+        it('valid recipient with route & diff config', () => {
+            this.connection.transaction.rcpt_to.push(
+                new Address('<matt@test1.com>')
+            );
+            const cfg = this.plugin.get_config(this.connection);
+            assert.deepEqual(cfg, {
+                host: '1.2.3.4',
+                enable_tls: false
+            });
+        })
+
+        it('valid 2 recipients with same route', () => {
+            this.connection.transaction.rcpt_to.push(
+                new Address('<matt@test.com>'),
+                new Address('<matt@test.com>')
+            );
+            const cfg = this.plugin.get_config(this.connection);
+            assert.deepEqual(cfg.host, '1.2.3.4' );
+        })
+
+        it('null sender', () => {
+            this.plugin.cfg.main.domain_selector = 'mail_from';
+            this.connection.transaction.mail_from = new Address('<>');
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(cfg.host, 'localhost');
+            assert.equal(cfg.enable_tls, true);
+            assert.equal(cfg.one_message_per_rcpt, true);
+        })
+
+        it('return mail_from domain configuration', () => {
+            this.connection.transaction.mail_from = new Address('<matt@test2.com>');
+            this.plugin.cfg.main.domain_selector = 'mail_from';
+            const cfg = this.plugin.get_config(this.connection);
+            assert.deepEqual(cfg.host, '2.3.4.5');
+            delete this.plugin.cfg.main.domain_selector; // clear this for future tests
+        })
+    })
+
+    describe('get_mx', () => {
+        beforeEach(_setup)
+
+        it('returns no outbound route for undefined domains', (done) => {
+            this.plugin.get_mx((code, mx) => {
+                assert.equal(code, undefined);
+                assert.deepEqual(mx, undefined);
+                done();
+            }, this.hmail, 'undefined.com');
+        })
+
+        it('returns no outbound route when queue.wants !== smtp_forward', (done) => {
+            this.hmail.todo.notes.set('queue.wants', 'outbound')
+            this.hmail.todo.notes.set('queue.next_hop', 'smtp://5.4.3.2:26')
+            this.plugin.get_mx((code, mx) => {
+                assert.equal(code, undefined);
+                assert.deepEqual(mx, undefined);
+                done();
+            }, this.hmail, 'undefined.com');
+        })
+
+        it('returns an outbound route for defined domains', (done) => {
+            this.plugin.get_mx((code, mx) => {
+                assert.equal(code, OK);
+                assert.deepEqual(mx, {
+                    priority: 0, exchange: '1.2.3.4', port: 2555,
+                    auth_user: 'postmaster@test.com',
+                    auth_pass: 'superDuperSecret'
+                });
+                done();
+            }, this.hmail, 'test.com');
+        })
+
+        it('is enabled when queue.wants is set', (done) => {
+            this.hmail.todo.notes.set('queue.wants', 'smtp_forward')
+            this.hmail.todo.notes.set('queue.next_hop', 'smtp://4.3.2.1:465')
+            this.plugin.get_mx((code, mx) => {
+                assert.equal(code, OK);
+                assert.deepEqual(mx, { priority: 0, port: 465, exchange: '4.3.2.1' });
+                done();
+            }, this.hmail, 'undefined.com');
+        })
+
+        it('sets using_lmtp when next_hop URL is lmtp', (done) => {
+            this.hmail.todo.notes.set('queue.wants', 'smtp_forward')
+            this.hmail.todo.notes.set('queue.next_hop', 'lmtp://4.3.2.1')
+            this.plugin.get_mx((code, mx) => {
+                assert.equal(code, OK);
+                assert.deepEqual(mx, { priority: 0, port: 24, using_lmtp: true, exchange: '4.3.2.1' });
+                done();
+            }, this.hmail, 'undefined.com');
+        })
+    })
+
+    describe('is_outbound_enabled', () => {
+        beforeEach(_setup)
+
+        it('enable_outbound is false by default', () => {
+            assert.equal(this.plugin.is_outbound_enabled(this.plugin.cfg), false);
+        })
+
+        it('per-domain enable_outbound is false by default', () => {
+            this.connection.transaction.rcpt_to = [ new Address('<postmaster@test.com>') ];
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(this.plugin.is_outbound_enabled(cfg), false);
+        })
+
+        it('per-domain enable_outbound can be set to true', () => {
+            this.plugin.cfg['test.com'].enable_outbound = true;
+            this.connection.transaction.rcpt_to = [ new Address('<postmaster@test.com>') ];
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(this.plugin.is_outbound_enabled(cfg), true);
+        })
+
+        it('per-domain enable_outbound is false even if top level is false', () => {
+            this.plugin.cfg.main.enable_outbound = false; // this will be ignored
+            this.plugin.cfg['test.com'].enable_outbound = false;
+            this.connection.transaction.rcpt_to = [ new Address('<postmaster@test.com>') ];
+            const cfg = this.plugin.get_config(this.connection);
+            assert.equal(this.plugin.is_outbound_enabled(cfg), false);
+        })
+    })
+})

package/test/plugins/rcpt_to.host_list_base.js

@@ -0,0 +1,122 @@
+'use strict';
+const assert = require('node:assert')
+
+const { Address }  = require('address-rfc2821');
+const fixtures     = require('haraka-test-fixtures');
+
+const _set_up = (done) => {
+
+    this.plugin = new fixtures.plugin('rcpt_to.host_list_base');
+    this.plugin.cfg = {};
+    this.plugin.host_list = {};
+
+    this.connection = fixtures.connection.createConnection();
+    this.connection.init_transaction()
+
+    done();
+}
+
+describe('rcpt_to.host_list_base', () => {
+
+    describe('in_host_list', () => {
+        beforeEach(_set_up)
+
+        it('miss', () => {
+            assert.equal(false, this.plugin.in_host_list('test.com'));
+        })
+
+        it('hit', () => {
+            this.plugin.host_list['test.com'] = true;
+            assert.equal(true, this.plugin.in_host_list('test.com'));
+        })
+    })
+
+    describe('in_host_regex', () => {
+        beforeEach(_set_up)
+
+        it('undef', () => {
+            const r = this.plugin.in_host_regex('test.com');
+            assert.equal(false, r);
+        })
+
+        it('miss', () => {
+            this.plugin.host_list_regex=['miss.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            const r = this.plugin.in_host_regex('test.com');
+            assert.equal(false, r);
+        })
+
+        it('exact hit', () => {
+            this.plugin.host_list_regex=['test.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            const r = this.plugin.in_host_regex('test.com');
+            assert.equal(true, r);
+        })
+
+        it('re hit', () => {
+            this.plugin.host_list_regex=['.*est.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            const r = this.plugin.in_host_regex('test.com');
+            assert.equal(true, r);
+        })
+    })
+
+    describe('hook_mail', () => {
+        beforeEach(_set_up)
+
+        it('null sender', (done) => {
+            this.connection.relaying=true;
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('<>')]);
+        })
+
+        it('miss', (done) => {
+            this.plugin.host_list = { 'miss.com': true };
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.host_list_base');
+                assert.notEqual(-1, res.msg.indexOf('mail_from!local'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+
+        it('hit', (done) => {
+            this.plugin.host_list = { 'example.com': true };
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.host_list_base');
+                assert.notEqual(-1, res.pass.indexOf('mail_from'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+
+        it('hit, regex, exact', (done) => {
+            this.plugin.host_list_regex = ['example.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.host_list_base');
+                assert.notEqual(-1, res.pass.indexOf('mail_from'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+
+        it('hit, regex, pattern', (done) => {
+            this.plugin.host_list_regex = ['.*mple.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.host_list_base');
+                assert.notEqual(-1, res.pass.indexOf('mail_from'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+    })
+})

package/test/plugins/rcpt_to.in_host_list.js

@@ -0,0 +1,193 @@
+'use strict';
+const assert = require('node:assert')
+
+const { Address }  = require('address-rfc2821');
+const fixtures     = require('haraka-test-fixtures');
+
+const _set_up = (done) => {
+
+    this.plugin = new fixtures.plugin('rcpt_to.in_host_list');
+    this.plugin.inherits('rcpt_to.host_list_base');
+    this.plugin.cfg = {};
+    this.plugin.host_list = {};
+
+    this.connection = fixtures.connection.createConnection();
+    this.connection.transaction = {
+        results: new fixtures.results(this.connection),
+        notes: {},
+    };
+
+    done();
+}
+
+describe('in_host_list', () => {
+    beforeEach(_set_up)
+
+    it('miss', () => {
+        assert.equal(this.plugin.in_host_list('test.com'), false);
+    })
+
+    it('hit', () => {
+        this.plugin.host_list['test.com'] = true;
+        assert.equal(this.plugin.in_host_list('test.com'), true);
+    })
+
+    describe('in_host_regex', () => {
+        beforeEach(_set_up)
+
+        it('undef', () => {
+            assert.equal(this.plugin.in_host_regex('test.com'), false);
+        })
+
+        it('miss', () => {
+            this.plugin.host_list_regex=['miss.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            assert.equal(this.plugin.in_host_regex('test.com'), false);
+        })
+
+        it('exact hit', () => {
+            this.plugin.host_list_regex=['test.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            assert.equal(this.plugin.in_host_regex('test.com'), true);
+        })
+
+        it('re hit', () => {
+            this.plugin.host_list_regex=['.*est.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            assert.equal(this.plugin.in_host_regex('test.com'), true);
+        })
+    })
+
+    describe('hook_mail', () => {
+        beforeEach(_set_up)
+
+        it('null sender', (done) => {
+            this.connection.relaying=true;
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('<>')]);
+        })
+
+        it('miss', (done) => {
+            this.plugin.host_list = { 'miss.com': true };
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.in_host_list');
+                assert.notEqual(-1, res.msg.indexOf('mail_from!local'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+
+        it('hit', (done) => {
+            this.plugin.host_list = { 'example.com': true };
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.in_host_list');
+                assert.notEqual(-1, res.pass.indexOf('mail_from'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+
+        it('hit, regex, exact', (done) => {
+            this.plugin.host_list_regex = ['example.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.in_host_list');
+                assert.notEqual(-1, res.pass.indexOf('mail_from'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+
+        it('hit, regex, pattern', (done) => {
+            this.plugin.host_list_regex = ['.*mple.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_mail((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                const res = this.connection.transaction.results.get('rcpt_to.in_host_list');
+                // console.log(res);
+                assert.notEqual(-1, res.pass.indexOf('mail_from'));
+                done();
+            }, this.connection, [new Address('<user@example.com>')]);
+        })
+    })
+
+    describe('hook_rcpt', () => {
+        beforeEach(_set_up)
+
+        it('missing txn', (done) => {
+            // sometimes txn goes away, make sure it's handled
+            delete this.connection.transaction;
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+            }, this.connection, [new Address('test@test.com')]);
+            assert.ok(true);
+            done();
+        })
+
+        it('hit list', (done) => {
+            this.plugin.host_list = { 'test.com': true };
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(OK, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('test@test.com')]);
+        })
+
+        it('miss list', (done) => {
+            this.plugin.host_list = { 'miss.com': true };
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('test@test.com')]);
+        })
+
+        it('hit regex, exact', (done) => {
+            this.plugin.host_list_regex=['test.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(OK, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('test@test.com')]);
+        })
+
+        it('hit regex, pattern', (done) => {
+            this.plugin.host_list_regex=['.est.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(OK, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('test@test.com')]);
+        })
+
+        it('miss regex, pattern', (done) => {
+            this.plugin.host_list_regex=['a.est.com'];
+            this.plugin.hl_re = new RegExp (`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i');
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(undefined, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('test@test.com')]);
+        })
+
+        it('rcpt miss, relaying to local sender', (done) => {
+            this.connection.relaying=true;
+            this.connection.transaction.notes = { local_sender: true };
+            this.plugin.hook_rcpt((rc, msg) => {
+                assert.equal(OK, rc);
+                assert.equal(undefined, msg);
+                done();
+            }, this.connection, [new Address('test@test.com')]);
+        })
+    })
+})