CertKeyPassword Property

The password for the certificate's private key (if any).

Syntax

 certmgr.getCertKeyPassword([callback])
 certmgr.setCertKeyPassword( certKeyPassword, [callback])

Default Value

""

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 getCertKeyPassword([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 setCertKeyPassword([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

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the CertStorePassword. CertKeyPassword. This can be used to read such password-protected private keys.

Note: this property defaults to the value of CertStorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but must be set before calling CertPrivateKey when the private key's password is different from the store's.

Data Type

String