@bitblit/ratchet-warden-server 4.0.84-alpha

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Notes]
+Alpha releases are exactly what they sound like - places where I am trying out new things that aren't ready for prime
+time, but I need published to see how they interact with the rest of my software ecosystem.  If you use an alpha
+package without knowing why it is alpha you'll get exactly what you deserve.
+
+## [Unreleased]
+
+## In Flight
+
+## [0.0.x] - 2018-03-23
+### Initial Release
+- Basic support for Warden, email and text messaging, and a simplified interface for bootstrapping over GraphQL
+

package/License.txt

@@ -0,0 +1,13 @@
+Copyright 2022-2023 Christopher Weiss
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,38 @@
+# @bitblit/Warden
+
+Typescript library to simplify using simplewebauthn and secondary auth methods over GraphQL.
+
+## Introduction
+
+I really like using the [SimpleWebAuthn](https://simplewebauthn.dev/) library for Authentication but it has a couple
+pieces of code that I still end up re-writing over and over - adding the secondary login methods (like single-use
+code sent to email/text) and setting it up to run over GraphQL, which I use regularly and don't really want to 
+add a bunch of special methods when they are boilerplate inside anyway once I nail down storage.
+
+So, Warden handles that stuff for me.  Relies heavily on my [Ratchet](https://github.com/bitblit/Ratchet) library
+for supporting code.
+
+You may wish to read [the changelog](CHANGELOG.md)
+
+## Installation
+
+`yarn install @bitblit/warden`
+
+## Usage
+
+TBD
+
+### Barrel Files
+A Note on barrel files - All of Warden's barrel files are one level down. This is because otherwise everything
+I said above about transitive dependencies gets thrown out the window if you put them all in one big barrel file
+
+# Testing
+
+Ha! No, seriously - all testing is done using Jest.  To run them:
+
+`yarn test`
+
+# Contributing
+
+Pull requests are welcome, although I'm not sure why you'd be interested!
+

package/dist/cjs/build/ratchet-warden-server-info.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RatchetWardenServerInfo = void 0;
+class RatchetWardenServerInfo {
+    constructor() { }
+    static buildInformation() {
+        const val = {
+            version: '84',
+            hash: 'f4d435f9dba4b8b2eaefb31582fcf44290522d7f',
+            branch: 'alpha-2023-03-12-7',
+            tag: 'alpha-2023-03-12-7',
+            timeBuiltISO: '2023-03-12T22:04:40-0700',
+            notes: '',
+        };
+        return val;
+    }
+}
+exports.RatchetWardenServerInfo = RatchetWardenServerInfo;

package/dist/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./build/ratchet-warden-server-info"), exports);
+tslib_1.__exportStar(require("./server/warden-service-options"), exports);
+tslib_1.__exportStar(require("./server/warden-service"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-default-user-decoration-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-event-processing-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-mailer-message-sending-provider-options"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-mailer-message-sending-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-message-sending-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-no-op-event-processing-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-s3-single-file-storage-provider-options"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-s3-single-file-storage-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-storage-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-twilio-text-message-sending-provider-options"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-twilio-text-message-sending-provider"), exports);
+tslib_1.__exportStar(require("./server/provider/warden-user-decoration-provider"), exports);

package/dist/cjs/server/provider/warden-default-user-decoration-provider.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenDefaultUserDecorationProvider = void 0;
+const ratchet_warden_common_1 = require("@bitblit/ratchet-warden-common");
+class WardenDefaultUserDecorationProvider {
+    async fetchDecoration(wardenUser) {
+        const rval = {
+            userTokenData: ratchet_warden_common_1.WardenUtils.stripWardenEntryToSummary(wardenUser),
+            userTokenExpirationSeconds: 3600,
+            userTeamRoles: [{ team: 'WARDEN', role: 'USER' }],
+        };
+        return rval;
+    }
+}
+exports.WardenDefaultUserDecorationProvider = WardenDefaultUserDecorationProvider;

package/dist/cjs/server/provider/warden-event-processing-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/provider/warden-mailer-message-sending-provider-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/provider/warden-mailer-message-sending-provider.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenMailerMessageSendingProvider = void 0;
+const ratchet_warden_common_1 = require("@bitblit/ratchet-warden-common");
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+class WardenMailerMessageSendingProvider {
+    static defaultOptions() {
+        const rval = {
+            emailBaseLayoutName: undefined,
+            expiringTokenHtmlTemplateName: 'expiring-token-request-email',
+            expiringTokenTxtTemplateName: undefined,
+        };
+        return rval;
+    }
+    constructor(mailer, options = WardenMailerMessageSendingProvider.defaultOptions()) {
+        this.mailer = mailer;
+        this.options = options;
+    }
+    async formatMessage(contact, messageType, context) {
+        const rts = {
+            destinationAddresses: [contact.value],
+            subject: 'Your login token',
+        };
+        await this.mailer.fillEmailBody(rts, context, this.options.expiringTokenHtmlTemplateName, this.options.expiringTokenTxtTemplateName, this.options.emailBaseLayoutName);
+        return rts;
+    }
+    handlesContactType(type) {
+        return type === ratchet_warden_common_1.WardenContactType.EmailAddress;
+    }
+    async sendMessage(contact, message) {
+        const rval = await this.mailer.sendEmail(message);
+        ratchet_common_1.Logger.debug('SendRawEmailResponse was : %j', rval);
+        return !!rval;
+    }
+}
+exports.WardenMailerMessageSendingProvider = WardenMailerMessageSendingProvider;

package/dist/cjs/server/provider/warden-message-sending-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/provider/warden-no-op-event-processing-provider.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenNoOpEventProcessingProvider = void 0;
+class WardenNoOpEventProcessingProvider {
+    async userCreated(entry) { }
+    async userRemoved(entry) { }
+}
+exports.WardenNoOpEventProcessingProvider = WardenNoOpEventProcessingProvider;

package/dist/cjs/server/provider/warden-s3-single-file-storage-provider-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/provider/warden-s3-single-file-storage-provider.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenS3SingleFileStorageProvider = void 0;
+const ratchet_warden_common_1 = require("@bitblit/ratchet-warden-common");
+const ratchet_aws_1 = require("@bitblit/ratchet-aws");
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+class WardenS3SingleFileStorageProvider {
+    constructor(s3, options) {
+        this.s3 = s3;
+        this.options = options;
+        this.ratchet = new ratchet_aws_1.S3CacheRatchet(this.s3, this.options.bucket);
+    }
+    async listUserSummaries() {
+        const allData = (await this.fetchDataFile()).entries;
+        const rval = allData.map((d) => ratchet_warden_common_1.WardenUtils.stripWardenEntryToSummary(d));
+        return rval;
+    }
+    async fetchDataFile() {
+        let data = await this.ratchet.fetchCacheFileAsObject(this.options.dataFileKey);
+        data = data || {
+            entries: [],
+            challenges: [],
+        };
+        return data;
+    }
+    async storeDataFile(file) {
+        let rval = null;
+        if (file) {
+            rval = await this.ratchet.writeObjectToCacheFile(this.options.dataFileKey, file);
+        }
+        return rval;
+    }
+    async fetchCurrentUserChallenge(userId, relyingPartyId) {
+        const data = await this.fetchDataFile();
+        const entry = (data.challenges || []).find((d) => d.userId === userId && d.relyingPartyId === relyingPartyId);
+        if (!entry) {
+            ratchet_common_1.ErrorRatchet.throwFormattedErr('fetchCurrentUserChallenge: Could not find user %s', userId);
+        }
+        return entry.challenge;
+    }
+    async findEntryByContact(contact) {
+        let rval = null;
+        if ((contact === null || contact === void 0 ? void 0 : contact.type) && ratchet_common_1.StringRatchet.trimToNull(contact === null || contact === void 0 ? void 0 : contact.value)) {
+            const data = await this.fetchDataFile();
+            rval = (data.entries || []).find((d) => !!(d.contactMethods || []).find((x) => x.type === contact.type && x.value === contact.value));
+        }
+        return rval;
+    }
+    async findEntryById(userId) {
+        let rval = null;
+        if (ratchet_common_1.StringRatchet.trimToNull(userId)) {
+            const data = await this.fetchDataFile();
+            rval = (data.entries || []).find((d) => d.userId === userId);
+        }
+        return rval;
+    }
+    async removeEntry(userId) {
+        const data = await this.fetchDataFile();
+        data.entries = (data.entries || []).filter((d) => d.userId !== userId);
+        await this.storeDataFile(data);
+        return true;
+    }
+    async saveEntry(entry) {
+        let rval = null;
+        if (entry && entry.userId) {
+            const now = Date.now();
+            entry.createdEpochMS = entry.createdEpochMS || now;
+            entry.updatedEpochMS = now;
+            const data = await this.fetchDataFile();
+            data.entries = (data.entries || []).filter((d) => d.userId !== entry.userId);
+            data.entries.push(entry);
+            await this.storeDataFile(data);
+            rval = await this.findEntryById(entry.userId);
+        }
+        return rval;
+    }
+    async updateUserChallenge(userId, relyingPartyId, challenge) {
+        const data = await this.fetchDataFile();
+        data.challenges = (data.challenges || []).filter((d) => d.userId !== userId || d.relyingPartyId !== relyingPartyId);
+        data.challenges.push({
+            userId: userId,
+            relyingPartyId: relyingPartyId,
+            challenge: challenge,
+            updatedEpochMS: Date.now(),
+        });
+        await this.storeDataFile(data);
+        return true;
+    }
+}
+exports.WardenS3SingleFileStorageProvider = WardenS3SingleFileStorageProvider;

package/dist/cjs/server/provider/warden-storage-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/provider/warden-twilio-text-message-sending-provider-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/provider/warden-twilio-text-message-sending-provider.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WardenTwilioTextMessageSendingProvider = void 0;
+const ratchet_warden_common_1 = require("@bitblit/ratchet-warden-common");
+const ratchet_common_1 = require("@bitblit/ratchet-common");
+class WardenTwilioTextMessageSendingProvider {
+    constructor(optsPromise) {
+        this.optsPromise = optsPromise;
+    }
+    async formatMessage(contact, messageType, context) {
+        ratchet_common_1.Logger.info('Creating text');
+        const msg = context['code'] +
+            ' is your ' +
+            context['relyingPartyName'] +
+            ' authentication code.\n@' +
+            context['relyingPartyName'] +
+            ' #' +
+            context['code'];
+        return msg;
+    }
+    handlesContactType(type) {
+        return type === ratchet_warden_common_1.WardenContactType.TextCapablePhoneNumber;
+    }
+    async sendMessage(contact, message) {
+        const opts = await this.optsPromise;
+        const rval = await ratchet_common_1.TwilioRatchet.sendMessageDirect(opts.accountSID, opts.authToken, opts.outBoundNumber, [contact.value], message);
+        ratchet_common_1.Logger.debug('sendMessage was : %j', rval);
+        return !!rval && rval.length > 0;
+    }
+}
+exports.WardenTwilioTextMessageSendingProvider = WardenTwilioTextMessageSendingProvider;

package/dist/cjs/server/provider/warden-user-decoration-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/server/warden-service-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });