AS4Client Component

Properties Methods Events Config Settings Errors

The AS4Client component connects to a server to send or receive files.

Syntax

TibeAS4Client

Remarks

The AS4Client component may be used to send or receive files from a server. The component will connect to a server and either send files (push), or request files to download (pull).

Sending Files

SendFiles sends the files specified by EDIData to URL.

Before calling this method set AgreementRef to the agreement identifier used by both parties. Set AS4From and AS4To. Set EDIData specifies the file(s) to be sent. To encrypt the data set RecipientCerts. To sign the data set SigningCert. The SignerCert property should be set to verify the signed receipt.

When this method is called the file(s) will be sent and any returned receipts will be verified.

To indicate a synchronous receipt is expected set ReceiptReplyMode to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):

AgreementRef
AS4From
AS4To
EDIData
URL
RecipientCerts (required to encrypt)
SignerCert (required to verify signed receipts)
SigningCert (required to sign files)
ConversationId (optional)
EncryptionAlgorithm (optional)
LogDirectory (optional)
MessageId (optional)
MessageProperties (optional)
Profile (optional)
ReceiptReplyMode
Service (optional)
ServiceType (optional)
SignatureAlgorithm (optional)

SendFiles Example (synchronous receipt): client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing file. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s) and verify the receipt. client.SendFiles();

The component also supports asynchronous receipts. In this configuration a file is sent from the component to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The AS4Server component may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either AS4Server or AS4Client may be used to verify the receipt.

Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set AsyncReceiptInfoDir before calling SendFiles. The component will automatically store the required information.

See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.

To indicate an asynchronous receipt is expected set ReceiptReplyMode to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):

AgreementRef
AS4From
AS4To
AsyncReceiptInfoDir
EDIData
URL
RecipientCerts (required to encrypt)
SignerCert (required to verify signed receipts)
SigningCert (required to sign files)
ConversationId (optional)
EncryptionAlgorithm (optional)
LogDirectory (optional)
MessageId (optional)
MessageProperties (optional)
OriginalSOAPMessage (optional)
OriginalSOAPMessageId (optional)
Profile (optional)
ReceiptReplyMode
Service (optional)
ServiceType (optional)
SignatureAlgorithm (optional)

SendFiles Example (asynchronous receipt): client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.AsyncReceiptInfoDir = "C:\\async_info"; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing files. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s). client.SendFiles();

At this point the file(s) have been sent, but a receipt has not yet been received. AS4Server can be used within a web site to listen for the receipt. //**** Inside a web site **** As4server server = new As4server; server.ReadRequest(); if (!String.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.AsyncReceiptInfoDir = "C:\\async_info"; server.VerifyReceipt(); //The receipt is now verified }

Receiving Files

ReceiveFiles establishes a connection to the server specified by URL and receives files.

The MPC specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If IncomingDirectory is set before calling this method the files will be written to the specified folder, otherwise inspect EDIData to obtain the received file data. The following properties are applicable when calling this method:

SigningCert (required to sign the request)
Certificate (required for decryption)
SignerCert (required for signature verification)
URL
IncomingDirectory (optional)
LogDirectory
MPC
TokenUser
TokenPassword
TokenPasswordType

After calling this method the following properties will be populated and may be inspected:

AS4From
AS4To
AgreementRef
ConversationId
Service
ServiceAction
ServiceType
MessageId
Receipt

The Receipt property will be populated with the receipt corresponding to the received message, but it is not yet delivered. The receipt may be delivered by bundling it with another request to receive files, or by calling SendReceipt.

To bundle the receipt with a subsequent ReceiveFiles call the Receipt property must hold the receipt. If the same instance of the component is being used this is already true since Receipt is populated automatically after receiving the file. To use another instance of the component for multiple calls to ReceiveFiles be sure to save the Receipt's Content and RefToMessageId values for later use.

ReceiveFiles Example: client.Profile = As4clientProfiles.ebpfENTSOG; //Company A's private certificate. Used for signing the request. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company A's private certificate. Used for decrypting the file. client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used for signature verification. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; //Message Channel id client.MPC = "mpc_a"; client.IncomingDirectory = "C:\\incoming_dir"; client.ReceiveFiles(); //Inspect client.AgreementRef and other properties for information about the received files Console.WriteLine(client.AgreementRef); Console.WriteLine(client.AS4From.Id); Console.WriteLine(client.AS4To.Id); Console.WriteLine(client.ConversationId); //Save the receipt for later use string receiptContent = client.Receipt.Content; string receiptRefId = client.Receipt.RefToMessageId;

At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message will be included with the request. client.Receipt = new EBReceipt(receiptRefId, receiptContent); client.ReceiveFiles(); //This will now include the bundled receipt

Sending Asynchronous Receipts

SendReceipt sends an asynchronous receipt to the URL.

This method is typically used in conjunction with AS4Server to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate Receipt and call this method.

//Send an asynchronous receipt client.URL = ""http://www.company.com:9090/msh""; client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content); client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.SendReceipt();

Property List

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


AgreementRef	The agreement reference.
AS4From	Defines information about the originating party.
AS4To	Defines information about the responding party.
AsyncReceiptInfoDir	A directory to hold information used for asynchronous receipt verification.
CertEncoded	This is the certificate (PEM/base64 encoded).
CertStore	This is the name of the certificate store for the client certificate.
CertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
CertStoreType	This is the type of certificate store for this certificate.
CertSubject	This is the subject of the certificate used for client authentication.
CompressionFormat	The compression format (if any) to use.
ConversationId	The Conversation Id of the message.
Cookies	This property includes a collection of cookies.
EDIData	The EDI data.
EncryptionAlgorithm	The algorithm used to encrypt the EDI data.
Errors	A collection of errors.
Firewall	A set of properties related to firewall access.
IncomingDirectory	The directory to which incoming files are saved.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LogDirectory	The path to a directory for logging.
LogFile	The log file written.
MessageId	The unique Id of the message.
MessageProperties	A collection of message properties.
MPC	The MPC (Message Partition Channel) from which to receive files.
OriginalSOAPMessage	The original SOAP message used to verify the receipt.
OriginalSOAPMessageId	The original SOAP message Id used to verify the receipt.
Profile	The AS4 profile.
Proxy	This property includes a set of properties related to proxy access.
Receipt	The receipt of a message.
ReceiptReplyMode	The expected receipt reply mode.
RecipientCertCount	The number of records in the RecipientCert arrays.
RecipientCertEncoded	This is the certificate (PEM/base64 encoded).
RefToMessageId	Specifies the RefToMessageId in the message.
Service	The service which acts on the message.
ServiceAction	The action within a service that acts on the message.
ServiceType	The type of service.
SignatureAlgorithm	Signature algorithm to be used in the message.
SignerCertEncoded	This is the certificate (PEM/base64 encoded).
SignerCertStore	This is the name of the certificate store for the client certificate.
SignerCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SignerCertStoreType	This is the type of certificate store for this certificate.
SignerCertSubject	This is the subject of the certificate used for client authentication.
SigningCertEncoded	This is the certificate (PEM/base64 encoded).
SigningCertStore	This is the name of the certificate store for the client certificate.
SigningCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SigningCertStoreType	This is the type of certificate store for this certificate.
SigningCertSubject	This is the subject of the certificate used for client authentication.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
TokenPassword	The password used in UsernameToken authentication.
TokenPasswordType	The password type used in UsernameToken authentication.
TokenUser	The username used in UsernameToken authentication.
URL	The URL to which the request is made.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
ReceiveFiles	Connects to a server to receive files.
Reset	Resets the state of the control.
SendFiles	Sends file(s) to the specified server and verify the receipt (if present).
SendReceipt	Sends an asynchronous receipt.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Connected	This event is fired immediately after a connection completes (or fails).
Disconnected	This event is fired when a connection is closed.
EndTransfer	This event is fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	This event is fired every time a header line comes in.
Log	Fired with log information while processing a message.
RecipientInfo	Fired for each recipient certificate of the encrypted message.
SetCookie	This event is fired for every cookie set by the server.
SignerCertInfo	This event is fired during verification of the signed message.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	This event is fired when a document starts transferring (after the headers).
TokenAuthentication	Fired when the server makes use of UsernameToken authentication.
Transfer	This event is fired while a document transfers (delivers document).

