DirectoryServerCertStore Property

The name of the certificate store for the client certificate.

Syntax

 client.getDirectoryServerCertStore([callback])
 client.setDirectoryServerCertStore( directoryServerCertStore_Buffer, [callback])

Default Value

"MY"

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 getDirectoryServerCertStore([callback]) method is defined as:

function(err, buffer){ }

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

'buffer' is the value returned by the method.

The callback for the setDirectoryServerCertStore([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 name of the certificate store for the client certificate.

The DirectoryServerCertStoreType property specifies the type of the certificate store specified by DirectoryServerCertStore. If the store is password protected, specify the password in DirectoryServerCertStorePassword.

DirectoryServerCertStore is used in conjunction with the DirectoryServerCertSubject property in order to specify client certificates. If DirectoryServerCertStore has a value, and DirectoryServerCertSubject or DirectoryServerCertEncoded is set, a search for a certificate is initiated. Please refer to the DirectoryServerCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Buffer