LDAP Connector

Properties   Config Settings  

The LDAP Component enables your MuleSoft to perform operations against any LDAP directory server.

Remarks

The LDAP Connector can be used to perform a variety of operations on any LDAP directory server.

LDAP Send Connector

The Send Connector will make a request to an LDAP server then listen for the response. The result is returned in the message payload and attributes.

Some operations require a message that adheres to a schema while others to not place any restrictions on the message content and rely solely on the connector property values.

The operation performed by the adapter is controlled by the Operation property. To begin, specify the connection information in Server, and Port. SSL may be enabled via the SSLStartMode property.

To perform an authenticated bind, set BindDN to your username and Password.

All operations will populate the ResultCode, ResultDescription, and ResultSuccess attributes. These should be checked to determine the result of the operation that was requested.

Below is an overview of the available operations.

Add

Adds an entry specified by DN to the directory server using the type and value attributes defined in the message. The message must adhere to the schema defined in "LDAPAdd.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text. To add attributes to an existing entry use the Modify operation instead.

To get started, set the message payload to an XML-formatted LDAPAdd message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPAdd><LDAPAttribute Type="objectClass" Value="top" /><LDAPAttribute Value="person"/><LDAPAttribute Value="organizationalPerson" /></LDAPAdd>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Add and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Authenticate

Binds with the user specified by BindDN. This is only used to validate the user can bind successfully to the LDAP server. No other action is performed.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to Authenticate. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

ChangePassword

Changes the password for the user specified by DN with the value specified in NewPassword.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to ChangePassword. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Delete

Deletes the entry specified by DN.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to Delete. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Modify

Modifies an existing entry specified by DN. The message must adhere to the schema defined in "LDAPModify.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text.

To get started, set the message payload to an XML-formatted LDAPModify message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPModify><LDAPAttribute Type="telephoneNumber" Value="phoneNumber1" ModifyOperation="add"/></LDAPModify>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Modify and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Search

Performs a search using the criteria specified in the message. The message must adhere to the schema defined in "LDAPSearch.xsd" that is located in the "schemas" folder of the installation. The response message will adhere to the schema defined in "LDAPSearchResult" and provide the search results.

To get started, set the message payload to an XML-formatted LDAPSearch message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPSearch SearchFilter="sAMAccountName=bob"></LDAPSearch>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Search and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Sender Property List


The following is the full list of the properties of the sender Connector with short descriptions. Click on the links for further details.

BindDNThe Distinguished Name used as the base for the LDAP bind.
DNThe Distinguished Name used as the base for LDAP operations.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
LogTypeHow information gets logged during component execution.
NewPasswordThe value of the new password.
OperationSpecifies the operation the component will perform.
OtherDefines a set of configuration settings to be used by the component.
PageSizeThe maximum number of results per page.
PasswordThe password used to authenticate to the LDAP server.
PortThe server port for the LDAP connection (default is 636).
ResultCodeThe result code returned in the last server response.
ResultDescriptionThe descriptive text returned in the last server response (if any).
ResultSuccessWhether or not the operations completed successfully.
RuntimeLicenseSpecifies the component runtime license key.
ServerThe name or address of the LDAP server.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
TimeoutA timeout for the component.
VersionThe version of LDAP used.

Config Settings


The following is a list of config settings for the Connector with short descriptions. Click on the links for further details.

BinaryAttributesA comma separated list of attributes that are expected to be in binary form.
RepeatAttributeTypesWhether to include the type name in the LDAPAttribute for repeated types returned from a search.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

BindDN Property (LDAP Connector)

The Distinguished Name used as the base for the LDAP bind.

Data Type

String

Default Value

""

Remarks

The Distinguished Name is provided in string format as specified by RFC 1779. In most cases this will be a username in the format "DOMAIN\User".

DN Property (LDAP Connector)

The Distinguished Name used as the base for LDAP operations.

Data Type

String

Default Value

""

Remarks

The Distinguished Name is provided in string format as specified by RFC 1779. Example value:

uid=TThompson,ou=Employees,dc=server

LogFile Property (LDAP Connector)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the connector's logging API, set this property to a valid file on disk and set the LogType property to "File".

LogMode Property (LDAP Connector)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)


Default Value

3

Remarks

This property controls what information the connector logs. The possible values have the following affect on the connector's behavior:

VerboseThe connector will report all information regarding the transport.
InfoThe connector will report all major operations, as well as all warnings and errors.
WarningThe connector will report any conditions that could result in unpredictable behavior as well as errors.
ErrorThe connector will report all errors that prevent normal operations from completing.
FatalThe connector will report only serious errors that cause the connector to completely stop functioning.

