AS2Receiver Configuration

If AcceptAnySignerCert is set to true, the component will accept any signer certificate for the incoming signature. Use of this setting in production is discouraged, as failing to authenticate the sender poses a security risk.

The version of AS2 that was used in the incoming message.

The version of AS2 to be used in the outgoing message.

This is True by default. In ASP.NET the HttpRequest.InputStream property will internally buffer the entire HTTP request before returning it. When BufferRequest is set to False the component will use an alternative approach that allows for true streaming. When BufferRequest is set to False, the component cannot be run in a default medium trust environment and requires a custom security policy file to be used.

Note: If you plan to support AS2 restart functionality through the use of RestartDirectory and ProcessRestartRequest this must be set to False to ensure proper functionality.

This setting specifies a relative or absolute path on disk where certificates received from a CEM request will be saved. The filename format is:

CEMRequestId + "_" + CertId + ".cer"

If this is not set, the certificates will be held in memory and can be accessed via CEMDetails. See CEMRequest for details.

This setting specifies whether CEM certificates are overwritten in CEMCertDir when another certificate with the same name and Id is received. The default value is False.

Determines if the stream specified by OutputStream is closed after ParseRequest or ProcessRequest returns. By default this is True. Setting this to False keeps the stream open for further use.

This configuration is only necessary when decoding EDI messages that contain attachments. If a value is specified for DecodeTempDirectory, the component will first decode the S/MIME message to the temp directory, then decode the embedded MIME message containing attachments to the IncomingDirectory.

Note: When using this configuration, if IncomingDirectory is not set, the component will not clean up any temp files it creates. These files must be monitored and cleaned manually by the user.

When receiving messages this setting controls whether the component attempts to detect duplicate messages. Consider the following scenario:

A sender transmits a message, it is successfully received but the MDN cannot be delivered due to a network error. The sender does not receive the MDN and retransmits the message.

This results in two messages being received and processed. In most cases this is not an issue as the backend processing done outside of the component will detect duplicate messages. However, this setting may be enabled to have the component check for duplicates to prevent duplicate incoming messages.

When enabled, LogDirectory must be set to a value that will resolve to the same location for both received requests. This means the "%Date:Format%" macro must not be used in the LogDirectory value. Additionally, this functionality can only work if the sender uses the same MessageId in both requests.

If a duplicate is detected, no exception is thrown, but the component will respond with an MDN including a warning that a duplicate was detected. The message in the duplicate request will not be processed.

The default value is False.

If the data is encrypted, EncryptionAlgorithm will contain the encryption algorithm used to encrypt the data; i.e., "3DES". If the data is not encrypted EncryptionAlgorithm will contain an empty string.

If the data is encrypted, EncryptionType will contain the MIME type of the encrypted data; i.e., "application/pkcs7-mime". If the data is not encrypted EncryptionType will contain an empty string.

At present only "application/pkcs7-mime" is supported for decryption.

By default, ParseRequest will halt and throw an exception if Request contains errors or requests algorithms, protocols, or receipt types not supported by the component. By setting ErrorProcessingFlags the component can be configured to not halt for certain types of errors. The errors will still be reported in ScanResult.

Use of this property allows EDIData to be determined even if the component is not fully able to respond to the client's request.

ErrorReportingFlags control how the errors are reported in the MDNReceipt.

The value should be set to the OR of one or more of the following values:

0x04 Unable to validate integrity of data, or unsupported signing protocol used.

0x08 Unable to authenticate the sender.

0x10 Client requested unsupported signature type.

0x20 Client requested unsupported MIC algorithm.

By default, MDNReceipt will report an error if any of the conditions below occur. The MIC will not be calculated and the data will be reported as unprocessed.

The MDNReceipt may be configured to permit one or more of the errors below. A warning will be reported if MDNWarning is set; otherwise the error will silently be ignored. Note that errors should be ignored only with extreme caution, and only by agreement of both trading parties.

Multiple errors may be permitted by OR-ing the flags together.

The value should be set to the OR of one or more of the following values:

0x04 Unable to validate integrity of data, or unsupported signing protocol used.

0x08 Unable to authenticate the sender.

0x10 Client requested unsupported signature type.

0x20 Client requested unsupported MIC algorithm.

This setting specifies whether to read the filename from the MIME part header (default) or the HTTP header.

When processing a request that supports filename preservation the filename will be read from the MIME body part by default. The MIME body part should hold the filename in the Content-Disposition header for that part as per the specification.

Some implementations do not behave according to the specification and specify the filename in the HTTP Content-Disposition header instead of the MIME part headers.

Possible value are:

Used to implement support for Filename Preservation with Associated MDN Response as requested by the Financial Services Technical Consortium (fstc.org). The following options are supported:

By default, the component will return a positive MDN receipt regardless of what value was provided as a filename in the transmission, renaming the filename to a valid value if a file with the filename value provided could not be written to the location specified in IncomingDirectory.

If set to 0 (Warn), the component will rename the filename as above to avoid file conflicts, but will issue a MDN warning when the filename provided is missing, contains invalid characters, or is detected as a duplicate (this behavior is governed by the Duplicate parameter of the EDIDataInfo event).

If set to 2 (Fail), the component will reject transmissions where the filename provided is missing, contains invalid characters, or is detected as a duplicate.

When LogDirectory is set, several pieces of information are written to log files in the specified directory. Set LogOptions to one or more of the following values to control what information is written to file. When specifying multiple values, include them in the same string (i.e. "LogOptions=Status, Response, Payload"):

Messages may contain multiple MIME parts if attachments are present. This setting specifies the maximum number of MIME parts to process. The default value is "100", which means 99 attachments will be processed. Each message contains one MIME part for the body, and one additional MIME part for each attachment. Set this value to "-1" to indicate no restrictions.

By default, the component will honor the request of the client, if possible. The MIC will be calculated using the requested algorithm, stored in the MICValue property of MDNReceipt, and reported in the outgoing MDN. If not possible, the MDN will not be signed, and ParseRequest will throw an exception unless ErrorProcessingFlags has been configured to prevent this. The following options are supported:

This setting may be configured in a variety of other ways, as well. If set to As Requested Or SHA1 (1), the component will honor requests for a signed receipt as with As Requested (0). If unable to comply, or if a signature was not explicitly requested, the MIC will still be calculated using the SHA1 algorithm. The ReceiptSigningProtocol property may then be set to return a signed receipt.

The property may be set to SHA1 (2), MD5 (3), or None (4) to override the client's request, and use the specified signing algorithm. Use extreme caution when doing this; it will result in a non-RFC compliant server.

If specified, this setting overrides the MDN disposition that was automatically calculated by the component. In most cases this is not necessary but may be used when specifying a custom Disposition header is required. For instance:

as2receiver.Config("MDNDisposition=message-deemed-invalid-due-to-unknown-from-and.or-to-parties");

The name of the user agent performing the disposition. The RFC 2298 recommendation is to use the DNS name of the user agent and the name of the software performing the disposition, for example, "edi-server.nsoftware.com; /n software EDI Server Demo".

MDNSendingMode allows the server software to describe the level of user interaction in sending the MDN. MDNSendingMode corresponds to the "disposition-mode" field in the Disposition Header, as described further in RFC 3335. The following values are supported:

By default, the disposition-mode value will be "automatic-action/MDN-sent-automatically".

MDNWarning defines a warning to appear in the outgoing MDNReceipt. If any errors are returned in ScanResult and not marked as to be allowed in ErrorReportingFlags the errors will take precedence and the warning will not be reported.

MDNWarning should be assigned when allowing the errors returned in ScanResult. The MDNReceipt will indicate successful processing of Request, but will contain a Warning field. The following warnings are defined by the AS2 specifications:

"authentication-failed, processing continued"

Any other warnings are not defined by the specifications and may or may not be understood by the client.

If ProcessingError is set to "True" before invoking CreateMDNReceipt, a MDN with the disposition "processed/Error: unexpected-processing-error" is returned.

