@matter/protocol 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/cjs/session/SecureSession.js

@@ -0,0 +1,291 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var SecureSession_exports = {};
+__export(SecureSession_exports, {
+  NoAssociatedFabricError: () => NoAssociatedFabricError,
+  SecureSession: () => SecureSession,
+  assertSecureSession: () => assertSecureSession
+});
+module.exports = __toCommonJS(SecureSession_exports);
+var import_general = require("#general");
+var import_PeerAddress = require("#peer/PeerAddress.js");
+var import_types = require("#types");
+var import_MessageCodec = require("../codec/MessageCodec.js");
+var import_MessageCounter = require("../protocol/MessageCounter.js");
+var import_MessageReceptionState = require("../protocol/MessageReceptionState.js");
+var import_Session = require("./Session.js");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const logger = import_general.Logger.get("SecureSession");
+const SESSION_KEYS_INFO = import_general.Bytes.fromString("SessionKeys");
+const SESSION_RESUMPTION_KEYS_INFO = import_general.Bytes.fromString("SessionResumptionKeys");
+class NoAssociatedFabricError extends import_types.StatusResponseError {
+  constructor(message) {
+    super(message, import_types.StatusCode.UnsupportedAccess);
+  }
+}
+class SecureSession extends import_Session.Session {
+  #subscriptions = new import_general.BasicSet();
+  #closingAfterExchangeFinished = false;
+  #sendCloseMessageWhenClosing = true;
+  #id;
+  #fabric;
+  #peerNodeId;
+  #peerSessionId;
+  #decryptKey;
+  #encryptKey;
+  #attestationKey;
+  #caseAuthenticatedTags;
+  #isClosing = false;
+  supportsMRP = true;
+  static async create(args) {
+    const {
+      manager,
+      id,
+      fabric,
+      peerNodeId,
+      peerSessionId,
+      sharedSecret,
+      salt,
+      isInitiator,
+      isResumption,
+      peerSessionParameters,
+      caseAuthenticatedTags
+    } = args;
+    const keys = await import_general.Crypto.hkdf(
+      sharedSecret,
+      salt,
+      isResumption ? SESSION_RESUMPTION_KEYS_INFO : SESSION_KEYS_INFO,
+      import_general.CRYPTO_SYMMETRIC_KEY_LENGTH * 3
+    );
+    const decryptKey = isInitiator ? keys.slice(16, 32) : keys.slice(0, 16);
+    const encryptKey = isInitiator ? keys.slice(0, 16) : keys.slice(16, 32);
+    const attestationKey = keys.slice(32, 48);
+    return new SecureSession({
+      manager,
+      id,
+      fabric,
+      peerNodeId,
+      peerSessionId,
+      decryptKey,
+      encryptKey,
+      attestationKey,
+      sessionParameters: peerSessionParameters,
+      isInitiator,
+      caseAuthenticatedTags
+    });
+  }
+  constructor(args) {
+    super({
+      ...args,
+      setActiveTimestamp: true,
+      // We always set the active timestamp for Secure sessions
+      // Can be changed to a PersistedMessageCounter if we implement session storage
+      messageCounter: new import_MessageCounter.MessageCounter(() => {
+        this.end(true, true).catch((error) => logger.error(`Error while closing session: ${error}`));
+      }),
+      messageReceptionState: new import_MessageReceptionState.MessageReceptionStateEncryptedWithoutRollover()
+    });
+    const {
+      manager,
+      id,
+      fabric,
+      peerNodeId,
+      peerSessionId,
+      decryptKey,
+      encryptKey,
+      attestationKey,
+      caseAuthenticatedTags
+    } = args;
+    this.#id = id;
+    this.#fabric = fabric;
+    this.#peerNodeId = peerNodeId;
+    this.#peerSessionId = peerSessionId;
+    this.#decryptKey = decryptKey;
+    this.#encryptKey = encryptKey;
+    this.#attestationKey = attestationKey;
+    this.#caseAuthenticatedTags = caseAuthenticatedTags ?? [];
+    manager?.sessions.add(this);
+    fabric?.addSession(this);
+    logger.debug(
+      `Created secure ${this.isPase ? "PASE" : "CASE"} session for fabric index ${fabric?.fabricIndex}`,
+      this.name,
+      import_general.Diagnostic.dict({
+        idleIntervalMs: this.idleIntervalMs,
+        activeIntervalMs: this.activeIntervalMs,
+        activeThresholdMs: this.activeThresholdMs,
+        dataModelRevision: this.dataModelRevision,
+        interactionModelRevision: this.interactionModelRevision,
+        specificationVersion: this.specificationVersion,
+        maxPathsPerInvoke: this.maxPathsPerInvoke,
+        caseAuthenticatedTags: this.#caseAuthenticatedTags
+      })
+    );
+  }
+  get caseAuthenticatedTags() {
+    return this.#caseAuthenticatedTags;
+  }
+  get closingAfterExchangeFinished() {
+    return this.#closingAfterExchangeFinished;
+  }
+  get sendCloseMessageWhenClosing() {
+    return this.#sendCloseMessageWhenClosing;
+  }
+  get isSecure() {
+    return true;
+  }
+  get isPase() {
+    return this.#peerNodeId === import_types.NodeId.UNSPECIFIED_NODE_ID;
+  }
+  get subscriptions() {
+    return this.#subscriptions;
+  }
+  get isClosing() {
+    return this.#isClosing;
+  }
+  async close(closeAfterExchangeFinished) {
+    if (closeAfterExchangeFinished === void 0) {
+      closeAfterExchangeFinished = this.isPeerActive();
+    }
+    await this.end(true, closeAfterExchangeFinished);
+  }
+  decode({ header, applicationPayload, messageExtension }, aad) {
+    if (header.hasMessageExtensions) {
+      logger.info(
+        `Message extensions are not supported. Ignoring ${messageExtension ? import_general.Bytes.toHex(messageExtension) : void 0}`
+      );
+    }
+    const nonce = this.generateNonce(header.securityFlags, header.messageId, this.#peerNodeId);
+    const message = import_MessageCodec.MessageCodec.decodePayload({
+      header,
+      applicationPayload: import_general.Crypto.decrypt(this.#decryptKey, applicationPayload, nonce, aad)
+    });
+    if (message.payloadHeader.hasSecuredExtension) {
+      logger.info(
+        `Secured extensions are not supported. Ignoring ${message.securityExtension ? import_general.Bytes.toHex(message.securityExtension) : void 0}`
+      );
+    }
+    return message;
+  }
+  encode(message) {
+    message.packetHeader.sessionId = this.#peerSessionId;
+    const { header, applicationPayload } = import_MessageCodec.MessageCodec.encodePayload(message);
+    const headerBytes = import_MessageCodec.MessageCodec.encodePacketHeader(message.packetHeader);
+    const securityFlags = headerBytes[3];
+    const sessionNodeId = this.isPase ? import_types.NodeId.UNSPECIFIED_NODE_ID : this.#fabric?.nodeId ?? import_types.NodeId.UNSPECIFIED_NODE_ID;
+    const nonce = this.generateNonce(securityFlags, header.messageId, sessionNodeId);
+    return { header, applicationPayload: import_general.Crypto.encrypt(this.#encryptKey, applicationPayload, nonce, headerBytes) };
+  }
+  get attestationChallengeKey() {
+    return this.#attestationKey;
+  }
+  get fabric() {
+    return this.#fabric;
+  }
+  addAssociatedFabric(fabric) {
+    if (this.#fabric !== void 0) {
+      throw new import_general.MatterFlowError("Session already has an associated Fabric. Cannot change this.");
+    }
+    this.#fabric = fabric;
+  }
+  get id() {
+    return this.#id;
+  }
+  get name() {
+    return `secure/${this.#id}`;
+  }
+  get peerSessionId() {
+    return this.#peerSessionId;
+  }
+  get nodeId() {
+    return this.#fabric?.nodeId ?? import_types.NodeId.UNSPECIFIED_NODE_ID;
+  }
+  get peerNodeId() {
+    return this.#peerNodeId;
+  }
+  get associatedFabric() {
+    if (this.#fabric === void 0) {
+      throw new NoAssociatedFabricError(
+        `${this.isPase ? "PASE " : ""}Session needs to have an associated Fabric for fabric sensitive data handling.`
+      );
+    }
+    return this.#fabric;
+  }
+  async clearSubscriptions(flushSubscriptions = false) {
+    const subscriptions = [...this.#subscriptions];
+    for (const subscription of subscriptions) {
+      await subscription.close(flushSubscriptions);
+    }
+  }
+  /** Ends a session. Outstanding subscription data will be flushed before the session is destroyed. */
+  async end(sendClose, closeAfterExchangeFinished = false) {
+    await this.clearSubscriptions(true);
+    await this.destroy(sendClose, closeAfterExchangeFinished);
+  }
+  /** Destroys a session. Outstanding subscription data will be discarded. */
+  async destroy(sendClose = false, closeAfterExchangeFinished = true) {
+    await this.clearSubscriptions(false);
+    this.#fabric?.removeSession(this);
+    if (!sendClose) {
+      this.#sendCloseMessageWhenClosing = false;
+    }
+    if (closeAfterExchangeFinished) {
+      logger.info(`Register Session ${this.name} to close when exchange is ended.`);
+      this.#closingAfterExchangeFinished = true;
+    } else {
+      this.#isClosing = true;
+      logger.info(`End ${this.isPase ? "PASE" : "CASE"} session ${this.name}`);
+      this.manager?.sessions.delete(this);
+      if (this.closer) {
+        await this.closer;
+      }
+    }
+  }
+  /**
+   * The peer node's address.
+   */
+  get peerAddress() {
+    return (0, import_PeerAddress.PeerAddress)({
+      fabricIndex: this.#fabric?.fabricIndex ?? import_types.FabricIndex.NO_FABRIC,
+      nodeId: this.#peerNodeId
+    });
+  }
+  /**
+   * Indicates whether a peer matches a specific address.
+   */
+  peerIs(address) {
+    return (this.#fabric?.fabricIndex ?? import_types.FabricIndex.NO_FABRIC) === address.fabricIndex && this.#peerNodeId === address.nodeId;
+  }
+  generateNonce(securityFlags, messageId, nodeId) {
+    const writer = new import_general.DataWriter(import_general.Endian.Little);
+    writer.writeUInt8(securityFlags);
+    writer.writeUInt32(messageId);
+    writer.writeUInt64(nodeId);
+    return writer.toByteArray();
+  }
+}
+function assertSecureSession(session, errorText) {
+  if (!session?.isSecure) {
+    throw new import_general.MatterFlowError(errorText ?? "Insecure session in secure context");
+  }
+}
+//# sourceMappingURL=SecureSession.js.map

package/dist/cjs/session/SecureSession.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/session/SecureSession.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAUO;AAEP,yBAA4B;AAC5B,mBAA2F;AAC3F,0BAA6E;AAE7E,4BAA+B;AAC/B,mCAA8D;AAC9D,qBAAiD;AAxBjD;AAAA;AAAA;AAAA;AAAA;AA2BA,MAAM,SAAS,sBAAO,IAAI,eAAe;AAEzC,MAAM,oBAAoB,qBAAM,WAAW,aAAa;AACxD,MAAM,+BAA+B,qBAAM,WAAW,uBAAuB;AAEtE,MAAM,gCAAgC,iCAAoB;AAAA,EAC7D,YAAY,SAAiB;AACzB,UAAM,SAAS,wBAAW,iBAAiB;AAAA,EAC/C;AACJ;AAEO,MAAM,sBAAsB,uBAAQ;AAAA,EAC9B,iBAAiB,IAAI,wBAAuB;AAAA,EACrD,gCAAgC;AAAA,EAChC,+BAA+B;AAAA,EACtB;AAAA,EACT;AAAA,EACS;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACT;AAAA,EACA,aAAa;AAAA,EACJ,cAAc;AAAA,EAEvB,aAAa,OAAO,MAYjB;AACC,UAAM;AAAA,MACF;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ,IAAI;AACJ,UAAM,OAAO,MAAM,sBAAO;AAAA,MACtB;AAAA,MACA;AAAA,MACA,eAAe,+BAA+B;AAAA,MAC9C,6CAA8B;AAAA,IAClC;AACA,UAAM,aAAa,cAAc,KAAK,MAAM,IAAI,EAAE,IAAI,KAAK,MAAM,GAAG,EAAE;AACtE,UAAM,aAAa,cAAc,KAAK,MAAM,GAAG,EAAE,IAAI,KAAK,MAAM,IAAI,EAAE;AACtE,UAAM,iBAAiB,KAAK,MAAM,IAAI,EAAE;AACxC,WAAO,IAAI,cAAc;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,mBAAmB;AAAA,MACnB;AAAA,MACA;AAAA,IACJ,CAAC;AAAA,EACL;AAAA,EAEA,YAAY,MAYT;AACC,UAAM;AAAA,MACF,GAAG;AAAA,MACH,oBAAoB;AAAA;AAAA;AAAA,MAEpB,gBAAgB,IAAI,qCAAe,MAAM;AAGrC,aAAK,IAAI,MAAM,IAAI,EAAE,MAAM,WAAS,OAAO,MAAM,gCAAgC,KAAK,EAAE,CAAC;AAAA,MAC7F,CAAC;AAAA,MACD,uBAAuB,IAAI,2EAA8C;AAAA,IAC7E,CAAC;AACD,UAAM;AAAA,MACF;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ,IAAI;AAEJ,SAAK,MAAM;AACX,SAAK,UAAU;AACf,SAAK,cAAc;AACnB,SAAK,iBAAiB;AACtB,SAAK,cAAc;AACnB,SAAK,cAAc;AACnB,SAAK,kBAAkB;AACvB,SAAK,yBAAyB,yBAAyB,CAAC;AAExD,aAAS,SAAS,IAAI,IAAI;AAC1B,YAAQ,WAAW,IAAI;AAEvB,WAAO;AAAA,MACH,kBAAkB,KAAK,SAAS,SAAS,MAAM,6BAA6B,QAAQ,WAAW;AAAA,MAC/F,KAAK;AAAA,MACL,0BAAW,KAAK;AAAA,QACZ,gBAAgB,KAAK;AAAA,QACrB,kBAAkB,KAAK;AAAA,QACvB,mBAAmB,KAAK;AAAA,QACxB,mBAAmB,KAAK;AAAA,QACxB,0BAA0B,KAAK;AAAA,QAC/B,sBAAsB,KAAK;AAAA,QAC3B,mBAAmB,KAAK;AAAA,QACxB,uBAAuB,KAAK;AAAA,MAChC,CAAC;AAAA,IACL;AAAA,EACJ;AAAA,EAEA,IAAI,wBAAwB;AACxB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,+BAA+B;AAC/B,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,8BAA8B;AAC9B,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,WAAoB;AACpB,WAAO;AAAA,EACX;AAAA,EAEA,IAAI,SAAkB;AAClB,WAAO,KAAK,gBAAgB,oBAAO;AAAA,EACvC;AAAA,EAEA,IAAI,gBAAgB;AAChB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,YAAY;AACZ,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,MAAM,MAAM,4BAAsC;AAC9C,QAAI,+BAA+B,QAAW;AAC1C,mCAA6B,KAAK,aAAa;AAAA,IACnD;AACA,UAAM,KAAK,IAAI,MAAM,0BAA0B;AAAA,EACnD;AAAA,EAEA,OAAO,EAAE,QAAQ,oBAAoB,iBAAiB,GAAkB,KAAiC;AACrG,QAAI,OAAO,sBAAsB;AAC7B,aAAO;AAAA,QACH,kDAAkD,mBAAmB,qBAAM,MAAM,gBAAgB,IAAI,MAAS;AAAA,MAClH;AAAA,IACJ;AACA,UAAM,QAAQ,KAAK,cAAc,OAAO,eAAe,OAAO,WAAW,KAAK,WAAW;AACzF,UAAM,UAAU,iCAAa,cAAc;AAAA,MACvC;AAAA,MACA,oBAAoB,sBAAO,QAAQ,KAAK,aAAa,oBAAoB,OAAO,GAAG;AAAA,IACvF,CAAC;AAED,QAAI,QAAQ,cAAc,qBAAqB;AAC3C,aAAO;AAAA,QACH,kDAAkD,QAAQ,oBAAoB,qBAAM,MAAM,QAAQ,iBAAiB,IAAI,MAAS;AAAA,MACpI;AAAA,IACJ;AAEA,WAAO;AAAA,EACX;AAAA,EAEA,OAAO,SAA0B;AAC7B,YAAQ,aAAa,YAAY,KAAK;AACtC,UAAM,EAAE,QAAQ,mBAAmB,IAAI,iCAAa,cAAc,OAAO;AACzE,UAAM,cAAc,iCAAa,mBAAmB,QAAQ,YAAY;AACxE,UAAM,gBAAgB,YAAY,CAAC;AACnC,UAAM,gBAAgB,KAAK,SACrB,oBAAO,sBACN,KAAK,SAAS,UAAU,oBAAO;AACtC,UAAM,QAAQ,KAAK,cAAc,eAAe,OAAO,WAAW,aAAa;AAC/E,WAAO,EAAE,QAAQ,oBAAoB,sBAAO,QAAQ,KAAK,aAAa,oBAAoB,OAAO,WAAW,EAAE;AAAA,EAClH;AAAA,EAEA,IAAI,0BAAsC;AACtC,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,SAAS;AACT,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,oBAAoB,QAAgB;AAChC,QAAI,KAAK,YAAY,QAAW;AAC5B,YAAM,IAAI,+BAAgB,+DAA+D;AAAA,IAC7F;AACA,SAAK,UAAU;AAAA,EACnB;AAAA,EAEA,IAAI,KAAK;AACL,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,OAAO;AACP,WAAO,UAAU,KAAK,GAAG;AAAA,EAC7B;AAAA,EAEA,IAAI,gBAAwB;AACxB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,SAAS;AACT,WAAO,KAAK,SAAS,UAAU,oBAAO;AAAA,EAC1C;AAAA,EAEA,IAAI,aAAa;AACb,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,mBAA2B;AAC3B,QAAI,KAAK,YAAY,QAAW;AAC5B,YAAM,IAAI;AAAA,QACN,GAAG,KAAK,SAAS,UAAU,EAAE;AAAA,MACjC;AAAA,IACJ;AACA,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,MAAM,mBAAmB,qBAAqB,OAAO;AACjD,UAAM,gBAAgB,CAAC,GAAG,KAAK,cAAc;AAC7C,eAAW,gBAAgB,eAAe;AACtC,YAAM,aAAa,MAAM,kBAAkB;AAAA,IAC/C;AAAA,EACJ;AAAA;AAAA,EAGA,MAAM,IAAI,WAAoB,6BAA6B,OAAO;AAC9D,UAAM,KAAK,mBAAmB,IAAI;AAClC,UAAM,KAAK,QAAQ,WAAW,0BAA0B;AAAA,EAC5D;AAAA;AAAA,EAGA,MAAM,QAAQ,YAAY,OAAO,6BAA6B,MAAM;AAChE,UAAM,KAAK,mBAAmB,KAAK;AACnC,SAAK,SAAS,cAAc,IAAI;AAChC,QAAI,CAAC,WAAW;AACZ,WAAK,+BAA+B;AAAA,IACxC;AAEA,QAAI,4BAA4B;AAC5B,aAAO,KAAK,oBAAoB,KAAK,IAAI,mCAAmC;AAC5E,WAAK,gCAAgC;AAAA,IACzC,OAAO;AACH,WAAK,aAAa;AAClB,aAAO,KAAK,OAAO,KAAK,SAAS,SAAS,MAAM,YAAY,KAAK,IAAI,EAAE;AACvE,WAAK,SAAS,SAAS,OAAO,IAAI;AAGlC,UAAI,KAAK,QAAQ;AACb,cAAM,KAAK;AAAA,MACf;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,cAAc;AACd,eAAO,gCAAY;AAAA,MACf,aAAa,KAAK,SAAS,eAAe,yBAAY;AAAA,MACtD,QAAQ,KAAK;AAAA,IACjB,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,SAAsB;AACzB,YACK,KAAK,SAAS,eAAe,yBAAY,eAAe,QAAQ,eACjE,KAAK,gBAAgB,QAAQ;AAAA,EAErC;AAAA,EAEQ,cAAc,eAAuB,WAAmB,QAAgB;AAC5E,UAAM,SAAS,IAAI,0BAAW,sBAAO,MAAM;AAC3C,WAAO,WAAW,aAAa;AAC/B,WAAO,YAAY,SAAS;AAC5B,WAAO,YAAY,MAAM;AACzB,WAAO,OAAO,YAAY;AAAA,EAC9B;AACJ;AAEO,SAAS,oBAAoB,SAAmB,WAAsD;AACzG,MAAI,CAAC,SAAS,UAAU;AACpB,UAAM,IAAI,+BAAgB,aAAa,oCAAoC;AAAA,EAC/E;AACJ;",
+  "names": []
+}

package/dist/cjs/session/Session.d.ts

@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { NodeId } from "#types";
+import { DecodedMessage, DecodedPacket, Message, Packet } from "../codec/MessageCodec.js";
+import { Fabric } from "../fabric/Fabric.js";
+import { MessageCounter } from "../protocol/MessageCounter.js";
+import { MessageReceptionState } from "../protocol/MessageReceptionState.js";
+import { type SessionManager } from "./SessionManager.js";
+/**
+ * Minimum amount of time between sender retries when the destination node is Active. This SHALL be greater than or
+ * equal to the maximum amount of time a node may be non-responsive to incoming messages when Active.
+ */
+export declare const SESSION_ACTIVE_INTERVAL_MS = 300;
+/**
+ * Minimum amount of time between sender retries when the destination node is Idle. This SHALL be greater than or equal
+ * to the maximum amount of time a node may be non-responsive to incoming messages when Idle.
+ */
+export declare const SESSION_IDLE_INTERVAL_MS = 500;
+/** Minimum amount of time the node SHOULD stay active after network activity. */
+export declare const SESSION_ACTIVE_THRESHOLD_MS = 4000;
+/** Fallback value for Data Model Revision when not provided in Session parameters. We use Matter 1.2 as assumption. */
+export declare const FALLBACK_DATAMODEL_REVISION = 17;
+/** Fallback value for Interaction Model Revision when not provided in Session parameters. We use Matter 1.2 as assumption. */
+export declare const FALLBACK_INTERACTIONMODEL_REVISION = 11;
+/**
+ * Fallback value for Specification Version when not provided in Session parameters. We use 0 as assumption which is
+ * "before 1.3".
+ */
+export declare const FALLBACK_SPECIFICATION_VERSION = 0;
+/**
+ * Fallback value for the maximum number of paths that can be included in a single invoke message when not provided in
+ * Session parameters.
+ */
+export declare const FALLBACK_MAX_PATHS_PER_INVOKE = 1;
+export interface SessionParameters {
+    idleIntervalMs: number;
+    activeIntervalMs: number;
+    activeThresholdMs: number;
+    dataModelRevision: number;
+    interactionModelRevision: number;
+    specificationVersion: number;
+    maxPathsPerInvoke: number;
+}
+export type SessionParameterOptions = Partial<SessionParameters>;
+export declare abstract class Session {
+    #private;
+    abstract get name(): string;
+    abstract get closingAfterExchangeFinished(): boolean;
+    timestamp: number;
+    activeTimestamp: number;
+    protected readonly idleIntervalMs: number;
+    protected readonly activeIntervalMs: number;
+    protected readonly activeThresholdMs: number;
+    protected readonly dataModelRevision: number;
+    protected readonly interactionModelRevision: number;
+    protected readonly specificationVersion: number;
+    protected readonly maxPathsPerInvoke: number;
+    protected readonly messageCounter: MessageCounter;
+    protected readonly messageReceptionState: MessageReceptionState;
+    /**
+     * If the ExchangeManager performs async work to clean up a session it sets this promise.  This is because
+     * historically we didn't return from destroy() until ExchangeManager was complete.  Not sure if this is entirely
+     * necessary but it makes sense so this allows us to maintain the old behavior.
+     */
+    closer?: Promise<void>;
+    constructor(args: {
+        manager?: SessionManager;
+        messageCounter: MessageCounter;
+        messageReceptionState: MessageReceptionState;
+        sessionParameters?: SessionParameterOptions;
+        setActiveTimestamp: boolean;
+    });
+    notifyActivity(messageReceived: boolean): void;
+    isPeerActive(): boolean;
+    getIncrementedMessageCounter(): Promise<number>;
+    updateMessageCounter(messageCounter: number, _sourceNodeId?: NodeId): void;
+    /**
+     * The peer's session parameters.
+     */
+    get parameters(): SessionParameters;
+    abstract isSecure: boolean;
+    abstract isPase: boolean;
+    abstract id: number;
+    abstract peerSessionId: number;
+    abstract nodeId: NodeId | undefined;
+    abstract peerNodeId: NodeId | undefined;
+    abstract associatedFabric: Fabric;
+    abstract supportsMRP: boolean;
+    abstract decode(packet: DecodedPacket, aad?: Uint8Array): DecodedMessage;
+    abstract encode(message: Message): Packet;
+    abstract end(sendClose: boolean): Promise<void>;
+    abstract destroy(sendClose?: boolean, closeAfterExchangeFinished?: boolean): Promise<void>;
+    protected get manager(): SessionManager | undefined;
+    /**
+     * @deprecated
+     */
+    get owner(): unknown;
+}
+//# sourceMappingURL=Session.d.ts.map

package/dist/cjs/session/Session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../../src/session/Session.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAEhD,uHAAuH;AACvH,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C,8HAA8H;AAC9H,eAAO,MAAM,kCAAkC,KAAK,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,8BAA8B,IAAI,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,6BAA6B,IAAI,CAAC;AAE/C,MAAM,WAAW,iBAAiB;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wBAAwB,EAAE,MAAM,CAAC;IACjC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEjE,8BAAsB,OAAO;;IACzB,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC;IAC5B,QAAQ,KAAK,4BAA4B,IAAI,OAAO,CAAC;IAErD,SAAS,SAAgB;IACzB,eAAe,SAAK;IACpB,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAC1C,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC5C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAC;IACpD,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAChD,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAClD,SAAS,CAAC,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;IAEhE;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBAEX,IAAI,EAAE;QACd,OAAO,CAAC,EAAE,cAAc,CAAC;QACzB,cAAc,EAAE,cAAc,CAAC;QAC/B,qBAAqB,EAAE,qBAAqB,CAAC;QAC7C,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;QAC5C,kBAAkB,EAAE,OAAO,CAAC;KAC/B;IA+BD,cAAc,CAAC,eAAe,EAAE,OAAO;IAQvC,YAAY,IAAI,OAAO;IAIvB,4BAA4B;IAI5B,oBAAoB,CAAC,cAAc,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM;IAInE;;OAEG;IACH,IAAI,UAAU,IAAI,iBAAiB,CAmBlC;IAED,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,CAAC,EAAE,UAAU,GAAG,cAAc;IACxE,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IACzC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAC/C,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,0BAA0B,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1F,SAAS,KAAK,OAAO,+BAEpB;IAED;;OAEG;IACH,IAAI,KAAK,YAER;CACJ"}

package/dist/cjs/session/Session.js

@@ -0,0 +1,141 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var Session_exports = {};
+__export(Session_exports, {
+  FALLBACK_DATAMODEL_REVISION: () => FALLBACK_DATAMODEL_REVISION,
+  FALLBACK_INTERACTIONMODEL_REVISION: () => FALLBACK_INTERACTIONMODEL_REVISION,
+  FALLBACK_MAX_PATHS_PER_INVOKE: () => FALLBACK_MAX_PATHS_PER_INVOKE,
+  FALLBACK_SPECIFICATION_VERSION: () => FALLBACK_SPECIFICATION_VERSION,
+  SESSION_ACTIVE_INTERVAL_MS: () => SESSION_ACTIVE_INTERVAL_MS,
+  SESSION_ACTIVE_THRESHOLD_MS: () => SESSION_ACTIVE_THRESHOLD_MS,
+  SESSION_IDLE_INTERVAL_MS: () => SESSION_IDLE_INTERVAL_MS,
+  Session: () => Session
+});
+module.exports = __toCommonJS(Session_exports);
+var import_general = require("#general");
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const SESSION_ACTIVE_INTERVAL_MS = 300;
+const SESSION_IDLE_INTERVAL_MS = 500;
+const SESSION_ACTIVE_THRESHOLD_MS = 4e3;
+const FALLBACK_DATAMODEL_REVISION = 17;
+const FALLBACK_INTERACTIONMODEL_REVISION = 11;
+const FALLBACK_SPECIFICATION_VERSION = 0;
+const FALLBACK_MAX_PATHS_PER_INVOKE = 1;
+class Session {
+  #manager;
+  timestamp = import_general.Time.nowMs();
+  activeTimestamp = 0;
+  idleIntervalMs;
+  activeIntervalMs;
+  activeThresholdMs;
+  dataModelRevision;
+  interactionModelRevision;
+  specificationVersion;
+  maxPathsPerInvoke;
+  messageCounter;
+  messageReceptionState;
+  /**
+   * If the ExchangeManager performs async work to clean up a session it sets this promise.  This is because
+   * historically we didn't return from destroy() until ExchangeManager was complete.  Not sure if this is entirely
+   * necessary but it makes sense so this allows us to maintain the old behavior.
+   */
+  closer;
+  constructor(args) {
+    const {
+      manager,
+      messageCounter,
+      messageReceptionState,
+      sessionParameters: {
+        idleIntervalMs = SESSION_IDLE_INTERVAL_MS,
+        activeIntervalMs = SESSION_ACTIVE_INTERVAL_MS,
+        activeThresholdMs = SESSION_ACTIVE_THRESHOLD_MS,
+        dataModelRevision = FALLBACK_DATAMODEL_REVISION,
+        interactionModelRevision = FALLBACK_INTERACTIONMODEL_REVISION,
+        specificationVersion = FALLBACK_SPECIFICATION_VERSION,
+        maxPathsPerInvoke = FALLBACK_MAX_PATHS_PER_INVOKE
+      } = {},
+      setActiveTimestamp
+    } = args;
+    this.#manager = manager;
+    this.messageCounter = messageCounter;
+    this.messageReceptionState = messageReceptionState;
+    this.idleIntervalMs = idleIntervalMs;
+    this.activeIntervalMs = activeIntervalMs;
+    this.activeThresholdMs = activeThresholdMs;
+    this.dataModelRevision = dataModelRevision;
+    this.interactionModelRevision = interactionModelRevision;
+    this.specificationVersion = specificationVersion;
+    this.maxPathsPerInvoke = maxPathsPerInvoke;
+    if (setActiveTimestamp) {
+      this.activeTimestamp = this.timestamp;
+    }
+  }
+  notifyActivity(messageReceived) {
+    this.timestamp = import_general.Time.nowMs();
+    if (messageReceived) {
+      this.activeTimestamp = this.timestamp;
+    }
+  }
+  isPeerActive() {
+    return import_general.Time.nowMs() - this.activeTimestamp < this.activeThresholdMs;
+  }
+  getIncrementedMessageCounter() {
+    return this.messageCounter.getIncrementedCounter();
+  }
+  updateMessageCounter(messageCounter, _sourceNodeId) {
+    this.messageReceptionState.updateMessageCounter(messageCounter);
+  }
+  /**
+   * The peer's session parameters.
+   */
+  get parameters() {
+    const {
+      idleIntervalMs,
+      activeIntervalMs,
+      activeThresholdMs,
+      dataModelRevision,
+      interactionModelRevision,
+      specificationVersion,
+      maxPathsPerInvoke
+    } = this;
+    return {
+      idleIntervalMs,
+      activeIntervalMs,
+      activeThresholdMs,
+      dataModelRevision,
+      interactionModelRevision,
+      specificationVersion,
+      maxPathsPerInvoke
+    };
+  }
+  get manager() {
+    return this.#manager;
+  }
+  /**
+   * @deprecated
+   */
+  get owner() {
+    return this.#manager?.owner;
+  }
+}
+//# sourceMappingURL=Session.js.map

package/dist/cjs/session/Session.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/session/Session.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAAqB;AANrB;AAAA;AAAA;AAAA;AAAA;AAkBO,MAAM,6BAA6B;AAMnC,MAAM,2BAA2B;AAGjC,MAAM,8BAA8B;AAGpC,MAAM,8BAA8B;AAGpC,MAAM,qCAAqC;AAM3C,MAAM,iCAAiC;AAMvC,MAAM,gCAAgC;AActC,MAAe,QAAQ;AAAA,EAG1B;AAAA,EACA,YAAY,oBAAK,MAAM;AAAA,EACvB,kBAAkB;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnB;AAAA,EAEA,YAAY,MAMT;AACC,UAAM;AAAA,MACF;AAAA,MACA;AAAA,MACA;AAAA,MACA,mBAAmB;AAAA,QACf,iBAAiB;AAAA,QACjB,mBAAmB;AAAA,QACnB,oBAAoB;AAAA,QACpB,oBAAoB;AAAA,QACpB,2BAA2B;AAAA,QAC3B,uBAAuB;AAAA,QACvB,oBAAoB;AAAA,MACxB,IAAI,CAAC;AAAA,MACL;AAAA,IACJ,IAAI;AACJ,SAAK,WAAW;AAChB,SAAK,iBAAiB;AACtB,SAAK,wBAAwB;AAC7B,SAAK,iBAAiB;AACtB,SAAK,mBAAmB;AACxB,SAAK,oBAAoB;AACzB,SAAK,oBAAoB;AACzB,SAAK,2BAA2B;AAChC,SAAK,uBAAuB;AAC5B,SAAK,oBAAoB;AACzB,QAAI,oBAAoB;AACpB,WAAK,kBAAkB,KAAK;AAAA,IAChC;AAAA,EACJ;AAAA,EAEA,eAAe,iBAA0B;AACrC,SAAK,YAAY,oBAAK,MAAM;AAC5B,QAAI,iBAAiB;AAEjB,WAAK,kBAAkB,KAAK;AAAA,IAChC;AAAA,EACJ;AAAA,EAEA,eAAwB;AACpB,WAAO,oBAAK,MAAM,IAAI,KAAK,kBAAkB,KAAK;AAAA,EACtD;AAAA,EAEA,+BAA+B;AAC3B,WAAO,KAAK,eAAe,sBAAsB;AAAA,EACrD;AAAA,EAEA,qBAAqB,gBAAwB,eAAwB;AACjE,SAAK,sBAAsB,qBAAqB,cAAc;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,aAAgC;AAChC,UAAM;AAAA,MACF;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ,IAAI;AACJ,WAAO;AAAA,MACH;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA,EAgBA,IAAc,UAAU;AACpB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,QAAQ;AACR,WAAO,KAAK,UAAU;AAAA,EAC1B;AACJ;",
+  "names": []
+}