@serve.zone/dcrouter 17.7.1 → 17.9.0

package/dist_ts/webpush/classes.webpush-crypto.js

@@ -0,0 +1,231 @@
+import * as plugins from '../plugins.js';
+const KEY_ID_PATTERN = /^[A-Za-z0-9._-]{1,64}$/;
+const BASE64URL_KEY_PATTERN = /^[A-Za-z0-9_-]{43}$/;
+const BASE64URL_VALUE_PATTERN = /^[A-Za-z0-9_-]+$/;
+const KEY_RING_LIMIT = 8;
+const AAD_SCHEMA_VERSION = 1;
+function requirePlainObject(valueArg, labelArg) {
+    if (valueArg === null
+        || typeof valueArg !== 'object'
+        || Array.isArray(valueArg)
+        || Object.getPrototypeOf(valueArg) !== Object.prototype) {
+        throw new Error(`${labelArg} must be a plain object`);
+    }
+    return valueArg;
+}
+function decodeBase64UrlExact(valueArg, lengthArg, labelArg) {
+    if (typeof valueArg !== 'string' || !BASE64URL_VALUE_PATTERN.test(valueArg)) {
+        throw new Error(`${labelArg} must be unpadded base64url`);
+    }
+    const decoded = Buffer.from(valueArg, 'base64url');
+    if (decoded.length !== lengthArg || decoded.toString('base64url') !== valueArg) {
+        throw new Error(`${labelArg} has an invalid encoded length`);
+    }
+    return decoded;
+}
+function parseKeyRingSource(rawValueArg, labelArg) {
+    if (typeof rawValueArg === 'string') {
+        const trimmed = rawValueArg.trim();
+        if (!trimmed) {
+            throw new Error(`${labelArg} is empty`);
+        }
+        const jsonText = trimmed.startsWith('base64Object:')
+            ? Buffer.from(trimmed.slice('base64Object:'.length), 'base64').toString('utf8')
+            : trimmed;
+        try {
+            return requirePlainObject(JSON.parse(jsonText), labelArg);
+        }
+        catch (error) {
+            if (error.message.startsWith(`${labelArg} `))
+                throw error;
+            throw new Error(`${labelArg} must be valid JSON`, { cause: error });
+        }
+    }
+    return requirePlainObject(rawValueArg, labelArg);
+}
+export function parseWebPushKeyRing(rawValueArg, labelArg) {
+    const source = parseKeyRingSource(rawValueArg, labelArg);
+    const currentKeyId = source.currentKeyId;
+    if (typeof currentKeyId !== 'string' || !KEY_ID_PATTERN.test(currentKeyId)) {
+        throw new Error(`${labelArg}.currentKeyId is invalid`);
+    }
+    const rawKeys = requirePlainObject(source.keys, `${labelArg}.keys`);
+    const entries = Object.entries(rawKeys);
+    if (entries.length === 0 || entries.length > KEY_RING_LIMIT) {
+        throw new Error(`${labelArg}.keys must contain 1 to ${KEY_RING_LIMIT} keys`);
+    }
+    const keys = new Map();
+    const fingerprints = new Set();
+    for (const [keyId, encodedKey] of entries) {
+        if (!KEY_ID_PATTERN.test(keyId)) {
+            throw new Error(`${labelArg}.keys contains an invalid key id`);
+        }
+        if (typeof encodedKey !== 'string' || !BASE64URL_KEY_PATTERN.test(encodedKey)) {
+            throw new Error(`${labelArg}.keys.${keyId} must be a 32-byte unpadded base64url key`);
+        }
+        const key = decodeBase64UrlExact(encodedKey, 32, `${labelArg}.keys.${keyId}`);
+        const fingerprint = key.toString('hex');
+        if (fingerprints.has(fingerprint)) {
+            throw new Error(`${labelArg}.keys must not contain duplicate key material`);
+        }
+        fingerprints.add(fingerprint);
+        keys.set(keyId, key);
+    }
+    if (!keys.has(currentKeyId)) {
+        throw new Error(`${labelArg}.currentKeyId does not name a configured key`);
+    }
+    return {
+        currentKeyId,
+        keys,
+    };
+}
+export function assertDistinctWebPushKeyRings(encryptionRingArg, hmacRingArg) {
+    const encryptionFingerprints = new Set([...encryptionRingArg.keys.values()].map((keyArg) => keyArg.toString('hex')));
+    if ([...hmacRingArg.keys.values()]
+        .some((keyArg) => encryptionFingerprints.has(keyArg.toString('hex')))) {
+        throw new Error('Web Push encryption and HMAC key rings must use distinct key material');
+    }
+}
+export function buildWebPushAad(contextArg) {
+    for (const [name, value] of Object.entries(contextArg)) {
+        if (typeof value !== 'string' || !value.trim()) {
+            throw new Error(`Web Push AAD ${name} is missing`);
+        }
+    }
+    return Buffer.from(canonicalJson({
+        schemaVersion: AAD_SCHEMA_VERSION,
+        gatewayClientId: contextArg.gatewayClientId,
+        appInstanceId: contextArg.appInstanceId,
+        bindingId: contextArg.bindingId,
+        documentType: contextArg.documentType,
+        documentId: contextArg.documentId,
+    }), 'utf8');
+}
+function canonicalize(valueArg) {
+    if (valueArg === null
+        || typeof valueArg === 'string'
+        || typeof valueArg === 'boolean') {
+        return valueArg;
+    }
+    if (typeof valueArg === 'number') {
+        if (!Number.isFinite(valueArg))
+            throw new Error('Canonical JSON does not support non-finite numbers');
+        return valueArg;
+    }
+    if (Array.isArray(valueArg)) {
+        return valueArg.map((entryArg) => canonicalize(entryArg));
+    }
+    const value = requirePlainObject(valueArg, 'Canonical JSON value');
+    const result = {};
+    for (const key of Object.keys(value).sort()) {
+        if (value[key] === undefined) {
+            throw new Error('Canonical JSON does not support undefined values');
+        }
+        result[key] = canonicalize(value[key]);
+    }
+    return result;
+}
+export function canonicalJson(valueArg) {
+    return JSON.stringify(canonicalize(valueArg));
+}
+export class WebPushCrypto {
+    encryptionRing;
+    hmacRing;
+    constructor(encryptionRing, hmacRing) {
+        this.encryptionRing = encryptionRing;
+        this.hmacRing = hmacRing;
+        assertDistinctWebPushKeyRings(encryptionRing, hmacRing);
+    }
+    get currentEncryptionKeyId() {
+        return this.encryptionRing.currentKeyId;
+    }
+    get currentHmacKeyId() {
+        return this.hmacRing.currentKeyId;
+    }
+    encryptJson(valueArg, aadContextArg) {
+        const keyId = this.encryptionRing.currentKeyId;
+        const key = this.encryptionRing.keys.get(keyId);
+        if (!key)
+            throw new Error('Current Web Push encryption key is unavailable');
+        const nonce = plugins.crypto.randomBytes(12);
+        const cipher = plugins.crypto.createCipheriv('aes-256-gcm', key, nonce);
+        cipher.setAAD(buildWebPushAad(aadContextArg));
+        const ciphertext = Buffer.concat([
+            cipher.update(canonicalJson(valueArg), 'utf8'),
+            cipher.final(),
+        ]);
+        const tag = cipher.getAuthTag();
+        return {
+            version: 1,
+            algorithm: 'aes-256-gcm',
+            keyId,
+            nonce: nonce.toString('base64url'),
+            ciphertext: ciphertext.toString('base64url'),
+            tag: tag.toString('base64url'),
+        };
+    }
+    decryptJson(envelopeArg, aadContextArg) {
+        if (envelopeArg?.version !== 1
+            || envelopeArg.algorithm !== 'aes-256-gcm'
+            || typeof envelopeArg.keyId !== 'string'
+            || !KEY_ID_PATTERN.test(envelopeArg.keyId)) {
+            throw new Error('Web Push encrypted envelope is malformed');
+        }
+        const key = this.encryptionRing.keys.get(envelopeArg.keyId);
+        if (!key)
+            throw new Error('Web Push encrypted envelope references an unavailable key');
+        const nonce = decodeBase64UrlExact(envelopeArg.nonce, 12, 'Web Push envelope nonce');
+        const tag = decodeBase64UrlExact(envelopeArg.tag, 16, 'Web Push envelope tag');
+        if (typeof envelopeArg.ciphertext !== 'string'
+            || !envelopeArg.ciphertext
+            || !BASE64URL_VALUE_PATTERN.test(envelopeArg.ciphertext)) {
+            throw new Error('Web Push envelope ciphertext is malformed');
+        }
+        const ciphertext = Buffer.from(envelopeArg.ciphertext, 'base64url');
+        if (ciphertext.toString('base64url') !== envelopeArg.ciphertext) {
+            throw new Error('Web Push envelope ciphertext is malformed');
+        }
+        try {
+            const decipher = plugins.crypto.createDecipheriv('aes-256-gcm', key, nonce);
+            decipher.setAAD(buildWebPushAad(aadContextArg));
+            decipher.setAuthTag(tag);
+            const plaintext = Buffer.concat([
+                decipher.update(ciphertext),
+                decipher.final(),
+            ]).toString('utf8');
+            return JSON.parse(plaintext);
+        }
+        catch (error) {
+            throw new Error('Web Push encrypted envelope authentication failed', { cause: error });
+        }
+    }
+    hmac(domainArg, valueArg, keyIdArg = this.hmacRing.currentKeyId) {
+        const key = this.hmacRing.keys.get(keyIdArg);
+        if (!key)
+            throw new Error('Web Push HMAC key is unavailable');
+        const digest = plugins.crypto
+            .createHmac('sha256', key)
+            .update(`dcrouter:webpush:v1:${domainArg}\0`, 'utf8')
+            .update(valueArg, 'utf8')
+            .digest('base64url');
+        return {
+            keyId: keyIdArg,
+            digest,
+        };
+    }
+    verifyHmac(domainArg, valueArg, keyIdArg, expectedDigestArg) {
+        let actualDigest;
+        try {
+            actualDigest = this.hmac(domainArg, valueArg, keyIdArg).digest;
+        }
+        catch {
+            return false;
+        }
+        const actual = Buffer.from(actualDigest, 'base64url');
+        const expected = Buffer.from(expectedDigestArg, 'base64url');
+        return actual.length === expected.length
+            && actual.length > 0
+            && plugins.crypto.timingSafeEqual(actual, expected);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"classes.webpush-crypto.js","sourceRoot":"","sources":["../../../ts/webpush/classes.webpush-crypto.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AA+BzC,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAChD,MAAM,qBAAqB,GAAG,qBAAqB,CAAC;AACpD,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AACnD,MAAM,cAAc,GAAG,CAAC,CAAC;AACzB,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAE7B,SAAS,kBAAkB,CACzB,QAAiB,EACjB,QAAgB;IAEhB,IACE,QAAQ,KAAK,IAAI;WACd,OAAO,QAAQ,KAAK,QAAQ;WAC5B,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;WACvB,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,SAAS,EACvD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,yBAAyB,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,QAAmC,CAAC;AAC7C,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAiB,EACjB,SAAiB,EACjB,QAAgB;IAEhB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5E,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,6BAA6B,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACnD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC/E,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,gCAAgC,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,kBAAkB,CAAC,WAAoB,EAAE,QAAgB;IAChE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,WAAW,CAAC,CAAC;QAC1C,CAAC;QACD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC;YAClD,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC/E,CAAC,CAAC,OAAO,CAAC;QACZ,IAAI,CAAC;YACH,OAAO,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAK,KAAe,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,QAAQ,GAAG,CAAC;gBAAE,MAAM,KAAK,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,qBAAqB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IACD,OAAO,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,WAAoB,EACpB,QAAgB;IAEhB,MAAM,MAAM,GAAG,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IACzC,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,0BAA0B,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,2BAA2B,cAAc,OAAO,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IACvC,KAAK,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,OAAO,EAAE,CAAC;QAC1C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,kCAAkC,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,SAAS,KAAK,2CAA2C,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,GAAG,GAAG,oBAAoB,CAAC,UAAU,EAAE,EAAE,EAAE,GAAG,QAAQ,SAAS,KAAK,EAAE,CAAC,CAAC;QAC9E,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,+CAA+C,CAAC,CAAC;QAC9E,CAAC;QACD,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,8CAA8C,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO;QACL,YAAY;QACZ,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,iBAAkC,EAClC,WAA4B;IAE5B,MAAM,sBAAsB,GAAG,IAAI,GAAG,CACpC,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAC7E,CAAC;IACF,IACE,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;SAC3B,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAA8B;IAC5D,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,aAAa,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;QAC/B,aAAa,EAAE,kBAAkB;QACjC,eAAe,EAAE,UAAU,CAAC,eAAe;QAC3C,aAAa,EAAE,UAAU,CAAC,aAAa;QACvC,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,YAAY,EAAE,UAAU,CAAC,YAAY;QACrC,UAAU,EAAE,UAAU,CAAC,UAAU;KAClC,CAAC,EAAE,MAAM,CAAC,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,QAAiB;IACrC,IACE,QAAQ,KAAK,IAAI;WACd,OAAO,QAAQ,KAAK,QAAQ;WAC5B,OAAO,QAAQ,KAAK,SAAS,EAChC,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACtG,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;IACnE,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5C,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAiB;IAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,OAAO,aAAa;IAEL;IACA;IAFnB,YACmB,cAA+B,EAC/B,QAAyB;QADzB,mBAAc,GAAd,cAAc,CAAiB;QAC/B,aAAQ,GAAR,QAAQ,CAAiB;QAE1C,6BAA6B,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,IAAW,sBAAsB;QAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEM,WAAW,CAChB,QAAiB,EACjB,aAAiC;QAEjC,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC;QAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;YAC9C,MAAM,CAAC,KAAK,EAAE;SACf,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,CAAC;YACV,SAAS,EAAE,aAAa;YACxB,KAAK;YACL,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;YAClC,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC5C,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC;SAC/B,CAAC;IACJ,CAAC;IAEM,WAAW,CAChB,WAAsC,EACtC,aAAiC;QAEjC,IACE,WAAW,EAAE,OAAO,KAAK,CAAC;eACvB,WAAW,CAAC,SAAS,KAAK,aAAa;eACvC,OAAO,WAAW,CAAC,KAAK,KAAK,QAAQ;eACrC,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAC1C,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QACvF,MAAM,KAAK,GAAG,oBAAoB,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,EAAE,yBAAyB,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,EAAE,uBAAuB,CAAC,CAAC;QAC/E,IACE,OAAO,WAAW,CAAC,UAAU,KAAK,QAAQ;eACvC,CAAC,WAAW,CAAC,UAAU;eACvB,CAAC,uBAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EACxD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QACpE,IAAI,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5E,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC;YAChD,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACzB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;gBAC9B,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC3B,QAAQ,CAAC,KAAK,EAAE;aACjB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAM,CAAC;QACpC,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,mDAAmD,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAEM,IAAI,CACT,SAA6B,EAC7B,QAAgB,EAChB,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY;QAErC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;aAC1B,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC;aACzB,MAAM,CAAC,uBAAuB,SAAS,IAAI,EAAE,MAAM,CAAC;aACpD,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;aACxB,MAAM,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,MAAM;SACP,CAAC;IACJ,CAAC;IAEM,UAAU,CACf,SAA6B,EAC7B,QAAgB,EAChB,QAAgB,EAChB,iBAAyB;QAEzB,IAAI,YAAoB,CAAC;QACzB,IAAI,CAAC;YACH,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC;QACjE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QAC7D,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;eACnC,MAAM,CAAC,MAAM,GAAG,CAAC;eACjB,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}

package/dist_ts/webpush/classes.webpush-manager.d.ts

@@ -0,0 +1,153 @@
+import * as plugins from '../plugins.js';
+import { WebPushBindingDoc, WebPushSpoolDoc, type IWebPushStoredCredential, type TWebPushControllerIntent } from '../db/index.js';
+import { type IWebPushTransport } from './classes.webpush-transport.js';
+type IWebPushBinding = plugins.servezoneInterfaces.data.IWebPushBinding;
+type IWebPushCredentialOneTimeSecret = plugins.servezoneInterfaces.data.IWebPushCredentialOneTimeSecret;
+type IWebPushDeliveryStatus = plugins.servezoneInterfaces.data.IWebPushDeliveryStatus;
+type IWebPushNotificationPayload = plugins.servezoneInterfaces.data.IWebPushNotificationPayload;
+type IWebPushResourceOwner = plugins.servezoneInterfaces.data.IWebPushResourceOwner;
+type IWebPushServiceStatus = plugins.servezoneInterfaces.data.IWebPushServiceStatus;
+type IWebPushSubscription = plugins.servezoneInterfaces.data.IWebPushSubscription;
+type TWebPushBindingSync = plugins.servezoneInterfaces.requests.webpush.TWebPushBindingSync;
+type IWebPushAppCredentialAuth = plugins.servezoneInterfaces.requests.webpush.IWebPushAppCredentialAuth;
+type TWebPushCancellationTarget = plugins.servezoneInterfaces.data.TWebPushCancellationTarget;
+type TWebPushDeliveryState = plugins.servezoneInterfaces.data.TWebPushDeliveryState;
+type TWebPushUrgency = plugins.servezoneInterfaces.data.TWebPushUrgency;
+interface IWebPushQenv {
+    getEnvVarOnDemand(nameArg: string): Promise<string | undefined>;
+}
+export interface IWebPushManagerOptions {
+    qenv?: IWebPushQenv;
+    transport?: IWebPushTransport;
+    startWorker?: boolean;
+    now?: () => number;
+    admissionPolicy?: Partial<IWebPushAdmissionPolicy>;
+}
+export interface IWebPushAdmissionPolicy {
+    shortWindowMs: number;
+    shortLimit: number;
+    longWindowMs: number;
+    longLimit: number;
+}
+export interface IWebPushAuthenticatedBinding {
+    binding: WebPushBindingDoc;
+    credential: IWebPushStoredCredential;
+}
+export interface IWebPushBindingSyncResult {
+    binding: IWebPushBinding;
+    credential?: IWebPushCredentialOneTimeSecret;
+}
+/**
+ * Durable controller ordering token. The controller id and epoch remain stable
+ * for an owner, while generation increases for every desired-state mutation.
+ */
+export interface IWebPushControllerMutation {
+    id: string;
+    epoch: string;
+    generation: number;
+    operationId: string;
+    intent: TWebPushControllerIntent;
+}
+export interface IWebPushBindingDelete {
+    id?: string;
+    owner: IWebPushResourceOwner;
+    controller: IWebPushControllerMutation;
+}
+export interface IWebPushEnqueueResult {
+    accepted: boolean;
+    spoolItemId: string;
+}
+export interface IWebPushCancelResult {
+    cancelledCount: number;
+    alreadyTerminalCount: number;
+}
+export declare function toPublicWebPushBinding(bindingArg: WebPushBindingDoc): IWebPushBinding;
+export declare function toPublicWebPushDelivery(spoolArg: WebPushSpoolDoc): IWebPushDeliveryStatus;
+export declare function buildWebPushTerminalUpdate(optionsArg: {
+    state: Extract<TWebPushDeliveryState, 'pushServiceAccepted' | 'invalidSubscription' | 'failed' | 'expired' | 'cancelled'>;
+    now: number;
+    pushServiceStatusCode?: number;
+    errorCode?: string;
+}): Record<string, unknown>;
+export declare class WebPushManager {
+    private readonly qenv;
+    private readonly transport;
+    private readonly startWorker;
+    private readonly now;
+    private readonly admissionPolicy;
+    private enabled;
+    private started;
+    private ready;
+    private crypto?;
+    private vapidSubject?;
+    private workerTimer?;
+    private activeWorkerCycle?;
+    private expiredCredentialOverlapCursor?;
+    private expiredCredentialRecoveryCursor?;
+    private retiredVapidCursor?;
+    private inactiveLifecycleCursor?;
+    constructor(optionsArg?: IWebPushManagerOptions);
+    get isEnabled(): boolean;
+    get isReady(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    getUnavailableServiceStatus(): IWebPushServiceStatus;
+    listBindings(ownerFilterArg?: Partial<IWebPushResourceOwner>): Promise<IWebPushBinding[]>;
+    getBindingById(idArg: string): Promise<WebPushBindingDoc | null>;
+    getBindingByCredentialId(credentialIdArg: string): Promise<WebPushBindingDoc | null>;
+    syncBinding(bindingArg: TWebPushBindingSync, controllerArg: IWebPushControllerMutation, createdByArg: string): Promise<IWebPushBindingSyncResult>;
+    private resumeControllerSyncReplay;
+    deleteBinding(deleteArg: IWebPushBindingDelete, deletedByArg: string): Promise<boolean>;
+    private resumeControllerDeleteReplay;
+    rotateCredential(credentialIdArg: string): Promise<IWebPushCredentialOneTimeSecret>;
+    rotateVapidKey(bindingIdArg: string): Promise<IWebPushBinding>;
+    authenticateAppCredential(authArg: IWebPushAppCredentialAuth): Promise<IWebPushAuthenticatedBinding>;
+    getServiceStatus(authArg: IWebPushAppCredentialAuth): Promise<IWebPushServiceStatus>;
+    enqueue(authArg: IWebPushAppCredentialAuth, requestArg: {
+        idempotencyKey: string;
+        subscriptionId: string;
+        subscription: IWebPushSubscription;
+        vapidKeyId: string;
+        payload: IWebPushNotificationPayload;
+        ttlSeconds?: number;
+        urgency?: TWebPushUrgency;
+        collapseKey?: string;
+    }): Promise<IWebPushEnqueueResult>;
+    getDeliveryStatus(authArg: IWebPushAppCredentialAuth, spoolItemIdArg: string): Promise<IWebPushDeliveryStatus | undefined>;
+    cancel(authArg: IWebPushAppCredentialAuth, targetArg: TWebPushCancellationTarget): Promise<IWebPushCancelResult>;
+    processDueDeliveriesOnce(limitArg?: number): Promise<number>;
+    private requirePersistenceReady;
+    private requireReady;
+    private bindingOwner;
+    private assertBindingOwner;
+    private credentialHmacValue;
+    private createCredential;
+    private credentialRotationRecoveryAad;
+    private replayCredentialRotation;
+    private createVapidKey;
+    private spoolAadBase;
+    private assertBindingLifecycleActive;
+    private reserveAdmission;
+    private cancelSpoolIfLifecycleChanged;
+    private scrubDeletedBindingLifecycle;
+    private cleanupExpiredCredentialOverlaps;
+    private cleanupExpiredCredentialRotationRecoveries;
+    private cleanupRetiredVapidKeys;
+    private runMaintenanceOnce;
+    private cleanupInactiveBindingLifecycles;
+    private selectBindingMaintenanceBatch;
+    private requestBindingLifecyclesBeforeCancellation;
+    private drainBindingLifecyclesBefore;
+    private waitForBindingLifecyclesBeforeDrain;
+    private finishStaleCancelledSending;
+    private finishStaleCancelledSendingBefore;
+    private cancelWithinBinding;
+    private expireDueItems;
+    private claimNextItem;
+    private processClaimedItem;
+    private finishTerminal;
+    private deferOrFinish;
+    private retryDelayMs;
+    private scheduleWorker;
+}
+export {};