@project-chip/matter.js 0.2.1 → 0.3.0

package/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MatterDevice } from "../../MatterDevice.js";
+import { InteractionServerMessenger } from "./InteractionMessenger.js";
+import { Fabric } from "../../fabric/Fabric.js";
+import { AttributeWithPath } from "./InteractionServer.js";
+import { NodeId } from "../../datatype/NodeId.js";
+import { TlvAttributePath } from "./InteractionProtocol.js";
+import { SecureSession } from "../../session/SecureSession.js";
+import { TlvSchema, TypeFromSchema } from "../../tlv/TlvSchema.js";
+export declare class SubscriptionHandler {
+    readonly subscriptionId: number;
+    private readonly server;
+    private readonly fabric;
+    private readonly peerNodeId;
+    private readonly attributes;
+    private lastUpdateTimeMs;
+    private updateTimer;
+    private outstandingAttributeUpdates;
+    private attributeListeners;
+    private sendUpdatesActivated;
+    private readonly maxInterval;
+    private readonly sendInterval;
+    private readonly minIntervalFloorMs;
+    private readonly maxIntervalCeilingMs;
+    constructor(subscriptionId: number, server: MatterDevice, fabric: Fabric, peerNodeId: NodeId, attributes: AttributeWithPath[], minIntervalFloor: number, maxIntervalCeiling: number);
+    getMaxInterval(): number;
+    activateSendingUpdates(): void;
+    sendUpdate(): Promise<void>;
+    sendInitialReport(messenger: InteractionServerMessenger, session: SecureSession<MatterDevice>): Promise<void>;
+    attributeChangeListener(path: TypeFromSchema<typeof TlvAttributePath>, schema: TlvSchema<any>, version: number, value: any): void;
+    cancel(): void;
+    private sendUpdateMessage;
+}
+//# sourceMappingURL=SubscriptionHandler.d.ts.map

package/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionHandler.d.ts","sourceRoot":"","sources":["../../../../src/protocol/interaction/SubscriptionHandler.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAuB,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAA8C,MAAM,wBAAwB,CAAC;AAGvG,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAc,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAExE,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAmBnE,qBAAa,mBAAmB;IAYxB,QAAQ,CAAC,cAAc,EAAE,MAAM;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAf/B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,2BAA2B,CAA4C;IAC/E,OAAO,CAAC,kBAAkB,CAA4D;IACtF,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAS;IAC5C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;gBAGjC,cAAc,EAAE,MAAM,EACd,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,iBAAiB,EAAE,EAChD,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,MAAM;IAsB9B,cAAc,IAAI,MAAM;IAIxB,sBAAsB;IAShB,UAAU;IA0BV,iBAAiB,CAAC,SAAS,EAAE,0BAA0B,EAAE,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC;IAuBnG,uBAAuB,CAAC,IAAI,EAAE,cAAc,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAK1H,MAAM;YAaQ,iBAAiB;CAmClC"}

package/dist/cjs/protocol/interaction/SubscriptionHandler.js

