@haibun/email-testing 1.9.5

package/README.md

@@ -0,0 +1,3 @@
+# haibun-mail-testing
+
+Features for testing standard email facilities.

package/build/email-testing-stepper.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { authenticate } = require('mailauth');
+const { dkimVerify } = require('mailauth/lib/dkim/verify');
+const { spf } = require('mailauth/lib/spf');
+const { getPolicy, validateMx } = require('mailauth/lib/mta-sts');
+const dmarc = require('dmarc-solution');
+const defs_1 = require("@haibun/core/build/lib/defs");
+const util_1 = require("@haibun/core/build/lib/util");
+const EMAIL_SERVER = 'EMAIL_SERVER';
+const EMAIL_MESSAGE = 'EMAIL_MESSAGE';
+const EmailTestingStepper = class EmailTestingStepper extends defs_1.AStepper {
+    constructor() {
+        super(...arguments);
+        this.knownPolicy = undefined;
+        // requireDomains = [EMAIL_SERVER, EMAIL_MESSAGE];
+        this.options = {
+            [EMAIL_SERVER]: {
+                desc: 'Target email server',
+                parse: (input) => (0, util_1.stringOrError)(input)
+            },
+        };
+        this.steps = {
+            dmarcExists: {
+                gwta: `DMARC record exists`,
+                action: async () => {
+                    try {
+                        const record = await dmarc.fetch(this.emailServer);
+                        return defs_1.OK;
+                    }
+                    catch (e) {
+                        return (0, util_1.actionNotOK)(e.getMessage());
+                    }
+                }
+            },
+            dmarcHas: {
+                gwta: `DMARC field {field} is defined`,
+                action: async ({ field }) => {
+                    try {
+                        const record = await dmarc.fetch(this.emailServer);
+                        if (!record.tags[field]) {
+                            return (0, util_1.actionNotOK)(`field ${field} doesn't exist`);
+                        }
+                        return defs_1.OK;
+                    }
+                    catch (e) {
+                        return (0, util_1.actionNotOK)(e.getMessage());
+                    }
+                }
+            },
+            checkMTASTS: {
+                gwta: `domain's mail server agent strict transfer security is valid`,
+                action: async () => {
+                    const { policy } = await this.getPolicy();
+                    for (const mx of policy.mx) {
+                        const policyMatch = validateMx(mx, policy);
+                        if (!policy.id) {
+                            return (0, util_1.actionNotOK)(policyMatch);
+                        }
+                        if (policy.mx && !policyMatch) {
+                            return (0, util_1.actionNotOK)(`unlisted MX ${mx}`);
+                        }
+                    }
+                    if (policy.mode !== 'enforce') {
+                        return (0, util_1.actionNotOK)(`not using enforce mode`);
+                    }
+                    return defs_1.OK;
+                }
+            },
+            validateMXHostname: {
+                gwta: `domain has a valid mail exchange record`,
+                action: async () => {
+                    const { policy } = await this.getPolicy();
+                    const res = await validateMx(this.emailServer, policy);
+                    return res === true ? defs_1.OK : (0, util_1.actionNotOK)(res);
+                }
+            },
+            authenticate: {
+                gwta: `authenticate`,
+                action: async () => {
+                    const message = 'hello';
+                    const { dkim, spf, arc, dmarc, bimi, receivedChain, headers } = await authenticate(message, // either a String, a Buffer or a Readable Stream
+                    {
+                        // SMTP transmission options if available
+                        ip: '217.146.67.33',
+                        helo: 'uvn-67-33.tll01.zonevs.eu',
+                        sender: 'andris@ekiri.ee',
+                        // Uncomment if you do not want to provide ip/helo/sender manually but parse from the message
+                        //trustReceived: true,
+                        // Server processing this message, defaults to os.hostname(). Inserted into Authentication headers
+                        mta: 'mx.ethereal.email',
+                        //  Optional  DNS resolver function (defaults to `dns.promises.resolve`)
+                        // resolver: async (name: any, rr: any) => await dns.promises.resolve(name, rr)
+                    });
+                    // output authenticated message
+                    process.stdout.write(headers); // includes terminating line break
+                    process.stdout.write(message);
+                    return defs_1.OK;
+                }
+            },
+            spf: {
+                gwta: `spf`,
+                action: async () => {
+                    let result = await spf({
+                        sender: 'andris@wildduck.email',
+                        ip: '217.146.76.20',
+                        helo: 'foo',
+                        mta: 'mx.myhost.com'
+                    });
+                    return defs_1.OK;
+                }
+            }
+        };
+    }
+    async setWorld(world, steppers) {
+        super.setWorld(world, steppers);
+        this.world = world;
+        this.emailServer = (0, util_1.getStepperOption)(this, EMAIL_SERVER, this.world.extraOptions);
+    }
+    async getPolicy() {
+        const res = await getPolicy(this.emailServer, this.knownPolicy);
+        return res;
+    }
+};
+exports.default = EmailTestingStepper;

