mailauth 4.6.1 → 4.6.3

package/CHANGELOG.md

@@ -1,15 +1,26 @@
 # Changelog
 
-## [4.6.1](https://github.com/postalsys/mailauth/compare/v4.6.0...v4.6.1) (2024-01-24)
+## [4.6.3](https://github.com/postalsys/mailauth/compare/v4.6.2...v4.6.3) (2024-01-26)
 
 
 ### Bug Fixes
 
-* **dkim-verify:** Show the length of the source body in DKIM results ([d28663b](https://github.com/postalsys/mailauth/commit/d28663b30b0bfaf07d395e9d3eaea044c9085657))
+* bumped 2022 in copyright notices to 2024 ([cc89823](https://github.com/postalsys/mailauth/commit/cc8982349d14b42a28581ebc52aa6de2e11b5be8))
 
-## [4.6.0](https://github.com/postalsys/mailauth/compare/v4.5.2...v4.6.0) (2023-11-02)
+## [4.6.2](https://github.com/postalsys/mailauth/compare/v4.6.1...v4.6.2) (2024-01-25)
+
+### Bug Fixes
+
+-   **bimi:** skip bimi with undersized DKIM signatures ([d666d74](https://github.com/postalsys/mailauth/commit/d666d7476cbcae8b3161c78a7e737559ad112fd9))
 
+## [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))
+-   **deploy:** Set up automatic publishing ([f9b9c32](https://github.com/postalsys/mailauth/commit/f9b9c325e4dbac060114aa12c5887ea8c92c0bf8))

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2020-2022 Postal Systems OÜ
+Copyright (c) 2020-2024 Postal Systems OÜ
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -470,6 +470,6 @@ const { authenticate } = require('mailauth');
 
 ## License
 
-© 2020-2022 Postal Systems OÜ
+© 2020-2024 Postal Systems OÜ
 
 Licensed under MIT license

package/lib/bimi/index.js

@@ -51,6 +51,13 @@ const lookup = async data => {
         return response;
     }
 
+    if (dmarc.alignment?.dkim?.underSized) {
+        response.status.result = 'skipped';
+        response.status.comment = 'undersized DKIM signature';
+        response.info = formatAuthHeaderRow('bimi', response.status);
+        return response;
+    }
+
     const authorDomain = dmarc.status?.header?.from;
     const orgDomain = dmarc.domain;
 

package/lib/dkim/dkim-verifier.js

@@ -7,6 +7,7 @@ const { generateCanonicalizedHeader } = require('./header');
 const { getARChain } = require('../arc');
 const addressparser = require('nodemailer/lib/addressparser');
 const crypto = require('crypto');
+const { v4: uuidv4 } = require('uuid');
 
 class DkimVerifier extends MessageParser {
     constructor(options) {
@@ -204,7 +205,9 @@ class DkimVerifier extends MessageParser {
                 };
 
                 if (signatureHeader.type === 'DKIM' && this.headerFrom?.length) {
-                    status.aligned = this.headerFrom?.length ? getAlignment(this.headerFrom[0].split('@').pop(), [signatureHeader.signingDomain]) : false;
+                    status.aligned = this.headerFrom?.length
+                        ? getAlignment(this.headerFrom[0].split('@').pop(), [signatureHeader.signingDomain])?.domain || false
+                        : false;
                 }
 
                 let bodyHash = this.bodyHashes.get(signatureHeader.bodyHashKey)?.hash;
@@ -305,6 +308,9 @@ class DkimVerifier extends MessageParser {
                 }
 
                 let result = {
+                    id: signatureHeader.parsed?.b?.value
+                        ? crypto.createHash('sha256').update(Buffer.from(signatureHeader.parsed?.b?.value, 'base64')).digest('hex')
+                        : uuidv4(),
                     signingDomain: signatureHeader.signingDomain,
                     selector: signatureHeader.selector,
                     signature: signatureHeader.parsed?.b?.value,
@@ -331,6 +337,9 @@ class DkimVerifier extends MessageParser {
                 if (typeof signatureHeader.maxBodyLength === 'number') {
                     result.canonBodyLengthLimited = true;
                     result.canonBodyLengthLimit = signatureHeader.maxBodyLength;
+                    if (result.canonBodyLengthTotal > result.canonBodyLength) {
+                        status.underSized = result.canonBodyLengthTotal - result.canonBodyLength;
+                    }
                 } else {
                     result.canonBodyLengthLimited = false;
                 }

package/lib/dmarc/verify.js

@@ -101,8 +101,8 @@ const verifyDmarc = async opts => {
         rr: dmarcRecord.rr,
 
         alignment: {
-            spf: { result: spfAlignment, strict: dmarcRecord.aspf === 's' },
-            dkim: { result: dkimAlignment, strict: dmarcRecord.adkim === 's' }
+            spf: { result: spfAlignment?.domain, strict: dmarcRecord.aspf === 's' },
+            dkim: { result: dkimAlignment?.domain, strict: dmarcRecord.adkim === 's', underSized: dkimAlignment?.underSized }
         }
     });
 };

package/lib/mailauth.js

@@ -119,7 +119,14 @@ const authenticate = async (input, opts) => {
         dmarcResult = await dmarc({
             headerFrom: dkimResult.headerFrom,
             spfDomains: [].concat((spfResult && spfResult.status.result === 'pass' && spfResult.domain) || []),
-            dkimDomains: (dkimResult.results || []).filter(r => r.status.result === 'pass').map(r => r.signingDomain),
+            dkimDomains: (dkimResult.results || [])
+                .filter(r => r.status.result === 'pass')
+                .map(r => ({
+                    id: r.id,
+                    domain: r.signingDomain,
+                    aligned: r.status.aligned,
+                    underSized: r.status.underSized
+                })),
             arcResult,
             resolver: opts.resolver
         });

package/lib/tools.js

@@ -398,6 +398,10 @@ const formatAuthHeaderRow = (method, status) => {
 
     parts.push(`${method}=${status.result || 'none'}`);
 
+    if (status.underSized) {
+        parts.push(`(${escapeCommentValue(`undersized signature: ${status.underSized}`)})`);
+    }
+
     if (status.comment) {
         parts.push(`(${escapeCommentValue(status.comment)})`);
     }
@@ -443,23 +447,32 @@ const formatDomain = domain => {
 };
 
 const getAlignment = (fromDomain, domainList, strict) => {
-    domainList = [].concat(domainList || []);
+    domainList = []
+        .concat(domainList || [])
+        .map(entry => {
+            if (typeof entry === 'string') {
+                return { domain: entry };
+            }
+            return entry;
+        })
+        .sort((a, b) => (a.underSized || 0) - (b.underSized || 0));
+
     if (strict) {
         fromDomain = formatDomain(fromDomain);
-        for (let domain of domainList) {
-            domain = formatDomain(psl.get(domain) || domain);
+        for (let entry of domainList) {
+            let domain = formatDomain(psl.get(entry.domain) || entry.domain);
             if (formatDomain(domain) === fromDomain) {
-                return domain;
+                return entry;
             }
         }
     }
 
     // match org domains
     fromDomain = formatDomain(psl.get(fromDomain) || fromDomain);
-    for (let domain of domainList) {
-        domain = formatDomain(psl.get(domain) || domain);
+    for (let entry of domainList) {
+        let domain = formatDomain(psl.get(entry.domain) || entry.domain);
         if (domain === fromDomain) {
-            return domain;
+            return entry;
         }
     }
 

package/man/mailauth.1

@@ -1,4 +1,4 @@
-.TH "MAILAUTH" "1" "January 2024" "v4.6.1" "Mailauth Help"
+.TH "MAILAUTH" "1" "January 2024" "v4.6.3" "Mailauth Help"
 .SH "NAME"
 \fBmailauth\fR
 .QP
@@ -138,7 +138,7 @@ You can split longer TXT strings into multiple strings\. There is no length limi
 Please report any bugs to https://github\.com/postalsys/mailauth/issues\.
 .SH LICENSE
 .P
-Copyright (c) 2020\-2022, Postal Systems (MIT)\.
+Copyright (c) 2020\-2024, Postal Systems (MIT)\.
 .SH SEE ALSO
 .P
 node\.js(1)

package/man/man.md

@@ -133,7 +133,7 @@ Please report any bugs to https://github.com/postalsys/mailauth/issues.
 
 ## LICENSE
 
-Copyright (c) 2020-2022, Postal Systems (MIT).
+Copyright (c) 2020-2024, Postal Systems (MIT).
 
 ## SEE ALSO
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mailauth",
-    "version": "4.6.1",
+    "version": "4.6.3",
     "description": "Email authentication library for Node.js",
     "main": "lib/mailauth.js",
     "scripts": {
@@ -43,7 +43,7 @@
         "marked-man": "0.7.0",
         "mbox-reader": "1.1.5",
         "mocha": "10.2.0",
-        "npm-check-updates": "16.14.12",
+        "npm-check-updates": "16.14.13",
         "pkg": "5.8.1"
     },
     "dependencies": {
@@ -56,6 +56,7 @@
         "psl": "1.9.0",
         "punycode": "2.3.1",
         "undici": "5.28.2",
+        "uuid": "9.0.1",
         "yargs": "17.7.2"
     },
     "engines": {