Class SSHPublicKey

Readonlydata

Readonlycomment

algorithm

• get algorithm(): SshAlgorithm

  Algorithm tag for this key.

  Returns SshAlgorithm

keyBytes

• get keyBytes(): Uint8Array

  Algorithm-specific raw payload bytes. Throws for DSA and RSA, whose keys are several integers — use data.p/q/g/y or data.e/n instead.

  Returns Uint8Array

Staticed25519

• ed25519(keyBytes: Uint8Array, comment?: string): SSHPublicKey

  An Ed25519 key from its 32 raw bytes.

  Parameters

  • keyBytes: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

StaticecdsaP256

• ecdsaP256(uncompressedPoint: Uint8Array, comment?: string): SSHPublicKey

  A P-256 key from its 65-byte SEC1 uncompressed point.

  Parameters

  • uncompressedPoint: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

StaticecdsaP384

• ecdsaP384(uncompressedPoint: Uint8Array, comment?: string): SSHPublicKey

  A P-384 key from its 97-byte SEC1 uncompressed point.

  Parameters

  • uncompressedPoint: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

StaticecdsaP521

• ecdsaP521(uncompressedPoint: Uint8Array, comment?: string): SSHPublicKey

  A P-521 key from its 133-byte SEC1 uncompressed point.

  Parameters

  • uncompressedPoint: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

Staticecdsa

• ecdsa(
      curve: SshEcdsaCurve,
      uncompressedPoint: Uint8Array,
      comment?: string,
  ): SSHPublicKey

  An ECDSA key on curve from its SEC1 uncompressed point.

  Parameters

  • curve: SshEcdsaCurve
  • uncompressedPoint: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

Staticdsa

• dsa(
      p: Uint8Array,
      q: Uint8Array,
      g: Uint8Array,
      y: Uint8Array,
      comment?: string,
  ): SSHPublicKey

  DSA public key. p/q/g/y must already be canonical positive bytes (no sign byte).

  Parameters

  • p: Uint8Array
  • q: Uint8Array
  • g: Uint8Array
  • y: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

Staticrsa

• rsa(e: Uint8Array, n: Uint8Array, comment?: string): SSHPublicKey

  RSA public key. e and n must already be canonical positive bytes (no sign byte).

  Parameters

  • e: Uint8Array
  • n: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

withComment

• withComment(comment: string): SSHPublicKey

  Returns a copy of this SSH public key with the comment replaced, leaving this instance untouched.

  Parameters

  • comment: string

  Returns SSHPublicKey

StaticfromOpenssh

• fromOpenssh(text: string): SSHPublicKey

  Parses the single-line OpenSSH text form (<algorithm> <base64 blob> [comment]) as ssh-key 0.6.7 PublicKey::from_openssh: trailing whitespace is removed, the algorithm and Base64 segments end at a single space, the Base64 is strict, and the text's algorithm name must equal the blob's (unknown algorithm otherwise).

  Parameters

  • text: string

  Returns SSHPublicKey

toOpenssh

• toOpenssh(): string

  The single-line OpenSSH text form.

  Returns string

StaticfromBlob

• fromBlob(blob: Uint8Array, comment?: string): SSHPublicKey

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

  Parameters

  • blob: Uint8Array
  • comment: string = ""

  Returns SSHPublicKey

toBlob

• toBlob(): Uint8Array

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

  Returns Uint8Array

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

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

  Returns string

equals

• equals(other: SSHPublicKey): boolean

  true when algorithm, key material and comment are all equal.

  Parameters

  • other: SSHPublicKey

  Returns boolean

keyEquals

• keyEquals(other: SSHPublicKey): boolean

  Comment-insensitive equality: matches when algorithm and key data agree, ignoring the comment. Used by verify paths since SSH wire-format pubkey blobs carry the key but not the comment.

  Parameters

  • other: SSHPublicKey

  Returns boolean

verifySshSignature

• verifySshSignature(
      namespace: string,
      message: Uint8Array,
      signature: SshSignatureParts,
  ): boolean

  Verifies an sshsig signature made over message in namespace, as ssh_key::PublicKey::verify: the embedded key must be this key, the namespace must match, and the algorithm-specific signature must verify over the signed-data blob. Never throws on malformed input.

  Parameters

  • namespace: string
  • message: Uint8Array
  • signature: SshSignatureParts

  Returns boolean