Class DpopKey

constructor

• new DpopKey(key: KeyObject): DpopKey

  Wraps a private key; prefer DpopKey.generate, DpopKey.load or loadDpopKey.

  Parameters

  • key: KeyObject

    A P-256 or Ed25519 private key.

  Returns DpopKey

  Throws

  TypeError for another key type or a public key.

Readonlyalg

Readonlyjkt

ReadonlypublicJwk

sign

• sign(data: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>

  Returns the JWS signature of data: 64-byte R || S for ES256, raw Ed25519 for EdDSA.

  Parameters

  • data: Uint8Array

    The JWS signing input.

  Returns Promise<Uint8Array<ArrayBufferLike>>

  The signature.

toJSON

• toJSON(): Record<string, string>

  Returns alg and jkt only, so a key never lands in JSON output.

  Returns Record<string, string>

toString

• toString(): string

  Returns DpopKey(<alg>, jkt=<thumbprint>), never the key.

  Returns string

Staticgenerate

• generate(options?: { alg?: DpopAlgorithm; path?: string }): Promise<DpopKey>

  Creates a new key; with path it is written there as a PKCS#8 PEM of mode 0600.

  Parameters

  • options: { alg?: DpopAlgorithm; path?: string } = {}

    path of a new file (must not exist; opened with O_EXCL) and alg (default ES256).

  Returns Promise<DpopKey>

  The key.

  Throws

  The EEXIST error of open when the file exists.

Staticload

• load(path: string): Promise<DpopKey>

  Loads a key that DpopKey.generate wrote (or any file loadDpopKey reads).

  Parameters

  • path: string

    The key file.

  Returns Promise<DpopKey>

  The key.

  Throws

  When the file is accessible by group or others, or holds no usable private key.