Config Settings

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


AgreementRefPMode	AgreementRef PMode of message.
AgreementRefType	The type of AgreementRef.
AllowWarnings	Whether warnings are interpreted as fatal errors.
AttachXMLFiles	Whether to send XML files as attachments or within the SOAP body.
Authorization	The Authorization string to be sent to the server.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
CloseStreamAfterProcessing	Whether to close the input or output stream after processing.
CompressXMLPayloads	Whether to compress XML data.
ContentTransferEncoding	The content encoding of the payload data.
DetectDuplicates	Whether to detect duplicate messages when receiving.
EBPrefix	Specifies the prefix to use for messaging.
EDIDataPartId[i]	Specified the part Id at the given index.
EncryptionSecurityTokenFormat	The format to use for the security token when encryption.
FilenameProperty	Defines a part property to hold the filename.
ForceSigningCert	Whether to force only the SigningCert to be used for signing.
FromId[i]	The Id of the party specified by AS4From.
FromIdCount	The number of Ids for the party specified by AS4From.
FromIdType[i]	The Id type of the party specified by AS4From.
IdRight	A custom Id for the right side of the MessageId.
IncludeHeaders	Whether headers are included when posting to a file.
KeyEncryptionAlgorithm	The algorithm used to encrypt the key.
LogLevel	The level of information to log.
LogOptions	The information to be written to log files.
MessageHeaders	Returns the headers of the message.
MessageType	Indicates the type of message received.
NormalizeIssuerSubject	Whether to normalize the certificate subject within the X509Data element.
OAEPMGF1HashAlgorithm	The MGF1 hash algorithm used when encrypting a key.
OAEPParams	The hex encoded OAEP parameters to be used when encrypting a key.
OAEPRSAHashAlgorithm	The RSA hash algorithm used when encrypting a key.
Password	A password if authentication is to be used.
PostToFile	Creates the message on disk.
PullAction	The Action to use with selective message pulling.
PullAgreementRef	The AgreementRef to use with selective message pulling.
PullRefToMessageId	The RefToMessageId to use with selective message pulling.
PullService	The Service to use with selective message pulling.
PullServiceType	The ServiceType to use with selective message pulling.
ReferenceHashAlgorithm	The hash algorithm used to has the data specified in the reference of a signature.
RequireEncryption	Whether encryption is required when processing received messages.
RequireSignature	Whether a signature is required when processing received messages.
ResponseFile	A file from which to read the response.
ResponseHeaders	The headers for the AS4 response message.
SignerCACert	The CA certificates that issued the signer certificate.
SigningSecurityTokenFormat	The format to use for the security token when signing.
TempPath	Where temporary files are optionally written.
ToId[i]	The Id of the party specified by AS4To.
ToIdCount	The number of Ids for the party specified by AS4To.
ToIdType[i]	The Id type of the party specified by AS4To.
TransformReceipt	Whether to canonicalize the received receipt.
UseNonce	Whether to use a nonce in UsernameToken authentication.
User	A user name if authentication is to be used.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseFIPSCompliantAPI	Tells the component whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

AgreementRef Property (AS4Client Component)

The agreement reference.

Syntax

property AgreementRef: String read get_AgreementRef write set_AgreementRef;

Default Value

Remarks

This property holds a value identifying the agreement between the two parties. The agreement is made outside the scope of the request and response and governs details about the interaction including reply mode, signing and encryption options, etc.

The value of this property should be set to a mutually agreed upon identifier. Both parties will use this value know what the expected requirements are for a particular request or response.

The format of this value is typically a URI, such as "http://mycompany.com/agreement_01" but can be any unique string that both parties are configured to accept. Another common format is the concatenation of the AS4From and AS4To values.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef"

AS4From Property (AS4Client Component)

Defines information about the originating party.

Syntax

property AS4From: TibeEBPartyInfo read get_AS4From write set_AS4From;

Remarks

This property defines information about the party that originates the message.

AS4To Property (AS4Client Component)

Defines information about the responding party.

Syntax

property AS4To: TibeEBPartyInfo read get_AS4To write set_AS4To;

Remarks

This property defines information about the party that receives the message.

AsyncReceiptInfoDir Property (AS4Client Component)

A directory to hold information used for asynchronous receipt verification.

Syntax

property AsyncReceiptInfoDir: String read get_AsyncReceiptInfoDir write set_AsyncReceiptInfoDir;

Default Value

Remarks

This setting specifies a directory which holds information about the original message that was sent.

When sending files and requesting asynchronous receipts set this directory to a location where data can be stored. When the receipt is later received this property should be set so original message information can be read in order to verify the receipt.

As an alternative the original message information may be manually stored by saving the values of OriginalSOAPMessage and OriginalSOAPMessageId after sending a file. In this case OriginalSOAPMessage and OriginalSOAPMessageId should be populated before verifying the receipt.

See the VerifyReceipt method of AS4Server for more details about verifying asynchronous receipts.

CertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property CertEncoded: String read get_CertEncoded write set_CertEncoded;
property CertEncodedB: TBytes read get_CertEncodedB write set_CertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

This property is not available at design time.

CertStore Property (AS4Client Component)

This is the name of the certificate store for the client certificate.

Syntax

property CertStore: String read get_CertStore write set_CertStore;
property CertStoreB: TBytes read get_CertStoreB write set_CertStoreB;

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

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

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.

Designations of certificate stores are platform-dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

CertStorePassword Property (AS4Client Component)

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

Syntax

property CertStorePassword: String read get_CertStorePassword write set_CertStorePassword;

Default Value

Remarks

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

CertStoreType Property (AS4Client Component)

This is the type of certificate store for this certificate.

Syntax

property CertStoreType: TibeCertStoreTypes read get_CertStoreType write set_CertStoreType;

TibeCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

CertSubject Property (AS4Client Component)

This is the subject of the certificate used for client authentication.

Syntax

property CertSubject: String read get_CertSubject write set_CertSubject;

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

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

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

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

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

CompressionFormat Property (AS4Client Component)

The compression format (if any) to use.

Syntax

property CompressionFormat: TibeTAS4CompressionFormats read get_CompressionFormat write set_CompressionFormat;

TibeTAS4CompressionFormats = (
  ebcfNone,
  ebcfGZIP
);

Default Value

ebcfNone

Remarks

This setting specifies the compression format to be applied to the parts specified by EDIData. When Profile is set to Standard the default value is 0 (ebcfNone). When Profile is set to ENTSOG or eDelivery the default value is 1 (ebcfGZIP).

Possible values are:

0 (ebcfNone - default for Standard)
1 (ebcfGZIP - default for ENTSOG and eDelivery)

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.

ConversationId Property (AS4Client Component)

The Conversation Id of the message.

Syntax

property ConversationId: String read get_ConversationId write set_ConversationId;

Default Value

Remarks

This property specifies an Id that may be used to identify a set of related messages. This is required and if a value is not specified one will automatically be created.

Note: When Profile is set to ebpfENTSOG this value will always be empty.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:ConversationId"

Cookies Property (AS4Client Component)

This property includes a collection of cookies.

Syntax

property Cookies: TibeHTTPCookieList read get_Cookies write set_Cookies;

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

EDIData Property (AS4Client Component)

The EDI data.

Syntax

property EData: TibeEBDataList read get_EDIData write set_EDIData;

Remarks

