Haraka 3.1.0 → 3.1.2

package/test/transaction.js

@@ -1,12 +1,12 @@
 const assert = require('node:assert')
-const fs = require('node:fs');
-const path = require('node:path');
+const fs = require('node:fs')
+const path = require('node:path')
 
 const config = require('haraka-config')
-const transaction = require('../transaction');
+const transaction = require('../transaction')
 
 const _set_up = (done) => {
-    this.transaction = transaction.createTransaction(undefined, config.get('smtp.ini'));
+    this.transaction = transaction.createTransaction(undefined, config.get('smtp.ini'))
     done()
 }
 
@@ -14,109 +14,102 @@ describe('transaction', () => {
     beforeEach(_set_up)
 
     it('add_body_filter', (done) => {
-
         this.transaction.add_body_filter('text/plain', (ct, enc, buf) => {
             // The functionality of these filter functions is tested in
             // haraka-email-message. This just assures the plumbing is in place.
 
-            assert.ok(ct.indexOf('text/plain') === 0, "correct body part");
-            assert.ok(/utf-?8/i.test(enc), "correct encoding");
-            assert.equal(buf.toString().trim(), "Text part", "correct body contents");
-        });
-
-        [
-            "Content-Type: multipart/alternative; boundary=abcd\n",
-            "\n",
-            "--abcd\n",
-            "Content-Type: text/plain\n",
-            "\n",
-            "Text part\n",
-            "--abcd\n",
-            "Content-Type: text/html\n",
-            "\n",
-            "<p>HTML part</p>\n",
-            "--abcd--\n",
-        ].forEach(line => {
-            this.transaction.add_data(line);
-        });
+            assert.ok(ct.indexOf('text/plain') === 0, 'correct body part')
+            assert.ok(/utf-?8/i.test(enc), 'correct encoding')
+            assert.equal(buf.toString().trim(), 'Text part', 'correct body contents')
+        })
+        ;[
+            'Content-Type: multipart/alternative; boundary=abcd\n',
+            '\n',
+            '--abcd\n',
+            'Content-Type: text/plain\n',
+            '\n',
+            'Text part\n',
+            '--abcd\n',
+            'Content-Type: text/html\n',
+            '\n',
+            '<p>HTML part</p>\n',
+            '--abcd--\n',
+        ].forEach((line) => {
+            this.transaction.add_data(line)
+        })
         this.transaction.end_data(() => {
-            done();
-        });
+            done()
+        })
     })
 
     it('regression: attachment_hooks before set_banner/add_body_filter', (done) => {
-
-        this.transaction.attachment_hooks(() => {});
-        this.transaction.set_banner('banner');
+        this.transaction.attachment_hooks(() => {})
+        this.transaction.set_banner('banner')
         this.transaction.add_body_filter('', () => {
-            assert.ok(true, "body filter called");
-        });
-        [
-            "Content-Type: text/plain\n",
-            "\n",
-            "Some text\n",
-        ].forEach(line => {
-            this.transaction.add_data(line);
-        });
+            assert.ok(true, 'body filter called')
+        })
+        ;['Content-Type: text/plain\n', '\n', 'Some text\n'].forEach((line) => {
+            this.transaction.add_data(line)
+        })
 
         this.transaction.end_data(() => {
-            this.transaction.message_stream.get_data(body => {
-                assert.ok(/banner$/.test(body.toString().trim()), "banner applied");
-                done();
+            this.transaction.message_stream.get_data((body) => {
+                assert.ok(/banner$/.test(body.toString().trim()), 'banner applied')
+                done()
             })
         })
     })
 
     it('correct output encoding when content in non-utf8 #2176', (done) => {
-
         // Czech panagram "Příliš žluťoučký kůň úpěl ďábelské ódy." in ISO-8859-2 encoding
-        const message = [0x50, 0xF8, 0xED, 0x6C, 0x69, 0xB9, 0x20, 0xBE, 0x6C, 0x75, 0xBB, 0x6F, 0x76, 0xE8, 0x6B, 0xFD, 0x20, 0x6B, 0xF9, 0xF2, 0xFA, 0xEC, 0x6C, 0x20, 0xEF, 0xE2, 0x62, 0x65, 0x6C, 0x73, 0x6b, 0xE9, 0x20, 0xF3, 0x64, 0x79, 0x2E];
+        const message = [
+            0x50, 0xf8, 0xed, 0x6c, 0x69, 0xb9, 0x20, 0xbe, 0x6c, 0x75, 0xbb, 0x6f, 0x76, 0xe8, 0x6b, 0xfd, 0x20, 0x6b,
+            0xf9, 0xf2, 0xfa, 0xec, 0x6c, 0x20, 0xef, 0xe2, 0x62, 0x65, 0x6c, 0x73, 0x6b, 0xe9, 0x20, 0xf3, 0x64, 0x79,
+            0x2e,
+        ]
         const payload = [
-            Buffer.from("Content-Type: text/plain; charset=iso-8859-2; format=flowed\n"),
-            "\n",
-            Buffer.from([...message, 0x0A]), // Add \n
-        ];
-
+            Buffer.from('Content-Type: text/plain; charset=iso-8859-2; format=flowed\n'),
+            '\n',
+            Buffer.from([...message, 0x0a]), // Add \n
+        ]
 
-        this.transaction.parse_body = true;
-        this.transaction.attachment_hooks(function () {});
+        this.transaction.parse_body = true
+        this.transaction.attachment_hooks(function () {})
 
         for (const line of payload) {
-            this.transaction.add_data(line);
+            this.transaction.add_data(line)
         }
         this.transaction.end_data(() => {
             this.transaction.message_stream.get_data(function (body) {
-                assert.ok(body.includes(Buffer.from(message)), "message not damaged");
-                done();
-            });
-        });
+                assert.ok(body.includes(Buffer.from(message)), 'message not damaged')
+                done()
+            })
+        })
     })
 
     it('no munging of bytes if not parsing body', (done) => {
-
         // Czech panagram "Příliš žluťoučký kůň úpěl ďábelské ódy.\n" in ISO-8859-2 encoding
-        const message = Buffer.from([0x50, 0xF8, 0xED, 0x6C, 0x69, 0xB9, 0x20, 0xBE, 0x6C, 0x75, 0xBB, 0x6F, 0x76, 0xE8, 0x6B, 0xFD, 0x20, 0x6B, 0xF9, 0xF2, 0xFA, 0xEC, 0x6C, 0x20, 0xEF, 0xE2, 0x62, 0x65, 0x6C, 0x73, 0x6b, 0xE9, 0x20, 0xF3, 0x64, 0x79, 0x2E, 0x0A]);
-        const payload = [
-            "Content-Type: text/plain; charset=iso-8859-2; format=flowed\n",
-            "\n",
-            message
-        ];
-
-        payload.forEach(line => {
-            this.transaction.add_data(line);
-        });
+        const message = Buffer.from([
+            0x50, 0xf8, 0xed, 0x6c, 0x69, 0xb9, 0x20, 0xbe, 0x6c, 0x75, 0xbb, 0x6f, 0x76, 0xe8, 0x6b, 0xfd, 0x20, 0x6b,
+            0xf9, 0xf2, 0xfa, 0xec, 0x6c, 0x20, 0xef, 0xe2, 0x62, 0x65, 0x6c, 0x73, 0x6b, 0xe9, 0x20, 0xf3, 0x64, 0x79,
+            0x2e, 0x0a,
+        ])
+        const payload = ['Content-Type: text/plain; charset=iso-8859-2; format=flowed\n', '\n', message]
+
+        payload.forEach((line) => {
+            this.transaction.add_data(line)
+        })
         this.transaction.end_data(() => {
-            this.transaction.message_stream.get_data(body => {
-                assert.ok(body.includes(message), "message not damaged");
-                done();
-            });
-        });
+            this.transaction.message_stream.get_data((body) => {
+                assert.ok(body.includes(message), 'message not damaged')
+                done()
+            })
+        })
     })
 
     it('bannering with nested mime structure', (done) => {
-
-        this.transaction.set_banner('TEXT_BANNER', 'HTML_BANNER');
-        [
+        this.transaction.set_banner('TEXT_BANNER', 'HTML_BANNER')
+        ;[
             'Content-Type: multipart/mixed; boundary="TOP_LEVEL"',
             '',
             '--TOP_LEVEL',
@@ -132,67 +125,67 @@ describe('transaction', () => {
             '<p>This is an html part</p>',
             '--INNER_LEVEL--',
             '--TOP_LEVEL--',
-        ].forEach(line => {
-            this.transaction.add_data(`${line}\r\n`);
-        });
+        ].forEach((line) => {
+            this.transaction.add_data(`${line}\r\n`)
+        })
         this.transaction.end_data(() => {
-            this.transaction.message_stream.get_data(body => {
-                assert.ok(/Hello, this is a text part/.test(body.toString()),
-                    "text content comes through in final message");
-                assert.ok(/This is an html part/.test(body.toString()),
-                    "html content comes through in final message");
-                assert.ok(/TEXT_BANNER/.test(body.toString()),
-                    "text banner comes through in final message");
-                assert.ok(/HTML_BANNER/.test(body.toString()),
-                    "html banner comes through in final message");
-                done();
-            });
-        });
+            this.transaction.message_stream.get_data((body) => {
+                assert.ok(
+                    /Hello, this is a text part/.test(body.toString()),
+                    'text content comes through in final message',
+                )
+                assert.ok(/This is an html part/.test(body.toString()), 'html content comes through in final message')
+                assert.ok(/TEXT_BANNER/.test(body.toString()), 'text banner comes through in final message')
+                assert.ok(/HTML_BANNER/.test(body.toString()), 'html banner comes through in final message')
+                done()
+            })
+        })
     })
 
     describe('base64_handling', () => {
         beforeEach(_set_up)
 
         it('varied-base64-fold-lengths-preserve-data', (done) => {
-
-            const parsed_attachments = {};
-            this.transaction.parse_body = true;
+            const parsed_attachments = {}
+            this.transaction.parse_body = true
             //accumulate attachment buffers.
             this.transaction.attachment_hooks((ct, filename, body, stream) => {
-                let attachment = Buffer.alloc(0);
-                stream.on('data', data => {
-                    attachment = Buffer.concat([attachment, data]);
-                });
+                let attachment = Buffer.alloc(0)
+                stream.on('data', (data) => {
+                    attachment = Buffer.concat([attachment, data])
+                })
                 stream.on('end', () => {
-                    parsed_attachments[filename] = attachment;
-                });
-            });
+                    parsed_attachments[filename] = attachment
+                })
+            })
 
