@zwave-js/cc 9.3.1-0-pr-4662-79458fb

package/build/cc/Security2CC.d.ts

@@ -0,0 +1,213 @@
+/// <reference types="node" />
+import { CommandClasses, Maybe, MessageOrCCLogEntry, SecurityClass, SecurityManager2 } from "@zwave-js/core";
+import type { ZWaveApplicationHost, ZWaveHost } from "@zwave-js/host/safe";
+import { CCAPI } from "../lib/API";
+import { CommandClass, type CCCommandOptions, type CommandClassDeserializationOptions } from "../lib/CommandClass";
+import { Security2Extension } from "../lib/Security2/Extension";
+import { ECDHProfiles, KEXFailType, KEXSchemes } from "../lib/Security2/shared";
+import { Security2Command } from "../lib/_Types";
+export declare class Security2CCAPI extends CCAPI {
+    supportsCommand(_cmd: Security2Command): Maybe<boolean>;
+    /**
+     * Sends a nonce to the node, either in response to a NonceGet request or a message that failed to decrypt. The message is sent without any retransmission etc.
+     * The return value indicates whether a nonce was successfully sent
+     */
+    sendNonce(): Promise<boolean>;
+    /**
+     * Queries the securely supported commands for the current security class
+     * @param securityClass Can be used to overwrite the security class to use. If this doesn't match the current one, new nonces will need to be exchanged.
+     */
+    getSupportedCommands(securityClass: SecurityClass.S2_AccessControl | SecurityClass.S2_Authenticated | SecurityClass.S2_Unauthenticated): Promise<CommandClasses[] | undefined>;
+    getKeyExchangeParameters(): Promise<Pick<Security2CCKEXReport, "requestCSA" | "echo" | "supportedKEXSchemes" | "supportedECDHProfiles" | "requestedKeys"> | undefined>;
+    /** Grants the joining node the given keys */
+    grantKeys(params: Omit<Security2CCKEXSetOptions, "echo">): Promise<void>;
+    /** Confirms the keys that were granted to a node */
+    confirmGrantedKeys(params: Omit<Security2CCKEXReportOptions, "echo">): Promise<void>;
+    /** Notifies the other node that the ongoing key exchange was aborted */
+    abortKeyExchange(failType: KEXFailType): Promise<void>;
+    sendPublicKey(publicKey: Buffer): Promise<void>;
+    sendNetworkKey(securityClass: SecurityClass, networkKey: Buffer): Promise<void>;
+    confirmKeyVerification(): Promise<void>;
+}
+export declare class Security2CC extends CommandClass {
+    ccCommand: Security2Command;
+    interview(applHost: ZWaveApplicationHost): Promise<void>;
+    /** Tests if a command should be sent secure and thus requires encapsulation */
+    static requiresEncapsulation(cc: CommandClass): boolean;
+    /** Encapsulates a command that should be sent encrypted */
+    static encapsulate(host: ZWaveHost, cc: CommandClass, securityClass?: SecurityClass): Security2CCMessageEncapsulation;
+}
+interface Security2CCMessageEncapsulationOptions extends CCCommandOptions {
+    /** Can be used to override the default security class for the command */
+    securityClass?: SecurityClass;
+    extensions?: Security2Extension[];
+    encapsulated: CommandClass;
+}
+export declare class Security2CCMessageEncapsulation extends Security2CC {
+    host: ZWaveHost & {
+        securityManager2: SecurityManager2;
+    };
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | Security2CCMessageEncapsulationOptions);
+    private _securityClass?;
+    readonly decryptionKey?: Buffer;
+    private _sequenceNumber;
+    /**
+     * Return the sequence number of this command.
+     *
+     * **WARNING:** If the sequence number hasn't been set before, this will create a new one.
+     * When sending messages, this should only happen immediately before serializing.
+     */
+    get sequenceNumber(): number;
+    encapsulated?: CommandClass;
+    extensions: Security2Extension[];
+    unsetSequenceNumber(): void;
+    private getDestinationIDTX;
+    private getDestinationIDRX;
+    /** Returns the Sender's Entropy Input if this command contains an SPAN extension */
+    private getSenderEI;
+    serialize(): Buffer;
+    protected computeEncapsulationOverhead(): number;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+export declare type Security2CCNonceReportOptions = {
+    MOS: boolean;
+    SOS: true;
+    receiverEI: Buffer;
+} | {
+    MOS: true;
+    SOS: false;
+    receiverEI?: undefined;
+};
+export declare class Security2CCNonceReport extends Security2CC {
+    host: ZWaveHost & {
+        securityManager2: SecurityManager2;
+    };
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | (CCCommandOptions & Security2CCNonceReportOptions));
+    private _sequenceNumber;
+    /**
+     * Return the sequence number of this command.
+     *
+     * **WARNING:** If the sequence number hasn't been set before, this will create a new one.
+     * When sending messages, this should only happen immediately before serializing.
+     */
+    get sequenceNumber(): number;
+    readonly SOS: boolean;
+    readonly MOS: boolean;
+    readonly receiverEI?: Buffer;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+export declare class Security2CCNonceGet extends Security2CC {
+    host: ZWaveHost & {
+        securityManager2: SecurityManager2;
+    };
+    constructor(host: ZWaveHost, options: CCCommandOptions);
+    private _sequenceNumber;
+    /**
+     * Return the sequence number of this command.
+     *
+     * **WARNING:** If the sequence number hasn't been set before, this will create a new one.
+     * When sending messages, this should only happen immediately before serializing.
+     */
+    get sequenceNumber(): number;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+interface Security2CCKEXReportOptions {
+    requestCSA: boolean;
+    echo: boolean;
+    supportedKEXSchemes: KEXSchemes[];
+    supportedECDHProfiles: ECDHProfiles[];
+    requestedKeys: SecurityClass[];
+}
+export declare class Security2CCKEXReport extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | (CCCommandOptions & Security2CCKEXReportOptions));
+    readonly requestCSA: boolean;
+    readonly echo: boolean;
+    readonly supportedKEXSchemes: readonly KEXSchemes[];
+    readonly supportedECDHProfiles: readonly ECDHProfiles[];
+    readonly requestedKeys: readonly SecurityClass[];
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+export declare class Security2CCKEXGet extends Security2CC {
+}
+interface Security2CCKEXSetOptions {
+    permitCSA: boolean;
+    echo: boolean;
+    selectedKEXScheme: KEXSchemes;
+    selectedECDHProfile: ECDHProfiles;
+    grantedKeys: SecurityClass[];
+}
+export declare class Security2CCKEXSet extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | (CCCommandOptions & Security2CCKEXSetOptions));
+    permitCSA: boolean;
+    echo: boolean;
+    selectedKEXScheme: KEXSchemes;
+    selectedECDHProfile: ECDHProfiles;
+    grantedKeys: SecurityClass[];
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+interface Security2CCKEXFailOptions extends CCCommandOptions {
+    failType: KEXFailType;
+}
+export declare class Security2CCKEXFail extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | Security2CCKEXFailOptions);
+    failType: KEXFailType;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+interface Security2CCPublicKeyReportOptions extends CCCommandOptions {
+    includingNode: boolean;
+    publicKey: Buffer;
+}
+export declare class Security2CCPublicKeyReport extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | Security2CCPublicKeyReportOptions);
+    includingNode: boolean;
+    publicKey: Buffer;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+interface Security2CCNetworkKeyReportOptions extends CCCommandOptions {
+    grantedKey: SecurityClass;
+    networkKey: Buffer;
+}
+export declare class Security2CCNetworkKeyReport extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | Security2CCNetworkKeyReportOptions);
+    grantedKey: SecurityClass;
+    networkKey: Buffer;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+interface Security2CCNetworkKeyGetOptions extends CCCommandOptions {
+    requestedKey: SecurityClass;
+}
+export declare class Security2CCNetworkKeyGet extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | Security2CCNetworkKeyGetOptions);
+    requestedKey: SecurityClass;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+export declare class Security2CCNetworkKeyVerify extends Security2CC {
+}
+interface Security2CCTransferEndOptions extends CCCommandOptions {
+    keyVerified: boolean;
+    keyRequestComplete: boolean;
+}
+export declare class Security2CCTransferEnd extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions | Security2CCTransferEndOptions);
+    keyVerified: boolean;
+    keyRequestComplete: boolean;
+    serialize(): Buffer;
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+export declare class Security2CCCommandsSupportedReport extends Security2CC {
+    constructor(host: ZWaveHost, options: CommandClassDeserializationOptions);
+    readonly supportedCCs: CommandClasses[];
+    toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry;
+}
+export declare class Security2CCCommandsSupportedGet extends Security2CC {
+}
+export {};
+//# sourceMappingURL=Security2CC.d.ts.map