This property defines the EDI data to be sent. This may include multiple files.

This property is not available at design time.

EncryptionAlgorithm Property (AS4Client Component)

The algorithm used to encrypt the EDI data.

Syntax

property EncryptionAlgorithm: String read get_EncryptionAlgorithm write set_EncryptionAlgorithm;

Default Value

'AES128GCM'

Remarks

If RecipientCerts contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The component supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The component supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

Possible values are:

3DES
DES
AESCBC128
AESCBC192
AESCBC256
AES128GCM (default)
AES192GCM
AES256GCM

Errors Property (AS4Client Component)

A collection of errors.

Syntax

property Errors: TibeEBErrorList read get_Errors write set_Errors;

Remarks

This property is populated with error information. There may be one or more errors.

Common errors defined in the ebMS specifications are listed below for reference.


Error Code	Short Description	Severity	Category	Description
EBMS:0001	ValueNotRecognized	failure	Content	Although the message document is well formed and schema valid, some element/attribute contains a value that could not be recognized and therefore could not be used by the MSH
EBMS:0002	FeatureNotSupported	warning	Content	Although the message document is well formed and schema valid, some element/attribute value cannot be processed as expected because the related feature is not supported by the MSH.
EBMS:0003	ValueInconsistent	failure	Content	Although the message document is well formed and schema valid, some element/attribute value is inconsistent either with the content of other element/attribute, or with the processing mode of the MSH, or with the normative requirements of the ebMS specification.
EBMS:0004	Other	failure	Content
EBMS:0005	ConnectionFailure	failure	Communication	The MSH is experiencing temporary or permanent failure in trying to open a transport connection with a remote MSH.
EBMS:0006	EmptyMessagePartitionChannel	warning	Communication	There is no message available for pulling from this MPC at this moment.
EBMS:0007	MimeInconsistency	failure	Unpackaging	The use of MIME is not consistent with the required usage in this specification.
EBMS:0008	FeatureNotSupported	failure	Unpackaging	Although the message document is well formed and schema valid, the presence or absence of some element/ attribute is not consistent with the capability of the MSH, with respect to supported features.
EBMS:0009	InvalidHeader	failure	Unpackaging	The ebMS header is either not well formed as an XML document, or does not conform to the ebMS packaging rules
EBMS:0010	ProcessingModeMismatch	failure	Processing	The ebMS header or another header (e.g. reliability, security) expected by the MSH is not compatible with the expected content, based on the associated P-Mode.
EBMS:0011	ExternalPayloadError	failure	Content	The MSH is unable to resolve an external payload reference (i.e. a Part that is not contained within the ebMS Message, as identified by a PartInfo/href URI).
EBMS:0101	FailedAuthentication	failure	Processing	The signature in the Security header intended for the "ebms" SOAP actor, could not be validated by the Security module.
EBMS:0102	FailedDecryption	failure	Processing	The encrypted data reference the Security header intended for the "ebms" SOAP actor could not be decrypted by the Security Module.
EBMS:0103	PolicyNoncompliance	failure	Processing	The processor determined that the message's security methods, parameters, scope or other security policy-level requirements or agreements were not satisfied.
EBMS:0201	DysfunctionalReliability	failure	Processing	Some reliability function as implemented by the Reliability module, is not operational, or the reliability state associated with this message sequence is not valid
EBMS:0202	DeliveryFailure	failure	Communication	Although the message was sent under Guaranteed delivery requirement, the Reliability module could not get assurance that the message was properly delivered, in spite of resending efforts.
EBMS:0301	MissingReceipt	failure	Communication	A Receipt has not been received for a message that was previously sent by the MSH generating this error.
EBMS:0302	InvalidReceipt	failure	Communication	A Receipt has been received for a message that was previously sent by the MSH generating this error, but the content does not match the message content (e.g. some part has not been acknowledged, or the digest associated does not match the signature digest, for NRR).
EBMS:0303	Decompression-Failure	failure	Communication	An error occurred during the decompression.

Firewall Property (AS4Client Component)

A set of properties related to firewall access.

Syntax

property Firewall: TibeFirewall read get_Firewall write set_Firewall;

Remarks

This is a Firewall type property which contains fields describing the firewall through which the component will attempt to connect.

IncomingDirectory Property (AS4Client Component)

The directory to which incoming files are saved.

Syntax

property IncomingDirectory: String read get_IncomingDirectory write set_IncomingDirectory;

Default Value

Remarks

If IncomingDirectory is set, the received files will be stored in the specified directory. If a filename is specified in the EDI message, the component will write to the specified filename, otherwise, a filename will be automatically generated based on a timestamp of the incoming transmission. In either case, if the filename exists on disk, the data will be written to the same name with a "-duplicate?" appended to the filename, where "?" is the number of duplicates.

This property is optional, if not set file data will be stored in EDIData.

LocalHost Property (AS4Client Component)

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

Syntax

property LocalHost: String read get_LocalHost write set_LocalHost;

Default Value

Remarks

The LocalHost property 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 property 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).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

LogDirectory Property (AS4Client Component)

The path to a directory for logging.

Syntax

property LogDirectory: String read get_LogDirectory write set_LogDirectory;

Default Value

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the component will log the complete text of the outgoing request and the incoming response.

The component will write multiple log files for each transmission, with separate extensions for each type of data:


Status (.log)	Contains information about the steps taken during processing.
Request (.out)	Contains the raw request/response that is sent by the component.
Response (.in)	Contains the raw request/response that is received by the component.
Incoming ebXML (.ieb)	Contains the incoming ebXML message.
Outgoing ebXML (.oeb)	Contains the outgoing ebXML message.

One or more of these log files may be disabled by setting the LogOptions configuration setting. LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the component will attempt to create the directory. The following macros are supported:


%AS4From%	The AS4From value in the message. Note that invalid filename characters will be replaced with the `_` character.
%MessageId%	The MessageId of the transmission, after it is generated.
%Date:format%	Format is a platform-specific date/time formatting string. For example:

The filenames will be chosen automatically by the component. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension.

If logs cannot be written an exception will be thrown.

LogFile Property (AS4Client Component)

The log file written.

Syntax

property LogFile: String read get_LogFile;

Default Value

Remarks

If LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files written, minus the extension.

The component will write multiple log files for each transmission, with separate extensions for each type of data:


Status (.log)	Contains information about the steps taken during processing.
Request (.out)	Contains the raw request/response that is sent by the component.
Response (.in)	Contains the raw request/response that is received by the component.
Incoming ebXML (.ieb)	Contains the incoming ebXML message.
Outgoing ebXML (.oeb)	Contains the outgoing ebXML message.


%AS4From%	The AS4From value in the message. Note that invalid filename characters will be replaced with the `_` character.
%MessageId%	The MessageId of the transmission, after it is generated.
%Date:format%	Format is a platform-specific date/time formatting string. For example:

If logs cannot be written an exception will be thrown.

This property is read-only.

MessageId Property (AS4Client Component)

The unique Id of the message.

Syntax

property MessageId: String read get_MessageId write set_MessageId;

Default Value

Remarks

This property defines the unique Id of the message. When sending files the component will automatically generate a value in the format "GUID@nsoftware". When receiving files the Id will be populated with the value read from the message.

In most cases there is no need to set this value, however if a file needs to be retransmitted using the same message Id for reliability this may be set. In AS4Client this may be set before calling SendFiles. In AS4Server this may be set after calling ReadRequest and before calling SendResponse.

This property is not available at design time.

MessageProperties Property (AS4Client Component)

A collection of message properties.

Syntax

property MessageProperties: TibeEBPropertyList read get_MessageProperties write set_MessageProperties;

Remarks

This collection specifies the message level properties that are sent with the message. This may be used to add additional values. The semantics of the values are beyond the scope of AS4, but this may be used for values that assist with processing, or other user-defined use cases.