-            const specimen_path = path.join(__dirname, 'mail_specimen', 'varied-fold-lengths-preserve-data.txt');
-            write_file_data_to_transaction(this.transaction, specimen_path);
+            const specimen_path = path.join(__dirname, 'mail_specimen', 'varied-fold-lengths-preserve-data.txt')
+            write_file_data_to_transaction(this.transaction, specimen_path)
 
-            assert.equal(this.transaction.body.children.length, 6);
+            assert.equal(this.transaction.body.children.length, 6)
 
-            let first_attachment = null;
+            let first_attachment = null
             for (const i in parsed_attachments) {
-                const current_attachment = parsed_attachments[i];
-                first_attachment = first_attachment || current_attachment;
+                const current_attachment = parsed_attachments[i]
+                first_attachment = first_attachment || current_attachment
                 // All buffers from data that was encoded with varied line lengths should
                 // still have the same final data.
-                assert.equal(true, first_attachment.equals(current_attachment),
-                    `The buffer data for '${i}' doesn't appear to be equal to the other attachments, and is likely corrupted.`);
+                assert.equal(
+                    true,
+                    first_attachment.equals(current_attachment),
+                    `The buffer data for '${i}' doesn't appear to be equal to the other attachments, and is likely corrupted.`,
+                )
             }
