Class SSHPrivateKey

Readonlydata

Readonlycomment

Readonlycheckint

algorithm

• get algorithm(): SshAlgorithm

  Algorithm tag for this key.

  Returns SshAlgorithm

publicBytes

• get publicBytes(): Uint8Array

  Returns Uint8Array

privateBytes

• get privateBytes(): Uint8Array

  Returns Uint8Array

StaticfromParts

• fromParts(
      data: SshPrivateKeyData,
      comment: string,
      checkint: number,
  ): SSHPrivateKey

  Construct an SSHPrivateKey from already-decoded parts. Used by PrivateKeyBase.sshSigningPrivateKey after generating key material from an HKDF-seeded RNG. The checkint should be derived deterministically from the private bytes (mirrors ssh-key 0.6.7's KeypairData::checkint).

  Parameters

  • data: SshPrivateKeyData
  • comment: string
  • checkint: number

  Returns SSHPrivateKey

StaticfromOpenssh

• fromOpenssh(text: string): SSHPrivateKey

  Parses the PEM-armoured OpenSSH private key text, as ssh_key::PrivateKey::from_openssh.

  Parameters

  • text: string

  Returns SSHPrivateKey

StaticfromBlob

• fromBlob(blob: Uint8Array): SSHPrivateKey

  Parses the binary openssh-key-v1 blob (the base64 payload of the text form).

  Parameters

  • blob: Uint8Array

  Returns SSHPrivateKey

toOpenssh

• toOpenssh(): string

  Re-serialize to the canonical OpenSSH armored format.

  Returns string

toBlob

• toBlob(): Uint8Array

  The binary openssh-key-v1 blob, byte for byte as OpenSSH writes it.

  Returns Uint8Array

publicKey

• publicKey(): SSHPublicKey

  The matching public key, with the same comment.

  Returns SSHPublicKey

digest

• digest(): Uint8Array

  SHA-256 of the OpenSSH text form (the reference's Reference image).

  Returns Uint8Array

refHexShort

• refHexShort(): string

  The first four bytes of digest() in hex, the reference's ref_hex_short.

  Returns string

toString

• toString(): string

  SSHPrivateKey(<short reference>), the reference's Display.

  Returns string

sign

• sign(
      namespace: string,
      hashAlgorithm: SshHashAlgorithm,
      message: Uint8Array,
  ): SSHSignature

  Signs message in namespace with hashAlgorithm, producing an sshsig signature.

  RSA keys cannot sign: ssh-key 0.6.7 rebuilds the rsa private key from (p, p) instead of (p, q), so the reference's SigningPrivateKey::sign fails with cryptographic error for every RSA key, and so does this method.

  Parameters

  • namespace: string
  • hashAlgorithm: SshHashAlgorithm
  • message: Uint8Array

  Returns SSHSignature