These properties may be populated before sending a message, and are populated after parsing an incoming message.

Sending

When sending a message any number of properties may be added. The PropertyType property is optional. For instance: //using fields client.MessageProperties.Add(new EBProperty()); client.MessageProperties[0].Name = "name1"; client.MessageProperties[0].Value = "value1"; client.MessageProperties[0].PropertyType = "string"; //optional //using constructor client.MessageProperties.Add(new EBProperty("name2", "value2"));

Receiving

When receiving a message the properties may be read from this collection. For instance: for (int i = 0; i < server.MessageProperties.Count; i++) { Console.WriteLine(server.MessageProperties[i].Name + ": " + server.MessageProperties[i].Value); }

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties""

MPC Property (AS4Client Component)

The MPC (Message Partition Channel) from which to receive files.

Syntax

property MPC: String read get_MPC write set_MPC;

Default Value

Remarks

This property specifies the MPC (Message Partition Channel) from which to receive files. This must be set before calling ReceiveFiles. The value specified here must be known to the other party.

When left unspecified this indicates the default MPC.

This value corresponds to the ebMS element "eb:Messaging/eb:SignalMessage/eb:PullRequest/@mpc"

OriginalSOAPMessage Property (AS4Client Component)

The original SOAP message used to verify the receipt.

Syntax

property OriginalSOAPMessage: String read get_OriginalSOAPMessage write set_OriginalSOAPMessage;

Default Value

Remarks

OriginalSOAPMessage and OriginalSOAPMessageId may be used as an alternative to AsyncReceiptInfoDir when verifying receipts.

If AsyncReceiptInfoDir is not set when the original message is sent, these values will be populated after the send and the values should be saved.

Before verifying the receipt set these properties to their original values.

This property is not available at design time.

OriginalSOAPMessageId Property (AS4Client Component)

The original SOAP message Id used to verify the receipt.

Syntax

property OriginalSOAPMessageId: String read get_OriginalSOAPMessageId write set_OriginalSOAPMessageId;

Default Value

Remarks

OriginalSOAPMessage and OriginalSOAPMessageId may be used as an alternative to AsyncReceiptInfoDir when verifying receipts.

If AsyncReceiptInfoDir is not set when the original message is sent, these values will be populated after the send and the values should be saved.

Before verifying the receipt set these properties to their original values.

This property is not available at design time.

Profile Property (AS4Client Component)

The AS4 profile.

Syntax

property Profile: TibeTProfiles read get_Profile write set_Profile;

TibeTProfiles = (
  ebpfStandard,
  ebpfENTSOG,
  ebpfEDelivery
);

Default Value

ebpfStandard

Remarks

This property specifies the AS4 profile to use. Different profiles may have different requirements and default options. Setting this property to the correct value ensures that the right options are selected in order to conform to the profile. Possible values are:


0 (ebfStandard - default)	The AS4 Profile of ebMS 3.0 Version 1.0 OASIS Standard
1 (ebfENTSOG)	The ENTSOG AS4 Profile
2 (ebpfEDelivery)	The eDelivery AS4 Profile

When Profile is set to ebpfENTSOG the following settings are automatically applied:


Property	Value
CompressionFormat	ebcfGZIP
EncryptionAlgorithm	"AES128GCM"
ConversationId	Remains empty
SignatureAlgorithm	"SHA256"
OAEPRSAHashAlgorithm	"SHA256"
OAEPMGF1HashAlgorithm	"SHA256"

When Profile is set to ebpfEDelivery the following settings are automatically applied:


Property	Value
CompressionFormat	ebcfGZIP
EncryptionAlgorithm	"AES128GCM"
RequireEncryption	True
RequireSignature	True
SignatureAlgorithm	"SHA256"
OAEPRSAHashAlgorithm	"SHA256"
OAEPMGF1HashAlgorithm	"SHA256"
EncryptionSecurityTokenFormat	1 (Binary)
SigningSecurityTokenFormat	1 (Binary)

Proxy Property (AS4Client Component)

This property includes a set of properties related to proxy access.

Syntax

property Proxy: TibeProxy read get_Proxy write set_Proxy;

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

Receipt Property (AS4Client Component)

The receipt of a message.

Syntax

property Receipt: TibeEBReceipt read get_Receipt write set_Receipt;

Remarks

This property holds the receipt of a message.

Sending

When sending files if a synchronous receipt is returned in the response it is verified and this property is populated.

Receiving

When receiving files this property is populated with the receipt to send after a file is received. If this property is populated the receipt will be sent in the next request made by calling ReceiveFiles.

If the receipt is not to be bundled with a subsequent call to ReceiveFiles the SendReceipt method may be used to directly send a receipt to the other party.

ReceiptReplyMode Property (AS4Client Component)

The expected receipt reply mode.

Syntax

property ReceiptReplyMode: TibeTReceiptReplyModes read get_ReceiptReplyMode write set_ReceiptReplyMode;

TibeTReceiptReplyModes = (
  rrmSync,
  rrmAsync,
  rrmNone
);

Default Value

rrmSync

Remarks

This setting tells the component how to expect or deliver a receipt. Possible values are:


0 (rrmSync - default)	The receipt is expected in the response to the request. This is only valid when sending files from a client to a server (push). This is a synchronous receipt (the receipt is returned in the same HTTP connection).
1 (rrmAsync)	The receipt is returned at a later time. The receipt may be returned by itself in a separate connection, or may be bundled with a subsequent request. This is the only available mode when receiving files from a server (pull).
2 (rrmNone)	No receipt is expected.

It is important to always set this property to the correct value in both AS4Client and AS4Server, whether sending or receiving, so the component can build a valid message. This should be set to the previously agreed upon value between the parties in the agreement identified by AgreementRef

RecipientCertCount Property (AS4Client Component)

The number of records in the RecipientCert arrays.

Syntax

property RecipientCertCount: Integer read get_RecipientCertCount write set_RecipientCertCount;

Default Value

Remarks

This property controls the size of the following arrays:

RecipientCertEncoded

The array indices start at 0 and end at RecipientCertCount - 1.

This property is not available at design time.

RecipientCertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property RecipientCertEncoded[RecipientCertIndex: Integer]: String read get_RecipientCertEncoded write set_RecipientCertEncoded;
property RecipientCertEncodedB[RecipientCertIndex: Integer]: TBytes read get_RecipientCertEncodedB write set_RecipientCertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

RefToMessageId Property (AS4Client Component)

Specifies the RefToMessageId in the message.

Syntax

property RefToMessageId: String read get_RefToMessageId write set_RefToMessageId;

Default Value

Remarks

This property specifies the RefToMessageId value in the message being sent.

This property is only applicable when Profile is set to ebpfEDelivery. The eDelivery profile supports the Two-Way/Push-and-Push MEP (Message Exchange Pattern), where sending a file can be in reference to a previously received file. In this case RefToMessageId specifies the Id of the previously received message to which this send is in reference.

When sending with AS4Client this should only be set when using the eDelivery profile and need to explicitly specify the RefToMessageId value as per the Two-Way/Push-And-Push MEP.

When receiving with AS4Server this may be read after receiving a message.

Service Property (AS4Client Component)

The service which acts on the message.

Syntax

property Service: String read get_Service write set_Service;

Default Value

'http://docs.oasis-open.org/ebxml-msg/as4/200902/service'

Remarks

This property specifies the service which acts on the message. This should only be changed from the default value if there is a specific reason to do so.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service"

ServiceAction Property (AS4Client Component)

The action within a service that acts on the message.

Syntax

property ServiceAction: String read get_ServiceAction write set_ServiceAction;

Default Value

'http://docs.oasis-open.org/ebxml-msg/as4/200902/action'

Remarks

This property defines the action within a service that acts upon a message. This should only be changed from the default value if there is a specific reason to do so.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Action".