package/build/email-testing-stepper.test.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lib_1 = require("@haibun/core/build/lib/test/lib");
+const util_1 = require("@haibun/core/build/lib/util");
+const run_1 = require("@haibun/core/build/lib/run");
+const email_testing_stepper_1 = __importDefault(require("./email-testing-stepper"));
+const domain = 'google.com';
+describe('MTA', () => {
+    it('MTA STS', async () => {
+        const protoOptions = { extraOptions: { [(0, util_1.getStepperOptionName)(email_testing_stepper_1.default, 'EMAIL_SERVER')]: domain, }, options: run_1.DEF_PROTO_DEFAULT_OPTIONS };
+        const { ok } = await (0, lib_1.testWithDefaults)(`domain's mail server agent strict transfer security is valid`, [email_testing_stepper_1.default], protoOptions);
+        expect(ok).toBe(true);
+    });
+});
+describe('DMARC', () => {
+    it('Has a valid dmarc record', async () => {
+        const protoOptions = { extraOptions: { [(0, util_1.getStepperOptionName)(email_testing_stepper_1.default, 'EMAIL_SERVER')]: domain, }, options: run_1.DEF_PROTO_DEFAULT_OPTIONS };
+        const { ok } = await (0, lib_1.testWithDefaults)(`DMARC record exists`, [email_testing_stepper_1.default], protoOptions);
+        expect(ok).toBe(true);
+    });
+    it('DMARC rua is defined', async () => {
+        const protoOptions = { extraOptions: { [(0, util_1.getStepperOptionName)(email_testing_stepper_1.default, 'EMAIL_SERVER')]: domain, }, options: run_1.DEF_PROTO_DEFAULT_OPTIONS };
+        const { ok } = await (0, lib_1.testWithDefaults)(`DMARC field rua is defined`, [email_testing_stepper_1.default], protoOptions);
+        expect(ok).toBe(true);
+    });
+});

