src.nth.io/

summaryrefslogtreecommitdiff
path: root/src/fabrics.ts
blob: 48687af2ffff53b7679ab2d8e5ad4c70b3ca4a69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
import { OperationalCredentials } from "@matter/main/clusters/operational-credentials";
import type { CommissioningController } from "@project-chip/matter.js";
import type { PairedNode } from "@project-chip/matter.js/device";

/**
 * Read-only view of the device's Operational Credentials fabric table.
 *
 * Every commissioning writes a fabric entry into the device's limited fabric
 * table. Entries never expire; identities whose local storage was deleted
 * leave orphans behind. These helpers make the table visible and flag likely
 * orphans. Removal is deliberately not offered: this controller does not use
 * its admin rights against other fabrics' entries. Clean stale entries up
 * from the device's primary ecosystem (e.g. Apple Home) or by factory reset;
 * our own live entry is removed with "decommission".
 */

export interface FabricEntry {
  fabricIndex: number;
  fabricId: bigint;
  nodeId: bigint;
  vendorId: number;
  label: string;
  /** True when the entry belongs to this controller's current identity. */
  isOurs: boolean;
}

export interface FabricTable {
  supportedFabrics: number;
  commissionedFabrics: number;
  entries: FabricEntry[];
}

const KNOWN_VENDORS: Record<number, string> = {
  0x1349: "Apple",
  0x6006: "Google",
  0x10e1: "SmartThings",
  0x117c: "IKEA",
};

function vendorName(vendorId: number): string {
  const known = KNOWN_VENDORS[vendorId];
  if (known !== undefined) return known;
  if (vendorId >= 0xfff1 && vendorId <= 0xfff4) return "test vendor";
  return "unknown vendor";
}

export async function readFabricTable(
  controller: CommissioningController,
  node: PairedNode,
): Promise<FabricTable> {
  const client = node.getRootClusterClient(OperationalCredentials.Complete);
  if (client === undefined) {
    throw new Error("Operational Credentials cluster not found on the device's root endpoint");
  }

  // Read from the device with fabric filtering off, so entries from all
  // fabrics are returned, not just our own.
  const fabrics = await client.attributes.fabrics.get(true, false);
  const supportedFabrics = (await client.attributes.supportedFabrics.get(true)) ?? 0;
  const commissionedFabrics = (await client.attributes.commissionedFabrics.get(true)) ?? 0;
  if (fabrics === undefined) {
    throw new Error("Device returned no fabric list");
  }

  const ourFabric = controller.fabric;
  const entries = fabrics.map(fabric => ({
    fabricIndex: Number(fabric.fabricIndex),
    fabricId: BigInt(fabric.fabricId),
    nodeId: BigInt(fabric.nodeId),
    vendorId: Number(fabric.vendorId),
    label: fabric.label,
    isOurs: ourFabric.matchesFabricIdAndRootPublicKey(fabric.fabricId, fabric.rootPublicKey),
  }));

  return { supportedFabrics, commissionedFabrics, entries };
}

export function formatFabricTable(nodeId: bigint, table: FabricTable): string {
  const lines: string[] = [];
  lines.push(
    `Fabric table on node ${nodeId} (${table.commissionedFabrics} of ${table.supportedFabrics} slots used):`,
  );
  for (const entry of table.entries) {
    const vendor = `0x${entry.vendorId.toString(16).padStart(4, "0")} (${vendorName(entry.vendorId)})`;
    const marker = entry.isOurs ? "  [this controller]" : "";
    lines.push(
      `  index ${entry.fabricIndex}: label ${JSON.stringify(entry.label)}  vendor ${vendor}  ` +
        `fabricId ${entry.fabricId}  nodeId ${entry.nodeId}${marker}`,
    );
  }
  const strays = findLikelyStrays(table);
  if (strays.length > 0) {
    lines.push("");
    lines.push(
      `Likely stale entries (our label, but not our current identity): ` +
        `${strays.map(entry => `index ${entry.fabricIndex}`).join(", ")}`,
    );
    lines.push(`Remove them from the device's primary ecosystem (e.g. Apple Home: device settings,`);
    lines.push(`Connected Services) or by factory-resetting and re-pairing the device.`);
  }
  return lines.join("\n");
}

/**
 * Entries carrying our fabric label but not our current identity: orphans
 * from a commissioning whose local storage was deleted or replaced.
 */
export function findLikelyStrays(table: FabricTable): FabricEntry[] {
  const ourLabel = table.entries.find(entry => entry.isOurs)?.label;
  return table.entries.filter(entry => !entry.isOurs && ourLabel !== undefined && entry.label === ourLabel);
}