@@ -0,0 +1,174 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionHandler = void 0;
+const InteractionMessenger_js_1 = require("./InteractionMessenger.js");
+const InteractionServer_js_1 = require("./InteractionServer.js");
+const Logger_js_1 = require("../../log/Logger.js");
+const Time_js_1 = require("../../time/Time.js");
+const TryCatchHandler_js_1 = require("../../common/TryCatchHandler.js");
+const logger = Logger_js_1.Logger.get("SubscriptionHandler");
+// We use 3 minutes as global max interval because with 60mins as defined by spec the timeframe
+// until the controller establishs a new subscription after e.g a reboot can be up to 60 mins
+// and the controller would assume that the value is unchanged. this is too long.
+// chip-tool is not respecting the 60mins at all and only respects the max sent by the controller
+// which can lead to spamming the network with unneeded packages. So I decided for 3 minutes for now
+// as a compromise until we have something better.
+const SUBSCRIPTION_MAX_INTERVAL_PUBLISHER_LIMIT_MS = 3 * 60 * 1000; /** 3 mins */ // Officially: 1000 * 60 * 60; /** 1 hour */
+class SubscriptionHandler {
+    constructor(subscriptionId, server, fabric, peerNodeId, attributes, minIntervalFloor, maxIntervalCeiling) {
+        this.subscriptionId = subscriptionId;
+        this.server = server;
+        this.fabric = fabric;
+        this.peerNodeId = peerNodeId;
+        this.attributes = attributes;
+        this.lastUpdateTimeMs = 0;
+        this.outstandingAttributeUpdates = new Map();
+        this.attributeListeners = new Map();
+        this.sendUpdatesActivated = false;
+        this.minIntervalFloorMs = minIntervalFloor * 1000;
+        this.maxIntervalCeilingMs = maxIntervalCeiling * 1000;
+        // The final Max interval needs to be between min-floor and the MAX of max-ceiling and the defined publisher
+        // maximum of 60 minutes - this is to ensure that the publisher is not flooded with updates. But spec also
+        // says that it should be more frequent than the max interval.
+        // So let's calculate a maximum in the second half of the range between the two, but then already send at
+        // half of that time (so ideally we have 2 updates per max interval, so one could fail, and we still are good).
+        const halfMaxIntervalCeilingMs = (Math.max(SUBSCRIPTION_MAX_INTERVAL_PUBLISHER_LIMIT_MS, this.maxIntervalCeilingMs) - this.minIntervalFloorMs) / 2;
+        this.maxInterval = Math.floor(this.minIntervalFloorMs + halfMaxIntervalCeilingMs + halfMaxIntervalCeilingMs * Math.random());
+        this.sendInterval = Math.floor(this.maxInterval / 2);
+        this.updateTimer = Time_js_1.Time.getTimer(this.sendInterval, () => this.sendUpdate()); // will be started later
+        attributes.forEach(({ path, attribute }) => {
+            // TODO: handle attributes with "getter" methods
+            const listener = (value, version) => this.attributeChangeListener(path, attribute.schema, version, value);
+            this.attributeListeners.set((0, InteractionServer_js_1.attributePathToId)(path), listener);
+            attribute.addMatterListener(listener);
+        });
+    }
+    getMaxInterval() {
+        return Math.ceil(this.maxInterval / 1000);
+    }
+    activateSendingUpdates() {
+        this.sendUpdatesActivated = true;
+        if (this.outstandingAttributeUpdates.size > 0) {
+            void this.sendUpdate();
+        }
+        else {
+            this.updateTimer = Time_js_1.Time.getTimer(this.sendInterval, () => this.sendUpdate()).start();
+        }
+    }
+    sendUpdate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.updateTimer.stop();
+            const now = Time_js_1.Time.nowMs();
+            const timeSinceLastUpdateMs = now - this.lastUpdateTimeMs;
+            if (timeSinceLastUpdateMs < this.minIntervalFloorMs) {
+                this.updateTimer = Time_js_1.Time.getTimer(this.minIntervalFloorMs - timeSinceLastUpdateMs, () => this.sendUpdate()).start();
+                return;
+            }
+            if (!this.sendUpdatesActivated) {
+                return;
+            }
+            const updatesToSend = Array.from(this.outstandingAttributeUpdates.values());
+            this.outstandingAttributeUpdates.clear();
+            this.lastUpdateTimeMs = now;
+            try {
+                yield this.sendUpdateMessage(updatesToSend);
+            }
+            catch (error) {
+                // TODO: Add maybe a counter and cancel subscription update sending after a certain number of errors?
+                logger.error("Error sending subscription update message", error);
+            }
+            this.updateTimer = Time_js_1.Time.getTimer(this.sendInterval, () => this.sendUpdate()).start();
+        });
+    }
+    sendInitialReport(messenger, session) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.updateTimer.stop();
+            const values = this.attributes.map(({ path, attribute }) => {
+                const { value, version } = attribute.getWithVersion(session);
+                return { path, value, version, schema: attribute.schema };
+            }).filter(({ value }) => value !== undefined);
+            this.lastUpdateTimeMs = Time_js_1.Time.nowMs();
+            yield messenger.sendDataReport({
+                suppressResponse: false,
+                subscriptionId: this.subscriptionId,
+                interactionModelRevision: 1,
+                attributeReports: values.map(({ path, schema, value, version }) => ({
+                    attributeData: {
+                        path,
+                        dataVersion: version,
+                        data: schema.encodeTlv(value),
+                    },
+                })),
+            });
+        });
+    }
+    attributeChangeListener(path, schema, version, value) {
+        this.outstandingAttributeUpdates.set((0, InteractionServer_js_1.attributePathToId)(path), { path, schema, version, value });
+        void this.sendUpdate();
+    }
+    cancel() {
+        this.sendUpdatesActivated = false;
+        this.attributes.forEach(({ path, attribute }) => {
+            const pathId = (0, InteractionServer_js_1.attributePathToId)(path);
+            const listener = this.attributeListeners.get(pathId);
+            if (listener !== undefined) {
+                attribute.removeMatterListener(listener);
+            }
+            this.attributeListeners.delete(pathId);
+        });
+        this.updateTimer.stop();
+    }
+    sendUpdateMessage(values) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.debug(`Sending subscription update message for ID ${this.subscriptionId} with ${values.length} values`);
+            const exchange = this.server.initiateExchange(this.fabric, this.peerNodeId, InteractionServer_js_1.INTERACTION_PROTOCOL_ID);
+            if (exchange === undefined)
+                return;
+            logger.debug(`Sending subscription changes for ID ${this.subscriptionId}: ${Logger_js_1.Logger.toJSON(values)}`);
+            const messenger = new InteractionMessenger_js_1.InteractionServerMessenger(exchange);
+            try {
+                yield (0, TryCatchHandler_js_1.tryCatchAsync)(() => __awaiter(this, void 0, void 0, function* () {
+                    yield messenger.sendDataReport({
+                        suppressResponse: !values.length,
+                        subscriptionId: this.subscriptionId,
+                        interactionModelRevision: 1,
+                        attributeReports: values.map(({ path, schema, value, version }) => ({
+                            attributeData: {
+                                path,
+                                dataVersion: version,
+                                data: schema.encodeTlv(value),
+                            },
+                        })),
+                    });
+                }), InteractionMessenger_js_1.StatusResponseError, (error) => {
+                    if (error.code === 125 /* StatusCode.InvalidSubscription */ ||
+                        error.code === 1 /* StatusCode.Failure */) {
+                        logger.info(`Subscription ${this.subscriptionId} cancelled by peer.`);
+                        this.cancel();
+                    }
+                    else {
+                        throw error;
+                    }
+                });
+            }
+            finally {
+                messenger.close();
+            }
+        });
+    }
+}
+exports.SubscriptionHandler = SubscriptionHandler;