package/build/email-testingstepper.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { authenticate } = require('mailauth');
+const { dkimVerify } = require('mailauth/lib/dkim/verify');
+const { spf } = require('mailauth/lib/spf');
+const { getPolicy, validateMx } = require('mailauth/lib/mta-sts');
+const defs_1 = require("@haibun/core/build/lib/defs");
+const util_1 = require("@haibun/core/build/lib/util");
+const EMAIL_SERVER = 'EMAIL_SERVER';
+const EMAIL_MESSAGE = 'EMAIL_MESSAGE';
+const EmailTestingStepper = class EmailTestingStepper extends defs_1.AStepper {
+    constructor() {
+        super(...arguments);
+        // requireDomains = [EMAIL_SERVER, EMAIL_MESSAGE];
+        this.options = {
+            [EMAIL_SERVER]: {
+                desc: 'Target email server',
+                parse: (input) => (0, util_1.stringOrError)(input)
+            },
+        };
+        this.steps = {
+            checkMTASTS: {
+                gwta: `domain's mail server agent strict transfer security is valid`,
+                action: async () => {
+                    const { policy } = await this.getPolicy();
+                    for (const mx of policy.mx) {
+                        const policyMatch = validateMx(mx, policy);
+                        if (!policy.id) {
+                            return (0, util_1.actionNotOK)(policyMatch);
+                        }
+                        if (policy.mx && !policyMatch) {
+                            return (0, util_1.actionNotOK)(`unlisted MX ${mx}`);
+                        }
+                    }
+                    if (policy.mode !== 'enforce') {
+                        return (0, util_1.actionNotOK)(`not using enforce mode`);
+                    }
+                    return defs_1.OK;
+                }
+            },
+            validateMXHostname: {
+                gwta: `domain has a valid mail exchange record`,
+                action: async () => {
+                    const { policy } = await this.getPolicy();
+                    const res = await validateMx(this.emailServer, policy);
+                    return res === true ? defs_1.OK : (0, util_1.actionNotOK)(res);
+                }
+            },
+            authenticate: {
+                gwta: `authenticate`,
+                action: async () => {
+                    const message = 'hello';
+                    const { dkim, spf, arc, dmarc, bimi, receivedChain, headers } = await authenticate(message, // either a String, a Buffer or a Readable Stream
+                    {
+                        // SMTP transmission options if available
+                        ip: '217.146.67.33',
+                        helo: 'uvn-67-33.tll01.zonevs.eu',
+                        sender: 'andris@ekiri.ee',
+                        // Uncomment if you do not want to provide ip/helo/sender manually but parse from the message
+                        //trustReceived: true,
+                        // Server processing this message, defaults to os.hostname(). Inserted into Authentication headers
+                        mta: 'mx.ethereal.email',
+                        //  Optional  DNS resolver function (defaults to `dns.promises.resolve`)
+                        // resolver: async (name: any, rr: any) => await dns.promises.resolve(name, rr)
+                    });
+                    // output authenticated message
+                    process.stdout.write(headers); // includes terminating line break
+                    process.stdout.write(message);
+                    return defs_1.OK;
+                }
+            },
+            spf: {
+                gwta: `spf`,
+                action: async () => {
+                    let result = await spf({
+                        sender: 'andris@wildduck.email',
+                        ip: '217.146.76.20',
+                        helo: 'foo',
+                        mta: 'mx.myhost.com'
+                    });
+                    return defs_1.OK;
+                }
+            }
+        };
+    }
+    async setWorld(world, steppers) {
+        super.setWorld(world, steppers);
+        this.world = world;
+        this.emailServer = (0, util_1.getStepperOption)(this, EMAIL_SERVER, this.world.extraOptions);
+    }
+    async getPolicy() {
+        const knownPolicy = undefined;
+        const res = await getPolicy(this.emailServer, knownPolicy);
+        return res;
+    }
+};
+exports.default = EmailTestingStepper;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@haibun/email-testing",
+  "version": "1.9.5",
+  "description": "",
+  "main": "build/web-http.js",
+  "files": [
+    "build/"
+  ],
+  "jest": {
+    "roots": [
+      "<rootDir>/src"
+    ],
+    "testMatch": [
+      "**/__tests__ /**/*.+(ts|tsx|js)",
+      "**/?(*.)+(spec|test).+(ts|tsx|js)"
+    ],
+    "transform": {
+      "^.+\\.(ts|tsx)$": "ts-jest"
+    }
+  },
+  "scripts": {
+    "prepublishOnly": "tsc -b .",
+    "tsc-watch": "tsc -b . --watch",
+    "test": "jest",
+    "test-watch": "jest --watch"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@haibun/core": "^1.2.4",
+    "dmarc-solution": "^1.2.5",
+    "mailauth": "^4.0.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^28.1.8",
+    "@types/node": "^15.0.1",
+    "@typescript-eslint/eslint-plugin": "^4.13.0",
+    "@typescript-eslint/parser": "^4.13.0",
+    "eslint": "^7.2.0",
+    "eslint-config-airbnb-typescript": "^12.0.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prefer-arrow": "^1.2.2",
+    "eslint-plugin-prettier": "^3.3.1",
+    "jest": "^28.1.3",
+    "prettier": "^2.3.1",
+    "ts-jest": "^28.0.8",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.1.3"
+  }
+}