mailauth 4.5.2 → 4.6.1

package/.ncurc.js

@@ -0,0 +1,12 @@
+module.exports = {
+    upgrade: true,
+    reject: [
+        'marked',
+        'marked-man',
+        // only works as ESM
+        'chai',
+
+        // Fails in Node 16
+        'undici'
+    ]
+};

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [4.6.1](https://github.com/postalsys/mailauth/compare/v4.6.0...v4.6.1) (2024-01-24)
+
+
+### Bug Fixes
+
+* **dkim-verify:** Show the length of the source body in DKIM results ([d28663b](https://github.com/postalsys/mailauth/commit/d28663b30b0bfaf07d395e9d3eaea044c9085657))
+
+## [4.6.0](https://github.com/postalsys/mailauth/compare/v4.5.2...v4.6.0) (2023-11-02)
+
+
+### Features
+
+* **deploy:** Set up automatic publishing ([f9b9c32](https://github.com/postalsys/mailauth/commit/f9b9c325e4dbac060114aa12c5887ea8c92c0bf8))

package/cli.md

@@ -22,7 +22,9 @@ Command line utility and a [Node.js library](README.md) for email authentication
 
 Download `mailauth` for your platform:
 
--   [MacOS](https://github.com/postalsys/mailauth/releases/latest/download/mailauth.pkg)
+-   MacOS
+    -   [Intel processors](https://github.com/postalsys/mailauth/releases/latest/download/mailauth.pkg)
+    -   [Apple silicon](https://github.com/postalsys/mailauth/releases/latest/download/mailauth-arm.pkg)
 -   [Linux](https://github.com/postalsys/mailauth/releases/latest/download/mailauth.tar.gz)
 -   [Windows](https://github.com/postalsys/mailauth/releases/latest/download/mailauth.exe)
 -   Or install from the NPM registry: `npm install -g mailauth`

package/lib/dkim/body/relaxed.js

@@ -26,9 +26,14 @@ class RelaxedHash {
         this.bodyHash = crypto.createHash(algorithm);
 
         this.remainder = false;
-        this.byteLength = 0;
 
+        // total body size
+        this.byteLength = 0;
+        // total canonicalized body size
+        this.canonicalizedLength = 0;
+        // hashed canonicalized body size (after l= tag)
         this.bodyHashedBytes = 0;
+
         this.maxBodyLength = maxBodyLength;
 
         this.maxSizeReached = maxBodyLength === 0;
@@ -37,6 +42,8 @@ class RelaxedHash {
     }
 
     _updateBodyHash(chunk) {
+        this.canonicalizedLength += chunk.length;
+
         if (this.maxSizeReached) {
             return;
         }

package/lib/dkim/body/simple.js

@@ -18,8 +18,12 @@ class SimpleHash {
         this.bodyHash = crypto.createHash(algorithm);
 
         this.remainder = [];
-        this.byteLength = 0;
 
+        // total body size
+        this.byteLength = 0;
+        // total canonicalized body size
+        this.canonicalizedLength = 0;
+        // hashed canonicalized body size (after l= tag)
         this.bodyHashedBytes = 0;
 
         this.maxBodyLength = maxBodyLength;
@@ -29,6 +33,8 @@ class SimpleHash {
     }
 
     _updateBodyHash(chunk) {
+        this.canonicalizedLength += chunk.length;
+
         if (this.maxSizeReached) {
             return;
         }

package/lib/dkim/dkim-signer.js

@@ -259,7 +259,9 @@ class DkimSigner extends MessageParser {
                     // value for the l= tag (if needed)
                     typeof signatureData.maxBodyLength === 'number'
                         ? {
-                              bodyHashedBytes: this.bodyHashes.get(hashKey).hasher.bodyHashedBytes
+                              bodyHashedBytes: this.bodyHashes.get(hashKey).hasher.bodyHashedBytes,
+                              canonicalizedLength: this.bodyHashes.get(hashKey).hasher.canonicalizedLength,
+                              sourceBodyLength: this.bodyHashes.get(hashKey).hasher.byteLength
                           }
                         : {}
                 )

package/lib/dkim/dkim-verifier.js

@@ -182,7 +182,8 @@ class DkimVerifier extends MessageParser {
 
                 let signingHeaders = {
                     keys: signingHeaderLines.keys,
-                    headers: signingHeaderLines.headers.map(l => l.line.toString())
+                    headers: signingHeaderLines.headers.map(l => l.line.toString()),
+                    canonicalizedHeader: canonicalizedHeader.toString('base64')
                 };
 
                 let publicKey, rr, modulusLength;
@@ -295,6 +296,8 @@ class DkimVerifier extends MessageParser {
                 }
 
                 signatureHeader.bodyHashedBytes = this.bodyHashes.get(signatureHeader.bodyHashKey)?.bodyHashedBytes;
+                signatureHeader.canonicalizedLength = this.bodyHashes.get(signatureHeader.bodyHashKey)?.canonicalizedLength;
+                signatureHeader.sourceBodyLength = this.bodyHashes.get(signatureHeader.bodyHashKey)?.byteLength;
 
                 if (typeof signatureHeader.maxBodyLength === 'number' && signatureHeader.maxBodyLength !== signatureHeader.bodyHashedBytes) {
                     status.result = 'fail';
@@ -313,12 +316,23 @@ class DkimVerifier extends MessageParser {
                     status
                 };
 
+                if (typeof signatureHeader.sourceBodyLength === 'number') {
+                    result.sourceBodyLength = signatureHeader.sourceBodyLength;
+                }
+
                 if (typeof signatureHeader.bodyHashedBytes === 'number') {
                     result.canonBodyLength = signatureHeader.bodyHashedBytes;
                 }
 
+                if (typeof signatureHeader.canonicalizedLength === 'number') {
+                    result.canonBodyLengthTotal = signatureHeader.canonicalizedLength;
+                }
+
                 if (typeof signatureHeader.maxBodyLength === 'number') {
-                    result.bodyLengthCount = signatureHeader.maxBodyLength;
+                    result.canonBodyLengthLimited = true;
+                    result.canonBodyLengthLimit = signatureHeader.maxBodyLength;
+                } else {
+                    result.canonBodyLengthLimited = false;
                 }
 
                 if (publicKey) {

package/lib/tools.js

@@ -269,14 +269,36 @@ const getPublicKey = async (type, name, minBitLength, resolver) => {
         }
 
         let paddingNeeded = publicKeyValue.length % 4 ? 4 - (publicKeyValue.length % 4) : 0;
+        let paddedPublicKey = publicKeyValue + '='.repeat(paddingNeeded);
+
+        let rawPublicKey = Buffer.from(publicKeyValue, 'base64');
+        let publicKeyObj;
+        let publicKeyOpts;
+
+        if (rawPublicKey.length === 32) {
+            // seems like an ed25519 key
+            rawPublicKey = Buffer.concat([Buffer.from('302A300506032B6570032100', 'hex'), rawPublicKey]);
+            publicKeyOpts = {
+                key: rawPublicKey,
+                format: 'der',
+                type: 'spki'
+            };
+        } else {
+            const publicKeyPem = Buffer.from(`-----BEGIN PUBLIC KEY-----\n${paddedPublicKey.replace(/.{64}/g, '$&\n').trim()}\n-----END PUBLIC KEY-----`);
+            publicKeyOpts = {
+                key: publicKeyPem,
+                format: 'pem'
+            };
+        }
 
-        const publicKeyPem = Buffer.from(
-            `-----BEGIN PUBLIC KEY-----\n${(publicKeyValue + '='.repeat(paddingNeeded)).replace(/.{64}/g, '$&\n')}\n-----END PUBLIC KEY-----`
-        );
-        const publicKeyObj = crypto.createPublicKey({
-            key: publicKeyPem,
-            format: 'pem'
-        });
+        try {
+            publicKeyObj = crypto.createPublicKey(publicKeyOpts);
+        } catch (err) {
+            let error = new Error('Unknown key type (${keyType})', { cause: err });
+            error.code = 'EINVALIDTYPE';
+            error.rr = rr;
+            throw error;
+        }
 
         let keyType = publicKeyObj.asymmetricKeyType;
 
@@ -297,7 +319,10 @@ const getPublicKey = async (type, name, minBitLength, resolver) => {
         }
 
         return {
-            publicKey: publicKeyPem,
+            publicKey: publicKeyObj.export({
+                type: publicKeyObj.asymmetricKeyType === 'ed25519' ? 'spki' : 'pkcs1',
+                format: 'pem'
+            }),
             rr,
             modulusLength
         };

package/man/mailauth.1

@@ -1,4 +1,4 @@
-.TH "MAILAUTH" "1" "August 2023" "v4.5.1" "Mailauth Help"
+.TH "MAILAUTH" "1" "January 2024" "v4.6.1" "Mailauth Help"
 .SH "NAME"
 \fBmailauth\fR
 .QP

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mailauth",
-    "version": "4.5.2",
+    "version": "4.6.1",
     "description": "Email authentication library for Node.js",
     "main": "lib/mailauth.js",
     "scripts": {
@@ -9,7 +9,8 @@
         "man": "cd man && marked-man --version `node -e \"console.log('v'+require('../package.json').version)\"` --manual 'Mailauth Help' --section 1 man.md > mailauth.1",
         "build-source": "rm -rf node_modules package-lock.json && npm install && npm run man && npm run licenses && rm -rf node_modules package-lock.json && npm install --production && rm -rf package-lock.json",
         "build-dist": "npx pkg --compress Brotli package.json && rm -rf package-lock.json && npm install",
-        "licenses": "license-report --only=prod --output=table --config license-report-config.json > licenses.txt"
+        "licenses": "license-report --only=prod --output=table --config license-report-config.json > licenses.txt",
+        "update": "rm -rf node_modules package-lock.json && ncu -u && npm install"
     },
     "repository": {
         "type": "git",
@@ -32,28 +33,29 @@
     },
     "homepage": "https://github.com/postalsys/mailauth",
     "devDependencies": {
-        "chai": "4.3.7",
-        "eslint": "8.46.0",
+        "chai": "4.4.1",
+        "eslint": "8.56.0",
         "eslint-config-nodemailer": "1.2.0",
-        "eslint-config-prettier": "8.10.0",
+        "eslint-config-prettier": "9.1.0",
         "js-yaml": "4.1.0",
-        "license-report": "6.4.0",
+        "license-report": "6.5.0",
         "marked": "0.7.0",
         "marked-man": "0.7.0",
         "mbox-reader": "1.1.5",
         "mocha": "10.2.0",
+        "npm-check-updates": "16.14.12",
         "pkg": "5.8.1"
     },
     "dependencies": {
         "@postalsys/vmc": "1.0.6",
-        "fast-xml-parser": "4.2.7",
+        "fast-xml-parser": "4.3.3",
         "ipaddr.js": "2.1.0",
-        "joi": "17.9.2",
+        "joi": "17.12.0",
         "libmime": "5.2.1",
-        "nodemailer": "6.9.4",
+        "nodemailer": "6.9.8",
         "psl": "1.9.0",
-        "punycode": "2.3.0",
-        "undici": "5.23.0",
+        "punycode": "2.3.1",
+        "undici": "5.28.2",
         "yargs": "17.7.2"
     },
     "engines": {

package/.ncurc.json

@@ -1,4 +0,0 @@
-{
-    "upgrade": true,
-    "reject": ["marked", "marked-man"]
-}

package/licenses.txt

@@ -1,12 +0,0 @@
-name             license type  link                                                            installed version  author
-----             ------------  ----                                                            -----------------  ------
-@postalsys/vmc   MIT           https://registry.npmjs.org/@postalsys/vmc/-/vmc-1.0.6.tgz       1.0.6              Postal Systems OÜ
-fast-xml-parser  MIT           git+https://github.com/NaturalIntelligence/fast-xml-parser.git  4.2.7              Amit Gupta (https://amitguptagwl.github.io)
-ipaddr.js        MIT           git://github.com/whitequark/ipaddr.js.git                       2.1.0              whitequark <whitequark@whitequark.org>
-joi              BSD-3-Clause  git://github.com/hapijs/joi.git                                 17.9.2             n/a
-libmime          MIT           git://github.com/andris9/libmime.git                            5.2.1              Andris Reinman <andris@kreata.ee>
-nodemailer       MIT-0         git+https://github.com/nodemailer/nodemailer.git                6.9.4              Andris Reinman
-psl              MIT           git+ssh://git@github.com/lupomontero/psl.git                    1.9.0              Lupo Montero <lupomontero@gmail.com> (https://lupomontero.com/)
-punycode         MIT           git+https://github.com/mathiasbynens/punycode.js.git            2.3.0              Mathias Bynens https://mathiasbynens.be/
-undici           MIT           git+https://github.com/nodejs/undici.git                        5.23.0             Matteo Collina <hello@matteocollina.com>
-yargs            MIT           git+https://github.com/yargs/yargs.git                          17.7.2             n/a