ServiceType Property (AS4Client Component)

The type of service.

Syntax

property ServiceType: String read get_ServiceType write set_ServiceType;

Default Value

Remarks

This optionally specifies the type of the service. The semantics of this value should be agreed upon by both parties ahead of time. It may be used to tell the other party how to interpret the Service value.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service@type"

SignatureAlgorithm Property (AS4Client Component)

Signature algorithm to be used in the message.

Syntax

property SignatureAlgorithm: String read get_SignatureAlgorithm write set_SignatureAlgorithm;

Default Value

'sha-256'

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

sha1
md5
sha-256 (or sha256) (default)
sha-384 (or sha384)
sha-512 (or sha512)
sha-224 (or sha224)

The default value is "sha-256".

SignerCertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property SignerCertEncoded: String read get_SignerCertEncoded write set_SignerCertEncoded;
property SignerCertEncodedB: TBytes read get_SignerCertEncodedB write set_SignerCertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

This property is not available at design time.

SignerCertStore Property (AS4Client Component)

This is the name of the certificate store for the client certificate.

Syntax

property SignerCertStore: String read get_SignerCertStore write set_SignerCertStore;
property SignerCertStoreB: TBytes read get_SignerCertStoreB write set_SignerCertStoreB;

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

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

Designations of certificate stores are platform-dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

SignerCertStorePassword Property (AS4Client Component)

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

Syntax

property SignerCertStorePassword: String read get_SignerCertStorePassword write set_SignerCertStorePassword;

Default Value

Remarks

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

SignerCertStoreType Property (AS4Client Component)

This is the type of certificate store for this certificate.

Syntax

property SignerCertStoreType: TibeCertStoreTypes read get_SignerCertStoreType write set_SignerCertStoreType;

TibeCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SignerCertSubject Property (AS4Client Component)

This is the subject of the certificate used for client authentication.

Syntax

property SignerCertSubject: String read get_SignerCertSubject write set_SignerCertSubject;

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

SigningCertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property SigningCertEncoded: String read get_SigningCertEncoded write set_SigningCertEncoded;
property SigningCertEncodedB: TBytes read get_SigningCertEncodedB write set_SigningCertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

This property is not available at design time.

SigningCertStore Property (AS4Client Component)

This is the name of the certificate store for the client certificate.

Syntax

property SigningCertStore: String read get_SigningCertStore write set_SigningCertStore;
property SigningCertStoreB: TBytes read get_SigningCertStoreB write set_SigningCertStoreB;

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

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

Designations of certificate stores are platform-dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

SigningCertStorePassword Property (AS4Client Component)

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

Syntax

property SigningCertStorePassword: String read get_SigningCertStorePassword write set_SigningCertStorePassword;

Default Value

Remarks

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

SigningCertStoreType Property (AS4Client Component)

This is the type of certificate store for this certificate.

Syntax

property SigningCertStoreType: TibeCertStoreTypes read get_SigningCertStoreType write set_SigningCertStoreType;

TibeCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SigningCertSubject Property (AS4Client Component)

This is the subject of the certificate used for client authentication.

Syntax

property SigningCertSubject: String read get_SigningCertSubject write set_SigningCertSubject;

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

SSLAcceptServerCertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded;
property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

This property is not available at design time.

SSLCertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded;
property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

This property is not available at design time.

SSLCertStore Property (AS4Client Component)

This is the name of the certificate store for the client certificate.

Syntax

property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore;
property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

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

Designations of certificate stores are platform-dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

SSLCertStorePassword Property (AS4Client Component)

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

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

Default Value

Remarks

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