LogType Property (LDAP Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

None (0)
Console (1)
File (2)


Default Value

1

Remarks

This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:

NoneThe connector will not report any logging information.
ConsoleThe connector will report all logging information to the console.
FileThe connector will report all logging information to a file. The desired file must be specified in the LogFile when this type has been selected.

NewPassword Property (LDAP Connector)

The value of the new password.

Data Type

Password

Default Value

""

Remarks

When Operation is set to ChangePassword the password for the account specified by BindDN will be changed to this value.

Operation Property (LDAP Connector)

Specifies the operation the component will perform.

Data Type

Enumeration

Possible Values

Add (0)
Delete (1)
Modify (2)
Search (3)
Change Password (4)
Authenticate (5)
Move To DN (6)


Default Value

0

Remarks

This property controls the action of the connector. Possible values are:

  • Add
  • Authenticate
  • ChangePassword
  • Delete
  • Modify
  • Search

Details on each operation are below.

Add

Adds an entry specified by DN to the directory server using the type and value attributes defined in the message. The message must adhere to the schema defined in "LDAPAdd.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text. To add attributes to an existing entry use the Modify operation instead.

To get started, set the message payload to an XML-formatted LDAPAdd message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPAdd><LDAPAttribute Type="objectClass" Value="top" /><LDAPAttribute Value="person"/><LDAPAttribute Value="organizationalPerson" /></LDAPAdd>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Add and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Authenticate

Binds with the user specified by BindDN. This is only used to validate the user can bind successfully to the LDAP server. No other action is performed.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to Authenticate. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

ChangePassword

Changes the password for the user specified by DN with the value specified in NewPassword.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to ChangePassword. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Delete

Deletes the entry specified by DN.

Add the LDAP Send Connector to your flow and configure the connection settings. This operation does not require a message which adheres to a schema. Simply configure the connection settings and set the Operation to Delete. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Modify

Modifies an existing entry specified by DN. The message must adhere to the schema defined in "LDAPModify.xsd" that is located in the "schemas" folder of the installation. Note that instead of including the Value attribute in the message, Base64 encoded data may be included in the LDAPAttribute element text.

To get started, set the message payload to an XML-formatted LDAPModify message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPModify><LDAPAttribute Type="telephoneNumber" Value="phoneNumber1" ModifyOperation="add"/></LDAPModify>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Modify and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Search

Performs a search using the criteria specified in the message. The message must adhere to the schema defined in "LDAPSearch.xsd" that is located in the "schemas" folder of the installation. The response message will adhere to the schema defined in "LDAPSearchResult" and provide the search results.

To get started, set the message payload to an XML-formatted LDAPSearch message before it arrives at the LDAP Send Connector. For example, add a Set Payload Transformer and set the value to the following message:

<LDAPSearch SearchFilter="sAMAccountName=bob"></LDAPSearch>

Then add a LDAP Send Connector behind the Set Payload Transformer and configure the connection settings. Set the Operation to Search and that's it. The results are available in the ResultCode, ResultDescription, and ResultSuccess attributes.

Other Property (LDAP Connector)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The connector accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

PageSize Property (LDAP Connector)

The maximum number of results per page.

Data Type

Integer

Default Value

0

Remarks

This property contains the maximum number of search results per page. It is only applicable when searching.

If a large number of search results are expected set this value to tell the server to page the results. All of the results will still be received by the connector, this setting only controls how the results are broken up by the server to prevent too large of a result set.

Note: LDAP paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.

Password Property (LDAP Connector)

The password used to authenticate to the LDAP server.

Data Type

Password

Default Value

""

Remarks

This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required.

Port Property (LDAP Connector)

The server port for the LDAP connection (default is 636).

Data Type

Integer

Default Value

636

Remarks

This property contains the server port for the LDAP connection (default is 636). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For explicit SSL, use port 389 instead (please refer to the SSLStartMode property for more information).

ResultCode Property (LDAP Connector)

The result code returned in the last server response.

Data Type

Integer

Default Value

0

Remarks

This property contains the result code returned in the last server response.

Possible result codes are:

0 success
1 operationsError
2 protocolError
3 timeLimitExceeded
4 sizeLimitExceeded
5 compareFalse
6 compareTrue
7 authMethodNotSupported
8 strongAuthRequired
9 reserved
10 referral
11 adminLimitExceeded
12 unavailableCriticalExtension
13 confidentialityRequired
14 saslBindInProgress
16 noSuchAttribute
17 undefinedAttributeType
18 inappropriateMatching
19 constraintViolation
20 attributeOrValueExists
21 invalidAttributeSyntax
32 noSuchObject
33 aliasProblem
34 invalidDNSyntax
35 reserved for undefined isLeaf
36 aliasDereferencingProblem
48 inappropriateAuthentication
49 invalidCredentials
50 insufficientAccessRights
51 busy
52 unavailable
53 unwillingToPerform
54 loopDetect
64 namingViolation
65 objectClassViolation
66 notAllowedOnNonLeaf
67 notAllowedOnRDN
68 entryAlreadyExists
69 objectClassModsProhibited
70 reserved for CLDAP
71 affectsMultipleDSAs

All the result codes with the exception of success, compareFalse and compareTrue are to be treated as meaning the operation could not be completed in its entirety. Result codes from 16 to 21 indicate an AttributeProblem, codes 32, 33, 34 and 36 indicate a NameProblem, codes 48, 49 and 50 indicate a SecurityProblem, codes 51 to 54 indicate a ServiceProblem, and codes 64 to 69 and 71 indicate an UpdateProblem.

ResultDescription Property (LDAP Connector)

The descriptive text returned in the last server response (if any).

Data Type

String

Default Value

""

Remarks

This property contains the descriptive text returned in the last server response (if any).

ResultSuccess Property (LDAP Connector)

Whether or not the operations completed successfully.

Data Type

Boolean

Default Value

true

Remarks

This property returns True if the Operation was successful. If the operation failed this property returns False and ResultCode and ResultDescription will contain more details.

RuntimeLicense Property (LDAP Connector)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the connector license.

Server Property (LDAP Connector)

The name or address of the LDAP server.

Data Type

String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the directory server.

SSLAcceptServerCert Property (LDAP Connector)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the connector will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the connector will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the connector to report the server's credentials to Location.

SSLCert Property (LDAP Connector)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

SSLStartMode Property (LDAP Connector)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

Automatic (0)
Implicit (1)
Explicit (2)
None (3)


Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

AutomaticIf the remote port is set to the standard plaintext port of the protocol (where applicable), the connector will behave the same as if SSLStartMode is set to Explicit. In all other cases, SSL negotiation will be implicit (Implicit).
ImplicitThe SSL negotiation will start immediately after the connection is established.
ExplicitThe connector will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
NoneNo SSL negotiation, no SSL security. All communication will be in plaintext mode.

Timeout Property (LDAP Connector)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the connector will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the connector fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the connector may be changed to absolute timeouts, i.e. the connector will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

Version Property (LDAP Connector)

The version of LDAP used.

Data Type

Integer

Default Value

2

Remarks

The default value is 2.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Store
String

Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware 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 (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String

Default Value: ""

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

StoreType
CertStoreTypes

Default Value: 0

The type of certificate store for this certificate.

The connector supports both public and private keys in a variety of formats. When the cstAuto value is used, the connector will automatically determine the type. This field can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CERTMGR connector. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String

Default Value: ""

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, Subject is set to the full subject of the matching certificate.

Thumbprint
String (read-only)

Default Value: ""

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

Config Settings (LDAP Connector)

The connector accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.

LDAP Config Settings

BinaryAttributes:   A comma separated list of attributes that are expected to be in binary form.

Certain attribute values returned by the LDAP server maybe represented in binary. Set this setting to a comma separated list of attributes that are expected to be binary. The connector will return a hex encoded version of the value in the result for each attribute defined here. For instance the objectGUID attribute value may be represented as "A4 A8 89 11 6F BC 11 46 A9 F6 FD BD CB 76 8F F3".

RepeatAttributeTypes:   Whether to include the type name in the LDAPAttribute for repeated types returned from a search.

By default, the connector will indicate that the type for an LDAPAttribute is an empty string if the previous LDAPAttribute was of the same type. When this configuration setting is set to True, the adapter will include the type name of the LDAPAttribute even if it is the same as the previous element.

For example, when False (default), the resulting xml for a search that contains three values for the "objectClass" type would look like this: <LDAPAttribute Type="objectClass" Value="top" /> <LDAPAttribute Type="" Value="person" /> <LDAPAttribute Type="" Value="organizationalPerson" /> The same search, with this configuration setting set to True would look like this: <LDAPAttribute Type="objectClass" Value="top" /> <LDAPAttribute Type="objectClass" Value="person" /> <LDAPAttribute Type="objectClass" Value="organizationalPerson" />

SSL Config Settings

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the connector will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the connector is the same.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the connector will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when UseInternalSecurityAPI is True: // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA Possible values when UseInternalSecurityAPI is True include:
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000) (Experimental)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the connector will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the connector will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

General Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost:   The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the connector initiate connections (or accept in the case of server connectors) only through that interface.

If the connector is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to False, the connector will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the connector to use the internal implementation instead of using the system security libraries.

This setting is set to False by default on all platforms.