@oneuptime/common 12.0.21 → 12.0.23

package/build/dist/Server/Utils/TwoFactorBackupCode.js

@@ -0,0 +1,269 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { EncryptionSecret } from "../EnvironmentConfig";
+import CaptureSpan from "./Telemetry/CaptureSpan";
+import crypto from "crypto";
+/*
+ * Single-use recovery codes for an account whose second factor is gone --
+ * the phone that held the authenticator app, or the security key that is now
+ * in a taxi somewhere.
+ *
+ * WHY THIS IS SERVER-ONLY
+ *
+ * Nothing in this file falls back to Math.random. Common/Utils/UUID does, on
+ * purpose, because it is bundled into the dashboard and has to keep producing
+ * well-formed ids in a browser with no Web Crypto -- which is exactly why
+ * ObjectID.generate() must never mint a code here. A backup code is a
+ * password-equivalent credential; if the platform cannot produce secure
+ * randomness, generation must throw rather than quietly emit something
+ * predictable. Common/Server/Utils/VerificationCode.ts makes the same call for
+ * the same reason.
+ *
+ * THE CODE SPACE
+ *
+ * Ten characters drawn uniformly from a 32 symbol alphabet is 2^50 codes, and
+ * a user holds ten of them at once -- so a blind guess lands with probability
+ * ~10/2^50, about one in 10^14. That is far beyond anything the rate limiter
+ * needs to defend, which matters because it settles the design question a TOTP
+ * code cannot settle: the six digit space is small enough that the limiter IS
+ * the control, whereas here the code itself is.
+ *
+ * THE HASH
+ *
+ * Codes are stored as HMAC-SHA256 keyed by the instance's EncryptionSecret,
+ * never in the clear, and the fast keyed-digest lane is the RIGHT one here
+ * rather than scrypt. scrypt exists to make guessing a low-entropy,
+ * human-chosen secret expensive; a code minted above has no low-entropy
+ * structure to guess, so the cost would buy nothing and would be paid on every
+ * verification. Keying with the EncryptionSecret is what a bare SHA-256 would
+ * miss: it lives in configuration rather than in Postgres, so a database dump
+ * on its own cannot be run through a dictionary of every possible code.
+ *
+ * The digest is deterministic given (userId, code), which is deliberate and is
+ * what makes single-use consumption a single conditional UPDATE rather than a
+ * read of every one of the user's rows followed by a comparison of each. A
+ * per-row salt would forfeit that for no gain -- see the note on domain
+ * separation below for the property it would have been bought for, which the
+ * userId already provides.
+ */
+/**
+ * Crockford's Base32 alphabet: the digits and the uppercase letters, minus
+ * I, L, O and U.
+ *
+ * These codes get read off a screen and typed back in months later, possibly
+ * from a piece of paper in a drawer, so the alphabet is chosen for the eye
+ * rather than for density. I/1, L/1 and O/0 are the pairs people transcribe
+ * wrongly; U is dropped by Crockford so that no code can spell an obscenity
+ * at a user who did nothing to deserve one.
+ *
+ * Exactly 32 symbols, so each character carries a clean five bits and the
+ * entropy arithmetic in the header comment is exact rather than approximate.
+ */
+export const BackupCodeAlphabet = "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
+/** Characters per code. Ten symbols over a 32 symbol alphabet is 2^50. */
+export const BackupCodeLength = 10;
+/**
+ * How many codes a user is issued at once.
+ *
+ * Ten is enough that losing a phone does not become an emergency after the
+ * second sign-in, and small enough that the printed list is one short block a
+ * person will actually keep.
+ */
+export const BackupCodeSetSize = 10;
+/** Characters per group in the displayed form, e.g. `AB3D5-9XZQ2`. */
+const DISPLAY_GROUP_LENGTH = 5;
+/*
+ * Prefixed into every digest so a stored hash is bound to the scheme that
+ * produced it. If the construction below ever has to change, old rows keep
+ * verifying under the version they were written with instead of silently
+ * failing to match and locking a user out of their own recovery codes.
+ */
+const HASH_SCHEME_VERSION = "v1";
+/*
+ * Characters a person plausibly types in place of a symbol that is not in the
+ * alphabet. Applied before the strip below, so `O` becomes `0` rather than
+ * being deleted -- deleting it would shorten the code and guarantee a
+ * mismatch, which is the confusing failure this map exists to avoid.
+ */
+const AMBIGUOUS_CHARACTER_MAP = {
+    I: "1",
+    L: "1",
+    O: "0",
+};
+export default class TwoFactorBackupCode {
+    /**
+     * One code, drawn uniformly from the alphabet above.
+     *
+     * `crypto.randomInt` per character rather than `randomBytes(n) % 32`. The
+     * modulo version happens to be uniform for this alphabet only because 32
+     * divides 256, and it stops being uniform the moment somebody edits the
+     * alphabet -- silently, with no test that would notice. `randomInt` rejects
+     * out-of-range draws internally for whatever bound it is given, so the
+     * uniformity does not depend on a coincidence nobody wrote down.
+     */
+    static generateCode() {
+        let code = "";
+        for (let index = 0; index < BackupCodeLength; index++) {
+            code += BackupCodeAlphabet.charAt(crypto.randomInt(0, BackupCodeAlphabet.length));
+        }
+        return code;
+    }
+    /**
+     * A full set of distinct codes.
+     *
+     * Duplicates are not a security problem -- at 2^50 the birthday odds across
+     * ten draws are around 4e-14 -- but a duplicate WOULD be a correctness
+     * problem downstream: two rows sharing a digest means consuming one leaves a
+     * second, identical, still-valid code behind, so a "single-use" code would
+     * work twice. Cheaper to rule out here than to reason about there.
+     */
+    static generateCodeSet(count = BackupCodeSetSize) {
+        const codes = new Set();
+        while (codes.size < count) {
+            codes.add(TwoFactorBackupCode.generateCode());
+        }
+        return Array.from(codes);
+    }
+    /**
+     * The form shown to the user: one hyphen in the middle, for the same reason
+     * the alphabet drops ambiguous letters -- a ten character run is hard to
+     * read back without losing your place.
+     *
+     * Purely cosmetic. `normalizeCode` strips the hyphen straight back out, so
+     * a user may type the code with it, without it, or with the spaces their
+     * password manager pasted in.
+     */
+    static formatForDisplay(code) {
+        const groups = [];
+        for (let index = 0; index < code.length; index += DISPLAY_GROUP_LENGTH) {
+            groups.push(code.substring(index, index + DISPLAY_GROUP_LENGTH));
+        }
+        return groups.join("-");
+    }
+    /**
+     * Reduce whatever the user typed to the canonical form the digest is
+     * computed over.
+     *
+     * Everything here is about not rejecting somebody who supplied exactly the
+     * right secret material: the display hyphen, the spaces a clipboard adds,
+     * lowercase from a phone keyboard, and the three transcription confusions
+     * the alphabet was chosen to make survivable. Anything still outside the
+     * alphabet after that is dropped rather than rejected -- this is a
+     * canonicaliser, not a validator; the digest comparison is what decides
+     * whether a code is real.
+     *
+     * @param rawCode - The code exactly as submitted.
+     * @returns The code reduced to alphabet symbols, uppercase.
+     */
+    static normalizeCode(rawCode) {
+        /*
+         * The code arrives straight off a JSON body, so it is only a string
+         * because the client chose to send one. A number or an object here must
+         * fail verification, not throw out of `.toUpperCase` and surface as a 500.
+         */
+        if (typeof rawCode !== "string" || !rawCode) {
+            return "";
+        }
+        let normalized = "";
+        for (const character of rawCode.toUpperCase()) {
+            const mapped = AMBIGUOUS_CHARACTER_MAP[character] || character;
+            if (BackupCodeAlphabet.includes(mapped)) {
+                normalized += mapped;
+            }
+        }
+        return normalized;
+    }
+    /**
+     * The digest stored for one of `userId`'s codes.
+     *
+     * Domain separated by the owning user, which is what stops one precomputed
+     * table from inverting every account's codes at once and stops two users who
+     * happen to be issued the same code from being visibly linked by a matching
+     * row. The user id is known at verification time -- the password has already
+     * been accepted by then -- so binding to it costs nothing.
+     *
+     * Both parts are LENGTH-PREFIXED into the message rather than merely
+     * concatenated, so no pair of (userId, code) values can be rearranged into
+     * the same byte string as another pair. Concatenation alone is a real
+     * ambiguity, not a theoretical one: without prefixes, ("ab", "cd") and
+     * ("abc", "d") hash identically.
+     */
+    static hashCode(data) {
+        const message = [
+            HASH_SCHEME_VERSION,
+            data.userId.toString(),
+            TwoFactorBackupCode.normalizeCode(data.code),
+        ]
+            .map((part) => {
+            return `${part.length}:${part}`;
+        })
+            .join("");
+        return crypto
+            .createHmac("sha256", EncryptionSecret.toString())
+            .update(message)
+            .digest("hex");
+    }
+    /**
+     * Compare two digests without leaking, through timing, how many leading
+     * characters matched.
+     *
+     * The consume path compares digests in Postgres rather than here, so this is
+     * for callers that already hold both -- but it exists so that nobody writing
+     * one reaches for `===` and hands an attacker a way to recover a stored hash
+     * one character at a time.
+     *
+     * Lengths are compared first because `crypto.timingSafeEqual` THROWS on a
+     * length mismatch. Digests here are always 64 hex characters, so an early
+     * exit only happens on malformed input, where the length is not the secret.
+     */
+    static isHashEqual(a, b) {
+        if (!a || !b || a.length !== b.length) {
+            return false;
+        }
+        return crypto.timingSafeEqual(Buffer.from(a, "utf8"), Buffer.from(b, "utf8"));
+    }
+}
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", String)
+], TwoFactorBackupCode, "generateCode", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Array)
+], TwoFactorBackupCode, "generateCodeSet", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", String)
+], TwoFactorBackupCode, "formatForDisplay", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", String)
+], TwoFactorBackupCode, "normalizeCode", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", String)
+], TwoFactorBackupCode, "hashCode", null);
+__decorate([
+    CaptureSpan(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Boolean)
+], TwoFactorBackupCode, "isHashEqual", null);
+//# sourceMappingURL=TwoFactorBackupCode.js.map