SSLCertStoreType Property (AS4Client Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibeCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

TibeCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SSLCertSubject Property (AS4Client Component)

This is the subject of the certificate used for client authentication.

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

SSLProvider Property (AS4Client Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibeTSSLProviders read get_SSLProvider write set_SSLProvider;

TibeTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

SSLServerCertEncoded Property (AS4Client Component)

This is the certificate (PEM/base64 encoded).

Syntax

property SSLServerCertEncoded: String read get_SSLServerCertEncoded;
property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

This property is read-only and not available at design time.

Timeout Property (AS4Client Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

Remarks

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

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

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

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

The default value for the Timeout property is 60 seconds.

TokenPassword Property (AS4Client Component)

The password used in UsernameToken authentication.

Syntax

property TokenPassword: String read get_TokenPassword write set_TokenPassword;

Default Value

Remarks

This property specifies the password used in UsernameToken authentication.

UsernameToken Authentication Notes

If TokenUser and TokenPassword are specified the component will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.

TokenPassword should normally be set to the plaintext password that both the client and server know. The component will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.

client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles();

A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.

If TokenPasswordType is set to tptText the component will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.

TokenPasswordType Property (AS4Client Component)

The password type used in UsernameToken authentication.

Syntax

property TokenPasswordType: TibeTTokenPasswordTypes read get_TokenPasswordType write set_TokenPasswordType;

TibeTTokenPasswordTypes = (
  tptDigest,
  tptText
);

Default Value

tptDigest

Remarks

The type of password to send in the request. Possible values are:


0 (tptDigest - default)	TokenPassword holds the plaintext password and the component hashes it.
1 (tptText)	TokenPassword is transmitted exactly as provided.

UsernameToken Authentication Notes

If TokenUser and TokenPassword are specified the component will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.

client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles();

A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.

TokenUser Property (AS4Client Component)

The username used in UsernameToken authentication.

Syntax

property TokenUser: String read get_TokenUser write set_TokenUser;

Default Value

Remarks

This property specifies the username to be sent for UsernameToken authentication.

UsernameToken Authentication Notes

If TokenUser and TokenPassword are specified the component will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.

client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles();

A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.

URL Property (AS4Client Component)

The URL to which the request is made.

Syntax

property URL: String read get_URL write set_URL;

Default Value

Remarks

This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https".

Config Method (AS4Client Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These 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.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (AS4Client Component)

Processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (AS4Client Component)

Interrupt the current method.

Syntax

procedure Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ReceiveFiles Method (AS4Client Component)

Connects to a server to receive files.

Syntax

procedure ReceiveFiles();

Remarks

ReceiveFiles establishes a connection to the server specified by URL and receives files.

SigningCert (required to sign the request)
Certificate (required for decryption)
SignerCert (required for signature verification)
URL
IncomingDirectory (optional)
LogDirectory
MPC
TokenUser
TokenPassword
TokenPasswordType

After calling this method the following properties will be populated and may be inspected:

AS4From
AS4To
AgreementRef
ConversationId
Service
ServiceAction
ServiceType
MessageId
Receipt

Reset Method (AS4Client Component)

Resets the state of the control.

Syntax

procedure Reset();

Remarks

Reset resets the state of the component. All properties will be set to their default values.

SendFiles Method (AS4Client Component)

Sends file(s) to the specified server and verify the receipt (if present).

Syntax

procedure SendFiles();

Remarks

SendFiles sends the files specified by EDIData to URL.

When this method is called the file(s) will be sent and any returned receipts will be verified.

AgreementRef
AS4From
AS4To
EDIData
URL
RecipientCerts (required to encrypt)
SignerCert (required to verify signed receipts)
SigningCert (required to sign files)
ConversationId (optional)
EncryptionAlgorithm (optional)
LogDirectory (optional)
MessageId (optional)
MessageProperties (optional)
Profile (optional)
ReceiptReplyMode
Service (optional)
ServiceType (optional)
SignatureAlgorithm (optional)

See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.

AgreementRef
AS4From
AS4To
AsyncReceiptInfoDir
EDIData
URL
RecipientCerts (required to encrypt)
SignerCert (required to verify signed receipts)
SigningCert (required to sign files)
ConversationId (optional)
EncryptionAlgorithm (optional)
LogDirectory (optional)
MessageId (optional)
MessageProperties (optional)
OriginalSOAPMessage (optional)
OriginalSOAPMessageId (optional)
Profile (optional)
ReceiptReplyMode
Service (optional)
ServiceType (optional)
SignatureAlgorithm (optional)

SendReceipt Method (AS4Client Component)

Sends an asynchronous receipt.

Syntax

procedure SendReceipt();

Remarks

SendReceipt sends an asynchronous receipt to the URL.

Connected Event (AS4Client Component)

This event is fired immediately after a connection completes (or fails).

Syntax

type TConnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

Remarks

If the connection is made normally, StatusCode is 0 and Description is 'OK'.

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Disconnected Event (AS4Client Component)

This event is fired when a connection is closed.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

Remarks

If the connection is broken normally, StatusCode is 0 and Description is 'OK'.

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (AS4Client Component)

This event is fired when a document finishes transferring.

Syntax

type TEndTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer;

Remarks

The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AS4Client Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AS4Client Component)

This event is fired every time a header line comes in.

Syntax

type THeaderEvent = procedure (
  Sender: TObject;
  const Field: String;
  const Value: String
) of Object;

property OnHeader: THeaderEvent read FOnHeader write FOnHeader;

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains '' (empty string).

Log Event (AS4Client Component)

Fired with log information while processing a message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  const LogType: String;
  const LogMessage: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are:


"INFO"	Information about the status of the process.
"ERROR"	An error was encountered.
"DEBUG"	Debug information.

RecipientInfo Event (AS4Client Component)

Fired for each recipient certificate of the encrypted message.

Syntax

type TRecipientInfoEvent = procedure (
  Sender: TObject;
  const Issuer: String;
  const SerialNumber: String;
  const SubjectKeyIdentifier: String;
  const EncryptionAlgorithm: String
) of Object;

property OnRecipientInfo: TRecipientInfoEvent read FOnRecipientInfo write FOnRecipientInfo;

Remarks

When ParseRequest is called and the file is encrypted, this event will fire for each recipient certificate for which the file was encrypted.

Issuer is the subject of the issuer certificate.

SerialNumber is the serial number of the encryption certificate.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

EncryptionAlgorithm is the encryption algorithm used to encrypt the message. Possible values are as follows:

"3DES"
"DES"
"RC2CBC40"
"RC2CBC64"
"RC2CBC128" or "RC2"
"AESCBC128" or "AES"
"AESCBC192"
"AESCBC256"
"AESGCM128" or "AESGCM"
"AESGCM192"
"AESGCM256"

SetCookie Event (AS4Client Component)

This event is fired for every cookie set by the server.

Syntax

type TSetCookieEvent = procedure (
  Sender: TObject;
  const Name: String;
  const Value: String;
  const Expires: String;
  const Domain: String;
  const Path: String;
  Secure: Boolean
) of Object;

property OnSetCookie: TSetCookieEvent read FOnSetCookie write FOnSetCookie;

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SignerCertInfo Event (AS4Client Component)

This event is fired during verification of the signed message.

Syntax

type TSignerCertInfoEvent = procedure (
  Sender: TObject;
  const Issuer: String;
  const SerialNumber: String;
  const SubjectKeyIdentifier: String;
  CertEncoded: String;
  CertEncodedB: TBytes
) of Object;

property OnSignerCertInfo: TSignerCertInfoEvent read FOnSignerCertInfo write FOnSignerCertInfo;

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

Note: When this value is present, the component will automatically use this value to perform signature verification.

The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

SSLServerAuthentication Event (AS4Client Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  CertEncoded: String;
  CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AS4Client Component)

Shows the progress of the secure connection.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (AS4Client Component)

This event is fired when a document starts transferring (after the headers).

Syntax

type TStartTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer;

Remarks

The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

TokenAuthentication Event (AS4Client Component)

Fired when the server makes use of UsernameToken authentication.

Syntax

type TTokenAuthenticationEvent = procedure (
  Sender: TObject;
  const User: String;
  var Password: String;
  const PasswordType: String;
  var Accept: Boolean
) of Object;

property OnTokenAuthentication: TTokenAuthenticationEvent read FOnTokenAuthentication write FOnTokenAuthentication;

Remarks

This event fires when a server sends a response that includes UsernameToken authentication. This is typically only used by servers when sending a pull response.

User identifies the user.

Password should be set from within the event if PasswordType is 0 (digest). This parameter can be read when PasswordType is 1 (text).

PasswordType specifies the type of password. Possible values are:

0 (Digest)
1 (Text)

Accept may be set to manually accept the request.

When PasswordType is 0 (Digest) set the Password parameter to the plaintext password. Do not set Accept The component will hash the provided password value and compare it to the value in the request. If it matched the component will accept the request. If it does not match the component will populate Errors with an error indicating authentication has failed.

When PasswordType is 1 (Text) the Password parameter will hold the exact value received in the request. Inspect Password and determine whether to accept the request. To accept the request set Accept to True.

After this event fires if authentication failed Errors will contain an appropriate error. Send the errors back to the server by calling SendResponse.

Transfer Event (AS4Client Component)

This event is fired while a document transfers (delivers document).

Syntax

type TTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  BytesTransferred: Int64;
  PercentDone: Integer;
  Text: String;
  TextB: TBytes
) of Object;

property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer;

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

EBData Type

The EDI payload of the AS4 message.

Remarks

The EDI payload of the AS4 message.

Fields


Data String	This property contains the EDI payload of the transmission. When sending files this may be specified to the data to be sent. This can be used as an alternative to setting Filename. When receiving files this will only be populated if IncomingDirectory and OutputStream have not been specified and ParseRequest finishes without an error. If so, Data will contain the full decrypted text of the EDI message.
DataB TBytes	This property contains the EDI payload of the transmission. When sending files this may be specified to the data to be sent. This can be used as an alternative to setting Filename. When receiving files this will only be populated if IncomingDirectory and OutputStream have not been specified and ParseRequest finishes without an error. If so, Data will contain the full decrypted text of the EDI message.
EDIType String	The Content-Type of the EDI message. Sample values are "application/edi-x12", "application/edifact" or "application/xml".
Filename String	When sending, if Filename is specified, the file specified will be used for the EDI payload of the transmission. Name will be populated with the name of the file. When receiving, if IncomingDirectory is set, this will be populated with the name of the file which contains the processed message contents. Note: When OutputStream is set, the data will be written to the stream and this property will not be populated.
Name String	Name is the final name to be associated with the contents of either the Data or FileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload. When constructing EDI data to be sent, Name will be set to the same value as FileName, but can be overridden after setting FileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, Name will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.
PropertyCount Integer	The number of properties for this file. Each file may contain zero or more properties associated with it. This property, in conjunction with PropertyIndex, PropertyName, and PropertyValue can be used to specify properties when sending and read properties when receiving. Sending When sending files to add properties set PropertyCount to specify the number of properties. Then set PropertyIndex to select the property. Set PropertyName and PropertyValue to define the values for the property at PropertyIndex. For instance: `data = new EBData(); data.EDIType = "image/jpeg"; data.Filename = "..\\1.jpg"; data.Name = "1.jpg"; data.PropertyCount = 2; //Define two properties data.PropertyIndex = 0; //Select the first property data.PropertyName = "name1"; data.PropertyValue = "value1"; data.PropertyIndex = 1; //Select the second property data.PropertyName = "name2"; data.PropertyValue = "value2";` Receiving When receiving files these properties may be queried to retrieve the values set by the sender. Inspect PropertyCount to obtain the number of properties. Next set PropertyIndex to select a property and query PropertyName and PropertyValue. For instance: `for (int i = 0; i < server.EDIData[0].PropertyCount;i++) { server.EDIData[0].PropertyIndex = i; Console.WriteLine(server.EDIData[0].PropertyName + ": " + server.EDIData[0].PropertyValue); }`
PropertyIndex Integer	Selects a property at the specified index.
PropertyName String	The name of the property.
PropertyValue String	The value of the property.
SchemaLocation String	The SchemaLocation, SchemaNamespace, and SchemaVersion optionally define the schema that applies to this particular file. This may be used by the receiving party to properly interpret the file data. Schema information is not required, but if schema information is included SchemaLocation is required and must be set to the URI of the schema. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@location"
SchemaNamespace String	The namespace of the schema. This property is optional. Refer to SchemaLocation for details. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace"
SchemaVersion String	The version of the schema. This property is optional. Refer to SchemaLocation for details. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace"

Constructors

constructor Create();

constructor Create(valData: TBytes; valEDIType: String);

constructor Create(valFilename: String; valEDIType: String);

EBError Type

This type defines details of the error.

Remarks

The properties below provide various information about the error.

Fields


Category String	The category of error. Typical values include "Content", "Packaging", "UnPackaging", "Communication", and "InternalProcess". This value is optional.
Code String	The error code. This value is required. The standard format is "EBMS:0001", where "0001" is the numeric code portion.
Description String	The description of the error. This value is optional.
Detail String	Additional details about the error. This may include other helpful information such as a stack trace. This value is optional.
Origin String	The module within which the error occurred. Typical values include "ebMS", "reliability", and "security". This value is optional.
RefMessageId String	The MessageId to which the error applies. This is optional but should be supplied if possible.
Severity TibeEBSeverityTypes	The severity of the error. Possible values are: 0 (ebstWarning - default) 1 (ebstFailure) This value is required.
ShortDescription String	A short description of the error. This may be helpful for logging or readability. This value is optional.

Constructors

constructor Create();

EBPartyInfo Type

This type defines information about the party.

Remarks

The properties define information about the respective party. This is used to define both sending and receiving party information.

Fields


Id String	The Id of the party. This value is required. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"
IdType String	The optional type of the Id. If specified this value should be the domain to which the Id belongs. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"
Role String	This property specifies the role of the party. This may be any value agreed upon by the trading partners. In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator". In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder". This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"

Constructors

constructor Create();

constructor Create(valId: String; valRole: String);

constructor Create(valId: String; valRole: String; valIdType: String);

EBProperty Type

A property of the message.

Remarks

This type holds details about the property of the message.

Fields


Name String	This property defines the name of the message property. This is required. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/@Name"
PropertyType String	The optional type of the message property. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/@Type"
Value String	The value of the message property. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/"

Constructors

constructor Create();

constructor Create(valName: String; valValue: String);

constructor Create(valName: String; valValue: String; valPropertyType: String);

EBReceipt Type

The receipt.

Remarks

This type contains properties that comprise the receipt.

Fields

Content
String

The content of the receipt. This is the raw XML of the receipt.

The component will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.

RefToMessageId
String

The Message Id to which this receipt applies. This is the original Message Id from the initial transmission of the file. This allows the receipt to be correlated with the original transmission.

Constructors

constructor Create();

constructor Create(valRefToMessageId: String; valContent: String);

Firewall Type

This is the firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

AutoDetect
Boolean

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

FirewallType
TibeFirewallTypes

This property determines the type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
String

This property contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Password
String

This property contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Port
Integer

This property contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

User
String

This property contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this property and Password properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Constructors

constructor Create();

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields


Domain String	This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.
Expiration String	This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.
Name String	This property, contains the name of the cookie. This property, along with Value, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
Path String	This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.
Secure Boolean	This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.
Value String	This property contains the value of the cookie. A corresponding value is associated with the cookie specified by Name. This property holds that value. The SetCookie event provides the cookies set by the server.

Constructors

constructor Create();

constructor Create(valName: String; valValue: String);

Proxy Type

This is the proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

AuthScheme
TibeProxyAuthSchemes

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password properties are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

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

AutoDetect
Boolean

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is False.

Password
String

This property contains a password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

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

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Port
Integer

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server property for details.

Server
String

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server property is set to the corresponding address. If the search is not successful, an error is returned.

SSL
TibeProxySSLTypes

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:


psAutomatic (0)	Default setting. If the URL is an `https` URL, the component will use the `psTunnel` option. If the URL is an `http` URL, the component will use the `psNever` option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

User
String

This property contains a user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

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

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

Config Settings (AS4Client Component)

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 Config 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:


0 (default)	Basic
1	Digest
2	Proprietary
3	None
4	NTLM
5	Negotiate
6	OAuth

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.

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.

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:


Base64 (2)	Base64 encoding of binary data.
Binary (4)	Binary data without any encoding.

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:Messaging It 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:


0 (X509 - default)	X509 data including the certificate's issuer name and issuer serial number is included in the X509Data element.
1 (Binary)	A binary security token holds the base64 encoded contents of the public certificate and is referenced from within the Reference element.
2 (Subject Key Identifier)	The X509 subject key identifier is included in the KeyIdentifier element.
3 (X509PKIPathv1)	A binary security token holds the base64 encoded ordered list of X509 public certificates and is referenced from within the Reference element.

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 eDelivery 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 property 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@nsoftware This 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:


Value	Algorithm	Notes
`RSA-OAEP-XMLENC11`	http://www.w3.org/2009/xmlenc11#rsa-oaep	This is used in the default configuration. Additionally if `RSA-OAEP` is specified this will be automatically used instead if OAEPMGF1HashAlgorithm is set to any value except `SHA1` or OAEPRSAHashAlgorithm is set to `SHA384` or `SHA512`.
`RSA-v1.5`	http://www.w3.org/2001/04/xmlenc#rsa-1_5	There are no conditions for the use of this algorithm. If specified it will be used regardless of other settings.
`RSA-OAEP`	http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p	This is used by default when OAEPMGF1HashAlgorithm is set to `SHA1` and OAEPRSAHashAlgorithm is set to `SHA1` or `SHA256`. This is only applicable under these conditions, it cannot override when `RSA-OAEP-XMLENC11` is used based on the OAEPMGF1HashAlgorithm and OAEPRSAHashAlgorithm values.

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:


0 (Error)	Only errors are logged.
1 (Info - default)	Informational and errors are logged.
2 (Debug)	All information is logged including debug info.

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:


Log	Contains information about the steps taken during processing. Also see LogLevel.
Incoming	Contains the raw request/response that is received by the component.
Outgoing	Contains the raw request/response that is sent by the component.
IncomingMessage	Contains the incoming ebXML message.
OutgoingMessage	Contains the outgoing ebXML message.
All (default)	All of the above

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:


1	Pull Request (Receive Files)
2	User Message (Send Files)
4	Receipt
8	Error Message

For instance: 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:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

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:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

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.

PullRefToMessageId: The RefToMessageId to use with selective message pulling.

PullService: The Service to use with selective message pulling.

PullServiceType: The ServiceType to use with selective message pulling.

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:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

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 raises 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:


0 (X509 - default)	X509 data including the certificate's issuer name and issuer serial number is included in the X509Data element.
1 (Binary)	A binary security token holds the base64 encoded contents of the public certificate and is referenced from within the Reference element.
2 (Subject Key Identifier)	The X509 subject key identifier is included in the KeyIdentifier element.
3 (X509PKIPathv1)	A binary security token holds the base64 encoded ordered list of X509 public certificates and is referenced from within the Reference element.

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 eDelivery 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 property 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.

HTTP Config 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 configuration setting 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 configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will 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 configuration setting. 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 configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only 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 raises an exception if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be 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 applicable only 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 nonempty 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.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked 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 applicable only 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 raises an exception.

Note: 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 potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from 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 raises an exception instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

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 through 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 as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. 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 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/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty 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. For example: 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: Not all servers support persistent connections. You also may 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 configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

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).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than 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 configuration 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"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

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

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ('#13#10') .

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

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

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty 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 configuration 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 configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration 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 configuration 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 configuration 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 configuration 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 configuration setting to ON before making a request to enable it. Following are examples of this request:

.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 configuration 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 (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.

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.

TCPClient Config 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 configuration 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 setting is provided for use by components that do not directly expose Firewall properties.

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 raises an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration 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:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: 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 raises an exception.

Note: 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 acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration 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 macOS.

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 Transmission Control Protocol (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.

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), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if 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 are 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 (e.g., by a client acknowledgment), 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, the socket connection will linger. This value is 0 by default, which means it will use the default IP 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.

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 configuration 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 configuration 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:


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, 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 SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

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:

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.

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 1 or 2, 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 raises an exception.

When set to 0 (default) the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the OCSP URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP 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 raises an exception.

When set to 0 (default) the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

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 SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internal:

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 SSLProvider is set to Internal include:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

The platform provider is only available on Windows 11 / Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

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 SSLProvider is set to Internal.

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.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the component will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) 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.TCPServer) 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. TCPServer) 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. TCPServer) 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. TCPServer) 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. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

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:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available 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 SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal 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 raises an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.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 SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

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

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

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

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

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

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

