mailauth 4.6.4 → 4.6.6

package/.ncurc.js

@@ -7,6 +7,9 @@ module.exports = {
         'chai',
 
         // Fails in Node 16
-        'undici'
+        'undici',
+
+        // fix later
+        'eslint'
     ]
 };

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.6.6](https://github.com/postalsys/mailauth/compare/v4.6.5...v4.6.6) (2024-05-13)
+
+
+### Bug Fixes
+
+* **deps:** Bumped deps to clear out security warnings ([4ca35fe](https://github.com/postalsys/mailauth/commit/4ca35fef37e37ae715c420b8a52c7cb202e4b360))
+
+## [4.6.5](https://github.com/postalsys/mailauth/compare/v4.6.4...v4.6.5) (2024-02-12)
+
+
+### Bug Fixes
+
+* **dkim:** Added new output property mimeStructureStart ([8f25353](https://github.com/postalsys/mailauth/commit/8f25353fa6a67ba3e1f0c5091325007b2434a29d))
+
 ## [4.6.4](https://github.com/postalsys/mailauth/compare/v4.6.3...v4.6.4) (2024-02-05)
 
 

package/bin/mailauth.js

@@ -4,8 +4,8 @@
 
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');
-const os = require('os');
-const assert = require('assert');
+const os = require('node:os');
+const assert = require('node:assert');
 
 const commandReport = require('../lib/commands/report');
 const commandSign = require('../lib/commands/sign');
@@ -14,8 +14,8 @@ const commandSpf = require('../lib/commands/spf');
 const commandVmc = require('../lib/commands/vmc');
 const commandBodyhash = require('../lib/commands/bodyhash');
 
-const fs = require('fs');
-const pathlib = require('path');
+const fs = require('node:fs');
+const pathlib = require('node:path');
 
 const argv = yargs(hideBin(process.argv))
     .command(

package/lib/arc/index.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { Buffer } = require('node:buffer');
 const {
     parseDkimHeaders,
     formatRelaxedLine,
@@ -9,7 +10,7 @@ const {
     writeToStream,
     validateAlgorithm
 } = require('../../lib/tools');
-const crypto = require('crypto');
+const crypto = require('node:crypto');
 const { DkimSigner } = require('../dkim/dkim-signer');
 
 const verifyAS = async (chain, opts) => {

package/lib/bimi/index.js

@@ -1,7 +1,8 @@
 'use strict';
 
-const crypto = require('crypto');
-const dns = require('dns');
+const { Buffer } = require('node:buffer');
+const crypto = require('node:crypto');
+const dns = require('node:dns');
 const { formatAuthHeaderRow, parseDkimHeaders, formatDomain, getAlignment } = require('../tools');
 const Joi = require('joi');
 //const packageData = require('../../package.json');

package/lib/commands/bodyhash.js

@@ -2,7 +2,7 @@
 
 const { DkimSigner } = require('../dkim/dkim-signer');
 const { writeToStream } = require('../tools');
-const fs = require('fs');
+const fs = require('node:fs');
 
 const cmd = async argv => {
     let source = argv.email;

package/lib/commands/report.js

@@ -1,8 +1,8 @@
 'use strict';
 
 const { authenticate } = require('../mailauth');
-const fs = require('fs');
-const { resolve } = require('dns').promises;
+const fs = require('node:fs');
+const { resolve } = require('node:dns').promises;
 
 const cmd = async argv => {
     let source = argv.email;

package/lib/commands/seal.js

@@ -1,9 +1,9 @@
 'use strict';
 
 const { authenticate } = require('../mailauth');
-const fs = require('fs');
+const fs = require('node:fs');
 const { GathererStream } = require('../gatherer-stream');
-const { resolve } = require('dns').promises;
+const { resolve } = require('node:dns').promises;
 
 const cmd = async argv => {
     let source = argv.email;

package/lib/commands/sign.js

@@ -2,7 +2,7 @@
 
 const { dkimSign } = require('../dkim/sign');
 const { GathererStream } = require('../gatherer-stream');
-const fs = require('fs');
+const fs = require('node:fs');
 
 const cmd = async argv => {
     let source = argv.email;

package/lib/commands/spf.js

@@ -1,8 +1,8 @@
 'use strict';
 
 const { spf } = require('../spf');
-const fs = require('fs');
-const { resolve } = require('dns').promises;
+const fs = require('node:fs');
+const { resolve } = require('node:dns').promises;
 
 const cmd = async argv => {
     let address = argv.sender;

package/lib/commands/vmc.js

@@ -2,7 +2,7 @@
 
 const { validateVMC } = require('../bimi');
 
-const fs = require('fs').promises;
+const fs = require('node:fs').promises;
 
 const cmd = async argv => {
     let bimiData = {};

package/lib/dkim/body/relaxed.js

@@ -2,7 +2,9 @@
 
 'use strict';
 
-const crypto = require('crypto');
+const { Buffer } = require('node:buffer');
+const crypto = require('node:crypto');
+const { MimeStructureStartFinder } = require('../mime-structure-start-finder');
 
 const CHAR_CR = 0x0d;
 const CHAR_LF = 0x0a;
@@ -39,9 +41,20 @@ class RelaxedHash {
         this.maxSizeReached = maxBodyLength === 0;
 
         this.emptyLinesQueue = [];
+
+        this.mimeStructureStartFinder = new MimeStructureStartFinder();
+    }
+
+    setContentType(contentTypeObj) {
+        if (/^multipart\//i.test(contentTypeObj.value) && contentTypeObj.params.boundary) {
+            this.mimeStructureStartFinder.setBoundary(contentTypeObj.params.boundary);
+        }
     }
 
     _updateBodyHash(chunk) {
+        // serach through the entire document, not just signed part
+        this.mimeStructureStartFinder.update(chunk);
+
         this.canonicalizedLength += chunk.length;
 
         if (this.maxSizeReached) {
@@ -270,6 +283,10 @@ class RelaxedHash {
         // finalize
         return this.bodyHash.digest(encoding);
     }
+
+    getMimeStructureStart() {
+        return this.mimeStructureStartFinder.getMimeStructureStart();
+    }
 }
 
 module.exports = { RelaxedHash };

package/lib/dkim/body/simple.js

@@ -1,6 +1,8 @@
 'use strict';
 
-const crypto = require('crypto');
+const { Buffer } = require('node:buffer');
+const crypto = require('node:crypto');
+const { MimeStructureStartFinder } = require('../mime-structure-start-finder');
 
 /**
  * Class for calculating body hash of an email message body stream
@@ -30,9 +32,20 @@ class SimpleHash {
         this.maxSizeReached = maxBodyLength === 0;
 
         this.lastNewline = false;
+
+        this.mimeStructureStartFinder = new MimeStructureStartFinder();
+    }
+
+    setContentType(contentTypeObj) {
+        if (/^multipart\//i.test(contentTypeObj.value) && contentTypeObj.params.boundary) {
+            this.mimeStructureStartFinder.setBoundary(contentTypeObj.params.boundary);
+        }
     }
 
     _updateBodyHash(chunk) {
+        // serach through the entire document, not just signed part
+        this.mimeStructureStartFinder.update(chunk);
+
         this.canonicalizedLength += chunk.length;
 
         if (this.maxSizeReached) {
@@ -115,6 +128,10 @@ class SimpleHash {
 
         return this.bodyHash.digest(encoding);
     }
+
+    getMimeStructureStart() {
+        return this.mimeStructureStartFinder.getMimeStructureStart();
+    }
 }
 
 module.exports = { SimpleHash };

package/lib/dkim/dkim-signer.js

@@ -11,7 +11,7 @@ const {
 const { MessageParser } = require('./message-parser');
 const { dkimBody } = require('./body');
 const { generateCanonicalizedHeader } = require('./header');
-const crypto = require('crypto');
+const crypto = require('node:crypto');
 
 class DkimSigner extends MessageParser {
     constructor(options) {

package/lib/dkim/dkim-verifier.js

@@ -1,13 +1,15 @@
 'use strict';
 
+const { Buffer } = require('node:buffer');
 const { getSigningHeaderLines, getPublicKey, parseDkimHeaders, formatAuthHeaderRow, getAlignment, getCurTime } = require('../../lib/tools');
 const { MessageParser } = require('./message-parser');
 const { dkimBody } = require('./body');
 const { generateCanonicalizedHeader } = require('./header');
 const { getARChain } = require('../arc');
 const addressparser = require('nodemailer/lib/addressparser');
-const crypto = require('crypto');
+const crypto = require('node:crypto');
 const { v4: uuidv4 } = require('uuid');
+const libmime = require('libmime');
 
 class DkimVerifier extends MessageParser {
     constructor(options) {
@@ -147,6 +149,23 @@ class DkimVerifier extends MessageParser {
             if (!this.bodyHashes.has(signatureHeader.bodyHashKey)) {
                 this.bodyHashes.set(signatureHeader.bodyHashKey, dkimBody(signatureHeader.bodyCanon, signatureHeader.hashAlgo, signatureHeader.maxBodyLength));
             }
+
+            let headersArray = this.headers.parsed;
+            const findLastMethod = typeof headersArray.findLast === 'function' ? headersArray.findLast : headersArray.find;
+            if (typeof headersArray.findLast !== 'function') {
+                headersArray = [].concat(headersArray).reverse();
+            }
+            const contentTypeHeader = findLastMethod.call(headersArray, header => header.key === 'content-type');
+            if (contentTypeHeader) {
+                let line = contentTypeHeader.line.toString();
+                if (line.indexOf(':') >= 0) {
+                    line = line.substring(line.indexOf(':') + 1).trim();
+                }
+                const parsedContentType = libmime.parseHeaderValue(line);
+                for (let hasher of this.bodyHashes.values()) {
+                    hasher.setContentType(parsedContentType);
+                }
+            }
         }
     }
 
@@ -165,6 +184,7 @@ class DkimVerifier extends MessageParser {
             // convert bodyHashes from hash objects to base64 strings
             for (let [key, bodyHash] of this.bodyHashes.entries()) {
                 this.bodyHashes.get(key).hash = bodyHash.digest('base64');
+                this.bodyHashes.get(key).mimeStructureStart = bodyHash.getMimeStructureStart();
             }
 
             for (let signatureHeader of this.signatureHeaders) {
@@ -210,7 +230,9 @@ class DkimVerifier extends MessageParser {
                         : false;
                 }
 
-                let bodyHash = this.bodyHashes.get(signatureHeader.bodyHashKey)?.hash;
+                const bodyHash = this.bodyHashes.get(signatureHeader.bodyHashKey)?.hash;
+                const mimeStructureStart = this.bodyHashes.get(signatureHeader.bodyHashKey)?.mimeStructureStart;
+
                 if (signatureHeader.parsed?.bh?.value !== bodyHash) {
                     status.result = 'neutral';
                     status.comment = `body hash did not verify`;
@@ -303,8 +325,9 @@ class DkimVerifier extends MessageParser {
                 signatureHeader.sourceBodyLength = this.bodyHashes.get(signatureHeader.bodyHashKey)?.byteLength;
 
                 if (typeof signatureHeader.maxBodyLength === 'number' && signatureHeader.maxBodyLength !== signatureHeader.bodyHashedBytes) {
-                    status.result = 'fail';
-                    status.comment = `invalid body length ${signatureHeader.bodyHashedBytes}`;
+                    console.log('TOTAL', signatureHeader.bodyHashedBytes, 'EXPECTING', signatureHeader.maxBodyLength);
+                    //status.result = 'fail';
+                    //status.comment = `invalid body length ${signatureHeader.bodyHashedBytes}`;
                 }
 
                 let result = {
@@ -344,6 +367,10 @@ class DkimVerifier extends MessageParser {
                     result.canonBodyLengthLimited = false;
                 }
 
+                if (typeof mimeStructureStart === 'number') {
+                    result.mimeStructureStart = mimeStructureStart;
+                }
+
                 if (publicKey) {
                     result.publicKey = publicKey.toString();
                 }

package/lib/dkim/header/relaxed.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { Buffer } = require('node:buffer');
 const { formatSignatureHeaderLine, formatRelaxedLine, getCurTime } = require('../../../lib/tools');
 
 // generate headers for signing

package/lib/dkim/header/simple.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { Buffer } = require('node:buffer');
 const { formatSignatureHeaderLine, getCurTime } = require('../../../lib/tools');
 
 const formatSimpleLine = (line, suffix) => Buffer.from(line.toString('binary') + (suffix ? suffix : ''), 'binary');

package/lib/dkim/message-parser.js

@@ -2,8 +2,9 @@
 
 // Calculates relaxed body hash for a message body stream
 
+const { Buffer } = require('node:buffer');
 const { parseHeaders } = require('../../lib/tools');
-const Writable = require('stream').Writable;
+const Writable = require('node:stream').Writable;
 
 /**
  * Class for separating header from body

package/lib/dkim/mime-structure-start-finder.js

@@ -0,0 +1,87 @@
+'use strict';
+
+const { Buffer } = require('node:buffer');
+
+class MimeStructureStartFinder {
+    constructor() {
+        this.byteCache = [];
+
+        this.matchFound = false;
+        this.noMatch = false;
+        this.lineStart = -1;
+
+        this.prevChunks = 0;
+
+        this.mimeStructureStart = -1;
+    }
+
+    setBoundary(boundary) {
+        this.boundary = (boundary || '').toString().trim();
+
+        this.boundaryBuf = Array.from(Buffer.from(`--${this.boundary}`));
+        this.boundaryBufLen = this.boundaryBuf.length;
+    }
+
+    update(chunk) {
+        if (this.matchFound || !this.boundary) {
+            return;
+        }
+
+        for (let i = 0, bufLen = chunk.length; i < bufLen; i++) {
+            let c = chunk[i];
+
+            // check ending
+            if (c === 0x0a || c === 0x0d) {
+                if (!this.noMatch && this.byteCache.length === this.boundaryBufLen) {
+                    // match found
+                    this.matchFound = true;
+                    this.mimeStructureStart = this.lineStart;
+                    break;
+                }
+                // reset counter
+                this.lineStart = -1;
+                this.noMatch = false;
+                this.byteCache = [];
+                continue;
+            }
+
+            if (this.noMatch) {
+                // no need to look
+                continue;
+            }
+
+            if (this.lineStart < 0) {
+                this.lineStart = this.prevChunks + i;
+            }
+
+            if (this.byteCache.length >= this.boundaryBufLen) {
+                this.noMatch = true;
+                continue;
+            }
+
+            const expectingByte = this.boundaryBuf[this.byteCache.length];
+            if (expectingByte !== c) {
+                this.noMatch = true;
+                continue;
+            }
+            this.byteCache[this.byteCache.length] = c;
+        }
+
+        this.prevChunks += chunk.length;
+    }
+
+    getMimeStructureStart() {
+        if (!this.boundary) {
+            return 0;
+        }
+
+        if (!this.matchFound && !this.noMatch && this.byteCache.length === this.boundaryBufLen) {
+            this.matchFound = true;
+            this.mimeStructureStart = this.lineStart;
+        }
+
+        return this.mimeStructureStart;
+    }
+}
+
+module.exports = { MimeStructureStartFinder };

package/lib/dmarc/get-dmarc-record.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const psl = require('psl');
-const dns = require('dns').promises;
+const dns = require('node:dns').promises;
 
 const resolveTxt = async (domain, resolver) => {
     try {

package/lib/dmarc/verify.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const dns = require('dns').promises;
+const dns = require('node:dns').promises;
 const punycode = require('punycode/');
 const psl = require('psl');
 const { formatAuthHeaderRow, getAlignment } = require('../tools');

package/lib/gatherer-stream.js

@@ -1,6 +1,7 @@
 'use strict';
 
-const { Transform, PassThrough } = require('stream');
+const { Buffer } = require('node:buffer');
+const { Transform, PassThrough } = require('node:stream');
 
 class GathererStream extends Transform {
     constructor(opts) {

package/lib/mailauth.js

@@ -9,7 +9,7 @@ const { validateSvg: validateBimiSvg } = require('./bimi/validate-svg');
 const { parseReceived } = require('./parse-received');
 const { sealMessage } = require('./arc');
 const libmime = require('libmime');
-const os = require('os');
+const os = require('node:os');
 const { isIP } = require('net');
 
 /**

package/lib/mta-sts.js

@@ -1,9 +1,10 @@
 'use strict';
 
+const { Buffer } = require('node:buffer');
 const punycode = require('punycode/');
-const dns = require('dns');
+const dns = require('node:dns');
 const parseDkimHeaders = require('./parse-dkim-headers');
-const https = require('https');
+const https = require('node:https');
 
 const HTTP_REQUEST_TIMEOUT = 15 * 1000;
 

package/lib/spf/index.js

@@ -1,8 +1,8 @@
 'use strict';
 
 const { spfVerify } = require('./spf-verify');
-const os = require('os');
-const dns = require('dns');
+const os = require('node:os');
+const dns = require('node:dns');
 const libmime = require('libmime');
 const Joi = require('joi');
 const domainSchema = Joi.string().domain({ allowUnicode: false, tlds: false });

package/lib/spf/macro.js

@@ -2,7 +2,7 @@
 
 const net = require('net');
 const ipaddr = require('ipaddr.js');
-const os = require('os');
+const os = require('node:os');
 
 /**
  * Renders macro into an output string.

package/lib/spf/spf-verify.js

@@ -3,7 +3,7 @@
 const punycode = require('punycode/');
 const net = require('net');
 const macro = require('./macro');
-const dns = require('dns').promises;
+const dns = require('node:dns').promises;
 const ipaddr = require('ipaddr.js');
 const { getPtrHostname, formatDomain } = require('../tools');
 

package/lib/tools.js

@@ -2,11 +2,12 @@
 
 'use strict';
 
+const { Buffer } = require('node:buffer');
 const punycode = require('punycode/');
 const libmime = require('libmime');
-const dns = require('dns').promises;
-const crypto = require('crypto');
-const https = require('https');
+const dns = require('node:dns').promises;
+const crypto = require('node:crypto');
+const https = require('node:https');
 const packageData = require('../package');
 const parseDkimHeaders = require('./parse-dkim-headers');
 const psl = require('psl');

package/man/mailauth.1

@@ -1,4 +1,4 @@
-.TH "MAILAUTH" "1" "February 2024" "v4.6.4" "Mailauth Help"
+.TH "MAILAUTH" "1" "May 2024" "v4.6.6" "Mailauth Help"
 .SH "NAME"
 \fBmailauth\fR
 .QP

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mailauth",
-    "version": "4.6.4",
+    "version": "4.6.6",
     "description": "Email authentication library for Node.js",
     "main": "lib/mailauth.js",
     "scripts": {
@@ -42,20 +42,19 @@
         "marked": "0.7.0",
         "marked-man": "0.7.0",
         "mbox-reader": "1.1.5",
-        "mocha": "10.2.0",
-        "npm-check-updates": "16.14.14",
-        "pkg": "5.8.1"
+        "mocha": "10.4.0",
+        "npm-check-updates": "16.14.20"
     },
     "dependencies": {
         "@postalsys/vmc": "1.0.8",
-        "fast-xml-parser": "4.3.4",
-        "ipaddr.js": "2.1.0",
-        "joi": "17.12.1",
-        "libmime": "5.2.1",
-        "nodemailer": "6.9.9",
+        "fast-xml-parser": "4.3.6",
+        "ipaddr.js": "2.2.0",
+        "joi": "17.13.1",
+        "libmime": "5.3.5",
+        "nodemailer": "6.9.13",
         "psl": "1.9.0",
         "punycode": "2.3.1",
-        "undici": "5.28.2",
+        "undici": "5.28.4",
         "uuid": "9.0.1",
         "yargs": "17.7.2"
     },