package/build/dist/Server/Utils/TwoFactorBackupCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TwoFactorBackupCode.js","sourceRoot":"","sources":["../../../../Server/Utils/TwoFactorBackupCode.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,WAAW,MAAM,yBAAyB,CAAC;AAClD,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAW,kCAAkC,CAAC;AAE7E,0EAA0E;AAC1E,MAAM,CAAC,MAAM,gBAAgB,GAAW,EAAE,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAW,EAAE,CAAC;AAE5C,sEAAsE;AACtE,MAAM,oBAAoB,GAAW,CAAC,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,mBAAmB,GAAW,IAAI,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,uBAAuB,GAA2B;IACtD,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACP,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC;;;;;;;;;OASG;IAEW,AAAP,MAAM,CAAC,YAAY;QACxB,IAAI,IAAI,GAAW,EAAE,CAAC;QAEtB,KAAK,IAAI,KAAK,GAAW,CAAC,EAAE,KAAK,GAAG,gBAAgB,EAAE,KAAK,EAAE,EAAE,CAAC;YAC9D,IAAI,IAAI,kBAAkB,CAAC,MAAM,CAC/B,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAC/C,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IAEW,AAAP,MAAM,CAAC,eAAe,CAC3B,QAAgB,iBAAiB;QAEjC,MAAM,KAAK,GAAgB,IAAI,GAAG,EAAU,CAAC;QAE7C,OAAO,KAAK,CAAC,IAAI,GAAG,KAAK,EAAE,CAAC;YAC1B,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IAEW,AAAP,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACzC,MAAM,MAAM,GAAkB,EAAE,CAAC;QAEjC,KACE,IAAI,KAAK,GAAW,CAAC,EACrB,KAAK,GAAG,IAAI,CAAC,MAAM,EACnB,KAAK,IAAI,oBAAoB,EAC7B,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,oBAAoB,CAAC,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IAEW,AAAP,MAAM,CAAC,aAAa,CAAC,OAAe;QACzC;;;;WAIG;QACH,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5C,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,UAAU,GAAW,EAAE,CAAC;QAE5B,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;YAC9C,MAAM,MAAM,GAAW,uBAAuB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC;YAEvE,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxC,UAAU,IAAI,MAAM,CAAC;YACvB,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IAEW,AAAP,MAAM,CAAC,QAAQ,CAAC,IAAwC;QAC7D,MAAM,OAAO,GAAW;YACtB,mBAAmB;YACnB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACtB,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;SAC7C;aACE,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;YACpB,OAAO,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;QAClC,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;QAEZ,OAAO,MAAM;aACV,UAAU,CAAC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC;aACjD,MAAM,CAAC,OAAO,CAAC;aACf,MAAM,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;OAYG;IAEW,AAAP,MAAM,CAAC,WAAW,CAAC,CAAS,EAAE,CAAS;QAC5C,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,MAAM,CAAC,eAAe,CAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,EACtB,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CACvB,CAAC;IACJ,CAAC;CACF;AA1Je;IADb,WAAW,EAAE;;;;6CAWb;AAYa;IADb,WAAW,EAAE;;;oCAGX,KAAK;gDAQP;AAYa;IADb,WAAW,EAAE;;;;iDAab;AAkBa;IADb,WAAW,EAAE;;;;8CAsBb;AAkBa;IADb,WAAW,EAAE;;;;yCAgBb;AAgBa;IADb,WAAW,EAAE;;;;4CAUb"}