package/dist/cjs/protocol/interaction/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from "./InteractionProtocol.js";
+export * from "./AttributeDataDecoder.js";
+export * from "./InteractionClient.js";
+export * from "./InteractionMessenger.js";
+export * from "./InteractionServer.js";
+export * from "./SubscriptionHandler.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/protocol/interaction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/protocol/interaction/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,cAAc,0BAA0B,CAAC;AAGzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC"}

package/dist/cjs/protocol/interaction/index.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export Protocol types
+__exportStar(require("./InteractionProtocol.js"), exports);
+// Export Interaction Classes
+__exportStar(require("./AttributeDataDecoder.js"), exports);
+__exportStar(require("./InteractionClient.js"), exports);
+__exportStar(require("./InteractionMessenger.js"), exports);
+__exportStar(require("./InteractionServer.js"), exports);
+__exportStar(require("./SubscriptionHandler.js"), exports);

package/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare const SECURE_CHANNEL_PROTOCOL_ID = 0;
+export declare const enum MessageType {
+    StandaloneAck = 16,
+    PbkdfParamRequest = 32,
+    PbkdfParamResponse = 33,
+    PasePake1 = 34,
+    PasePake2 = 35,
+    PasePake3 = 36,
+    Sigma1 = 48,
+    Sigma2 = 49,
+    Sigma3 = 50,
+    Sigma2Resume = 51,
+    StatusReport = 64
+}
+export declare const enum ProtocolStatusCode {
+    Success = 0,
+    NoSharedTrustRoots = 1,
+    InvalidParam = 2,
+    CloseSession = 3,
+    Busy = 4
+}
+export declare const enum GeneralStatusCode {
+    /** Operation completed successfully. */
+    Success = 0,
+    /** Generic failure, additional details may be included in the protocol specific status. */
+    Error = 1,
+    /** Operation was rejected by the system because the system is in an invalid state. */
+    BadPrecondition = 2,
+    /** A value was out of a required range */
+    OutOfRange = 3,
+    /** A request was unrecognized or malformed */
+    BadRequest = 4,
+    /** An unrecognized or unsupported request was received. */
+    Unsupported = 5,
+    /** A request was not expected at this time. */
+    Unexpected = 6,
+    /** Insufficient resources to process the given request. */
+    ResourceExhausted = 7,
+    /** Device is busy and cannot handle this request at this time. */
+    Busy = 8,
+    /** A timeout occurred. */
+    Timeout = 9,
+    /** Context-specific signal to proceed */
+    Continue = 10,
+    /** Failure, may be due to a concurrency error. */
+    Aborted = 11,
+    /** An invalid/unsupported argument was provided. */
+    InvalidArgument = 12,
+    /** Some requested entity was not found. */
+    NotFound = 13,
+    /** The sender attempted to create something that already exists. */
+    AlreadyExists = 14,
+    /** The sender does not have sufficient permissions to execute the requested operations. */
+    PermissionDenied = 15,
+    /** Unrecoverable data loss or corruption has occurred. */
+    DataLoss = 16
+}
+//# sourceMappingURL=SecureChannelMessages.d.ts.map

