AS4Client Configuration
The component 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 component, access to these internal properties is provided through the Config method.AS4Client Configuration Settings
AgreementRefPMode:
AgreementRef PMode of message.This optional setting allows for the association of a message with a particular P-Mode. If specified
it should be the PMode.ID parameter.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef/@pmode" | |||||||||||||||
AgreementRefType:
The type of AgreementRef.This optional setting indicates how parties should interpret the value of AgreementRef. The semantics
of this value should be decided upon between the parties.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef/@type" | |||||||||||||||
AllowWarnings: Whether warnings are interpreted as fatal errors.When set to False (default) any ebMS level error returned by the other party will be considered an error and cause an exception. When set to True the severity of the ebMS error will be inspected. If the severity is "warning" it will not cause an exception. In this case Errors will still be populated with the error details. | |||||||||||||||
AttachXMLFiles:
Whether to send XML files as attachments or within the SOAP body.This setting specifies whether XML files are included as attachments or within the SOAP body.
This setting is only applicable when the first file specified in EDIData is of type "text/xml" or "application/xml". In addition this is only applicable when Profile is set to Standard. If set to True (default), the file will be sent as an attachment. This allows the filename to be preserved and the file is sent as a separate MIME part. If set to False and the criteria above are met then the file will be sent within the SOAP body. In this case the filename cannot be preserved normally. The default value is True. | |||||||||||||||
Authorization:
The Authorization string to be sent to the server.
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]". | |||||||||||||||
AuthScheme:
The authorization scheme to be used when server authorization is to be performed.
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:
For security reasons, setting this value will clear the values of User and Password. | |||||||||||||||
CloseStreamAfterProcessing: Whether to close the input or output stream after processing.This setting specifies whether the input or output stream will be closed after processing. This may be set to False to leave the stream open for further operations. The default value is True and the stream will be by the component. | |||||||||||||||
CompressXMLPayloads:
Whether to compress XML data.When CompressionFormat is set to GZIP all EDIData parts will be compressed. To exclude XML payloads
with EDIType values of "text/xml" or "application/xml" from being compressed set this value
to False. By default this is True and all attachments will be compressed.
Note: When Profile is set to Standard the first EDIData part will be included in the SOAP body if the EDIType is "text/xml" or "application/xml". In that case since the data is included in the SOAP body it will not be compressed. When Profile is set to ENTSOG all EDIData parts are compressed. | |||||||||||||||
ContentTransferEncoding:
The content encoding of the payload data.This setting can be used to specify the content encoding of the payload data of the AS4 message. This is
set to binary (4) by default. Possible values for the this field are:
| |||||||||||||||
DetectDuplicates:
Whether to detect duplicate messages when receiving.Whether to detect duplicate messages. If set to True LogDirectory must be set. When a file is received
the component will store a file containing the MessageId of the received file. When additional files are
received the component will scan the LogDirectory to see if a file with the same MessageId has already
been received. If a duplicate is detected an entry is added to the .log file and Log fires.
The default value depends on the Profile. For the Standard profile the default value is False. When Profile is set to ENTSOG this value is set to True. | |||||||||||||||
EBPrefix:
Specifies the prefix to use for messaging.This setting specified the prefix to use for messaging. The default value is "eb3" and will result in values such as:
eb3:MessagingIt may be desirable to set this to another value such as "eb" so client and server sides both use the same prefix. | |||||||||||||||
EDIDataPartId[i]:
Specified the part Id at the given index.This setting may be used to specify the value for each EDIData part that is present in the message.
By default the component will generate a unique value. For instance:
<eb3:PartInfo href="cid:_de48eece-d1d8-4823-8a63-d3a8d14dc1a8@nsoftware">In some cases it may be desired or necessary to specify a user-defined value. For instance: <eb3:PartInfo href="cid:mypart@myhost">After adding the part to EDIData the Id may be specified by setting: AS4Component.Config("EDIDataPartId[0]=mypart@myhost");This setting is also populated with the parsed Ids after receiving a message. | |||||||||||||||
EncryptionSecurityTokenFormat:
The format to use for the security token when encryption.This setting specifies the security token format that is included in the message when encrypting.
This setting should only be set if there is a specific reason to do so. This specifies the reference
type in the SecurityTokenReference element applicable to the encrypted data. Possible values
are:
The default value is 0 (X509) and should not be changed unless there is a specific reason to do so. Note: The default value when Profile is set to e-SENS is 1 (Binary). | |||||||||||||||
FilenameProperty:
Defines a part property to hold the filename.This setting specifies the PropertyName that will hold the name of the file. This may be used
to preserve filenames. Both the client and server must agree on the name of the property that will be
used to hold the filename.
This is helpful in the case where Profile is set to ebpfStandard and the first file being sent is of type "text/xml" or "application/xml". In that case the file content is included in the SOAP body and there is no standard mechanism for preserving the filename. When set the component will automatically populate the property when sending files and will read the filename from this property when receiving files. By default this is not specified. Note: The filenames will always be preserved within the MIME header attributes whenever possible regardless of whether this setting is specified. | |||||||||||||||
ForceSigningCert:
Whether to force only the SigningCert to be used for signing.When set to False the component will first check SigningCert for a certificate to use
for signing operations. If SigningCert is not specified it will use the certificate specified in Certificate.
If set to True (default) the component will only attempt to use the certificate specified by SigningCert. If SigningCert is not specified signing will not be attempted. | |||||||||||||||
FromId[i]: The Id of the party specified by AS4From.This setting sets the Id of the party specified by AS4From at the index specified here. This is only used when multiple Ids are set. See FromIdCount for more details. | |||||||||||||||
FromIdCount:
The number of Ids for the party specified by AS4From.Multiple Ids may be specified for the AS4From party. This setting defines the total number of Ids.
This is used in conjunction with FromId and FromIdType. For instance:
component.Config("FromIdCount=2"); component.Config("FromId[0]=id1"); component.Config("FromIdType[0]=mytype"); component.Config("FromId[1]=id2"); When receiving a message with multiple Ids, query these settings to read the values. By default this value is unspecified and only a single Id is used as specified in the Id field of AS4From. | |||||||||||||||
FromIdType[i]: The Id type of the party specified by AS4From.This setting sets the Id type of the party specified by AS4From at the index specified here. This is only used when multiple Ids are set. See FromIdCount for more details. | |||||||||||||||
IdRight:
A custom Id for the right side of the MessageId.This setting may be used to specify a custom value for the right side of the MessageId that is generated by
the component. By default the component will automatically generate message Ids in the format:
2a1546bd-d623-4e7f-bb8d-ddecfb4de51c@nsoftwareThis setting provides a way to replace the "nsoftware" value after the "@" symbol with another value. | |||||||||||||||
IncludeHeaders: Whether headers are included when posting to a file.This setting determines if headers are included in the file when using PostToFile. By default this value is true. When set to False headers are not included in the content written to the file. When set to False this also allows data to be streamed directly to the file specified by PostToFile without any substantial memory overhead or the use of EncodeToTempDir. After posting to a file check the MessageHeaders to obtain the headers. This setting should only be used when PostToFile is set. | |||||||||||||||
KeyEncryptionAlgorithm:
The algorithm used to encrypt the key.This setting specifies the algorithm used to encrypt the key for this message. In most cases
this should not be changed. Only change this value if there is a specific reason to do so.
Possible values are:
| |||||||||||||||
LogLevel:
The level of information to log.This setting specifies the level of detail that is logged to the Log event and to any log files on disk.
Possible value are:
| |||||||||||||||
LogOptions:
The information to be written to log files.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=Incoming, Outgoing, Log"). The default value is All.
Possible values are:
| |||||||||||||||
MessageHeaders: Returns the headers of the message.This setting returns the headers of the generated message when IncludeHeaders is False and PostToFile is set. It should not be used in any other cases. | |||||||||||||||
MessageType:
Indicates the type of message received.This property may be used to determine what type of message was received in a request. Requests may be used
for multiple functions. For instance a request may contain a pull request and a receipt. This setting may
be used as a bitmask to determine which combination of types are present. To inspect the message perform
a binary 'AND' with one or more of the following values:
int requestType = Int32.Parse(AS4Server.Config("MessageType")); if((requestType & 1) != 0) //The request contains a pull request | |||||||||||||||
NormalizeIssuerSubject:
Whether to normalize the certificate subject within the X509Data element.If set to True (default) the component will normalize the X509IssuerName element within the request to
conform to RFC 2253. If set to False the component will use a standard format used by other components
within the toolkit, which may not be compatible with all other AS4 software.
The default value is True to maximize interoperability with other AS4 software. | |||||||||||||||
OAEPMGF1HashAlgorithm:
The MGF1 hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the MGF1 hash algorithm used for the encryption key by RSA OAEP.
Possible values are:
Note: If Profile is set to ENTSOG the MGF1HashAlgorithm will be set to "SHA256" by default. | |||||||||||||||
OAEPParams: The hex encoded OAEP parameters to be used when encrypting a key.This setting is optional and should only be specified if OAEP parameters need to be explicitly set. The value specified should be a hex string. By default this setting is unspecified. | |||||||||||||||
OAEPRSAHashAlgorithm:
The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key.
This may differ from the hash algorithm used to sign the AS4 message content. Possible values are:
| |||||||||||||||
Password:
A password if authentication is to be used.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. | |||||||||||||||
PostToFile: Creates the message on disk.This setting allows for the message to be created on disk without actually being sent. This is useful in certain situations to prepare the message where it is sent by a different transport mechanism at a later time. This should be set to a relative or absolute file path including the filename. When this is set the component will immediately start processing the message and writing to the specified file. | |||||||||||||||
PullAction: The Action to use with selective message pulling.When calling ReceiveFiles this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. | |||||||||||||||
PullAgreementRef: The AgreementRef to use with selective message pulling.When calling ReceiveFiles this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. | |||||||||||||||
PullRefToMessageId: The RefToMessageId to use with selective message pulling.When calling ReceiveFiles this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. | |||||||||||||||
PullService: The Service to use with selective message pulling.When calling ReceiveFiles this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. | |||||||||||||||
PullServiceType: The ServiceType to use with selective message pulling.When calling ReceiveFiles this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. | |||||||||||||||
ReferenceHashAlgorithm:
The hash algorithm used to has the data specified in the reference of a signature.When signing the content being signed is referred to by a reference in the Signature element. This setting
specifies the hash algorithm used when computing the reference digest. Possible values are:
| |||||||||||||||
RequireEncryption: Whether encryption is required when processing received messages.This setting may be set to True to require that received messages are encrypted. When True if a message is received that is not encrypted the component will throw an exception. The default value is False. | |||||||||||||||
RequireSignature: Whether a signature is required when processing received messages.This setting may be set to True to require that received messages are signed. When True if a message is received that is not signed the component will throw an exception. The default value is False. | |||||||||||||||
ResponseFile: A file from which to read the response.This setting specifies a file from which the response is read. This may be useful in cases where the response is not received directly by the component. For instance it may be useful in debugging. If ResponseHeaders is not specified they will be read from file. | |||||||||||||||
ResponseHeaders: The headers for the AS4 response message.This setting specifies the headers to be used in conjunction with ResponseFile to provide the request to the component. See ResponseFile for details. | |||||||||||||||
SignerCACert:
The CA certificates that issued the signer certificate.This setting may be set prior to signature verification when receiving messages that are signed using a certificate
specified in the message itself as a BinarySecurityToken.
If this setting is specified, the component will verify the chain of the signer certificate against the CA
list set in this setting. To specify one or more CA certificate prior to signature verification set
this to the base64 encoded public certificate of each CA certificate. Each additional certificate can be
added by prepending the data with a + character. If the value begins with a + the component
will add the following value to an internal store of CA certificates. For instance:
//Add the first CA certificate
as4.Config("SignerCACert=MIICFDCCAX2g...");
//Add another CA certificate (Note the leading '+')
as4.Config("SignerCACert=+MIICHDCCAYW...");
If the chain validation fails during signature verification the component throws an exception. If this setting is not specified no chain validation is performed. | |||||||||||||||
SigningSecurityTokenFormat:
The format to use for the security token when signing.This setting specifies the security token format that is included in the message when signing.
This setting should only be set if there is a specific reason to do so. This specifies the reference
type in the SecurityTokenReference element applicable to the signed data. Possible values
are:
The default value is 0 (X509) and should not be changed unless there is a specific reason to do so. Note: The default value when Profile is set to e-SENS is 1 (Binary). | |||||||||||||||
TempPath: Where temporary files are optionally written.When processing large files an excessive amount of memory may be used, leading to out-of-memory exceptions. To reduce the amount of memory used, partially encoded files can be written to a temporary directory. Set this to a folder on disk where temporary files may be written. | |||||||||||||||
ToId[i]: The Id of the party specified by AS4To.This setting sets the Id of the party specified by AS4To at the index specified here. This is only used when multiple Ids are set. See ToIdCount for more details. | |||||||||||||||
ToIdCount:
The number of Ids for the party specified by AS4To.Multiple Ids may be specified for the AS4To party. This setting defines the total number of Ids.
This is used in conjunction with ToId and ToIdType. For instance:
component.Config("ToIdCount=2"); component.Config("ToId[0]=id1"); component.Config("ToIdType[0]=mytype"); component.Config("ToId[1]=id2"); When receiving a message with multiple Ids, query these settings to read the values. By default this value is unspecified and only a single Id is used as specified in the Id field of AS4To. | |||||||||||||||
ToIdType[i]: The Id type of the party specified by AS4To.This setting sets the Id type of the party specified by AS4To at the index specified here. This is only used when multiple Ids are set. See ToIdCount for more details. | |||||||||||||||
TransformReceipt:
Whether to canonicalize the received receipt.When a receipt is received this setting controls whether the value in Content is transformed.
When set to True (default) the component will perform canonicalize the receipt when it is received. This may be helpful if the value of Content is to be used in a later process where a valid XML document is required. When set to true (false by default), the component will transform the receipt content made available in the component using Exclusive XML Canonicalization. If False the component will not alter the received receipt. The value of Content will not itself be a well formed XML document. | |||||||||||||||
UseNonce:
Whether to use a nonce in UsernameToken authentication.This setting specifies whether a nonce is included in the UsernameToken authentication when ReceiveFiles is called.
If True (default) the component will generate and include a nonce. This is recommended for security purposes.
If set to False the component will not include a nonce in the request.
See TokenUser and TokenPassword for more details. | |||||||||||||||
User:
A user name if authentication is to be used.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. | |||||||||||||||
WriteLogFilesToEvent: Whether to log the contents of the LogFiles in the Log event.When LogDirectory is set, several pieces of information are written to log files in the specified directory. When WriteLogFilesToEvent is True the log data will also be output in the Log event. The Message parameter will contain the hex-encoded string value of the log data and the LogType parameter will indicate the associated log's file extension (LOG, DAT.OUT, DAT.IN, IEB, or OEB). |
HTTP Configuration Settings
AcceptEncoding: Used to tell the server which types of content encodings the client supports.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. | |||||||||
AllowHTTPCompression:
This property enables HTTP compression for receiving data.This setting enables HTTP compression for receiving data.
When set to True (default), the component will accept compressed data. It will then uncompress the data it has received. The component will handle data compressed by both GZIP and Deflate compression algorithms.
When true, the component adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate". The default value is True. | |||||||||
AllowHTTPFallback:
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server
does not support HTTP/2. This setting is only applicable when HTTPVersion is set to "2.0".
If set to True (default) the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the component throws an exception if the server does not support HTTP/2. The default value is True. | |||||||||
AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.This setting only applies when AuthScheme is set to Negotiate. If set to True the component will automatically use NTLM if the server does not support Negotiate authentication. Note that the server must indicate it supports NTLM authentication via the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False. | |||||||||
Append: Whether to append data to LocalFile.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. | |||||||||
Authorization:
The Authorization string to be sent to the server.
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]". | |||||||||
BytesTransferred: Contains the number of bytes transferred in the response data. 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. | |||||||||
ChunkSize: Specifies the chunk size in bytes when using 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. | |||||||||
CompressHTTPRequest:
Set to true to compress the body of a PUT or POST request.If set to true, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-encoding" header is also added to the outgoing request.
The default value is False. | |||||||||
EncodeURL: If set to true the URL will be encoded by the component.If set to True the URL passed to the component will be URL encoded. The default value is False. | |||||||||
FollowRedirects:
Determines what happens when the server issues a redirect.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:
| |||||||||
GetOn302Redirect: If set to true the component will perform a GET on the new location.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. | |||||||||
HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically these headers are inserted into the table via incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. | |||||||||
HTTPVersion:
The version of HTTP used by the component.This property specifies the HTTP version used by the component. Possible values are:
When using HTTP/2 ("2.0") additional restrictions apply. Please see notes below for details.
HTTP/2 NotesWhen using HTTP/2 only secure (TLS/SSL) connections are currently supported. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2 the component will automatically use HTTP/1.1 instead. This is done in order to provide compatibility without the need for any additional settings. To see which version was used check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed. HTTP/2 is supported on all versions of Windows. If the Windows version is prior to Windows 8.1/Windows Server 2012 R2 the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later the system security libraries will be used by default. | |||||||||
IfModifiedSince:
A date determining the maximum age of the desired document.If this setting contains a non-empty string, an If-Modified-Since HTTP header is added to the request.
The value of this header is used to make the HTTP request conditional: if the requested documented has not
been modified since the time specified in the field, a copy of the document will not be returned from
the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is:
Sat, 29 Oct 2017 19:43:31 GMT. | |||||||||
KeepAlive:
Determines whether the HTTP connection is closed after completion of the request.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. | |||||||||
KerberosSPN: The Service Principal Name for the Kerberos Domain Controller. 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. | |||||||||
LogLevel:
The level of detail that is logged.This setting controls the level of detail that is logged through the Log event. Possible values are:
The value 1 (Info) logs basic information including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). | |||||||||
MaxHeaders:
Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.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. | |||||||||
MaxHTTPCookies:
Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.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. | |||||||||
MaxRedirectAttempts: Limits the number of redirects that are followed in a request.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. | |||||||||
NegotiatedHTTPVersion: The negotiated HTTP version.This setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" if the server does not support "2.0" the component will fallback to using "1.1" automatically. This setting will indicate which was used. | |||||||||
OtherHeaders:
Other headers as determined by the user (optional).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. | |||||||||
ProxyAuthorization: The authorization string to be sent to the proxy server.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. | |||||||||
ProxyAuthScheme: The authorization scheme to be used for the proxy.This is the same as AuthScheme. This setting is provided for use by components that do not directly expose Proxy properties. | |||||||||
ProxyPassword: A password if authentication is to be used for the proxy.This is the same as Password. This setting is provided for use by components that do not directly expose Proxy properties. | |||||||||
ProxyPort: Port for the proxy server (default 80).This is the same as Port. This setting is provided for use by components that do not directly expose Proxy properties. | |||||||||
ProxyServer: Name or IP address of a proxy server (optional).This is the same as Server. This setting is provided for use by components that do not directly expose Proxy properties. | |||||||||
ProxyUser: A user name if authentication is to be used for the proxy.This is the same as User. This setting is provided for use by components that do not directly expose Proxy properties. | |||||||||
SentHeaders: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. | |||||||||
StatusLine: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description]. | |||||||||
TransferredData: The contents of the last response from the server.This setting contains the contents of the last response from the server. | |||||||||
TransferredDataLimit: The maximum number of incoming bytes to be stored by the component.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. | |||||||||
TransferredHeaders: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. | |||||||||
TransferredRequest:
The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this config to ON before making a request to enable it. Examples are below.
.NET
Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest"));C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); | |||||||||
UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.
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. | |||||||||
UseIDNs:
Whether to encode hostnames to internationalized domain names.This setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names.
When set to True if a hostname contains non-ASCII characters it is encoded using Punycode to an IDN.
The default value is False and the hostname will always be used exactly as specified. | |||||||||
UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.This setting specifies whether the platform deflate algorithm implementation is used to decompress responses that use compression. If set to True (default) the platform implementation is used. If set to False an internal implementation is used. | |||||||||
UsePlatformHTTPClient: Whether or not to use the platform HTTP client.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). | |||||||||
UserAgent:
Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default
setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software. |
IPPort Configuration Settings
CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.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. | |||||||||||
ConnectionTimeout: Sets a separate timeout value for establishing a connection.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. | |||||||||||
FirewallAutoDetect: Tells the component whether or not to automatically detect and use firewall system settings, if available.This is the same as AutoDetect. This setting is provided for use by components that do not directly expose Firewall properties. | |||||||||||
FirewallHost:
Name or IP address of firewall (optional).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. | |||||||||||
FirewallListener:
If true, the component binds to a SOCKS firewall as a server (IPPort only).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. | |||||||||||
FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.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. | |||||||||||
FirewallPort:
The TCP port for the FirewallHost;.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. | |||||||||||
FirewallType:
Determines the type of firewall to connect through.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. | |||||||||||
FirewallUser:
A user name if authentication is to be used connecting through a firewall.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. | |||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.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. | |||||||||||
KeepAliveTime:
The inactivity time in milliseconds before a TCP keep-alive packet is sent.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. | |||||||||||
Linger:
When set to True, connections are terminated gracefully.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: Time in seconds to have the connection linger. 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. | |||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
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). | |||||||||||
LocalPort:
The port in the local host where the component binds.
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:
The maximum amount of data to accumulate when no EOL is found.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. | |||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.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. | |||||||||||
ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This setting optionally specifies a semicolon separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property the proxy will not be used. For instance:
www.google.com;www.nsoftware.com | |||||||||||
TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.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. | |||||||||||
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. | |||||||||||
UseIPv6:
Whether to use IPv6.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:
| |||||||||||
UseNTLMv2: Whether to use NTLM V2.When authenticating with NTLM this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2. |
SSL Configuration Settings
CACertFilePaths:
The paths to CA certificate files when using Mono on Unix/Linux.This setting specifies the paths on disk to CA certificate files when using Mono on Unix/Linux. It
is not applicable in any other circumstances.
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server certificates. The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem | |||||||||||||||||||||||||
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if UseInternalSecurityAPI is False. | |||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the component will reuse the context if and only if the following criteria are met:
| |||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- | |||||||||||||||||||||||||
SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the component will check the Certificate Revocation List specified by the server certificate. If set to true the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.
When set to false (default) the CRL check will not be performed by the component. | |||||||||||||||||||||||||
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. 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. | |||||||||||||||||||||||||
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 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 UseInternalSecurityAPI is False (default):
obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");Possible values when UseInternalSecurityAPI is False (default) include:
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");Possible values when UseInternalSecurityAPI is True include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
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:
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList setting. 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. | |||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when UseInternalSecurityAPI is set to true. | |||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. 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. | |||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
| |||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| |||||||||||||||||||||||||
SSLProvider:
The name of the security provider to use.
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. The special value "Internal" picks the internal SSL implementation. This does not rely on any system libraries. This is equivalent to setting UseInternalSecurityAPI to True. Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed except to a value of "Internal". | |||||||||||||||||||||||||
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:
This functionality is currently not available in Java or when the provider is OpenSSL. | |||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- | |||||||||||||||||||||||||
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 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("UseInternalSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-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:
| |||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
| |||||||||||||||||||||||||
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:
|
Socket Configuration 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.
Note: This option is not valid for UDP ports. | |
FirewallData: Used to send extra data to the firewall.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). | |
InBufferSize:
The size in bytes of the incoming queue of the socket.
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. | |
OutBufferSize:
The size in bytes of the outgoing queue of the socket.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. |
Base Configuration Settings
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | |
GUIAvailable:
Tells the component whether or not a message loop is available for processing events.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. | |
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
| |
UseInternalSecurityAPI:
Tells the component whether or not to use the system security libraries or an internal implementation.
By default the component will use the system security libraries to perform cryptographic functions.
When set to False 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 implementation
instead of using the system's security API.
Note: This setting is static. The value set is applicable to all components used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |