mailauth 4.6.0 → 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

@@ -1,5 +1,12 @@
 # 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)
 
 

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

@@ -296,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';
@@ -314,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/man/mailauth.1

@@ -1,4 +1,4 @@
-.TH "MAILAUTH" "1" "November 2023" "v4.6.0" "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.6.0",
+    "version": "4.6.1",
     "description": "Email authentication library for Node.js",
     "main": "lib/mailauth.js",
     "scripts": {
@@ -33,28 +33,29 @@
     },
     "homepage": "https://github.com/postalsys/mailauth",
     "devDependencies": {
-        "chai": "4.3.10",
-        "eslint": "8.52.0",
+        "chai": "4.4.1",
+        "eslint": "8.56.0",
         "eslint-config-nodemailer": "1.2.0",
-        "eslint-config-prettier": "9.0.0",
+        "eslint-config-prettier": "9.1.0",
         "js-yaml": "4.1.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.3.2",
+        "fast-xml-parser": "4.3.3",
         "ipaddr.js": "2.1.0",
-        "joi": "17.11.0",
+        "joi": "17.12.0",
         "libmime": "5.2.1",
-        "nodemailer": "6.9.7",
+        "nodemailer": "6.9.8",
         "psl": "1.9.0",
         "punycode": "2.3.1",
-        "undici": "5.27.0",
+        "undici": "5.28.2",
         "yargs": "17.7.2"
     },
     "engines": {

package/.ncurc.json

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