package/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecureChannelMessages.d.ts","sourceRoot":"","sources":["../../../../src/protocol/securechannel/SecureChannelMessages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,eAAO,MAAM,0BAA0B,IAAa,CAAC;AAErD,0BAAkB,WAAW;IACzB,aAAa,KAAO;IACpB,iBAAiB,KAAO;IACxB,kBAAkB,KAAO;IACzB,SAAS,KAAO;IAChB,SAAS,KAAO;IAChB,SAAS,KAAO;IAChB,MAAM,KAAO;IACb,MAAM,KAAO;IACb,MAAM,KAAO;IACb,YAAY,KAAO;IACnB,YAAY,KAAO;CACtB;AAED,0BAAkB,kBAAkB;IAChC,OAAO,IAAS;IAChB,kBAAkB,IAAS;IAC3B,YAAY,IAAS;IACrB,YAAY,IAAS;IACrB,IAAI,IAAS;CAChB;AAED,0BAAkB,iBAAiB;IAC/B,wCAAwC;IACxC,OAAO,IAAI;IAEX,2FAA2F;IAC3F,KAAK,IAAI;IAET,sFAAsF;IACtF,eAAe,IAAI;IAEnB,0CAA0C;IAC1C,UAAU,IAAI;IAEd,8CAA8C;IAC9C,UAAU,IAAI;IAEd,2DAA2D;IAC3D,WAAW,IAAI;IAEf,+CAA+C;IAC/C,UAAU,IAAI;IAEd,2DAA2D;IAC3D,iBAAiB,IAAI;IAErB,kEAAkE;IAClE,IAAI,IAAI;IAER,0BAA0B;IAC1B,OAAO,IAAI;IAEX,yCAAyC;IACzC,QAAQ,KAAK;IAEb,kDAAkD;IAClD,OAAO,KAAK;IAEZ,oDAAoD;IACpD,eAAe,KAAK;IAEpB,2CAA2C;IAC3C,QAAQ,KAAK;IAEb,oEAAoE;IACpE,aAAa,KAAK;IAElB,2FAA2F;IAC3F,gBAAgB,KAAK;IAErB,0DAA0D;IAC1D,QAAQ,KAAK;CAChB"}

package/dist/cjs/protocol/securechannel/SecureChannelMessages.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SECURE_CHANNEL_PROTOCOL_ID = void 0;
+exports.SECURE_CHANNEL_PROTOCOL_ID = 0x00000000;