This setting is used while sending an asynchronous MDN.

This setting is used while sending an asynchronous MDN.

This setting is used while sending an asynchronous MDN.

This setting is used while sending an asynchronous MDN.

This setting is used while sending an asynchronous MDN.

The protocol used to sign the outgoing MDNReceipt. The following values are supported:

By default, the component will honor the request of the client, if possible. If not possible, the MDNReceipt will not be signed, and ParseRequest will throw an exception unless ErrorProcessingFlags has been configured to prevent this.

If the client does not request a signature, one will not be provided by default. However, the server may provide one by setting ReceiptSigningProtocol to PKCS7 (1). If the client requests a signature, and the signature protocol is supported by the component, the request must be honored, per RFC specifications.

This property will contain the algorithm(s) requested ("sha1", "md5", "sha-256", etc.) as well as the importance ("required" or "optional") specified by the client. If multiple algorithms are specified, precedence is given to the ones on the left. Formatting is as in RFC 3335, e.g., "optional, sha1, md5".

This setting will contain an empty string if a MIC was not requested.

This property will contain the protocol requested ("pkcs7-signature" or "pgp-signature") as well as the importance ("required" or "optional") specified by the client, as formatted in RFC 3335, e.g., "optional, pkcs7-signature".

This setting will contain an empty string if a signature was not requested.

This setting is used while processing the received message and causes an exception to be thrown if the message is not intended for the receiver specified by RequireAS2To.

This setting is used while processing the received message and causes an exception to be thrown if the encryption requirement is not met.

This setting is used while processing the received message and causes an exception to be thrown if the signature requirement is not met.

The human-readable subject to be used for the MDN response.

This will contain the name of the algorithm used to sign the incoming message. Possible values are:

• sha1
• md5
• sha-256
• sha-384
• sha-512
• sha-224

This property will contain the protocol requested ("pkcs7-signature" or "pgp-signature") as well as the importance ("required" or "optional") specified by the client, as formatted in RFC 3335, e.g., "optional, pkcs7-signature".

This setting will contain an empty string if a signature was not requested.

In case an asynchronous MDN is requested over SMTP, the sender; i.e., the value of "From".

In case an asynchronous MDN is delivered over SMTP, the address of the server to be used to send it.

This setting controls whether to log a .wrn file or a .err file in the LogDirectory when MDN delivery fails. When set to True and MDN delivery fails a .wrn file is created in the LogDirectory. This allows an application to treat MDN failures as warnings when monitoring log files. When set to False and MDN delivery fails a .err file is created. The default value is False.

Note: This setting is not applicable when calling SendAsyncMDN.

This setting specifies whether to log debug data. When set to True the component will create additional files in the LogDirectory. The default value is False.

When sending, files with extensions ".input", ".sign", ".compress", and ".encrypt" may be created. When receiving, files with extensions ".input", ".verify", ".decompress", and ".decrypt" may be created.

Use the AuthScheme property to tell the component which type of authorization to perform when the User and Password properties are set. Possible values are:

By default, AuthScheme is Basic (0), and if the User and Password configuration settings are set, the component will attempt basic authentication. If AuthScheme is set to Digest (1), digest authentication will be attempted instead.

For security reasons, setting this value will clear the values of User and Password.

If the Authorization setting contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This setting is provided so that the component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme; setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.

If AuthScheme is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.

If set, this will be used as for the filename of the log file.

Note that only the base name should be specified as the component will append the appropriate file extension.

When AllowHTTPCompression is true, the component adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The component only supports gzip and deflate decompression algorithms.

This is the same as the AllowHTTPCompression property. This setting is exposed here for use by components that inherit from HTTP.

By default the component does not allow redirects to the same URL to avoid redirect loops. In some cases the server may intentionally redirect the client back to the same URL. In that case this setting may be set to True to allow the redirect to be followed. The default value is False.

This setting determines whether data is appended when writing to LocalFile. When set to True downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is only applicable when LocalFile is set. The default value is False.

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred.