package/build/dist/Types/Email/EmailTemplateType.js

@@ -11,6 +11,8 @@ var EmailTemplateType;
     EmailTemplateType["ConfirmStatusPageSubscription"] = "ConfirmStatusPageSubscription.hbs";
     EmailTemplateType["EmailVerified"] = "EmailVerified.hbs";
     EmailTemplateType["PasswordChanged"] = "PasswordChanged.hbs";
+    EmailTemplateType["TwoFactorBackupCodeUsed"] = "TwoFactorBackupCodeUsed.hbs";
+    EmailTemplateType["TwoFactorBackupCodesRegenerated"] = "TwoFactorBackupCodesRegenerated.hbs";
     EmailTemplateType["ProbeOwnerAdded"] = "ProbeOwnerAdded.hbs";
     EmailTemplateType["InviteMember"] = "InviteMember.hbs";
     EmailTemplateType["EmailChanged"] = "EmailChanged.hbs";

package/build/dist/Types/Email/EmailTemplateType.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmailTemplateType.js","sourceRoot":"","sources":["../../../../Types/Email/EmailTemplateType.ts"],"names":[],"mappings":"AAAA,IAAK,iBAgGJ;AAhGD,WAAK,iBAAiB;IACpB,wDAAmC,CAAA;IACnC,0DAAqC,CAAA;IACrC,sDAAiC,CAAA;IACjC,kEAA6C,CAAA;IAC7C,sEAAiD,CAAA;IACjD,oFAA+D,CAAA;IAC/D,wFAAmE,CAAA;IACnE,gEAA2C,CAAA;IAC3C,wFAAmE,CAAA;IACnE,wDAAmC,CAAA;IACnC,4DAAuC,CAAA;IACvC,4DAAuC,CAAA;IACvC,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,0EAAqD,CAAA;IACrD,wFAAmE,CAAA;IACnE,gFAA2D,CAAA;IAC3D,oGAA+E,CAAA;IAC/E,kFAA6D,CAAA;IAC7D,wFAAmE,CAAA;IACnE,0FAAqE,CAAA;IACrE,kHAA6F,CAAA;IAC7F,0HAAqG,CAAA;IACrG,4HAAuG,CAAA;IACvG,8EAAyD,CAAA;IACzD,gFAA2D,CAAA;IAC3D,0EAAqD,CAAA;IACrD,0HAAqG,CAAA;IACrG,8CAAyB,CAAA;IACzB,gEAA2C,CAAA;IAC3C,oFAA+D,CAAA;IAC/D,oEAA+C,CAAA;IAC/C,gFAA2D,CAAA;IAE3D,wEAAmD,CAAA;IAEnD,kEAA6C,CAAA;IAC7C,gFAA2D,CAAA;IAC3D,4EAAuD,CAAA;IACvD,sFAAiE,CAAA;IACjE,oEAA+C,CAAA;IAC/C,4FAAuE,CAAA;IAEvE,4DAAuC,CAAA;IACvC,0EAAqD,CAAA;IACrD,sEAAiD,CAAA;IACjD,gFAA2D,CAAA;IAC3D,sFAAiE,CAAA;IAEjE,0EAAqD,CAAA;IACrD,wFAAmE,CAAA;IACnE,oFAA+D,CAAA;IAC/D,8FAAyE,CAAA;IACzE,oFAA+D,CAAA;IAE/D,gFAA2D,CAAA;IAC3D,8FAAyE,CAAA;IACzE,0FAAqE,CAAA;IACrE,oGAA+E,CAAA;IAC/E,gGAA2E,CAAA;IAE3E,8EAAyD,CAAA;IACzD,wFAAmE,CAAA;IACnE,sFAAiE,CAAA;IAEjE,oGAA+E,CAAA;IAC/E,0FAAqE,CAAA;IACrE,wGAAmF,CAAA;IACnF,8GAAyF,CAAA;IACzF,oHAA+F,CAAA;IAC/F,0FAAqE,CAAA;IACrE,sEAAiD,CAAA;IACjD,gGAA2E,CAAA;IAC3E,wDAAmC,CAAA;IACnC,8DAAyC,CAAA;IACzC,oEAA+C,CAAA;IAC/C,8DAAyC,CAAA;IACzC,4EAAuD,CAAA;IACvD,kFAA6D,CAAA;IAE7D,4EAAuD,CAAA;IACvD,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAC/D,0EAAqD,CAAA;IACrD,8FAAyE,CAAA;IAEzE,kFAA6D,CAAA;IAC7D,4CAAuB,CAAA;IAEvB,gFAA2D,CAAA;IAC3D,kEAA6C,CAAA;IAC7C,wEAAmD,CAAA;IAEnD,8FAAyE,CAAA;IACzE,4FAAuE,CAAA;AACzE,CAAC,EAhGI,iBAAiB,KAAjB,iBAAiB,QAgGrB;AAED,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"EmailTemplateType.js","sourceRoot":"","sources":["../../../../Types/Email/EmailTemplateType.ts"],"names":[],"mappings":"AAAA,IAAK,iBAkGJ;AAlGD,WAAK,iBAAiB;IACpB,wDAAmC,CAAA;IACnC,0DAAqC,CAAA;IACrC,sDAAiC,CAAA;IACjC,kEAA6C,CAAA;IAC7C,sEAAiD,CAAA;IACjD,oFAA+D,CAAA;IAC/D,wFAAmE,CAAA;IACnE,gEAA2C,CAAA;IAC3C,wFAAmE,CAAA;IACnE,wDAAmC,CAAA;IACnC,4DAAuC,CAAA;IACvC,4EAAuD,CAAA;IACvD,4FAAuE,CAAA;IACvE,4DAAuC,CAAA;IACvC,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,0EAAqD,CAAA;IACrD,wFAAmE,CAAA;IACnE,gFAA2D,CAAA;IAC3D,oGAA+E,CAAA;IAC/E,kFAA6D,CAAA;IAC7D,wFAAmE,CAAA;IACnE,0FAAqE,CAAA;IACrE,kHAA6F,CAAA;IAC7F,0HAAqG,CAAA;IACrG,4HAAuG,CAAA;IACvG,8EAAyD,CAAA;IACzD,gFAA2D,CAAA;IAC3D,0EAAqD,CAAA;IACrD,0HAAqG,CAAA;IACrG,8CAAyB,CAAA;IACzB,gEAA2C,CAAA;IAC3C,oFAA+D,CAAA;IAC/D,oEAA+C,CAAA;IAC/C,gFAA2D,CAAA;IAE3D,wEAAmD,CAAA;IAEnD,kEAA6C,CAAA;IAC7C,gFAA2D,CAAA;IAC3D,4EAAuD,CAAA;IACvD,sFAAiE,CAAA;IACjE,oEAA+C,CAAA;IAC/C,4FAAuE,CAAA;IAEvE,4DAAuC,CAAA;IACvC,0EAAqD,CAAA;IACrD,sEAAiD,CAAA;IACjD,gFAA2D,CAAA;IAC3D,sFAAiE,CAAA;IAEjE,0EAAqD,CAAA;IACrD,wFAAmE,CAAA;IACnE,oFAA+D,CAAA;IAC/D,8FAAyE,CAAA;IACzE,oFAA+D,CAAA;IAE/D,gFAA2D,CAAA;IAC3D,8FAAyE,CAAA;IACzE,0FAAqE,CAAA;IACrE,oGAA+E,CAAA;IAC/E,gGAA2E,CAAA;IAE3E,8EAAyD,CAAA;IACzD,wFAAmE,CAAA;IACnE,sFAAiE,CAAA;IAEjE,oGAA+E,CAAA;IAC/E,0FAAqE,CAAA;IACrE,wGAAmF,CAAA;IACnF,8GAAyF,CAAA;IACzF,oHAA+F,CAAA;IAC/F,0FAAqE,CAAA;IACrE,sEAAiD,CAAA;IACjD,gGAA2E,CAAA;IAC3E,wDAAmC,CAAA;IACnC,8DAAyC,CAAA;IACzC,oEAA+C,CAAA;IAC/C,8DAAyC,CAAA;IACzC,4EAAuD,CAAA;IACvD,kFAA6D,CAAA;IAE7D,4EAAuD,CAAA;IACvD,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAC/D,0EAAqD,CAAA;IACrD,8FAAyE,CAAA;IAEzE,kFAA6D,CAAA;IAC7D,4CAAuB,CAAA;IAEvB,gFAA2D,CAAA;IAC3D,kEAA6C,CAAA;IAC7C,wEAAmD,CAAA;IAEnD,8FAAyE,CAAA;IACzE,4FAAuE,CAAA;AACzE,CAAC,EAlGI,iBAAiB,KAAjB,iBAAiB,QAkGrB;AAED,eAAe,iBAAiB,CAAC"}

package/build/dist/Types/NetworkAutomation/RuleRunResult.js

@@ -1,3 +1,5 @@
+// How many addresses matchedIpAddressSample carries at most.
+export const MAX_MATCHED_IP_SAMPLE = 50;
 /*
  * A count off the wire. An absent or non-numeric field reads as zero rather
  * than as NaN: a summary line that says "NaN devices" is worse than one that
@@ -35,5 +37,27 @@ export class RuleRunResultUtil {
             isTruncated: source["isTruncated"] === true,
         };
     }
+    static parseAutoImportRuleRunResult(json) {
+        const source = json || {};
+        const sample = Array.isArray(source["matchedIpAddressSample"])
+            ? source["matchedIpAddressSample"]
+                .filter((value) => {
+                return typeof value === "string";
+            })
+                .slice(0, MAX_MATCHED_IP_SAMPLE)
+            : [];
+        return {
+            hostsEvaluated: readCount(source, "hostsEvaluated"),
+            hostsMatched: readCount(source, "hostsMatched"),
+            hostsExcluded: readCount(source, "hostsExcluded"),
+            hostsSkippedAlreadyRegistered: readCount(source, "hostsSkippedAlreadyRegistered"),
+            devicesCreated: readCount(source, "devicesCreated"),
+            devicesFailed: readCount(source, "devicesFailed"),
+            isTruncated: source["isTruncated"] === true,
+            hasMoreScans: source["hasMoreScans"] === true,
+            isDryRun: source["isDryRun"] === true,
+            matchedIpAddressSample: sample,
+        };
+    }
 }
 //# sourceMappingURL=RuleRunResult.js.map

package/build/dist/Types/NetworkAutomation/RuleRunResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"RuleRunResult.js","sourceRoot":"","sources":["../../../../Types/NetworkAutomation/RuleRunResult.ts"],"names":[],"mappings":"AAmEA;;;;GAIG;AACH,SAAS,SAAS,CAAC,IAAgB,EAAE,GAAW;IAC9C,MAAM,KAAK,GAAY,IAAI,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,OAAO,iBAAiB;IACrB,MAAM,CAAC,gCAAgC,CAC5C,IAAmC;QAEnC,MAAM,MAAM,GAAe,IAAI,IAAI,EAAE,CAAC;QAEtC,OAAO;YACL,gBAAgB,EAAE,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;YACvD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,eAAe,EAAE,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;YACrD,wBAAwB,EAAE,SAAS,CAAC,MAAM,EAAE,0BAA0B,CAAC;YACvE,kCAAkC,EAAE,SAAS,CAC3C,MAAM,EACN,oCAAoC,CACrC;YACD,kCAAkC,EAAE,SAAS,CAC3C,MAAM,EACN,oCAAoC,CACrC;YACD,aAAa,EAAE,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC;YACjD,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI;SAC5C,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,uBAAuB,CACnC,IAAmC;QAEnC,MAAM,MAAM,GAAe,IAAI,IAAI,EAAE,CAAC;QAEtC,OAAO;YACL,gBAAgB,EAAE,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;YACvD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,YAAY,EAAE,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;YAC/C,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI;SAC5C,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"RuleRunResult.js","sourceRoot":"","sources":["../../../../Types/NetworkAutomation/RuleRunResult.ts"],"names":[],"mappings":"AAoHA,6DAA6D;AAC7D,MAAM,CAAC,MAAM,qBAAqB,GAAW,EAAE,CAAC;AAEhD;;;;GAIG;AACH,SAAS,SAAS,CAAC,IAAgB,EAAE,GAAW;IAC9C,MAAM,KAAK,GAAY,IAAI,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,OAAO,iBAAiB;IACrB,MAAM,CAAC,gCAAgC,CAC5C,IAAmC;QAEnC,MAAM,MAAM,GAAe,IAAI,IAAI,EAAE,CAAC;QAEtC,OAAO;YACL,gBAAgB,EAAE,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;YACvD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,eAAe,EAAE,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;YACrD,wBAAwB,EAAE,SAAS,CAAC,MAAM,EAAE,0BAA0B,CAAC;YACvE,kCAAkC,EAAE,SAAS,CAC3C,MAAM,EACN,oCAAoC,CACrC;YACD,kCAAkC,EAAE,SAAS,CAC3C,MAAM,EACN,oCAAoC,CACrC;YACD,aAAa,EAAE,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC;YACjD,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI;SAC5C,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,uBAAuB,CACnC,IAAmC;QAEnC,MAAM,MAAM,GAAe,IAAI,IAAI,EAAE,CAAC;QAEtC,OAAO;YACL,gBAAgB,EAAE,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;YACvD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,YAAY,EAAE,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;YAC/C,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI;SAC5C,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,4BAA4B,CACxC,IAAmC;QAEnC,MAAM,MAAM,GAAe,IAAI,IAAI,EAAE,CAAC;QAEtC,MAAM,MAAM,GAAkB,KAAK,CAAC,OAAO,CACzC,MAAM,CAAC,wBAAwB,CAAC,CACjC;YACC,CAAC,CAAE,MAAM,CAAC,wBAAwB,CAAoB;iBACjD,MAAM,CAAC,CAAC,KAAc,EAAE,EAAE;gBACzB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;YACnC,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC;YACpC,CAAC,CAAC,EAAE,CAAC;QAEP,OAAO;YACL,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,YAAY,EAAE,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;YAC/C,aAAa,EAAE,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC;YACjD,6BAA6B,EAAE,SAAS,CACtC,MAAM,EACN,+BAA+B,CAChC;YACD,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC;YACnD,aAAa,EAAE,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC;YACjD,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK,IAAI;YAC3C,YAAY,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,IAAI;YAC7C,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI;YACrC,sBAAsB,EAAE,MAAuB;SAChD,CAAC;IACJ,CAAC;CACF"}

package/build/dist/Types/Permission.js

@@ -480,6 +480,10 @@ var Permission;
     Permission["DeleteNetworkDeviceLabelRule"] = "DeleteNetworkDeviceLabelRule";
     Permission["EditNetworkDeviceLabelRule"] = "EditNetworkDeviceLabelRule";
     Permission["ReadNetworkDeviceLabelRule"] = "ReadNetworkDeviceLabelRule";
+    Permission["CreateNetworkDeviceAutoImportRule"] = "CreateNetworkDeviceAutoImportRule";
+    Permission["DeleteNetworkDeviceAutoImportRule"] = "DeleteNetworkDeviceAutoImportRule";
+    Permission["EditNetworkDeviceAutoImportRule"] = "EditNetworkDeviceAutoImportRule";
+    Permission["ReadNetworkDeviceAutoImportRule"] = "ReadNetworkDeviceAutoImportRule";
     // Podman Host Label Rule Permissions
     Permission["CreatePodmanHostLabelRule"] = "CreatePodmanHostLabelRule";
     Permission["DeletePodmanHostLabelRule"] = "DeletePodmanHostLabelRule";
@@ -10484,6 +10488,43 @@ export class PermissionHelper {
                 isRolePermission: false,
                 group: PermissionGroup.Telemetry,
             },
+            // Network Device Auto Import Rule Permissions
+            {
+                permission: Permission.CreateNetworkDeviceAutoImportRule,
+                title: "Create Network Device Auto Import Rule",
+                description: "This permission can create Network Device Auto Import Rules in this project.",
+                isAssignableToTenant: true,
+                isAccessControlPermission: false,
+                isRolePermission: false,
+                group: PermissionGroup.Telemetry,
+            },
+            {
+                permission: Permission.DeleteNetworkDeviceAutoImportRule,
+                title: "Delete Network Device Auto Import Rule",
+                description: "This permission can delete Network Device Auto Import Rules of this project.",
+                isAssignableToTenant: true,
+                isAccessControlPermission: false,
+                isRolePermission: false,
+                group: PermissionGroup.Telemetry,
+            },
+            {
+                permission: Permission.EditNetworkDeviceAutoImportRule,
+                title: "Edit Network Device Auto Import Rule",
+                description: "This permission can edit Network Device Auto Import Rules of this project.",
+                isAssignableToTenant: true,
+                isAccessControlPermission: false,
+                isRolePermission: false,
+                group: PermissionGroup.Telemetry,
+            },
+            {
+                permission: Permission.ReadNetworkDeviceAutoImportRule,
+                title: "Read Network Device Auto Import Rule",
+                description: "This permission can read Network Device Auto Import Rules of this project.",
+                isAssignableToTenant: true,
+                isAccessControlPermission: false,
+                isRolePermission: false,
+                group: PermissionGroup.Telemetry,
+            },
             // Podman Host Label Rule Permissions
             {
                 permission: Permission.CreatePodmanHostLabelRule,