IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

GenerateCSR Method

Generates a new CSR to be sent to a signing authority.


certmgr.generateCSR(certSubject, keyName, [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, data){ }

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

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:



This method will generate a new Certificate Signing Request (CSR) to be sent to the signing authority. CertSubject specifies the subject of the Certificate Signing Request (CSR). KeyName specifies the name of the keyset (public/private key pair) to be used. If the keyset does not already exist in the Cryptographic Service Provider (CSP), the class will automatically generate one. To set the CSP, use the CSP configuration setting.

NOTE: it is important to remember the name of the keyset that is used when creating a CSR, as keyset must be later re-associated with the certificate after the trust authority has signed the CSR.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

CNCommon Name. This is commonly a host name like www.server.com.
OUOrganizational Unit
EEmail Address

If a field value contains a comma it must be quoted.

NOTE: This functionality is only available in Windows.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Node.js Edition - Version 20.0 [Build 7721]