SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

Generate Method

Generates a new SSH key.

Syntax

sshkeymanager.generate(keyAlgorithm, scheme, schemeParams, keyBits, [callback])

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 this 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

Call this method to generate a new key or keypair with the desired KeyAlgorithmand KeyBits of length.

The generated key will be populated in the Key property.

The KeyAlgorithm parameter supports the following algorithm identifiers:

  • RSA
  • DSS
  • ECDSA
  • EDDSA

If using ECDSA, the following curves are supported (to be passed as the Scheme parameter):

  • NISTP256
  • NISTP384
  • NISTP521
  • NISTK163
  • NISTP192
  • NISTP224
  • NISTK233
  • NISTB233
  • NISTK283
  • NISTK409
  • NISTB409
  • NISTK571

The following curves can also be used with EDDSA:

  • CURVE25519
  • CURVE448

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