IMR_SetCertificateInfo

SDK Resources > Redirection Library > Redirection Library API > Functions for General Library Management > IMR_SetCertificateInfo

IMR_SetCertificateInfo

This function is now deprecated on Windows Operating systems, and TLS – SSPI mode should be used. On Windows OS if this function is not called or called with empty strings the Redirection library automatically perform SSPI secure redirection session flow.

Look at Secure Session Support and at IMR_SetClientCertificate() for more information.

This function sets information that is necessary for certificate verification when establishing a TLS session.

The root certificate, in .cer format, must be installed in the Trusted Root store and must be used for all secure sessions. In sessions that use mutual authentication, a client certificate in .pem format must also be installed in the Trusted Root store.

Function Header

IMRResult IMR_SetCertificateInfo(

const char *root_cert,

const char *private_cert,

const char *cert_pass

);

Function Parameters

Field	Input/Output	Value or Description
root_cert	Input	A NULL terminated string specifying the path to a file containing Certificate Authority certificates as described in the Secure Session Support section. When establishing a TLS session with a client, these root certificates will be used to authenticate the SSL certificates sent by the client. The file path name can be either absolute or relative to the directory from which the application is run. This parameter must not be NULL.
private_cert	Input	A NULL terminated string specifying the path to a file containing a private certificate as described in the Secure Session Support section. When establishing a TLS session with a client, this certificate will be sent to the client if it requires the console to provide its own certificate for authentication. The file path name can be either absolute or relative to the directory from which the application is run. This parameter may be NULL, in which case the library will not be able to provide a certificate if one is requested by the client. If the parameter is an empty string rather than NULL, the first certificate in the My certificate store with the appropriate OIDs will be selected.
cert_pass	Input	A NULL terminated string specifying the password protecting the certificate file specified in ‘private_cert’. This parameter may be NULL, in which case ‘private_cert’ should not be password protected. If ‘private_cert’ is NULL, then this parameter must also be NULL.

Function Return Status

For a complete list of possible error codes, see Error Codes.

Status	Value or Description
IMR_RES_OK	The command finished successfully.