package/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MessageExchange } from "../../protocol/MessageExchange.js";
+import { GeneralStatusCode, ProtocolStatusCode } from "./SecureChannelMessages.js";
+import { TlvSchema } from "../../tlv/TlvSchema.js";
+import { MatterError } from "../../common/MatterError.js";
+import { Message } from "../../codec/MessageCodec.js";
+/** Error base Class for all errors related to the status response messages. */
+export declare class ChannelStatusResponseError extends MatterError {
+    readonly generalStatusCode: GeneralStatusCode;
+    readonly protocolStatusCode: ProtocolStatusCode;
+    constructor(message: string, generalStatusCode: GeneralStatusCode, protocolStatusCode: ProtocolStatusCode);
+}
+export declare class SecureChannelMessenger<ContextT> {
+    protected readonly exchange: MessageExchange<ContextT>;
+    constructor(exchange: MessageExchange<ContextT>);
+    nextMessage(expectedMessageType?: number): Promise<Message>;
+    nextMessageDecoded<T>(expectedMessageType: number, schema: TlvSchema<T>): Promise<T>;
+    waitForSuccess(): Promise<void>;
+    send<T>(message: T, type: number, schema: TlvSchema<T>): Promise<Uint8Array>;
+    sendError(): Promise<void>;
+    sendSuccess(): Promise<void>;
+    getChannelName(): string;
+    close(): void;
+    private sendStatusReport;
+    protected throwIfErrorStatusReport(message: Message): void;
+}
+//# sourceMappingURL=SecureChannelMessenger.d.ts.map

package/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecureChannelMessenger.d.ts","sourceRoot":"","sources":["../../../../src/protocol/securechannel/SecureChannelMessenger.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAA2C,MAAM,4BAA4B,CAAC;AAC5H,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,+EAA+E;AAC/E,qBAAa,0BAA2B,SAAQ,WAAW;aAGnC,iBAAiB,EAAE,iBAAiB;aACpC,kBAAkB,EAAE,kBAAkB;gBAFtD,OAAO,EAAE,MAAM,EACC,iBAAiB,EAAE,iBAAiB,EACpC,kBAAkB,EAAE,kBAAkB;CAI7D;AAED,qBAAa,sBAAsB,CAAC,QAAQ;IAEpC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC;gBAAnC,QAAQ,EAAE,eAAe,CAAC,QAAQ,CAAC;IAGpD,WAAW,CAAC,mBAAmB,CAAC,EAAE,MAAM;IAQxC,kBAAkB,CAAC,CAAC,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAIvE,cAAc;IAKd,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAM5D,SAAS;IAIT,WAAW;IAIX,cAAc;IAId,KAAK;YAIS,gBAAgB;IAQ9B,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO;CAYtD"}

package/dist/cjs/protocol/securechannel/SecureChannelMessenger.js

@@ -0,0 +1,96 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecureChannelMessenger = exports.ChannelStatusResponseError = void 0;
+const SecureChannelMessages_js_1 = require("./SecureChannelMessages.js");
+const MatterError_js_1 = require("../../common/MatterError.js");
+const SecureChannelStatusMessageSchema_js_1 = require("./SecureChannelStatusMessageSchema.js");
+/** Error base Class for all errors related to the status response messages. */
+class ChannelStatusResponseError extends MatterError_js_1.MatterError {
+    constructor(message, generalStatusCode, protocolStatusCode) {
+        super(`(${generalStatusCode}/${protocolStatusCode}) ${message}`);
+        this.generalStatusCode = generalStatusCode;
+        this.protocolStatusCode = protocolStatusCode;
+    }
+}
+exports.ChannelStatusResponseError = ChannelStatusResponseError;
+class SecureChannelMessenger {
+    constructor(exchange) {
+        this.exchange = exchange;
+    }
+    nextMessage(expectedMessageType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const message = yield this.exchange.nextMessage();
+            const messageType = message.payloadHeader.messageType;
+            this.throwIfErrorStatusReport(message);
+            if (expectedMessageType !== undefined && messageType !== expectedMessageType)
+                throw new Error(`Received unexpected message type: ${messageType}, expected: ${expectedMessageType}`);
+            return message;
+        });
+    }
+    nextMessageDecoded(expectedMessageType, schema) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return schema.decode((yield this.nextMessage(expectedMessageType)).payload);
+        });
+    }
+    waitForSuccess() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // If the status is not Success, this would throw an Error.
+            yield this.nextMessage(64 /* MessageType.StatusReport */);
+        });
+    }
+    send(message, type, schema) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = schema.encode(message);
+            yield this.exchange.send(type, payload);
+            return payload;
+        });
+    }
+    sendError() {
+        return this.sendStatusReport(1 /* GeneralStatusCode.Error */, 2 /* ProtocolStatusCode.InvalidParam */);
+    }
+    sendSuccess() {
+        return this.sendStatusReport(0 /* GeneralStatusCode.Success */, 0 /* ProtocolStatusCode.Success */);
+    }
+    getChannelName() {
+        return this.exchange.channel.channel.getName();
+    }
+    close() {
+        this.exchange.close();
+    }
+    sendStatusReport(generalStatus, protocolStatus) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.exchange.send(64 /* MessageType.StatusReport */, SecureChannelStatusMessageSchema_js_1.TlvSecureChannelStatusMessage.encode({
+                generalStatus,
+                protocolId: SecureChannelMessages_js_1.SECURE_CHANNEL_PROTOCOL_ID,
+                protocolStatus
+            }));
+        });
+    }
+    throwIfErrorStatusReport(message) {
+        const { payloadHeader: { messageType }, payload } = message;
+        if (messageType !== 64 /* MessageType.StatusReport */)
+            return;
+        const { generalStatus, protocolId, protocolStatus } = SecureChannelStatusMessageSchema_js_1.TlvSecureChannelStatusMessage.decode(payload);
+        if (generalStatus !== 0 /* GeneralStatusCode.Success */) {
+            throw new ChannelStatusResponseError(`Received general error status (${protocolId})`, generalStatus, protocolStatus);
+        }
+        if (protocolStatus !== 0 /* ProtocolStatusCode.Success */) {
+            throw new ChannelStatusResponseError(`Received general success status, but protocol status is not Success`, generalStatus, protocolStatus);
+        }
+    }
+}
+exports.SecureChannelMessenger = SecureChannelMessenger;

