SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

ServerKeyKeyFormat Property

Specifies the format in which the key is stored.

Syntax

 sshclient.getServerKeyKeyFormat([callback])

Possible Values

  0 (ckfOpenSSH), 
  1 (ckfOpenSSH2), 
  2 (ckfIETF), 
  3 (ckfPuTTY), 
  4 (ckfX509), 
  5 (ckfBinary), 
  6 (ckfSSH1), 
  7 (ckfPGP), 
  8 (ckfPKCS8)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getServerKeyKeyFormat([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setServerKeyKeyFormat([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Specifies the format in which the key is stored.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88

This property is read-only.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Node.js Edition - Version 20.0 [Build 8165]