SSL
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
|
Property |
Description |
|
SSLClientCert |
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
|
SSLClientCertType |
The type of key store containing the TLS/SSL client certificate. |
|
SSLClientCertPassword |
The password for the TLS/SSL client certificate. |
|
SSLClientCertSubject |
The subject of the TLS/SSL client certificate. |
|
SSLServerCert |
The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLClientCert
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
Data Type
string
Default Value
""
Remarks
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
|
MY |
A certificate store holding personal certificates with their associated private keys. |
|
CA |
Certifying authority certificates. |
|
ROOT |
Root certificates. |
|
SPC |
Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
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 (for example, PKCS12 certificate store).
SSLClientCertType
The type of key store containing the TLS/SSL client certificate.
Possible Values
USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB
Data Type
string
Default Value
"USER"
Remarks
This property can take one of the following values:
|
USER - default |
For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
|
MACHINE |
For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
|
PFXFILE |
The certificate store is the name of a PFX (PKCS12) file containing certificates. |
|
PFXBLOB |
The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
|
JKSFILE |
The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
|
JKSBLOB |
The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
|
PEMKEY_FILE |
The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
|
PEMKEY_BLOB |
The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
|
PUBLIC_KEY_FILE |
The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
|
PUBLIC_KEY_BLOB |
The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
|
SSHPUBLIC_KEY_FILE |
The certificate store is the name of a file that contains an SSH-style public key. |
|
SSHPUBLIC_KEY_BLOB |
The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
|
P7BFILE |
The certificate store is the name of a PKCS7 file containing certificates. |
|
PPKFILE |
The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
|
XMLFILE |
The certificate store is the name of a file that contains a certificate in XML format. |
|
XMLBLOB |
The certificate store is a string that contains a certificate in XML format. |
SSLClientCertPassword
The password for the TLS/SSL client certificate.
Data Type
string
Default Value
""
Remarks
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSLClientCertSubject
The subject of the TLS/SSL client certificate.
Data Type
string
Default Value
"*"
Remarks
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.
|
Field |
Meaning |
|
CN |
Common Name. This is commonly a host name like www.server.com. |
|
O |
Organization |
|
OU |
Organizational Unit |
|
L |
Locality |
|
S |
State |
|
C |
Country |
|
E |
Email Address |
If a field value contains a comma, it must be quoted.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
|
Description |
Example |
|
A full PEM Certificate (example shortened for brevity) |
-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
|
A path to a local file containing the certificate |
C:\cert.cer |
|
The public key (example shortened for brevity) |
-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
|
The MD5 Thumbprint (hex values can also be either space or colon separated) |
ecadbdda5a1529c58a1e9e09828d70e4 |
|
The SHA1 Thumbprint (hex values can also be either space or colon separated) |
34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.