package/dist/cjs/protocol/securechannel/SecureChannelProtocol.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Message } from "../../codec/MessageCodec.js";
+import { MessageExchange } from "../../protocol/MessageExchange.js";
+import { ProtocolHandler } from "../../protocol/ProtocolHandler.js";
+import { CaseServer } from "../../session/case/CaseServer.js";
+import { PaseServer } from "../../session/pase/PaseServer.js";
+import { MatterDevice } from "../../MatterDevice.js";
+export declare class SecureChannelProtocol implements ProtocolHandler<MatterDevice> {
+    private paseCommissioner;
+    private readonly caseCommissioner;
+    constructor(paseCommissioner: PaseServer, caseCommissioner: CaseServer);
+    getId(): number;
+    updatePaseCommissioner(paseServer: PaseServer): void;
+    onNewExchange(exchange: MessageExchange<MatterDevice>, message: Message): Promise<void>;
+    static isStandaloneAck(protocolId: number, messageType: number): boolean;
+}
+//# sourceMappingURL=SecureChannelProtocol.d.ts.map

package/dist/cjs/protocol/securechannel/SecureChannelProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecureChannelProtocol.d.ts","sourceRoot":"","sources":["../../../../src/protocol/securechannel/SecureChannelProtocol.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,qBAAa,qBAAsB,YAAW,eAAe,CAAC,YAAY,CAAC;IAGnE,OAAO,CAAC,gBAAgB;IACxB,OAAO,CAAC,QAAQ,CAAC,gBAAgB;gBADzB,gBAAgB,EAAE,UAAU,EACnB,gBAAgB,EAAE,UAAU;IAGjD,KAAK,IAAI,MAAM;IAIf,sBAAsB,CAAC,UAAU,EAAE,UAAU;IAIvC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,OAAO;IAe7E,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAGjE"}

package/dist/cjs/protocol/securechannel/SecureChannelProtocol.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecureChannelProtocol = void 0;
+const SecureChannelMessages_js_1 = require("./SecureChannelMessages.js");
+class SecureChannelProtocol {
+    constructor(paseCommissioner, caseCommissioner) {
+        this.paseCommissioner = paseCommissioner;
+        this.caseCommissioner = caseCommissioner;
+    }
+    getId() {
+        return SecureChannelMessages_js_1.SECURE_CHANNEL_PROTOCOL_ID;
+    }
+    updatePaseCommissioner(paseServer) {
+        this.paseCommissioner = paseServer;
+    }
+    onNewExchange(exchange, message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const messageType = message.payloadHeader.messageType;
+            switch (messageType) {
+                case 32 /* MessageType.PbkdfParamRequest */:
+                    yield this.paseCommissioner.onNewExchange(exchange);
+                    break;
+                case 48 /* MessageType.Sigma1 */:
+                    yield this.caseCommissioner.onNewExchange(exchange);
+                    break;
+                default:
+                    throw new Error(`Unexpected initial message on secure channel protocol: ${messageType.toString(16)}`);
+            }
+        });
+    }
+    static isStandaloneAck(protocolId, messageType) {
+        return protocolId === SecureChannelMessages_js_1.SECURE_CHANNEL_PROTOCOL_ID && messageType === 16 /* MessageType.StandaloneAck */;
+    }
+}
+exports.SecureChannelProtocol = SecureChannelProtocol;