The default value is false. If set to true the URL passed to the component will be URL encoded.

This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same, otherwise the component throws an exception.

Note that following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Valid options are:

• 0 - Never
• 1 - Always
• 2 - Same Scheme

The default value is false. If set to true the component will perform a GET on the new location. Otherwise it will use the same HTTP method again.

Possible values include "1.0", and "1.1". The default is "1.1".

This is the same as the IfModifiedSince property. This setting is exposed here for use by components that inherit from HTTP.

If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

This config should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

This config should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection .

To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

When FollowRedirects is set to any value besides frNever the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

This configuration option can be set to a string of headers to be appended to the HTTP request headers.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\ n") .

Use this configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail.

This configuration option is useful for extending the functionality of the component beyond what is provided.

Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

This is the same as AuthScheme. This setting is provided for use by components that do not directly expose Proxy properties.

This is the same as Password. This setting is provided for use by components that do not directly expose Proxy properties.

This is the same as Port. This setting is provided for use by components that do not directly expose Proxy properties.

This is the same as Server. This setting is provided for use by components that do not directly expose Proxy properties.

This is the same as User. This setting is provided for use by components that do not directly expose Proxy properties.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise this reflects the maximum number of incoming bytes that can be stored by the component.

This configuration setting returns the complete set of raw headers as received from the server.

If UseChunkedEncoding is set to true, the component will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the component will not use HTTP chunked encoding. The default value is false.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

If True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

This is the value supplied in the HTTP User-Agent header. The default setting is "/n software IPWorks HTTP/S Component - www.nsoftware.com".

Override the default with the name and version of your software.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

This is the same as AutoDetect. This setting is provided for use by components that do not directly expose Firewall properties.

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host. This setting is provided for use by components that do not directly expose Firewall properties.

This entry is for IPPort only and does not work for other components that descend from IPPort.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

NOTE: This is the same as Password. This setting is provided for use by components that do not directly expose Firewall properties.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This is the same as Port. This setting is provided for use by components that do not directly expose Firewall properties.

The appropriate values are as follows:

NOTE: This is the same as FirewallType. This setting is provided for use by components that do not directly expose Firewall properties.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

NOTE: This is the same as User. This setting is provided for use by components that do not directly expose Firewall properties.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Note: This value is not applicable in Java.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in Java or MAC.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

The LocalHost setting 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost setting 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 multi-homed hosts (machines with more than one IP interface).

This must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

If set to a positive value, this setting defines the length of data records to be received. The component will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

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.

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

When specified the component 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 component throws an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance:

IPPort.Config("UseManagedSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-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.

If set to true, the component 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 component is the same.

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. The actual cipher strength used for the connection is shown by the SSLStatus event.

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

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

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:

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

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

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

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

This functionality is currently not available in Java or when the provider is OpenSSL.

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 component 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 UseManagedSecurityAPI is False (default):

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");

• 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

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");

• TLS_DH_ANON_EXPORT_WITH_DES40_CBC_SHA
• TLS_DH_ANON_WITH_3DES_EDE_CBC_SHA
• TLS_DH_ANON_WITH_AES_128_CBC_SHA
• TLS_DH_ANON_WITH_AES_128_CBC_SHA256
• TLS_DH_ANON_WITH_AES_256_CBC_SHA
• TLS_DH_ANON_WITH_AES_256_CBC_SHA256
• TLS_DH_ANON_WITH_DES_CBC_SHA
• TLS_DH_ANON_WITH_RC4_128_MD5
• TLS_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
• 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_EXPORT_WITH_DES40_CBC_SHA
• 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_EXPORT_WITH_DES40_CBC_SHA
• 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

SSLEnabledCipherSuites is used together with SSLCipherStrength.

Note: This configuration setting is available only in .NET and Java.

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.

Note: This option is not valid for UDP ports.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the component does not attempt to process external events.

If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.

By default the component will use the system security libraries to perform cryptographic functions. This means calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal managed implementation instead of using the system's security API.

Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this file.