SSL-Related Objects

The following interfaces, properties, and methods are used for SSL management in the COM API.

•  ICISSLVersion and ICISSLVersions interfaces to support the SSL library.

• In the ICIServer interface:

• AvailableSSLVersions method (for use in the ICISSLVersions interface).

• CipherList property to retrieve or specify the cipher list

• CreateSSLCertificate method to create and SSL certificate

• CreateSSLCertificateRemotely method create and sign an SSL certificate

• PassPhrase property to retrieve or specify an SSL certificate private key passphrase

• SetSSLCertificate method specifies the SSL certificate for admin connections

• SignSSLCertificateRemotely method to sign a certificate remotely

• SSLFIPSEnabled property retrieves or specifies whether FIPS is enabled

• SSLVersionMask property to retrieve or specify the SSL version mask

• SSL certification expiration notification properties:

  • SSLCertSendEmailUponExpiration

  • SSLCertSendEmailPriorExpiration

  • SSLCertDaysPriorExpiration

  • SSLCertEmailRecipients

  • SSLCertSendEmailCopyToAssociatedUser As Boolean

• UseSSLForAdministration property enables or disables SSL for the admin socket connection

• In the ICISite interface:

• GetCertFilePath retrieves the Site certificate file path

• GetCheckClientCert method determines whether the server requires a certificate from users connecting via implicit SSL.

• GetKeyFilePath retrieves the Site's SSL private key file path

• GetPassPhrase retrieves the Site's SSL private key passphrase

• GetSSLAuth returns TRUE if SSL authentication is enabled

• GetSSLImp returns TRUE if SSL implicit is enabled

• SetCertFilePath certificate file path and returns TRUE if the Site has to be restarted

• SetCheckClientCert enables or disables the requirement of certificates on an implicit SSL Site

• SetKeyFilePath retrieves the Site's SSL private key file path

• SetPassPhrase retrieves the Site's SSL private key passphrase

• SetSSLAuth returns TRUE if SSL authentication is enabled

• SetSSLImp returns TRUE if SSL implicit is enabled

• SSL certification expiration notification properties:

  • SSLCertSendEmailUponExpiration

  • SSLCertSendEmailPriorExpiration

  • SSLCertDaysPriorExpiration

  • SSLCertEmailRecipients

  • SSLCertSendEmailCopyToAssociatedUser As Boolean

• In the ICIClientSettings interface:

• GetSSLAuthenticationType to retrieve the SSL authentication type for the client

• GetSSLKeyID to retrieve the SSL key ID for the client

• SetSSLAuthenticationType to specify the SSL authentication type for the client

• SetSSLKeyID to specify the SSL key ID for the client

• In the ICILDAPAuthManagerSettings interface:

• UseSSL property retrieves or specifies whether to use SSL for LDAP authentication.

• In the Enums:

• CertificateFormat, used in the ICIServer CreateSSLCertificate method, is used to specify the certificate and private key format

• In the EventProperty enum, ClientSSLAllowed specifies whether the user can connect using SSL.

Also refer to Remotely Administering EFT Using the API for information about the SSL DLLs required by the COM API.