Config2_SSHKeys

Provides methods for setting up the server SSH keys for the current site.

Instances of this class are obtained from:

Properties

PropertyTypeDescription
dsa String

Returns a string representing the server's DSA public key in OpenSSH format for this site.
ecdsa Config2_ECDSAKeys

ECDSA keys for this site.
ed25519 String

Returns a string representing the server's Ed25519 public key in OpenSSH format for this site.
rsa String

Returns a string representing the server's RSA public key in OpenSSH format for this site.

Methods

MethodReturnsDescription
remove() void

Remove a server key by algorithm.
set() String

Set up the server key for the current site.

Property Details

(readonly) dsa :String

Description:

  • Returns a string representing the server's DSA public key in OpenSSH format for this site.

Returns a string representing the server's DSA public key in OpenSSH format for this site.

Type:
  • String

ecdsa :Config2_ECDSAKeys

Description:

  • ECDSA keys for this site.

ECDSA keys for this site.

Type:

(readonly) ed25519 :String

Description:

  • Returns a string representing the server's Ed25519 public key in OpenSSH format for this site.

Returns a string representing the server's Ed25519 public key in OpenSSH format for this site.

Type:
  • String

(readonly) rsa :String

Description:

  • Returns a string representing the server's RSA public key in OpenSSH format for this site.

Returns a string representing the server's RSA public key in OpenSSH format for this site.

Type:
  • String

Method Details

remove(algorithm)

Description:

  • Remove a server key by algorithm.

Parameters:
Name Type Description
algorithm String

Algorithm name (e.g. 'RSA', 'DSA', 'Ed25519', 'ECDSA').

set(privateKey, password) → {String}

Description:

  • Set up the server key for the current site.

Parameters:
Name Type Description
privateKey String

The server's private key in OpenSSH, SSH.com or Putty format.
password String

The password that protects the private key.
Returns:

Result message

Type
String