Socket Config Settings

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

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

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 Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

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:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is False.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseFIPSCompliantAPI: Tells the component whether or not to use FIPS certified APIs.

When set to True, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting which applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI: Tells the component whether or not to use the system security libraries or an internal implementation.

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

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

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

Trappable Errors (AS4Client Component)

AS4Client Errors

601   Unsupported signature algorithm.
705   No response to deliver.
774   Error writing to stream.
1201   Invalid ebXML.
1204   Invalid part href value.
1205   Unknown original message when creating receipt.
1206   Could not build user message.
1207   MPC value is missing.
1210   A required property is not set, check the message for details.
1211   Invalid or missing URL.
1212   Unable to send request.
1213   The other party returned an error. Check the Errors property for details.
1214   Error processing receipt.
1215   Error saving data to AsyncReceiptInfoDir.
1216   Error reading data from AsyncReceiptInfoDir.
1217   MPC in the response does not match the MPC in the request.
1218   Duplicate message detected.
1219   Invalid profile value.
1220   Unsupported compression type
1221   Input file not found.
1222   Error compressing file.
1223   Invalid LogLevel value.
1224   Error setting EDI content when building message.
1225   Could not find a required message part.
1226   Invalid SOAP message.
1227   Invalid signature.
1228   Unknown XML reference.
1229   Digest verification failed.
1230   Could not find the required key.
1231   No CipherReference of CipherValue found.
1232   Only cid references are supported.
1233   Error signing message.
1234   Cannot find subject identifier.
1235   Error creating encryption key.
1236   Error decrypting part.
1237   Error calculating digest.
1238   The specified certificate cannot be used to decrypt this message.
1239   A signature is required, but is not present.
1240   Encryption is required, but the message is not encrypted.

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the component is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).


	601 Unsupported signature algorithm.
	705 No response to deliver.
	774 Error writing to stream.
	1201 Invalid ebXML.
	1204 Invalid part href value.
	1205 Unknown original message when creating receipt.
	1206 Could not build user message.
	1207 MPC value is missing.
	1210 A required property is not set, check the message for details.
	1211 Invalid or missing URL.
	1212 Unable to send request.
	1213 The other party returned an error. Check the Errors property for details.
	1214 Error processing receipt.
	1215 Error saving data to AsyncReceiptInfoDir.
	1216 Error reading data from AsyncReceiptInfoDir.
	1217 MPC in the response does not match the MPC in the request.
	1218 Duplicate message detected.
	1219 Invalid profile value.
	1220 Unsupported compression type
	1221 Input file not found.
	1222 Error compressing file.
	1223 Invalid LogLevel value.
	1224 Error setting EDI content when building message.
	1225 Could not find a required message part.
	1226 Invalid SOAP message.
	1227 Invalid signature.
	1228 Unknown XML reference.
	1229 Digest verification failed.
	1230 Could not find the required key.
	1231 No CipherReference of CipherValue found.
	1232 Only cid references are supported.
	1233 Error signing message.
	1234 Cannot find subject identifier.
	1235 Error creating encryption key.
	1236 Error decrypting part.
	1237 Error calculating digest.
	1238 The specified certificate cannot be used to decrypt this message.
	1239 A signature is required, but is not present.
	1240 Encryption is required, but the message is not encrypted.


	118 Firewall Error. Error description contains detailed message.
	143 Busy executing current method.
	151 HTTP protocol error. The error message has the server response.
	152 No server specified in URL
	153 Specified URLScheme is invalid.
	155 Range operation is not supported by server.
	156 Invalid cookie index (out of range).
	301 Interrupted.
	302 Can't open AttachedFile.


	100 You cannot change the RemotePort at this time. A connection is in progress.
	101 You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102 The RemoteHost address is invalid (0.0.0.0).
	104 Already connected. If you want to reconnect, close the current connection first.
	106 You cannot change the LocalPort at this time. A connection is in progress.
	107 You cannot change the LocalHost at this time. A connection is in progress.
	112 You cannot change MaxLineLength at this time. A connection is in progress.
	116 RemotePort cannot be zero. Please specify a valid service port number.
	117 You cannot change the UseConnection option while the component is active.
	135 Operation would block.
	201 Timeout.
	211 Action impossible in control's present state.
	212 Action impossible while not connected.
	213 Action impossible while listening.
	301 Timeout.
	302 Could not open file.
	434 Unable to convert string to selected CodePage.
	1105 Already connecting. If you want to reconnect, close the current connection first.
	1117 You need to connect first.
	1119 You cannot change the LocalHost at this time. A connection is in progress.
	1120 Connection dropped by remote host.


	10004 [10004] Interrupted system call.
	10009 [10009] Bad file number.
	10013 [10013] Access denied.
	10014 [10014] Bad address.
	10022 [10022] Invalid argument.
	10024 [10024] Too many open files.
	10035 [10035] Operation would block.
	10036 [10036] Operation now in progress.
	10037 [10037] Operation already in progress.
	10038 [10038] Socket operation on non-socket.
	10039 [10039] Destination address required.
	10040 [10040] Message too long.
	10041 [10041] Protocol wrong type for socket.
	10042 [10042] Bad protocol option.
	10043 [10043] Protocol not supported.
	10044 [10044] Socket type not supported.
	10045 [10045] Operation not supported on socket.
	10046 [10046] Protocol family not supported.
	10047 [10047] Address family not supported by protocol family.
	10048 [10048] Address already in use.
	10049 [10049] Can't assign requested address.
	10050 [10050] Network is down.
	10051 [10051] Network is unreachable.
	10052 [10052] Net dropped connection or reset.
	10053 [10053] Software caused connection abort.
	10054 [10054] Connection reset by peer.
	10055 [10055] No buffer space available.
	10056 [10056] Socket is already connected.
	10057 [10057] Socket is not connected.
	10058 [10058] Can't send after socket shutdown.
	10059 [10059] Too many references, can't splice.
	10060 [10060] Connection timed out.
	10061 [10061] Connection refused.
	10062 [10062] Too many levels of symbolic links.
	10063 [10063] File name too long.
	10064 [10064] Host is down.
	10065 [10065] No route to host.
	10066 [10066] Directory not empty
	10067 [10067] Too many processes.
	10068 [10068] Too many users.
	10069 [10069] Disc Quota Exceeded.
	10070 [10070] Stale NFS file handle.
	10071 [10071] Too many levels of remote in path.
	10091 [10091] Network subsystem is unavailable.
	10092 [10092] WINSOCK DLL Version out of range.
	10093 [10093] Winsock not loaded yet.
	11001 [11001] Host not found.
	11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004 [11004] Valid name, no data record (check DNS setup).