package/dist/cjs/protocol/securechannel/SecureChannelStatusMessageSchema.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Schema } from "../../schema/Schema.js";
+import { ByteArray } from "../../util/ByteArray.js";
+import { GeneralStatusCode, ProtocolStatusCode } from "./SecureChannelMessages.js";
+export type StatusMessage = {
+    generalStatus: GeneralStatusCode;
+    protocolId: number;
+    protocolStatus: ProtocolStatusCode;
+};
+export declare class SecureChannelStatusMessageSchema extends Schema<StatusMessage, ByteArray> {
+    encodeInternal({ generalStatus, protocolId, protocolStatus }: StatusMessage): Uint8Array;
+    decodeInternal(bytes: ByteArray): {
+        generalStatus: number;
+        protocolId: number;
+        protocolStatus: number;
+    };
+}
+export declare const TlvSecureChannelStatusMessage: SecureChannelStatusMessageSchema;
+//# sourceMappingURL=SecureChannelStatusMessageSchema.d.ts.map

package/dist/cjs/protocol/securechannel/SecureChannelStatusMessageSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecureChannelStatusMessageSchema.d.ts","sourceRoot":"","sources":["../../../../src/protocol/securechannel/SecureChannelStatusMessageSchema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAU,MAAM,yBAAyB,CAAC;AAG5D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEnF,MAAM,MAAM,aAAa,GAAG;IACxB,aAAa,EAAE,iBAAiB,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,kBAAkB,CAAC;CACtC,CAAA;AAED,qBAAa,gCAAiC,SAAQ,MAAM,CAAC,aAAa,EAAE,SAAS,CAAC;IAClF,cAAc,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,EAAE,aAAa;IAQ3E,cAAc,CAAC,KAAK,EAAE,SAAS;;;;;CAOlC;AAED,eAAO,MAAM,6BAA6B,kCAAyC,CAAC"}

package/dist/cjs/protocol/securechannel/SecureChannelStatusMessageSchema.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TlvSecureChannelStatusMessage = exports.SecureChannelStatusMessageSchema = void 0;
+const Schema_js_1 = require("../../schema/Schema.js");
+const ByteArray_js_1 = require("../../util/ByteArray.js");
+const DataReader_js_1 = require("../../util/DataReader.js");
+const DataWriter_js_1 = require("../../util/DataWriter.js");
+class SecureChannelStatusMessageSchema extends Schema_js_1.Schema {
+    encodeInternal({ generalStatus, protocolId, protocolStatus }) {
+        const writer = new DataWriter_js_1.DataWriter(ByteArray_js_1.Endian.Little);
+        writer.writeUInt16(generalStatus);
+        writer.writeUInt32(protocolId);
+        writer.writeUInt16(protocolStatus);
+        return writer.toByteArray();
+    }
+    decodeInternal(bytes) {
+        const reader = new DataReader_js_1.DataReader(bytes, ByteArray_js_1.Endian.Little);
+        const generalStatus = reader.readUInt16();
+        const protocolId = reader.readUInt32();
+        const protocolStatus = reader.readUInt16();
+        return { generalStatus, protocolId, protocolStatus };
+    }
+}
+exports.SecureChannelStatusMessageSchema = SecureChannelStatusMessageSchema;
+exports.TlvSecureChannelStatusMessage = new SecureChannelStatusMessageSchema();

package/dist/cjs/protocol/securechannel/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from "./SecureChannelMessages.js";
+export * from "./SecureChannelMessenger.js";
+export * from "./SecureChannelProtocol.js";
+export * from "./SecureChannelStatusMessageSchema.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/protocol/securechannel/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/protocol/securechannel/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uCAAuC,CAAC"}