-            done();
+            done()
         })
 
         it('base64-root-html-decodes-correct-number-of-bytes', (done) => {
+            this.transaction.parse_body = true
+            const specimen_path = path.join(__dirname, 'mail_specimen', 'base64-root-part.txt')
+            write_file_data_to_transaction(this.transaction, specimen_path)
 
-            this.transaction.parse_body = true;
-            const specimen_path = path.join(__dirname, 'mail_specimen', 'base64-root-part.txt');
-            write_file_data_to_transaction(this.transaction, specimen_path);
-
-            assert.equal(this.transaction.body.bodytext.length, 425);
-            done();
+            assert.equal(this.transaction.body.bodytext.length, 425)
+            done()
         })
     })
 
@@ -205,66 +198,72 @@ describe('transaction', () => {
         // populate the same email data in transaction (self.transaction.add_data()) and
         // in raw buffer, then compare
         it('fix mime boundary corruption issue', (done) => {
-            const self = this;
-            let buffer = '';
-            self.transaction.add_data("Content-Type: multipart/alternative; boundary=abcd\r\n");
-            buffer += "Content-Type: multipart/alternative; boundary=abcd\r\n";
-            self.transaction.add_data('To: "User1_firstname_middlename_lastname" <user1_firstname_middlename_lastname@test.com>,\r\n');
-            buffer += 'To: "User1_firstname_middlename_lastname" <user1_firstname_middlename_lastname@test.com>,\r\n';
+            const self = this
+            let buffer = ''
+            self.transaction.add_data('Content-Type: multipart/alternative; boundary=abcd\r\n')
+            buffer += 'Content-Type: multipart/alternative; boundary=abcd\r\n'
+            self.transaction.add_data(
+                'To: "User1_firstname_middlename_lastname" <user1_firstname_middlename_lastname@test.com>,\r\n',
+            )
+            buffer += 'To: "User1_firstname_middlename_lastname" <user1_firstname_middlename_lastname@test.com>,\r\n'
             // make sure we add headers so that it exceeds 64k bytes to expose this issue
-            for (let i=0;i<725;i++){
-                self.transaction.add_data(` "User${i}_firstname_middlename_lastname" <user${i}_firstname_middlename_lastname@test.com>,\r\n`);
+            for (let i = 0; i < 725; i++) {
+                self.transaction.add_data(
+                    ` "User${i}_firstname_middlename_lastname" <user${i}_firstname_middlename_lastname@test.com>,\r\n`,
+                )
                 buffer += ` "User${i}_firstname_middlename_lastname" <user${i}_firstname_middlename_lastname@test.com>,\r\n`
             }
-            self.transaction.add_data(' "Final User_firstname_middlename_lastname" <final_user_firstname_middlename_lastname@test.com>\r\n');
-            buffer += ' "Final User_firstname_middlename_lastname" <final_user_firstname_middlename_lastname@test.com>\r\n';
-            self.transaction.add_data('Message-ID: <Boundary_Marker_Test>\r\n');
-            buffer += 'Message-ID: <Boundary_Marker_Test>\r\n';
-            self.transaction.add_data('MIME-Version: 1.0\r\n');
-            buffer += 'MIME-Version: 1.0\r\n';
-            self.transaction.add_data('Date: Wed, 1 Jun 2022 16:44:39 +0530 (IST)\r\n');
-            buffer += 'Date: Wed, 1 Jun 2022 16:44:39 +0530 (IST)\r\n';
-            self.transaction.add_data('\r\n');
-            buffer += '\r\n';
-            self.transaction.add_data("--abcd\r\n");
-            buffer += "--abcd\r\n";
-
-            [
-                "Content-Type: text/plain\r\n",
-                "\r\n",
-                "Text part\r\n",
-                "--abcd\r\n",
-                "Content-Type: text/html\r\n",
-                "\r\n",
-                "<p>HTML part</p>\r\n",
-                "--abcd--\r\n",
-            ].forEach(line => {
-                self.transaction.add_data(line);
-                buffer += line;
-            });
+            self.transaction.add_data(
+                ' "Final User_firstname_middlename_lastname" <final_user_firstname_middlename_lastname@test.com>\r\n',
+            )
+            buffer +=
+                ' "Final User_firstname_middlename_lastname" <final_user_firstname_middlename_lastname@test.com>\r\n'
+            self.transaction.add_data('Message-ID: <Boundary_Marker_Test>\r\n')
+            buffer += 'Message-ID: <Boundary_Marker_Test>\r\n'
+            self.transaction.add_data('MIME-Version: 1.0\r\n')
+            buffer += 'MIME-Version: 1.0\r\n'
+            self.transaction.add_data('Date: Wed, 1 Jun 2022 16:44:39 +0530 (IST)\r\n')
+            buffer += 'Date: Wed, 1 Jun 2022 16:44:39 +0530 (IST)\r\n'
+            self.transaction.add_data('\r\n')
+            buffer += '\r\n'
+            self.transaction.add_data('--abcd\r\n')
+            buffer += '--abcd\r\n'
+            ;[
+                'Content-Type: text/plain\r\n',
+                '\r\n',
+                'Text part\r\n',
+                '--abcd\r\n',
+                'Content-Type: text/html\r\n',
+                '\r\n',
+                '<p>HTML part</p>\r\n',
+                '--abcd--\r\n',
+            ].forEach((line) => {
+                self.transaction.add_data(line)
+                buffer += line
+            })
 
             this.transaction.end_data(function () {
                 self.transaction.message_stream.get_data(function (body) {
-                    assert.ok(body.includes(buffer), "message is damaged");
-                    done();
+                    assert.ok(body.includes(buffer), 'message is damaged')
+                    done()
                 })
             })
         })
     })
 })
 
-function write_file_data_to_transaction (test_transaction, filename) {
-    const specimen = fs.readFileSync(filename, 'utf8');
-    const matcher = /[^\n]*([\n]|$)/g;
+function write_file_data_to_transaction(test_transaction, filename) {
+    const specimen = fs.readFileSync(filename, 'utf8')
+    const matcher = /[^\n]*([\n]|$)/g
 
-    let line;
+    let line
     do {
-        line = matcher.exec(specimen);
+        line = matcher.exec(specimen)
         if (line[0] == '') {
-            break;
+            break
         }
-        test_transaction.add_data(line[0]);
-    } while (line[0] != '');
+        test_transaction.add_data(line[0])
+    } while (line[0] != '')
 
-    test_transaction.end_data();
+    test_transaction.end_data()
 }