package/build/cc/Security2CC.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Security2CC.d.ts","sourceRoot":"","sources":["../../src/cc/Security2CC.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,cAAc,EAOd,KAAK,EACL,mBAAmB,EAMnB,aAAa,EAGb,gBAAgB,EAOhB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAG3E,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAGN,YAAY,EAIZ,KAAK,gBAAgB,EACrB,KAAK,kCAAkC,EAEvC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEN,kBAAkB,EAElB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAqEjD,qBACa,cAAe,SAAQ,KAAK;IACjC,eAAe,CAAC,IAAI,EAAE,gBAAgB,GAAG,KAAK,CAAC,OAAO,CAAC;IAK9D;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAwD1C;;;OAGG;IACU,oBAAoB,CAChC,aAAa,EACV,aAAa,CAAC,gBAAgB,GAC9B,aAAa,CAAC,gBAAgB,GAC9B,aAAa,CAAC,kBAAkB,GACjC,OAAO,CAAC,cAAc,EAAE,GAAG,SAAS,CAAC;IAiC3B,wBAAwB;IAsBrC,6CAA6C;IAChC,SAAS,CACrB,MAAM,EAAE,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,GAC5C,OAAO,CAAC,IAAI,CAAC;IAYhB,oDAAoD;IACvC,kBAAkB,CAC9B,MAAM,EAAE,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC;IAehB,wEAAwE;IAC3D,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/C,cAAc,CAC1B,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAeH,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAkBpD;AAED,qBAEa,WAAY,SAAQ,YAAY;IACpC,SAAS,EAAE,gBAAgB,CAAC;IAEvB,SAAS,CAAC,QAAQ,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsJrE,+EAA+E;WACjE,qBAAqB,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO;IAkC9D,2DAA2D;WAC7C,WAAW,CACxB,IAAI,EAAE,SAAS,EACf,EAAE,EAAE,YAAY,EAChB,aAAa,CAAC,EAAE,aAAa,GAC3B,+BAA+B;CAOlC;AAED,UAAU,sCAAuC,SAAQ,gBAAgB;IACxE,yEAAyE;IACzE,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAClC,YAAY,EAAE,YAAY,CAAC;CAC3B;AAyBD,qBAKa,+BAAgC,SAAQ,WAAW;IAGvD,IAAI,EAAE,SAAS,GAAG;QACzB,gBAAgB,EAAE,gBAAgB,CAAC;KACnC,CAAC;gBAGD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,sCAAsC;IA8O1C,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvC,OAAO,CAAC,eAAe,CAAqB;IAC5C;;;;;OAKG;IACH,IAAW,cAAc,IAAI,MAAM,CAQlC;IAEM,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,EAAE,kBAAkB,EAAE,CAAC;IAEjC,mBAAmB,IAAI,IAAI;IAIlC,OAAO,CAAC,kBAAkB;IAa1B,OAAO,CAAC,kBAAkB;IAQ1B,oFAAoF;IACpF,OAAO,CAAC,WAAW;IAOZ,SAAS,IAAI,MAAM;IA0H1B,SAAS,CAAC,4BAA4B,IAAI,MAAM;IAkBzC,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CActE;AAED,oBAAY,6BAA6B,GACtC;IACA,GAAG,EAAE,OAAO,CAAC;IACb,GAAG,EAAE,IAAI,CAAC;IACV,UAAU,EAAE,MAAM,CAAC;CAClB,GACD;IACA,GAAG,EAAE,IAAI,CAAC;IACV,GAAG,EAAE,KAAK,CAAC;IACX,UAAU,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEL,qBACa,sBAAuB,SAAQ,WAAW;IAG9C,IAAI,EAAE,SAAS,GAAG;QACzB,gBAAgB,EAAE,gBAAgB,CAAC;KACnC,CAAC;gBAGD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,CAAC,gBAAgB,GAAG,6BAA6B,CAAC;IAoCtD,OAAO,CAAC,eAAe,CAAqB;IAC5C;;;;;OAKG;IACH,IAAW,cAAc,IAAI,MAAM,CAQlC;IAED,SAAgB,GAAG,EAAE,OAAO,CAAC;IAC7B,SAAgB,GAAG,EAAE,OAAO,CAAC;IAC7B,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B,SAAS,IAAI,MAAM;IAWnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CActE;AAED,qBAEa,mBAAoB,SAAQ,WAAW;IAM3C,IAAI,EAAE,SAAS,GAAG;QACzB,gBAAgB,EAAE,gBAAgB,CAAC;KACnC,CAAC;gBAEiB,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB;IAgB7D,OAAO,CAAC,eAAe,CAAqB;IAC5C;;;;;OAKG;IACH,IAAW,cAAc,IAAI,MAAM,CAQlC;IAEM,SAAS,IAAI,MAAM;IAKnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAMtE;AAED,UAAU,2BAA2B;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,mBAAmB,EAAE,UAAU,EAAE,CAAC;IAClC,qBAAqB,EAAE,YAAY,EAAE,CAAC;IACtC,aAAa,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED,qBACa,oBAAqB,SAAQ,WAAW;gBAEnD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,CAAC,gBAAgB,GAAG,2BAA2B,CAAC;IA6BpD,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,SAAgB,mBAAmB,EAAE,SAAS,UAAU,EAAE,CAAC;IAC3D,SAAgB,qBAAqB,EAAE,SAAS,YAAY,EAAE,CAAC;IAC/D,SAAgB,aAAa,EAAE,SAAS,aAAa,EAAE,CAAC;IAEjD,SAAS,IAAI,MAAM;IAmBnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAkBtE;AAED,qBAEa,iBAAkB,SAAQ,WAAW;CAAG;AAErD,UAAU,wBAAwB;IACjC,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,OAAO,CAAC;IACd,iBAAiB,EAAE,UAAU,CAAC;IAC9B,mBAAmB,EAAE,YAAY,CAAC;IAClC,WAAW,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,qBACa,iBAAkB,SAAQ,WAAW;gBAEhD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,CAAC,gBAAgB,GAAG,wBAAwB,CAAC;IAmC1C,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,OAAO,CAAC;IACd,iBAAiB,EAAE,UAAU,CAAC;IAC9B,mBAAmB,EAAE,YAAY,CAAC;IAClC,WAAW,EAAE,aAAa,EAAE,CAAC;IAE7B,SAAS,IAAI,MAAM;IAmBnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAoBtE;AAED,UAAU,yBAA0B,SAAQ,gBAAgB;IAC3D,QAAQ,EAAE,WAAW,CAAC;CACtB;AAED,qBACa,kBAAmB,SAAQ,WAAW;gBAEjD,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,kCAAkC,GAAG,yBAAyB;IAWjE,QAAQ,EAAE,WAAW,CAAC;IAEtB,SAAS,IAAI,MAAM;IAKnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAMtE;AAED,UAAU,iCAAkC,SAAQ,gBAAgB;IACnE,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,qBACa,0BAA2B,SAAQ,WAAW;gBAEzD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,iCAAiC;IAa9B,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,IAAI,MAAM;IAQnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAStE;AAED,UAAU,kCAAmC,SAAQ,gBAAgB;IACpE,UAAU,EAAE,aAAa,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,qBACa,2BAA4B,SAAQ,WAAW;gBAE1D,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,kCAAkC;IAe/B,UAAU,EAAE,aAAa,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,IAAI,MAAM;IAQnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAatE;AAED,UAAU,+BAAgC,SAAQ,gBAAgB;IACjE,YAAY,EAAE,aAAa,CAAC;CAC5B;AAED,qBAEa,wBAAyB,SAAQ,WAAW;gBAEvD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,+BAA+B;IAW5B,YAAY,EAAE,aAAa,CAAC;IAE5B,SAAS,IAAI,MAAM;IAKnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAWtE;AAED,qBACa,2BAA4B,SAAQ,WAAW;CAAG;AAE/D,UAAU,6BAA8B,SAAQ,gBAAgB;IAC/D,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;CAC5B;AAED,qBACa,sBAAuB,SAAQ,WAAW;gBAErD,IAAI,EAAE,SAAS,EACf,OAAO,EACJ,kCAAkC,GAClC,6BAA6B;IAa1B,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAE5B,SAAS,IAAI,MAAM;IAOnB,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAStE;AAED,qBACa,kCAAmC,SAAQ,WAAW;gBAEjE,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,kCAAkC;IAY5C,SAAgB,YAAY,EAAE,cAAc,EAAE,CAAC;IAExC,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,mBAAmB;CAWtE;AAED,qBAEa,+BAAgC,SAAQ,WAAW;CAAG"}