mailauth 4.2.0 → 4.3.0

package/README.md

@@ -300,13 +300,13 @@ DMARC is verified as part of the authentication process and even as the `dmarc`
 
 ### Helpers
 
-#### getDmarcRecord
+#### getDmarcRecord(domain [,resolver])
 
-Returns parsed DMARC DNS record for a domain, or a subdomain
+Returns parsed DMARC DNS record for a domain or a subdomain or `false` is no record exists.
 
 ```
 const getDmarcRecord = require('mailauth/lib/dmarc/get-dmarc-record');
-const dmarcRecord = getDmarcRecord("ethereal.email");
+const dmarcRecord = await getDmarcRecord("ethereal.email");
 console.log(dmarcRecord);
 ```
 
@@ -327,6 +327,8 @@ console.log(dmarcRecord);
 
 `isOrgRecord` is `true` for sudomains, where organizational domain's DMARC policy applies, so use the `sp`, not `p` policy.
 
+Optionally set `resolver` argument with custom resolver (uses `dns.resolve` by default).
+
 ## BIMI
 
 Brand Indicators for Message Identification (BIMI) support is based on [draft-blank-ietf-bimi-01](https://tools.ietf.org/html/draft-blank-ietf-bimi-01).
@@ -382,7 +384,7 @@ if (policy.mode === 'enforce') {
     // must use TLS
 }
 
-if (policy.mx && !policyMatch) {
+if (policy.mx && !policyMatch.valid) {
     // can't connect, unlisted MX
 }
 ```
@@ -419,7 +421,7 @@ The function returns an object with the following properties:
 Check if a resolved MX hostname is valid by MTA-STS policy or not.
 
 ```
-validateMx(mx, policy) -> Boolean
+validateMx(mx, policy) -> Object
 ```
 
 Where
@@ -427,7 +429,7 @@ Where
 -   **mx** is the resolved MX hostname (eg. "gmail-smtp-in.l.google.com")
 -   **policy** is the policy object returned by `getPolicy()`
 
-The function returns a boolean. If it is `true`, then MX hostname is allowed to use.
+The function returns an object. If `{valid}` is `true`, then MX hostname is allowed to be used.
 
 ## Testing
 

package/lib/mta-sts.js

@@ -139,9 +139,13 @@ const parsePolicy = file => {
  */
 const validateMx = (mx, policy) => {
     policy = policy || { mode: 'none' };
-    if (policy.mode === 'none' || policy.mode === 'testing') {
+    if (policy.mode === 'none' || !policy.mode) {
         // nothing to check for
-        return true;
+        return {
+            valid: true,
+            mode: policy.mode || 'none',
+            testing: policy.mode === 'testing'
+        };
     }
 
     mx = (mx || '').toString().trim().toLowerCase();
@@ -161,15 +165,29 @@ const validateMx = (mx, policy) => {
             // remove wildcard
             allowed = allowed.substr(1);
             if (mx.substr(-allowed.length) === allowed) {
-                return true;
+                return {
+                    valid: true,
+                    mode: policy.mode || 'none',
+                    match: allowed,
+                    testing: policy.mode === 'testing'
+                };
             }
         } else if (allowed === mx) {
-            return true;
+            return {
+                valid: true,
+                mode: policy.mode || 'none',
+                match: allowed,
+                testing: policy.mode === 'testing'
+            };
         }
     }
 
     // no match found
-    return false;
+    return {
+        valid: false,
+        mode: policy.mode || 'none',
+        testing: policy.mode === 'testing'
+    };
 };
 
 /**

package/licenses.txt

@@ -1,11 +1,11 @@
 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.0.15             Amit Gupta (https://amitkumargupta.work/)
+fast-xml-parser  MIT           git+https://github.com/NaturalIntelligence/fast-xml-parser.git  4.1.1              Amit Gupta (https://amitkumargupta.work/)
 ipaddr.js        MIT           git://github.com/whitequark/ipaddr.js.git                       2.0.1              whitequark <whitequark@whitequark.org>
 joi              BSD-3-Clause  git://github.com/hapijs/joi.git                                 17.7.0             n/a
-libmime          MIT           git://github.com/andris9/libmime.git                            5.2.0              Andris Reinman <andris@kreata.ee>
-nodemailer       MIT           git+https://github.com/nodemailer/nodemailer.git                6.9.0              Andris Reinman
+libmime          MIT           git://github.com/andris9/libmime.git                            5.2.1              Andris Reinman <andris@kreata.ee>
+nodemailer       MIT           git+https://github.com/nodemailer/nodemailer.git                6.9.1              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/
 yargs            MIT           git+https://github.com/yargs/yargs.git                          17.6.2             n/a

package/man/mailauth.1

@@ -1,4 +1,4 @@
-.TH "MAILAUTH" "1" "February 2023" "v4.1.0" "Mailauth Help"
+.TH "MAILAUTH" "1" "March 2023" "v4.2.0" "Mailauth Help"
 .SH "NAME"
 \fBmailauth\fR
 .QP

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mailauth",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "Email authentication library for Node.js",
     "main": "lib/mailauth.js",
     "scripts": {
@@ -33,7 +33,7 @@
     "homepage": "https://github.com/postalsys/mailauth",
     "devDependencies": {
         "chai": "4.3.7",
-        "eslint": "8.33.0",
+        "eslint": "8.35.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "8.6.0",
         "js-yaml": "4.1.0",
@@ -46,14 +46,14 @@
     },
     "dependencies": {
         "@postalsys/vmc": "1.0.6",
-        "fast-xml-parser": "4.1.1",
+        "fast-xml-parser": "4.1.3",
         "ipaddr.js": "2.0.1",
-        "joi": "17.7.0",
+        "joi": "17.8.3",
         "libmime": "5.2.1",
         "nodemailer": "6.9.1",
         "psl": "1.9.0",
         "punycode": "2.3.0",
-        "yargs": "17.6.2"
+        "yargs": "17.7.1"
     },
     "engines": {
         "node": ">=16.0.0"