AS2Receiver Component
Properties Methods Events Config Settings Errors
The AS2Receiver component is used to process EDI messages and generate receipts.
Syntax
TibeAS2Receiver
Remarks
The AS2Receiver implements server-side processing of EDI messages, as specified in [AS2] and RFC 3335. It can be used to decrypt and verify incoming messages and to generate receipts including Message Disposition Notifications (MDNs). The component is designed to be easily incorporated into an HTTP server, and features custom functionality for server environments such as ASP.NET.
BASIC OPERATION
When an AS2 request comes in, you should first invoke ReadRequest. This will populate AS2From and AS2To, and based on this information, you may then set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.
Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in [AS2] and RFC 3335. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.
The MDNReceipt may be returned by invoking SendResponse. The receipt will be returned either synchronously in the HTTP reply, or asynchronously over a separate HTTP, HTTPS, or SMTP connection, as requested by the client.
To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data.
The following example illustrates how to use the component from an ASP.NET page. Note that in Java it will be necessary to provide an HTTPServletRequest as an argument to ReadRequest before processing the request.
EXAMPLE
AS2Receiver1.ReadRequest();
// At this point, you should check the values of AS2From and AS2To.
AS2Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "c:\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me");
AS2Receiver1.SignerCert = new Certificate("c:\\my_server_directory\\my_partner_cer_file.cer");
AS2Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory";
AS2Receiver1.ProcessRequest();
AS2Receiver1.SendResponse();
Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN.
ADVANCED FUNCTIONALITY
Advanced functionality is provided to allow the user to break down the AS2 process, and to allow finer control over the operation of the server. Where ProcessRequest automates the entire process, additional methods are also provided to handle each step separately.
Parsing Incoming Data
To process an EDI message, invoke ReadRequest to process the headers from the server, or alternatively, manually set Request to the contents of the HTTP request. It may contain both headers and body, or the headers may be specified separately in RequestHeaders. This will provide more information about the client's request, without attempting to read the underlying EDI data.
After invoking ReadRequest, the AS2From, AS2To, and MessageId properties will contain the appropriate values. MDNTo will contain a nonempty string if an MDN is requested; RequestedSignatureProtocol, RequestedMICAlgorithms, and ReceiptDeliveryOption provide more information about the client's request. Finally, RequestHeaders contains the complete list of HTTP/AS2 headers.
Next, invoke ParseRequest. The certificate used to decrypt and sign should be specified with the Certificate property, and your partner's signing certificate should be specified with SignerCert. This will process the headers, decompress and/or decrypt the message (if applicable), and verify the signature (if present). EncryptionType, SignatureType, and CompressionFormat describe whether and how the data was encrypted, signed, and compressed, respectively.
ParseRequest will populate EDIEDIType and EDIData.
Error Handling
If any errors occur an exception will be thrown and EDIData will not be populated. Information about the exception will be provided through the exception's error code and message and also through ScanResult. An MDN receipt reporting the error may still be generated; it is recommended that server software trap the error and invoke CreateMDNReceipt to report the error to the client.
The ErrorProcessingFlags property may be configured to allow predetermined types of errors. If ErrorProcessingFlags is set when ParseRequest (or ProcessRequest) is invoked, the errors specified will be allowed, an exception will not be thrown, and EDIData will still be determined. However, ScanResult will still report the error, as will the receipt generated by CreateMDNReceipt. To avoid reporting the errors in the receipt, set the ErrorReportingFlags property.
Creating an MDN-based Receipt
An MDN-based receipt may be created by invoking CreateMDNReceipt. Regardless of the success or failure of ProcessRequest, the receipt may be created as specified in RFCs 3335 and 2298. If no errors occurred when ProcessRequest was invoked, the receipt will report success and will be suitable for non-repudiation of receipt (NRR) if signed. If errors occurred, the MDN will report that an error occurred and that the EDI data was not processed. It is strongly recommended that server software trap any errors thrown by ProcessRequest and return the receipt in this case as well.
The MDNReceipt will consist of the MDN itself, a human-readable message, MIME headers and footers, and a signature if applicable. The receipt may be generated by invoking CreateMDNReceipt and customized further by setting the parameters to CreateMDNReceipt.
The Message parameter to CreateMDNReceipt may be used to customize the human-readable message in the receipt. If it is set to an empty string, an appropriate message will automatically be written whenever MDNReceipt is regenerated.
The receipt will be signed using the protocol specified by ReceiptSigningProtocol, if any. The certificate used to sign the receipt is specified by Certificate. By default the receipt will be signed if explicitly requested by the client, and unsigned otherwise.
Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDNReceipt to report a failure to process the message (either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error). Setting ErrorReportingFlags will cause the MDNReceipt to overlook the chosen types of errors. If all errors are overlooked, the MDNReceipt will report success and calculate a MIC on the original message as usual. A warning may be reported by setting the MDNWarning configuration setting.
Additional Server-Side Functionality
When used in a server environment such as ASP.NET, the component may be used to interface directly with the underlying HTTP context. If Request is not set by the user, ParseRequest and ProcessRequest will first get the request from the underlying HTTP environment, if possible. SendResponse will send the reply in this environment if able; otherwise the reply will be directed to standard out.
ASP.NET Core Notes
The component may be used within any .NET Standard compatible platform, including .NET Core and ASP.NET Core. When using AS2Receiver within an ASP.NET Core MVC application the component can be configured to automatically read from the request context, and send using the response context. To do so pass the HttpContext to the constructor of the AS2Receiver class. For instance:
//Inside HomeController.cs
As2receiver as2 = new As2receiver(HttpContext);
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AS2From | The AS2 Identifier of the sending system. |
AS2To | The AS2 Identifier of the receiving system. |
AttachmentCount | The number of records in the Attachment arrays. |
AttachmentContentType | The MIME content-type of this ediattachment . |
AttachmentData | This property contains the attachment data. |
AttachmentFileName | The file name of the attachment. |
AttachmentHeaders | The component fills out Headers each time any of the other properties for that ediattachment are changed. |
AttachmentName | Name is the final name to be associated with the contents of either the Data or FileName properties. |
CEMCount | The number of records in the CEM arrays. |
CEMAccepted | Whether the CEM request is accepted. |
CEMCertId | A user defined identifier for the certificate. |
CEMCertIssuer | This property holds the issuer of the certificate. |
CEMCertSerialNumber | This property holds the serial number of the certificate. |
CEMCertStore | The name of the certificate store for the certificate. |
CEMCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
CEMCertStoreType | The type of certificate store for this certificate. |
CEMCertSubject | The subject of the certificate. |
CEMCertUsage | This property defines which usages are applicable to the certificate. |
CEMRejectionReason | If Accepted is False this property specifies the reason a request was rejected. |
CEMRespondByDate | This property specifies the date by which the other party should respond. |
CEMResponseURL | This property defines the URL to which the response should be sent. |
CertEffectiveDate | The date on which this certificate becomes valid. |
CertExpirationDate | The date on which the certificate expires. |
CertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
CertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
CertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
CertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
CertIssuer | The issuer of the certificate. |
CertPrivateKey | The private key of the certificate (if available). |
CertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
CertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
CertPublicKey | The public key of the certificate. |
CertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
CertPublicKeyLength | The length of the certificate's public key (in bits). |
CertSerialNumber | The serial number of the certificate encoded as a string. |
CertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
CertStore | 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 | The type of certificate store for this certificate. |
CertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
CertThumbprintMD5 | The MD5 hash of the certificate. |
CertThumbprintSHA1 | The SHA-1 hash of the certificate. |
CertThumbprintSHA256 | The SHA-256 hash of the certificate. |
CertUsage | The text description of UsageFlags . |
CertUsageFlags | The flags that show intended use for the certificate. |
CertVersion | The certificate's version number. |
CertSubject | The subject of the certificate used for client authentication. |
CertEncoded | The certificate (PEM/Base64 encoded). |
CompressionFormat | The compression format used on the incoming message. |
EDIData | This property contains the EDI payload of the transmission. |
EDIType | The Content-Type of the EDI message. |
EDIName | Name is the final name to be associated with the contents of either the Data or FileName properties. |
EDIFileName | In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission. |
FirewallAutoDetect | Whether to automatically detect and use firewall system settings, if available. |
FirewallType | The type of firewall to connect through. |
FirewallHost | The name or IP address of the firewall (optional). |
FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
FirewallPort | The Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | A username if authentication is to be used when connecting through a firewall. |
IncomingDirectory | The directory to be used to store incoming messages. |
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. |
MDNReceiptContent | This contains the entire content of the MDN Receipt. |
MDNReceiptHeaderCount | The number of headers in the MDN. |
MDNReceiptHeaderField | The property name of the MDN header currently selected by HeaderIndex . |
MDNReceiptHeaderIndex | Which MDN header is currently selected to populate HeaderField and HeaderValue . |
MDNReceiptHeaders | Headers contains all of the headers of the AS2 MDN Receipt as a single string. |
MDNReceiptHeaderValue | The value of the MDN header currently selected by HeaderIndex . |
MDNReceiptMDN | MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. |
MDNReceiptMessage | The human-readable portion of the MDN receipt. |
MDNReceiptMICValue | The Message Integrity Check(s) (one-way hash) of the original EDI message. |
MDNReceiptSigningProtocol | This property contains the MIME type of the signature used, if any (i. |
MDNTo | The recipient for the Message Disposition Notification (MDN). |
MessageId | The message ID of the incoming message. |
ReceiptDeliveryOption | A URL indicating how the receipt is to be delivered. |
Request | The HTTP request to be processed. |
RequestHeaderCount | The number of records in the RequestHeader arrays. |
RequestHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
RequestHeaderValue | This property contains the header contents. |
RequestHeadersString | The HTTP headers in the AS2 request. |
RestartDirectory | The directory to log cached files when using AS2 restart functionality. |
RolloverCertEffectiveDate | The date on which this certificate becomes valid. |
RolloverCertExpirationDate | The date on which the certificate expires. |
RolloverCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
RolloverCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
RolloverCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
RolloverCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
RolloverCertIssuer | The issuer of the certificate. |
RolloverCertPrivateKey | The private key of the certificate (if available). |
RolloverCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
RolloverCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
RolloverCertPublicKey | The public key of the certificate. |
RolloverCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
RolloverCertPublicKeyLength | The length of the certificate's public key (in bits). |
RolloverCertSerialNumber | The serial number of the certificate encoded as a string. |
RolloverCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
RolloverCertStore | The name of the certificate store for the client certificate. |
RolloverCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
RolloverCertStoreType | The type of certificate store for this certificate. |
RolloverCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
RolloverCertThumbprintMD5 | The MD5 hash of the certificate. |
RolloverCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
RolloverCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
RolloverCertUsage | The text description of UsageFlags . |
RolloverCertUsageFlags | The flags that show intended use for the certificate. |
RolloverCertVersion | The certificate's version number. |
RolloverCertSubject | The subject of the certificate used for client authentication. |
RolloverCertEncoded | The certificate (PEM/Base64 encoded). |
ScanResult | The result of invoking ParseRequest . |
SignerCertEffectiveDate | The date on which this certificate becomes valid. |
SignerCertExpirationDate | The date on which the certificate expires. |
SignerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SignerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SignerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SignerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SignerCertIssuer | The issuer of the certificate. |
SignerCertPrivateKey | The private key of the certificate (if available). |
SignerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SignerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SignerCertPublicKey | The public key of the certificate. |
SignerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SignerCertPublicKeyLength | The length of the certificate's public key (in bits). |
SignerCertSerialNumber | The serial number of the certificate encoded as a string. |
SignerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SignerCertStore | 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 | The type of certificate store for this certificate. |
SignerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SignerCertThumbprintMD5 | The MD5 hash of the certificate. |
SignerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SignerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SignerCertUsage | The text description of UsageFlags . |
SignerCertUsageFlags | The flags that show intended use for the certificate. |
SignerCertVersion | The certificate's version number. |
SignerCertSubject | The subject of the certificate used for client authentication. |
SignerCertEncoded | The certificate (PEM/Base64 encoded). |
SSLAcceptServerCertEffectiveDate | The date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | The date on which the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | The issuer of the certificate. |
SSLAcceptServerCertPrivateKey | The private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | The public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | The name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | The type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | The text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | The flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | The certificate's version number. |
SSLAcceptServerCertSubject | The subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | The certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | The date on which this certificate becomes valid. |
SSLCertExpirationDate | The date on which the certificate expires. |
SSLCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | The issuer of the certificate. |
SSLCertPrivateKey | The private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | The public key of the certificate. |
SSLCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLCertStore | 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 | The type of certificate store for this certificate. |
SSLCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLCertUsage | The text description of UsageFlags . |
SSLCertUsageFlags | The flags that show intended use for the certificate. |
SSLCertVersion | The certificate's version number. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLCertEncoded | The certificate (PEM/Base64 encoded). |
UsePSS | This property specifies whether or not RSA-PSS will be used during signing and verification. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AckRequest | Optional. Acknowledges the incoming request. |
Config | Sets or retrieves a configuration setting. |
CreateMDNReceipt | Creates MDNReceipt . |
ParseRequest | Parses the EDI message and determines the EDIData . |
ProcessRequest | Processes the EDI data, and generates the receipt. |
ProcessRestartRequest | Processes the AS2 restart request, and sends a response to the client. |
ReadRequest | Reads the AS2 request from the HTTP session. |
Reset | Resets the state of the control. |
SendAsyncMDN | Sends the MDNReceipt to the RemoteURL specified. |
SendResponse | In a server environment, responds to the requesting client with MDNReceipt . |
SetTPInfo | A convenient way to set AS2 communication parameters using XML strings. |
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.
CEMRequest | Fired when a Certificate Exchange Messaging (CEM) request is received. |
CEMResponse | Fired when a Certificate Exchange Messaging (CEM) response is received. |
EDIDataInfo | Fired when processing an incoming message. |
Error | Fired when information is available about errors during data delivery. |
Log | Fired with log information while processing a message. |
RecipientInfo | Fired for each recipient certificate of the encrypted message. |
SignerCertInfo | This event is fired during verification of the signed message. |
SSLServerAuthentication | For asynchronous HTTPS MDNs, fired after the server presents its certificate. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AcceptAnySignerCert | Used to accept trust any signing certificate unconditionally. |
AS2VersionIncoming | The version of AS2 that was used in the incoming message. |
AS2VersionOutgoing | The version of AS2 to be used in the outgoing message. |
Authorization | The Authorization string to be sent to the server. |
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
CEMCertDir | Specifies the directory where certificates are saved when receiving a CEM request. |
CloseStreamAfterProcessing | Specifies whether or not the OutputStream should be closed after processing. |
DecodeTempDirectory | The temp directory the component will use to decode messages. |
DetectDuplicates | Whether to detect duplicate messages. |
EncryptionAlgorithm | The encryption algorithm used to encrypt the incoming data. |
EncryptionPaddingScheme | The encryption padding scheme used when encrypting the incoming data. |
EncryptionType | The MIME type of the encrypted data. |
ErrorProcessingFlags | Flags controlling how errors affect ProcessRequest. |
ErrorReportingFlags | Flags controlling how errors affect the MDNReceipt. |
FileNameSource | The location from which to read the filename. |
IgnoreLoggingErrors | Whether to ignore errors that occur when writing to the log. |
InvalidFileNameMDNAction | Instructs MDN disposition on invalid and duplicate filenames. |
LogDebug | Whether to log debug data. |
LogFilename | The base name of the log file. |
LogOptions | The information to be written to log files. |
MaxParts | The maximum number of MIME parts to process. |
MDNDisposition | Overrides the automatically calculated MDN disposition. |
MDNMICAlgorithm | The algorithm used to sign the outgoing MDN. |
MDNReportingUA | The name of the user agent performing the disposition. |
MDNSendingMode | The level of end user interaction involved in sending the MDN. |
MDNWarning | A warning to appear in the MDN. |
NormalizeMIC | Whether to normalize line endings before calculating the MIC. |
OverwriteCEMCerts | Whether existing CEM certificates are overwritten when a duplicate is received. |
Password | A password if authentication is to be used. |
ProcessingError | A processing error occurred in the received EDI message. |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyPassword | A password if Basic 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 Basic authentication is to be used for the proxy. |
ReceiptSigningProtocol | The protocol used to sign the outgoing MDN receipt. |
RequestedMICAlgorithms | The Message Integrity Check algorithm(s) requested by the client, if any. |
RequestedSignatureProtocol | The signing protocol requested by the client, if any. |
RequestFile | Reads the AS2 message from disk. |
RequireAS2To | Ensure that the received message is intended for the given AS2 identifier. |
RequiredSignatureAlgorithms | Specifies a list of acceptable signature algorithms. |
RequireEncrypt | Ensure that the received message is encrypted. |
RequireOAEP | Ensure that the encryption padding mode is RSAES-OAEP. |
RequirePSS | Ensure that the signature scheme in the received message is RSASSA-PSS. |
RequireSign | Ensure that the received message is signed. |
ResponseSubject | The subject to be used for the MDN response. |
SenderSignatureAlgorithm | The algorithm used by the sender to sign the message. |
SenderSignatureScheme | The signature scheme used by the sender to sign the message. |
SignatureType | The MIME type of the signature (if any). |
SignerCACert | CA certificate used to verify signed messages. |
SMTPFrom | The email address of the sender of the message. |
SMTPServer | The SMTP server to be used. |
User | A user name if authentication is to be used. |
WarnOnMDNFailure | Whether to log a .wrn file instead of a .err file when MDN delivery fails. |
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. |
StatusCode | The status code of the last response from the server. |
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. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
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 certificates to be included when performing an SSL handshake. |
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. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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 cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
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 certificates 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. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AS2From Property (AS2Receiver Component)
The AS2 Identifier of the sending system.
Syntax
__property String AS2From = { read=FAS2From };
Default Value
""
Remarks
May be company name, DUNS number, or anything agreed on by trading partners.
This property is read-only.
Data Type
String
AS2To Property (AS2Receiver Component)
The AS2 Identifier of the receiving system.
Syntax
__property String AS2To = { read=FAS2To };
Default Value
""
Remarks
May be company name, DUNS number, or anything agreed on by trading partners.
This property is read-only.
Data Type
String
AttachmentCount Property (AS2Receiver Component)
The number of records in the Attachment arrays.
Syntax
__property int AttachmentCount = { read=FAttachmentCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at AttachmentCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
AttachmentContentType Property (AS2Receiver Component)
The MIME content-type of this ediattachment .
Syntax
__property String AttachmentContentType[int AttachmentIndex] = { read=FAttachmentContentType };
Default Value
""
Remarks
The MIME content-type of this EDIAttachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentData Property (AS2Receiver Component)
This property contains the attachment data.
Syntax
__property String AttachmentData[int AttachmentIndex] = { read=FAttachmentData }; __property DynamicArray<Byte> AttachmentDataB[int AttachmentIndex] = { read=FAttachmentDataB };
Default Value
""
Remarks
This property contains the attachment data.
In a receiver, the component decodes the attachment to the AttachmentData property when AttachmentData's value is first queried. This property will contain the full decrypted text of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
AttachmentFileName Property (AS2Receiver Component)
The file name of the attachment.
Syntax
__property String AttachmentFileName[int AttachmentIndex] = { read=FAttachmentFileName };
Default Value
""
Remarks
The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the AttachmentHeaders.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentHeaders Property (AS2Receiver Component)
The component fills out Headers each time any of the other properties for that ediattachment are changed.
Syntax
__property String AttachmentHeaders[int AttachmentIndex] = { read=FAttachmentHeaders };
Default Value
""
Remarks
The component fills out AttachmentHeaders each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentName Property (AS2Receiver Component)
Name is the final name to be associated with the contents of either the Data or FileName properties.
Syntax
__property String AttachmentName[int AttachmentIndex] = { read=FAttachmentName };
Default Value
""
Remarks
AttachmentName is the final name to be associated with the contents of either the AttachmentData or AttachmentFileName properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
CEMCount Property (AS2Receiver Component)
The number of records in the CEM arrays.
Syntax
__property int CEMCount = { read=FCEMCount, write=FSetCEMCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- CEMAccepted
- CEMCertId
- CEMCertIssuer
- CEMCertSerialNumber
- CEMCertStore
- CEMCertStorePassword
- CEMCertStoreType
- CEMCertSubject
- CEMCertUsage
- CEMRejectionReason
- CEMRespondByDate
- CEMResponseURL
The array indices start at 0 and end at CEMCount - 1.
This property is not available at design time.
Data Type
Integer
CEMAccepted Property (AS2Receiver Component)
Whether the CEM request is accepted.
Syntax
__property bool CEMAccepted[int CEMIndex] = { read=FCEMAccepted, write=FSetCEMAccepted };
Default Value
False
Remarks
Whether the CEM request is accepted.
Before calling SendCEMResponse set this to True to accept the CEM request.
When processing a CEM response check this property to determine if the request was accepted.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
Boolean
CEMCertId Property (AS2Receiver Component)
A user defined identifier for the certificate.
Syntax
__property String CEMCertId[int CEMIndex] = { read=FCEMCertId, write=FSetCEMCertId };
Default Value
""
Remarks
A user defined identifier for the certificate.
This property defines a user specified identifier for the certificate. This may be set to a value which helps the recipient identify the certificate. For instance "CompanyA.Encryption.Cert.2014".
This property may be set before calling SendCEMRequest or SendCEMResponse from AS2Sender.
This property may be queried when received a CEM request or response with AS2Receiver.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMCertIssuer Property (AS2Receiver Component)
This property holds the issuer of the certificate.
Syntax
__property String CEMCertIssuer[int CEMIndex] = { read=FCEMCertIssuer, write=FSetCEMCertIssuer };
Default Value
""
Remarks
This property holds the issuer of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMCertSerialNumber Property (AS2Receiver Component)
This property holds the serial number of the certificate.
Syntax
__property String CEMCertSerialNumber[int CEMIndex] = { read=FCEMCertSerialNumber, write=FSetCEMCertSerialNumber };
Default Value
""
Remarks
This property holds the serial number of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMCertStore Property (AS2Receiver Component)
The name of the certificate store for the certificate.
Syntax
__property String CEMCertStore[int CEMIndex] = { read=FCEMCertStore, write=FSetCEMCertStore }; __property DynamicArray<Byte> CEMCertStoreB[int CEMIndex] = { read=FCEMCertStoreB, write=FSetCEMCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the certificate.
This property defines the store location for the type specified by CEMCertStoreType.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
Byte Array
CEMCertStorePassword Property (AS2Receiver Component)
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
Syntax
__property String CEMCertStorePassword[int CEMIndex] = { read=FCEMCertStorePassword, write=FSetCEMCertStorePassword };
Default Value
""
Remarks
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMCertStoreType Property (AS2Receiver Component)
The type of certificate store for this certificate.
Syntax
__property TibeAS2ReceiverCEMCertStoreTypes CEMCertStoreType[int CEMIndex] = { read=FCEMCertStoreType, write=FSetCEMCertStoreType };
enum TibeAS2ReceiverCEMCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CEMStore and set CEMStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
Integer
CEMCertSubject Property (AS2Receiver Component)
The subject of the certificate.
Syntax
__property String CEMCertSubject[int CEMIndex] = { read=FCEMCertSubject, write=FSetCEMCertSubject };
Default Value
""
Remarks
The subject of the certificate.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMCertUsage Property (AS2Receiver Component)
This property defines which usages are applicable to the certificate.
Syntax
__property int CEMCertUsage[int CEMIndex] = { read=FCEMCertUsage, write=FSetCEMCertUsage };
Default Value
15
Remarks
This property defines which usages are applicable to the certificate. This may be set to a binary 'OR' of one or more of the following values:
- 1 (TLS Client)
- 2 (TLS Server)
- 4 (Encryption)
- 8 (Signature)
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
Integer
CEMRejectionReason Property (AS2Receiver Component)
If Accepted is False this property specifies the reason a request was rejected.
Syntax
__property String CEMRejectionReason[int CEMIndex] = { read=FCEMRejectionReason, write=FSetCEMRejectionReason };
Default Value
""
Remarks
If CEMAccepted is False this property specifies the reason a request was rejected.
When using AS2Sender this may be set to a string value which the recipient will see.
When using AS2Receiver query this property for details on why the request was rejected.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMRespondByDate Property (AS2Receiver Component)
This property specifies the date by which the other party should respond.
Syntax
__property String CEMRespondByDate[int CEMIndex] = { read=FCEMRespondByDate, write=FSetCEMRespondByDate };
Default Value
""
Remarks
This property specifies the date by which the other party should respond. If the other party does not respond the new certificate may be used without any further notice. This property exists to assist the recipient in knowing when they should respond by. It does not guarantee a response by the specified date.
The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".
When using AS2Sender set this before calling SendCEMRequest.
When using AS2Receiver this property may be queried.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CEMResponseURL Property (AS2Receiver Component)
This property defines the URL to which the response should be sent.
Syntax
__property String CEMResponseURL[int CEMIndex] = { read=FCEMResponseURL, write=FSetCEMResponseURL };
Default Value
""
Remarks
This property defines the URL to which the response should be sent.
When using AS2Sender set this property before calling SendCEMRequest. This tells the recipient where to send the response.
When using AS2Receiver query this property to determine the URL where the response should be sent.
The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.
This property is not available at design time.
Data Type
String
CertEffectiveDate Property (AS2Receiver Component)
The date on which this certificate becomes valid.
Syntax
__property String CertEffectiveDate = { read=FCertEffectiveDate };
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
CertExpirationDate Property (AS2Receiver Component)
The date on which the certificate expires.
Syntax
__property String CertExpirationDate = { read=FCertExpirationDate };
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
CertExtendedKeyUsage Property (AS2Receiver Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String CertExtendedKeyUsage = { read=FCertExtendedKeyUsage };
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
CertFingerprint Property (AS2Receiver Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String CertFingerprint = { read=FCertFingerprint };
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
CertFingerprintSHA1 Property (AS2Receiver Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String CertFingerprintSHA1 = { read=FCertFingerprintSHA1 };
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
CertFingerprintSHA256 Property (AS2Receiver Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String CertFingerprintSHA256 = { read=FCertFingerprintSHA256 };
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
CertIssuer Property (AS2Receiver Component)
The issuer of the certificate.
Syntax
__property String CertIssuer = { read=FCertIssuer };
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
CertPrivateKey Property (AS2Receiver Component)
The private key of the certificate (if available).
Syntax
__property String CertPrivateKey = { read=FCertPrivateKey };
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
CertPrivateKeyAvailable Property (AS2Receiver Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool CertPrivateKeyAvailable = { read=FCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
CertPrivateKeyContainer Property (AS2Receiver Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String CertPrivateKeyContainer = { read=FCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
CertPublicKey Property (AS2Receiver Component)
The public key of the certificate.
Syntax
__property String CertPublicKey = { read=FCertPublicKey };
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
CertPublicKeyAlgorithm Property (AS2Receiver Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String CertPublicKeyAlgorithm = { read=FCertPublicKeyAlgorithm };
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
CertPublicKeyLength Property (AS2Receiver Component)
The length of the certificate's public key (in bits).
Syntax
__property int CertPublicKeyLength = { read=FCertPublicKeyLength };
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
CertSerialNumber Property (AS2Receiver Component)
The serial number of the certificate encoded as a string.
Syntax
__property String CertSerialNumber = { read=FCertSerialNumber };
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
CertSignatureAlgorithm Property (AS2Receiver Component)
The text description of the certificate's signature algorithm.
Syntax
__property String CertSignatureAlgorithm = { read=FCertSignatureAlgorithm };
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
CertStore Property (AS2Receiver Component)
The name of the certificate store for the client certificate.
Syntax
__property String CertStore = { read=FCertStore, write=FSetCertStore }; __property DynamicArray<Byte> CertStoreB = { read=FCertStoreB, write=FSetCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Byte Array
CertStorePassword Property (AS2Receiver 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 String CertStorePassword = { read=FCertStorePassword, write=FSetCertStorePassword };
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.
Data Type
String
CertStoreType Property (AS2Receiver Component)
The type of certificate store for this certificate.
Syntax
__property TibeAS2ReceiverCertStoreTypes CertStoreType = { read=FCertStoreType, write=FSetCertStoreType };
enum TibeAS2ReceiverCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
CertSubjectAltNames Property (AS2Receiver Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String CertSubjectAltNames = { read=FCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
CertThumbprintMD5 Property (AS2Receiver Component)
The MD5 hash of the certificate.
Syntax
__property String CertThumbprintMD5 = { read=FCertThumbprintMD5 };
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
CertThumbprintSHA1 Property (AS2Receiver Component)
The SHA-1 hash of the certificate.
Syntax
__property String CertThumbprintSHA1 = { read=FCertThumbprintSHA1 };
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
CertThumbprintSHA256 Property (AS2Receiver Component)
The SHA-256 hash of the certificate.
Syntax
__property String CertThumbprintSHA256 = { read=FCertThumbprintSHA256 };
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
CertUsage Property (AS2Receiver Component)
The text description of UsageFlags .
Syntax
__property String CertUsage = { read=FCertUsage };
Default Value
""
Remarks
The text description of CertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
CertUsageFlags Property (AS2Receiver Component)
The flags that show intended use for the certificate.
Syntax
__property int CertUsageFlags = { read=FCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the CertUsage property for a text representation of CertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
CertVersion Property (AS2Receiver Component)
The certificate's version number.
Syntax
__property String CertVersion = { read=FCertVersion };
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
CertSubject Property (AS2Receiver Component)
The subject of the certificate used for client authentication.
Syntax
__property String CertSubject = { read=FCertSubject, write=FSetCertSubject };
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
Data Type
String
CertEncoded Property (AS2Receiver Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String CertEncoded = { read=FCertEncoded, write=FSetCertEncoded }; __property DynamicArray<Byte> CertEncodedB = { read=FCertEncodedB, write=FSetCertEncodedB };
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
CompressionFormat Property (AS2Receiver Component)
The compression format used on the incoming message.
Syntax
__property TibeAS2ReceiverCompressionFormats CompressionFormat = { read=FCompressionFormat };
enum TibeAS2ReceiverCompressionFormats { cfNone=0, cfZLIB=1 };
Default Value
cfNone
Remarks
The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the component.
This property is read-only.
Data Type
Integer
EDIData Property (AS2Receiver Component)
This property contains the EDI payload of the transmission.
Syntax
__property String EDIData = { read=FEDIData }; __property DynamicArray<Byte> EDIDataB = { read=FEDIDataB };
Default Value
""
Remarks
This property contains the EDI payload of the transmission.
In a receiver, this property will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.
This property will only be populated if ParseRequest or ProcessRequest finishes without an error, setting ScanResult to 0. If so, EDIData will contain the processed EDI message.
This property is read-only.
Data Type
Byte Array
EDIType Property (AS2Receiver Component)
The Content-Type of the EDI message.
Syntax
__property String EDIType = { read=FEDIType };
Default Value
""
Remarks
The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".
This property is read-only.
Data Type
String
EDIName Property (AS2Receiver Component)
Name is the final name to be associated with the contents of either the Data or FileName properties.
Syntax
__property String EDIName = { read=FEDIName };
Default Value
"rfc1767.edi"
Remarks
EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.
When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.
When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.
This property is read-only.
Data Type
String
EDIFileName Property (AS2Receiver Component)
In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission.
Syntax
__property String EDIFileName = { read=FEDIFileName };
Default Value
""
Remarks
In a sender, if EDIFileName is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.
In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.
Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.
This property is read-only.
Data Type
String
FirewallAutoDetect Property (AS2Receiver Component)
Whether to automatically detect and use firewall system settings, if available.
Syntax
__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };
Default Value
False
Remarks
Whether to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (AS2Receiver Component)
The type of firewall to connect through.
Syntax
__property TibeAS2ReceiverFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };
enum TibeAS2ReceiverFirewallTypes { fwNone=0, fwTunnel=1, fwSOCKS4=2, fwSOCKS5=3, fwSOCKS4A=10 };
Default Value
fwNone
Remarks
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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (AS2Receiver Component)
The name or IP address of the firewall (optional).
Syntax
__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };
Default Value
""
Remarks
The name or IP address of the firewall (optional). If a FirewallHost 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.
Data Type
String
FirewallPassword Property (AS2Receiver Component)
A password if authentication is to be used when connecting through the firewall.
Syntax
__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };
Default Value
""
Remarks
A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.
Data Type
String
FirewallPort Property (AS2Receiver Component)
The Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };
Default Value
0
Remarks
The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost 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.
Data Type
Integer
FirewallUser Property (AS2Receiver Component)
A username if authentication is to be used when connecting through a firewall.
Syntax
__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };
Default Value
""
Remarks
A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.
Data Type
String
IncomingDirectory Property (AS2Receiver Component)
The directory to be used to store incoming messages.
Syntax
__property String IncomingDirectory = { read=FIncomingDirectory, write=FSetIncomingDirectory };
Default Value
""
Remarks
If IncomingDirectory is set, the received message is stored as a file in that 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.
Please note that the SetTPInfo method, if used, needs to be invoked before setting this property because it overrides the setting for incoming directory.
Data Type
String
LocalHost Property (AS2Receiver Component)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };
Default Value
""
Remarks
This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
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 multihomed 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.
Data Type
String
LogDirectory Property (AS2Receiver Component)
The path to a directory for logging.
Syntax
__property String LogDirectory = { read=FLogDirectory, write=FSetLogDirectory };
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 file for each transmission, with separate extensions for each type of data:
Status (.log) | Contains information on applied security options and pass/fail status of transmission |
Request (.req) | Contains the raw incoming request before processing |
Payload (.dat) | Contains the EDI payload after processing |
MDN Receipt (.mdn) | Contains the MDN receipt prepared by the receiver |
Error (.err) | This is only written in an error is encountered, containing the error. |
One or more of these logs 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:
%MessageID% | The MessageID of the AS2 transmission, after it is generated. |
%AS2From% | The AS2-From field in the transmission |
%OriginalMessageID% | In MDN Receipts, the MessageID of the transmission that the receipt is for. You can use this to pair asynchronous MDN receipt logs with their transmissions |
%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.
Data Type
String
LogFile Property (AS2Receiver Component)
The log file written.
Syntax
__property String LogFile = { read=FLogFile };
Default Value
""
Remarks
In case 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 just 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 on applied security options and pass/fail status of transmission |
Request (.req) | Contains the raw incoming request before processing |
Payload (.dat) | Contains the EDI payload after processing |
MDN Receipt (.mdn) | Contains the MDN receipt prepared by the receiver |
Error (.err) | This is only written in an error is encountered, containing the error. |
This property is read-only.
Data Type
String
MDNReceiptContent Property (AS2Receiver Component)
This contains the entire content of the MDN Receipt.
Syntax
__property String MDNReceiptContent = { read=FMDNReceiptContent, write=FSetMDNReceiptContent }; __property DynamicArray<Byte> MDNReceiptContentB = { read=FMDNReceiptContentB, write=FSetMDNReceiptContentB };
Default Value
""
Remarks
This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable MDNReceiptMDN (Message Disposition Notification) and a human readable MDNReceiptMessage, which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.
Data Type
Byte Array
MDNReceiptHeaderCount Property (AS2Receiver Component)
The number of headers in the MDN.
Syntax
__property int MDNReceiptHeaderCount = { read=FMDNReceiptHeaderCount };
Default Value
0
Remarks
The number of headers in the MDN.
This property is read-only and not available at design time.
Data Type
Integer
MDNReceiptHeaderField Property (AS2Receiver Component)
The property name of the MDN header currently selected by HeaderIndex .
Syntax
__property String MDNReceiptHeaderField = { read=FMDNReceiptHeaderField };
Default Value
""
Remarks
The field name of the MDN header currently selected by MDNReceiptHeaderIndex.
This property is read-only and not available at design time.
Data Type
String
MDNReceiptHeaderIndex Property (AS2Receiver Component)
Which MDN header is currently selected to populate HeaderField and HeaderValue .
Syntax
__property int MDNReceiptHeaderIndex = { read=FMDNReceiptHeaderIndex, write=FSetMDNReceiptHeaderIndex };
Default Value
0
Remarks
Which MDN header is currently selected to populate MDNReceiptHeaderField and MDNReceiptHeaderValue.
Valid values are 0 to MDNReceiptHeaderCount - 1.
This property is not available at design time.
Data Type
Integer
MDNReceiptHeaders Property (AS2Receiver Component)
Headers contains all of the headers of the AS2 MDN Receipt as a single string.
Syntax
__property String MDNReceiptHeaders = { read=FMDNReceiptHeaders, write=FSetMDNReceiptHeaders };
Default Value
""
Remarks
Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).
You can also use MDNReceiptHeaderCount, MDNReceiptHeaderIndex, MDNReceiptHeaderField, and MDNReceiptHeaderValue to easily iterate through each individual header.
Data Type
String
MDNReceiptHeaderValue Property (AS2Receiver Component)
The value of the MDN header currently selected by HeaderIndex .
Syntax
__property String MDNReceiptHeaderValue = { read=FMDNReceiptHeaderValue };
Default Value
""
Remarks
The value of the MDN header currently selected by MDNReceiptHeaderIndex.
This property is read-only and not available at design time.
Data Type
String
MDNReceiptMDN Property (AS2Receiver Component)
MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.
Syntax
__property String MDNReceiptMDN = { read=FMDNReceiptMDN };
Default Value
""
Remarks
MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.
This property is read-only.
Data Type
String
MDNReceiptMessage Property (AS2Receiver Component)
The human-readable portion of the MDN receipt.
Syntax
__property String MDNReceiptMessage = { read=FMDNReceiptMessage };
Default Value
""
Remarks
The human-readable portion of the MDN receipt.
The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.
This property is read-only.
Data Type
String
MDNReceiptMICValue Property (AS2Receiver Component)
The Message Integrity Check(s) (one-way hash) of the original EDI message.
Syntax
__property String MDNReceiptMICValue = { read=FMDNReceiptMICValue };
Default Value
""
Remarks
The Message Integrity Check(s) (one-way hash) of the original EDI message.
An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.
The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".
This property is read-only.
Data Type
String
MDNReceiptSigningProtocol Property (AS2Receiver Component)
This property contains the MIME type of the signature used, if any (i.
Syntax
__property String MDNReceiptSigningProtocol = { read=FMDNReceiptSigningProtocol };
Default Value
""
Remarks
This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.
This property is read-only.
Data Type
String
MDNTo Property (AS2Receiver Component)
The recipient for the Message Disposition Notification (MDN).
Syntax
__property String MDNTo = { read=FMDNTo };
Default Value
""
Remarks
MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.
The receipt will be contained in MDNReceipt. If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, SendResponse will send the response as appropriate.
According to RFC specifications, MDNReceipt must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server.
This property is read-only.
Data Type
String
MessageId Property (AS2Receiver Component)
The message ID of the incoming message.
Syntax
__property String MessageId = { read=FMessageId };
Default Value
""
Remarks
MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.
This property is read-only.
Data Type
String
ReceiptDeliveryOption Property (AS2Receiver Component)
A URL indicating how the receipt is to be delivered.
Syntax
__property String ReceiptDeliveryOption = { read=FReceiptDeliveryOption };
Default Value
""
Remarks
This property corresponds to the Receipt-delivery-option header in Request. If nonempty, the client has requested that the receipt be sent to the URL specified asynchronously. If empty, the receipt is to be delivered synchronously in the HTTP reply. In either case the receipt may be delivered by invoking SendResponse.
ReceiptDeliveryOption does not indicate whether or not a receipt was actually requested. If an MDN was requested, that information is given in MDNTo.
This property is read-only.
Data Type
String
Request Property (AS2Receiver Component)
The HTTP request to be processed.
Syntax
__property String Request = { read=FRequest, write=FSetRequest }; __property DynamicArray<Byte> RequestB = { read=FRequestB, write=FSetRequestB };
Default Value
""
Remarks
The body of the request to be processed. The HTTP headers may be set separately in RequestHeaders or may be included in Request. If they are included, a double CRLF pair should be used to separate the headers from the body.
When ParseRequest or ProcessRequest is invoked, the contents of Request are lost and you can read the processed data in EDIData.
This property is not available at design time.
Data Type
Byte Array
RequestHeaderCount Property (AS2Receiver Component)
The number of records in the RequestHeader arrays.
Syntax
__property int RequestHeaderCount = { read=FRequestHeaderCount, write=FSetRequestHeaderCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at RequestHeaderCount - 1.
This property is not available at design time.
Data Type
Integer
RequestHeaderField Property (AS2Receiver Component)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
__property String RequestHeaderField[int RequestHeaderIndex] = { read=FRequestHeaderField, write=FSetRequestHeaderField };
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.
This property is not available at design time.
Data Type
String
RequestHeaderValue Property (AS2Receiver Component)
This property contains the header contents.
Syntax
__property String RequestHeaderValue[int RequestHeaderIndex] = { read=FRequestHeaderValue, write=FSetRequestHeaderValue };
Default Value
""
Remarks
This property contains the Header contents.
The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.
This property is not available at design time.
Data Type
String
RequestHeadersString Property (AS2Receiver Component)
The HTTP headers in the AS2 request.
Syntax
__property String RequestHeadersString = { read=FRequestHeadersString, write=FSetRequestHeadersString };
Default Value
""
Remarks
The entire list of headers, concatenated into a single string. These will include AS2- specific headers as well as general HTTP headers. You may access specific headers through RequestHeaders.
When assigning an AS2 request to the component, the headers may be included in Request or specified separately in RequestHeaders. If the headers are included in Request they will be parsed out whenever ReadRequest, ParseRequest, or ProcessRequest is invoked.
Data Type
String
RestartDirectory Property (AS2Receiver Component)
The directory to log cached files when using AS2 restart functionality.
Syntax
__property String RestartDirectory = { read=FRestartDirectory, write=FSetRestartDirectory };
Default Value
""
Remarks
If this property is set, the component will cache all received files to the RestartDirectory. Thus, when receiving a file is interrupted, the client can restart the transmission of the file starting where it was interrupted.
To use this functionality, HTTP HEAD requests must be processed using the ProcessRestartRequest method.
When using restart functionality, the data is processed after the entire file contents are received.
NOTE: This directory will not automatically be cleaned up.
Data Type
String
RolloverCertEffectiveDate Property (AS2Receiver Component)
The date on which this certificate becomes valid.
Syntax
__property String RolloverCertEffectiveDate = { read=FRolloverCertEffectiveDate };
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
RolloverCertExpirationDate Property (AS2Receiver Component)
The date on which the certificate expires.
Syntax
__property String RolloverCertExpirationDate = { read=FRolloverCertExpirationDate };
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
RolloverCertExtendedKeyUsage Property (AS2Receiver Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String RolloverCertExtendedKeyUsage = { read=FRolloverCertExtendedKeyUsage };
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
RolloverCertFingerprint Property (AS2Receiver Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String RolloverCertFingerprint = { read=FRolloverCertFingerprint };
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
RolloverCertFingerprintSHA1 Property (AS2Receiver Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String RolloverCertFingerprintSHA1 = { read=FRolloverCertFingerprintSHA1 };
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
RolloverCertFingerprintSHA256 Property (AS2Receiver Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String RolloverCertFingerprintSHA256 = { read=FRolloverCertFingerprintSHA256 };
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
RolloverCertIssuer Property (AS2Receiver Component)
The issuer of the certificate.
Syntax
__property String RolloverCertIssuer = { read=FRolloverCertIssuer };
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
RolloverCertPrivateKey Property (AS2Receiver Component)
The private key of the certificate (if available).
Syntax
__property String RolloverCertPrivateKey = { read=FRolloverCertPrivateKey };
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The RolloverCertPrivateKey may be available but not exportable. In this case, RolloverCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
RolloverCertPrivateKeyAvailable Property (AS2Receiver Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool RolloverCertPrivateKeyAvailable = { read=FRolloverCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a RolloverCertPrivateKey is available for the selected certificate. If RolloverCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
RolloverCertPrivateKeyContainer Property (AS2Receiver Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String RolloverCertPrivateKeyContainer = { read=FRolloverCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the RolloverCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
RolloverCertPublicKey Property (AS2Receiver Component)
The public key of the certificate.
Syntax
__property String RolloverCertPublicKey = { read=FRolloverCertPublicKey };
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
RolloverCertPublicKeyAlgorithm Property (AS2Receiver Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String RolloverCertPublicKeyAlgorithm = { read=FRolloverCertPublicKeyAlgorithm };
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
RolloverCertPublicKeyLength Property (AS2Receiver Component)
The length of the certificate's public key (in bits).
Syntax
__property int RolloverCertPublicKeyLength = { read=FRolloverCertPublicKeyLength };
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
RolloverCertSerialNumber Property (AS2Receiver Component)
The serial number of the certificate encoded as a string.
Syntax
__property String RolloverCertSerialNumber = { read=FRolloverCertSerialNumber };
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
RolloverCertSignatureAlgorithm Property (AS2Receiver Component)
The text description of the certificate's signature algorithm.
Syntax
__property String RolloverCertSignatureAlgorithm = { read=FRolloverCertSignatureAlgorithm };
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
RolloverCertStore Property (AS2Receiver Component)
The name of the certificate store for the client certificate.
Syntax
__property String RolloverCertStore = { read=FRolloverCertStore, write=FSetRolloverCertStore }; __property DynamicArray<Byte> RolloverCertStoreB = { read=FRolloverCertStoreB, write=FSetRolloverCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The RolloverCertStoreType property denotes the type of the certificate store specified by RolloverCertStore. If the store is password-protected, specify the password in RolloverCertStorePassword.
RolloverCertStore is used in conjunction with the RolloverCertSubject property to specify client certificates. If RolloverCertStore has a value, and RolloverCertSubject or RolloverCertEncoded is set, a search for a certificate is initiated. Please see the RolloverCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Byte Array
RolloverCertStorePassword Property (AS2Receiver 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 String RolloverCertStorePassword = { read=FRolloverCertStorePassword, write=FSetRolloverCertStorePassword };
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.
Data Type
String
RolloverCertStoreType Property (AS2Receiver Component)
The type of certificate store for this certificate.
Syntax
__property TibeAS2ReceiverRolloverCertStoreTypes RolloverCertStoreType = { read=FRolloverCertStoreType, write=FSetRolloverCertStoreType };
enum TibeAS2ReceiverRolloverCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the RolloverCertStore and set RolloverCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
RolloverCertSubjectAltNames Property (AS2Receiver Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String RolloverCertSubjectAltNames = { read=FRolloverCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
RolloverCertThumbprintMD5 Property (AS2Receiver Component)
The MD5 hash of the certificate.
Syntax
__property String RolloverCertThumbprintMD5 = { read=FRolloverCertThumbprintMD5 };
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
RolloverCertThumbprintSHA1 Property (AS2Receiver Component)
The SHA-1 hash of the certificate.
Syntax
__property String RolloverCertThumbprintSHA1 = { read=FRolloverCertThumbprintSHA1 };
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
RolloverCertThumbprintSHA256 Property (AS2Receiver Component)
The SHA-256 hash of the certificate.
Syntax
__property String RolloverCertThumbprintSHA256 = { read=FRolloverCertThumbprintSHA256 };
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
RolloverCertUsage Property (AS2Receiver Component)
The text description of UsageFlags .
Syntax
__property String RolloverCertUsage = { read=FRolloverCertUsage };
Default Value
""
Remarks
The text description of RolloverCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
RolloverCertUsageFlags Property (AS2Receiver Component)
The flags that show intended use for the certificate.
Syntax
__property int RolloverCertUsageFlags = { read=FRolloverCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of RolloverCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the RolloverCertUsage property for a text representation of RolloverCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
RolloverCertVersion Property (AS2Receiver Component)
The certificate's version number.
Syntax
__property String RolloverCertVersion = { read=FRolloverCertVersion };
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
RolloverCertSubject Property (AS2Receiver Component)
The subject of the certificate used for client authentication.
Syntax
__property String RolloverCertSubject = { read=FRolloverCertSubject, write=FSetRolloverCertSubject };
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
Data Type
String
RolloverCertEncoded Property (AS2Receiver Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String RolloverCertEncoded = { read=FRolloverCertEncoded, write=FSetRolloverCertEncoded }; __property DynamicArray<Byte> RolloverCertEncodedB = { read=FRolloverCertEncodedB, write=FSetRolloverCertEncodedB };
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RolloverCertStore and RolloverCertSubject properties also may be used to specify a certificate.
When RolloverCertEncoded is set, a search is initiated in the current RolloverCertStore for the private key of the certificate. If the key is found, RolloverCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RolloverCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
ScanResult Property (AS2Receiver Component)
The result of invoking ParseRequest .
Syntax
__property int ScanResult = { read=FScanResult };
Default Value
0
Remarks
ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.
0x01 | Unable to decrypt data. |
0x02 | Unable to decompress data. |
0x04 | Unable to validate integrity of data. |
0x08 | Unable to verify the signature. |
0x10 | Client requested unsupported signature type. |
0x20 | Client requested unsupported MIC algorithm. |
0x40 | Insufficient message security, as determined by the Config entries RequireSign and RequireEncrypt. |
0x80 | Unexpected processing error. An exception was encountered outside of message processing, such as configuration issues in the component. |
0x100 | Duplicate filename. |
0x200 | Illegal filename. |
0x400 | Empty filename. |
0x800 | Error writing incoming file. |
This property is read-only.
Data Type
Integer
SignerCertEffectiveDate Property (AS2Receiver Component)
The date on which this certificate becomes valid.
Syntax
__property String SignerCertEffectiveDate = { read=FSignerCertEffectiveDate };
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only and not available at design time.
Data Type
String
SignerCertExpirationDate Property (AS2Receiver Component)
The date on which the certificate expires.
Syntax
__property String SignerCertExpirationDate = { read=FSignerCertExpirationDate };
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only and not available at design time.
Data Type
String
SignerCertExtendedKeyUsage Property (AS2Receiver Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String SignerCertExtendedKeyUsage = { read=FSignerCertExtendedKeyUsage };
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only and not available at design time.
Data Type
String
SignerCertFingerprint Property (AS2Receiver Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SignerCertFingerprint = { read=FSignerCertFingerprint };
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only and not available at design time.
Data Type
String
SignerCertFingerprintSHA1 Property (AS2Receiver Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SignerCertFingerprintSHA1 = { read=FSignerCertFingerprintSHA1 };
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only and not available at design time.
Data Type
String
SignerCertFingerprintSHA256 Property (AS2Receiver Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SignerCertFingerprintSHA256 = { read=FSignerCertFingerprintSHA256 };
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only and not available at design time.
Data Type
String
SignerCertIssuer Property (AS2Receiver Component)
The issuer of the certificate.
Syntax
__property String SignerCertIssuer = { read=FSignerCertIssuer };
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only and not available at design time.
Data Type
String
SignerCertPrivateKey Property (AS2Receiver Component)
The private key of the certificate (if available).
Syntax
__property String SignerCertPrivateKey = { read=FSignerCertPrivateKey };
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.
This property is read-only and not available at design time.
Data Type
String
SignerCertPrivateKeyAvailable Property (AS2Receiver Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SignerCertPrivateKeyAvailable = { read=FSignerCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only and not available at design time.
Data Type
Boolean
SignerCertPrivateKeyContainer Property (AS2Receiver Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SignerCertPrivateKeyContainer = { read=FSignerCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the SignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only and not available at design time.
Data Type
String
SignerCertPublicKey Property (AS2Receiver Component)
The public key of the certificate.
Syntax
__property String SignerCertPublicKey = { read=FSignerCertPublicKey };
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only and not available at design time.
Data Type
String
SignerCertPublicKeyAlgorithm Property (AS2Receiver Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String SignerCertPublicKeyAlgorithm = { read=FSignerCertPublicKeyAlgorithm };
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only and not available at design time.
Data Type
String
SignerCertPublicKeyLength Property (AS2Receiver Component)
The length of the certificate's public key (in bits).
Syntax
__property int SignerCertPublicKeyLength = { read=FSignerCertPublicKeyLength };
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only and not available at design time.
Data Type
Integer
SignerCertSerialNumber Property (AS2Receiver Component)
The serial number of the certificate encoded as a string.
Syntax
__property String SignerCertSerialNumber = { read=FSignerCertSerialNumber };
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only and not available at design time.
Data Type
String
SignerCertSignatureAlgorithm Property (AS2Receiver Component)
The text description of the certificate's signature algorithm.
Syntax
__property String SignerCertSignatureAlgorithm = { read=FSignerCertSignatureAlgorithm };
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only and not available at design time.
Data Type
String
SignerCertStore Property (AS2Receiver Component)
The name of the certificate store for the client certificate.
Syntax
__property String SignerCertStore = { read=FSignerCertStore, write=FSetSignerCertStore }; __property DynamicArray<Byte> SignerCertStoreB = { read=FSignerCertStoreB, write=FSetSignerCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
This property is not available at design time.
Data Type
Byte Array
SignerCertStorePassword Property (AS2Receiver 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 String SignerCertStorePassword = { read=FSignerCertStorePassword, write=FSetSignerCertStorePassword };
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.
This property is not available at design time.
Data Type
String
SignerCertStoreType Property (AS2Receiver Component)
The type of certificate store for this certificate.
Syntax
__property TibeAS2ReceiverSignerCertStoreTypes SignerCertStoreType = { read=FSignerCertStoreType, write=FSetSignerCertStoreType };
enum TibeAS2ReceiverSignerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
This property is not available at design time.
Data Type
Integer
SignerCertSubjectAltNames Property (AS2Receiver Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SignerCertSubjectAltNames = { read=FSignerCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only and not available at design time.
Data Type
String
SignerCertThumbprintMD5 Property (AS2Receiver Component)
The MD5 hash of the certificate.
Syntax
__property String SignerCertThumbprintMD5 = { read=FSignerCertThumbprintMD5 };
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only and not available at design time.
Data Type
String
SignerCertThumbprintSHA1 Property (AS2Receiver Component)
The SHA-1 hash of the certificate.
Syntax
__property String SignerCertThumbprintSHA1 = { read=FSignerCertThumbprintSHA1 };
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only and not available at design time.
Data Type
String
SignerCertThumbprintSHA256 Property (AS2Receiver Component)
The SHA-256 hash of the certificate.
Syntax
__property String SignerCertThumbprintSHA256 = { read=FSignerCertThumbprintSHA256 };
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only and not available at design time.
Data Type
String
SignerCertUsage Property (AS2Receiver Component)
The text description of UsageFlags .
Syntax
__property String SignerCertUsage = { read=FSignerCertUsage };
Default Value
""
Remarks
The text description of SignerCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only and not available at design time.
Data Type
String
SignerCertUsageFlags Property (AS2Receiver Component)
The flags that show intended use for the certificate.
Syntax
__property int SignerCertUsageFlags = { read=FSignerCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only and not available at design time.
Data Type
Integer
SignerCertVersion Property (AS2Receiver Component)
The certificate's version number.
Syntax
__property String SignerCertVersion = { read=FSignerCertVersion };
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only and not available at design time.
Data Type
String
SignerCertSubject Property (AS2Receiver Component)
The subject of the certificate used for client authentication.
Syntax
__property String SignerCertSubject = { read=FSignerCertSubject, write=FSetSignerCertSubject };
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
This property is not available at design time.
Data Type
String
SignerCertEncoded Property (AS2Receiver Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SignerCertEncoded = { read=FSignerCertEncoded, write=FSetSignerCertEncoded }; __property DynamicArray<Byte> SignerCertEncodedB = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB };
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
SSLAcceptServerCertEffectiveDate Property (AS2Receiver Component)
The date on which this certificate becomes valid.
Syntax
__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (AS2Receiver Component)
The date on which the certificate expires.
Syntax
__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (AS2Receiver Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (AS2Receiver Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (AS2Receiver Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (AS2Receiver Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (AS2Receiver Component)
The issuer of the certificate.
Syntax
__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (AS2Receiver Component)
The private key of the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (AS2Receiver Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (AS2Receiver Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (AS2Receiver Component)
The public key of the certificate.
Syntax
__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (AS2Receiver Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (AS2Receiver Component)
The length of the certificate's public key (in bits).
Syntax
__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (AS2Receiver Component)
The serial number of the certificate encoded as a string.
Syntax
__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (AS2Receiver Component)
The text description of the certificate's signature algorithm.
Syntax
__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (AS2Receiver Component)
The name of the certificate store for the client certificate.
Syntax
__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore }; __property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Byte Array
SSLAcceptServerCertStorePassword Property (AS2Receiver 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 String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };
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.
Data Type
String
SSLAcceptServerCertStoreType Property (AS2Receiver Component)
The type of certificate store for this certificate.
Syntax
__property TibeAS2ReceiverSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };
enum TibeAS2ReceiverSSLAcceptServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (AS2Receiver Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (AS2Receiver Component)
The MD5 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (AS2Receiver Component)
The SHA-1 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (AS2Receiver Component)
The SHA-256 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (AS2Receiver Component)
The text description of UsageFlags .
Syntax
__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };
Default Value
""
Remarks
The text description of SSLAcceptServerCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (AS2Receiver Component)
The flags that show intended use for the certificate.
Syntax
__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (AS2Receiver Component)
The certificate's version number.
Syntax
__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (AS2Receiver Component)
The subject of the certificate used for client authentication.
Syntax
__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
Data Type
String
SSLAcceptServerCertEncoded Property (AS2Receiver Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded }; __property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
SSLCertEffectiveDate Property (AS2Receiver Component)
The date on which this certificate becomes valid.
Syntax
__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (AS2Receiver Component)
The date on which the certificate expires.
Syntax
__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (AS2Receiver Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (AS2Receiver Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprint = { read=FSSLCertFingerprint };
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (AS2Receiver Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (AS2Receiver Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (AS2Receiver Component)
The issuer of the certificate.
Syntax
__property String SSLCertIssuer = { read=FSSLCertIssuer };
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (AS2Receiver Component)
The private key of the certificate (if available).
Syntax
__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (AS2Receiver Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };
Default Value
false
Remarks
Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (AS2Receiver Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };
Default Value
""
Remarks
The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (AS2Receiver Component)
The public key of the certificate.
Syntax
__property String SSLCertPublicKey = { read=FSSLCertPublicKey };
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (AS2Receiver Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (AS2Receiver Component)
The length of the certificate's public key (in bits).
Syntax
__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (AS2Receiver Component)
The serial number of the certificate encoded as a string.
Syntax
__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (AS2Receiver Component)
The text description of the certificate's signature algorithm.
Syntax
__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (AS2Receiver Component)
The name of the certificate store for the client certificate.
Syntax
__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore }; __property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Byte Array
SSLCertStorePassword Property (AS2Receiver 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 String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };
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.
Data Type
String
SSLCertStoreType Property (AS2Receiver Component)
The type of certificate store for this certificate.
Syntax
__property TibeAS2ReceiverSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TibeAS2ReceiverSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLCertSubjectAltNames Property (AS2Receiver Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (AS2Receiver Component)
The MD5 hash of the certificate.
Syntax
__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (AS2Receiver Component)
The SHA-1 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (AS2Receiver Component)
The SHA-256 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (AS2Receiver Component)
The text description of UsageFlags .
Syntax
__property String SSLCertUsage = { read=FSSLCertUsage };
Default Value
""
Remarks
The text description of SSLCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (AS2Receiver Component)
The flags that show intended use for the certificate.
Syntax
__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (AS2Receiver Component)
The certificate's version number.
Syntax
__property String SSLCertVersion = { read=FSSLCertVersion };
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (AS2Receiver Component)
The subject of the certificate used for client authentication.
Syntax
__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
Data Type
String
SSLCertEncoded Property (AS2Receiver Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded }; __property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
UsePSS Property (AS2Receiver Component)
This property specifies whether or not RSA-PSS will be used during signing and verification.
Syntax
__property bool UsePSS = { read=FUsePSS, write=FSetUsePSS };
Default Value
false
Remarks
This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.
Data Type
Boolean
AckRequest Method (AS2Receiver Component)
Optional. Acknowledges the incoming request.
Syntax
void __fastcall AckRequest();
Remarks
When called from within a server environment, AckRequest will acknowledge the client request with a 200 OK. This may be useful if the client has posted a lot of data, and has requested an asynchronous receipt.
If an acknowledgement is not expected (i.e., the client is expecting an MDN in the response), then invoking this method will do nothing. Servers may safely call this method immediately after ParseRequest for both synchronous and asynchronous MDN requests.
Config Method (AS2Receiver Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
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.
CreateMDNReceipt Method (AS2Receiver Component)
Creates MDNReceipt .
Syntax
void __fastcall CreateMDNReceipt(String Headers, String MDN, String Message);
Remarks
CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.
This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the component generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.
ParseRequest Method (AS2Receiver Component)
Parses the EDI message and determines the EDIData .
Syntax
void __fastcall ParseRequest();
Remarks
Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.
If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.
The component may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.
Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.
ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.
ProcessRequest Method (AS2Receiver Component)
Processes the EDI data, and generates the receipt.
Syntax
void __fastcall ProcessRequest();
Remarks
Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.
The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.
The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.
The component will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.
ProcessRestartRequest Method (AS2Receiver Component)
Processes the AS2 restart request, and sends a response to the client.
Syntax
void __fastcall ProcessRestartRequest();
Remarks
Invoking ProcessRestartRequest automates the restart AS2 server process. The method should be invoked when the HTTP HEAD request is received. The component will then parse the request, and respond to the client with the number of bytes (if any) the component received during a previous connection. The component will look for unfinished files in the RestartDirectory when processing these requests.
ReadRequest Method (AS2Receiver Component)
Reads the AS2 request from the HTTP session.
Syntax
void __fastcall ReadRequest();
Remarks
ReadRequest reads the AS2 request from the content of the Request (and optionally the RequestHeadersString) property. The component will parse the request from Request. The headers will be read into RequestHeaders. Finally, the component will parse the headers and populate the following properties:
- AS2From
- AS2To
- AS2VersionIncoming
- MessageId
- MDNTo
- ReceiptDeliveryOption
- RequestedSignatureProtocol
- RequestedMICAlgorithms
ParseRequest may be used to scan the entire message.
Reset Method (AS2Receiver Component)
Resets the state of the control.
Syntax
void __fastcall Reset();
Remarks
Reset resets the state of the component. All properties will be set to their default values.
SendAsyncMDN Method (AS2Receiver Component)
Sends the MDNReceipt to the RemoteURL specified.
Syntax
void __fastcall SendAsyncMDN(String RemoteURL, DynamicArray<Byte> MDNReceipt, String MDNReceiptHeaders);
Remarks
This method sends the asynchronous MDNReceipt to the RemoteURL specified. It need not be invoked if the prior call to SendResponse was successful. The RemoteURL, MDNReceipt, and MDNReceiptHeaders parameters should be the ones that were retrieved from ReceiptDeliveryOption and MDNReceipt's Content and Headers properties respectively.
If the RemoteURL requires SMTP transfer, the appropriate SMTP settings should be set using Config.
SendResponse Method (AS2Receiver Component)
In a server environment, responds to the requesting client with MDNReceipt .
Syntax
void __fastcall SendResponse();
Remarks
When called from within a server environment, SendResponse will respond to the requesting client. If an MDN was requested, then MDNReceipt will be returned to the client, either in the HTTP response or in a separate transmission, depending on the client request. In case it is returned in a separate transmission, a simple acknowledgement of "200 OK" will also be sent in the HTTP response, unless this was sent previously using AckRequest.
The AS2 headers will be taken from MDNReceipt and will be merged with HTTP headers as appropriate. Note that if ReceiptDeliveryOption indicates a "mailto:" URL, the appropriate SMTP settings should be set using Config.
The exact behavior of the method is specific to the environment. . Otherwise, the receipt will be directed to stdout. If this is impossible, an exception will be thrown.
Optionally, if an asynchronous MDN is requested, the MDNReceipt and ReceiptDeliveryOption may be saved so that the MDN may be sent later through the SendAsyncMDN method.
This method should only be invoked after MDNReceipt has been generated by CreateMDNReceipt or ProcessRequest.
SetTPInfo Method (AS2Receiver Component)
A convenient way to set AS2 communication parameters using XML strings.
Syntax
void __fastcall SetTPInfo(String Profile);
Remarks
SetTPInfo offers a convenient way to set AS2 communication parameters using XML strings. The format of the XML is the same as provided by the method GetTPInfo of AS2ProfileMgr.
An example usage scenario is shown below.
AS2Receiver as2receiver = new AS2Receiver();
AS2Profilemgr mgr = new AS2Profilemgr();
mgr.DataDir = "C:\as2data";
as2receiver.setTPInfo(mgr.getTPInfo("self"));
as2receiver.readRequest();
as2sender.setTPInfo(mgr.getTPInfo(as2receiver.getAS2From()));
as2receiver.processRequest();
as2receiver.sendResponse();
CEMRequest Event (AS2Receiver Component)
Fired when a Certificate Exchange Messaging (CEM) request is received.
Syntax
typedef struct { String RequestId; String As2From; } TibeAS2ReceiverCEMRequestEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverCEMRequestEvent)(System::TObject* Sender, TibeAS2ReceiverCEMRequestEventParams *e); __property TibeAS2ReceiverCEMRequestEvent OnCEMRequest = { read=FOnCEMRequest, write=FOnCEMRequest };
Remarks
This event fires when a Certificate Exchange Messaging (CEM) request is received.
RequestId is the CEM request Id. This must be saved and will be used when sending the CEM response.
As2From identifies the sender of the CEM request.
If CEMCertDir is set the received certificates will be written to the specified location. If CEMCertDir is not set the certificates will be held in memory and may be accessed by inspecting CEMDetails.
The CEM request also populates CEMRespondByDate and CEMResponseURL. CEMRespondByDate specifies the date by which the sender expects a response. CEMResponseURL specifies the URL to which the CEM response should be sent.
When this event fires the following CEMDetails properties are applicable:
- CEMCertStoreType
- CEMCertStore
- CEMCertSubject
- CEMCertUsage
- CEMCertIssuer
- CEMCertSerialNumber
- CEMCertId
- CEMRespondByDate
- CEMResponseURL
To send a CEM response save the CEMDetails values and call SendCEMResponse with the AS2Sender component.
CEMResponse Event (AS2Receiver Component)
Fired when a Certificate Exchange Messaging (CEM) response is received.
Syntax
typedef struct { String RequestId; String As2From; } TibeAS2ReceiverCEMResponseEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverCEMResponseEvent)(System::TObject* Sender, TibeAS2ReceiverCEMResponseEventParams *e); __property TibeAS2ReceiverCEMResponseEvent OnCEMResponse = { read=FOnCEMResponse, write=FOnCEMResponse };
Remarks
This event fires when a Certificate Exchange Messaging (CEM) response is received.
RequestId is the CEM request Id. Match this to the request Id from the original request.
As2From identifies the sender of the CEM request.
When this event fires the CEMDetails property will be populated. Inspect the CEMAccepted property to determine whether each CEM request was accepted. If the request was rejected, check CEMRejectionReason for details.
When this event fires the following CEMDetails properties are applicable:
EDIDataInfo Event (AS2Receiver Component)
Fired when processing an incoming message.
Syntax
typedef struct { String Name; String DataType; bool Duplicate; } TibeAS2ReceiverEDIDataInfoEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverEDIDataInfoEvent)(System::TObject* Sender, TibeAS2ReceiverEDIDataInfoEventParams *e); __property TibeAS2ReceiverEDIDataInfoEvent OnEDIDataInfo = { read=FOnEDIDataInfo, write=FOnEDIDataInfo };
Remarks
When ParseRequest or ProcessRequest has been called this event will fire and provide the filename of the incoming data via the Name parameter. DataType will be the EDI type specified in the message, such as "application/edi-x12".
Duplicate is used in conjunction with the InvalidFileNameMDNAction configuration setting when Filename Preservation with an Associated MDN Response is implemented in the receiving agent to support MDN responses for duplicate filenames. If IncomingDirectory is specified, the Duplicate parameter will return True if the filename specified in the request exists on disk. Additionally, the Duplicate parameter may be set to True before the event exits so that checking for duplicate filenames may be extended to the application logic.
Error Event (AS2Receiver Component)
Fired when information is available about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TibeAS2ReceiverErrorEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverErrorEvent)(System::TObject* Sender, TibeAS2ReceiverErrorEventParams *e); __property TibeAS2ReceiverErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (AS2Receiver Component)
Fired with log information while processing a message.
Syntax
typedef struct { String LogType; String LogMessage; DynamicArray<Byte> LogMessageB; } TibeAS2ReceiverLogEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverLogEvent)(System::TObject* Sender, TibeAS2ReceiverLogEventParams *e); __property TibeAS2ReceiverLogEvent OnLog = { 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:
"LOG" | Information about the status of the process. |
"ERR" | An error was encountered. |
"DAT" | The EDI payload. |
"REQ" | The raw request |
"MDN" | The MDN response. |
"DEBUG" | Debug information. |
"DAT.INPUT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.ENCRYPT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.COMPRESS" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.SIGN" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DECRYPT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DECOMPRESS" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.VERIFY" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DEBUG" | Debug information when processing payload. Only applicable when LogDebug is True. |
RecipientInfo Event (AS2Receiver Component)
Fired for each recipient certificate of the encrypted message.
Syntax
typedef struct { String Issuer; String SerialNumber; String SubjectKeyIdentifier; String EncryptionAlgorithm; } TibeAS2ReceiverRecipientInfoEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverRecipientInfoEvent)(System::TObject* Sender, TibeAS2ReceiverRecipientInfoEventParams *e); __property TibeAS2ReceiverRecipientInfoEvent OnRecipientInfo = { read=FOnRecipientInfo, write=FOnRecipientInfo };
Remarks
When ParseRequest or ProcessRequest has been called on a valid encrypted message, this event will fire for each recipient certificate that the message has been encrypted for.
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"
SignerCertInfo Event (AS2Receiver Component)
This event is fired during verification of the signed message.
Syntax
typedef struct { String Issuer; String SerialNumber; String SubjectKeyIdentifier; String CertEncoded; DynamicArray<Byte> CertEncodedB; } TibeAS2ReceiverSignerCertInfoEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverSignerCertInfoEvent)(System::TObject* Sender, TibeAS2ReceiverSignerCertInfoEventParams *e); __property TibeAS2ReceiverSignerCertInfoEvent OnSignerCertInfo = { 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 (AS2Receiver Component)
For asynchronous HTTPS MDNs, fired after the server presents its certificate.
Syntax
typedef struct { String CertEncoded; DynamicArray<Byte> CertEncodedB; String CertSubject; String CertIssuer; String Status; bool Accept; } TibeAS2ReceiverSSLServerAuthenticationEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverSSLServerAuthenticationEvent)(System::TObject* Sender, TibeAS2ReceiverSSLServerAuthenticationEventParams *e); __property TibeAS2ReceiverSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };
Remarks
This event is fired when returning asynchronous MDNs over HTTPS to the client, and allows the client can decide whether to continue with the connection process or not. In general, the component will allow self-signed certs only if explicitly specified.
To accept a self-signed certificate, either trap the SSLServerAuthentication event and set Accept to true based on the values of CertSubject, CertEncoded, etc., or set the SSLAcceptServerCert property to the value of the expected certificate (if the server certificate is known in advance the latter method is simpler).
SSLStatus Event (AS2Receiver Component)
Fired when secure connection progress messages are available.
Syntax
typedef struct { String Message; } TibeAS2ReceiverSSLStatusEventParams; typedef void __fastcall (__closure *TibeAS2ReceiverSSLStatusEvent)(System::TObject* Sender, TibeAS2ReceiverSSLStatusEventParams *e); __property TibeAS2ReceiverSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (AS2Receiver 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.AS2Receiver Config Settings
If AcceptAnySignerCert is set to true, the component will accept any signer certificate for the incoming signature. Use of this setting in production is discouraged, as failing to authenticate the sender poses a security risk.
The version of AS2 that was used in the incoming message.
The version of AS2 to be used in the outgoing message.
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]".
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 |
For security reasons, setting this value will clear the values of User and Password.
This setting specifies a relative or absolute path on disk where certificates received from a CEM request will be saved. The filename format is:
CEMRequestId + "_" + CEMCertId + ".cer"
The CEMRequestId may be retrieved from the CEMRequest event. Any invalid characters will be replaced
with "_". If there is an error writing the file to disk the Error event will fire with details.
To overwrite existing certificate files set OverwriteCEMCerts to True.
If this is not set, the certificates will be held in memory and can be accessed via CEMDetails. See CEMRequest for details.
Determines if the stream specified by EDIDataOutputStream is closed after ParseRequest or ProcessRequest returns. By default this is True. Setting this to False keeps the stream open for further use.
This configuration is only necessary when decoding EDI messages that contain attachments. If a value is specified for DecodeTempDirectory, the component will first decode the S/MIME message to the temp directory, then decode the embedded MIME message containing attachments to the IncomingDirectory.
Note: When using this configuration, if IncomingDirectory is not set, the component will not clean up any temp files it creates. These files must be monitored and cleaned manually by the user.
When receiving messages this setting controls whether the component attempts to detect duplicate messages. Consider the following scenario:
A sender transmits a message, it is successfully received but the MDN cannot be delivered due to a network error. The sender does not receive the MDN and retransmits the message.
This results in two messages being received and processed. In most cases this is not an issue as the backend processing done outside of the component will detect duplicate messages. However, this setting may be enabled to have the component check for duplicates to prevent duplicate incoming messages.
When enabled, LogDirectory must be set to a value that will resolve to the same location for both received requests. This means the "%Date:Format%" macro must not be used in the LogDirectory value. Additionally, this functionality can only work if the sender uses the same MessageId in both requests.
If a duplicate is detected, no exception is thrown, but the component will respond with an MDN including a warning that a duplicate was detected. The message in the duplicate request will not be processed.
The default value is False.
If the data is encrypted, EncryptionAlgorithm will contain the encryption algorithm used to encrypt the data; i.e., "3DES". If the data is not encrypted EncryptionAlgorithm will contain an empty string.
If the data is encrypted this setting contains the padding scheme used when the data was originally encrypted. Possible values are:
- RSAES-PKCS1-v1_5
- RSAES-OAEP
If the data is encrypted, EncryptionType will contain the MIME type of the encrypted data; i.e., "application/pkcs7-mime". If the data is not encrypted EncryptionType will contain an empty string.
At present only "application/pkcs7-mime" is supported for decryption.
By default, ParseRequest will halt and throw an exception if Request contains errors or requests algorithms, protocols, or receipt types not supported by the component. By setting ErrorProcessingFlags the component can be configured to not halt for certain types of errors. The errors will still be reported in ScanResult.
Use of this property allows EDIData to be determined even if the component is not fully able to respond to the client's request.
ErrorReportingFlags control how the errors are reported in the MDNReceipt.
The value should be set to the OR of one or more of the following values:
0x04 Unable to validate integrity of data, or unsupported signing protocol used.
0x08 Unable to authenticate the sender.
0x10 Client requested unsupported signature type.
0x20 Client requested unsupported MIC algorithm.
By default, MDNReceipt will report an error if any of the conditions below occur. The MIC will not be calculated and the data will be reported as unprocessed.
The MDNReceipt may be configured to permit one or more of the errors below. A warning will be reported if MDNWarning is set; otherwise the error will silently be ignored. Note that errors should be ignored only with extreme caution, and only by agreement of both trading parties.
Multiple errors may be permitted by OR-ing the flags together.
The value should be set to the OR of one or more of the following values:
0x04 Unable to validate integrity of data, or unsupported signing protocol used.
0x08 Unable to authenticate the sender.
0x10 Client requested unsupported signature type.
0x20 Client requested unsupported MIC algorithm.
This setting specifies whether to read the filename from the MIME part header (default) or the HTTP header.
When processing a request that supports filename preservation the filename will be read from the MIME body part by default. The MIME body part should hold the filename in the Content-Disposition header for that part as per the specification.
Some implementations do not behave according to the specification and specify the filename in the HTTP Content-Disposition header instead of the MIME part headers.
Possible value are:
0 (default) | MIME part header |
1 | HTTP header |
2 | Content-Type MIME part header |
When this setting is enabled (default False), any errors that occur while writing to log files will be ignored, and no exception will be thrown. Note that this may cause logs to be incomplete or missing without any indication that an issue occurred.
Used to implement support for Filename Preservation with Associated MDN Response as requested by the Financial Services Technical Consortium (fstc.org). The following options are supported:
0 | Continue |
1 | Warn |
2 | Fail |
If set to 1 (Warn), the component will rename the filename as above to avoid file conflicts, but will issue a MDN warning when the filename provided is missing, contains invalid characters, or is detected as a duplicate (this behavior is governed by the Duplicate parameter of the EDIDataInfo event).
If set to 2 (Fail), the component will reject transmissions where the filename provided is missing, contains invalid characters, or is detected as a duplicate.
This setting specifies whether to log debug data. When set to True the component will create additional files in the LogDirectory. The default value is False.
When sending, files with extensions ".input", ".sign", ".compress", and ".encrypt" may be created. When receiving, files with extensions ".input", ".verify", ".decompress", and ".decrypt" may be created.
If set, this will be used as for the filename of the log file.
Note that only the base name should be specified as the component will append the appropriate file extension.
When LogDirectory is set, several pieces of information are written to log files in the specified directory. Set LogOptions to one or more of the following values to control what information is written to file. When specifying multiple values, include them in the same string (i.e. "LogOptions=Status, Response, Payload"):
Status | Contains information on applied security options and pass/fail status of transmission |
Request | Contains the raw incoming request before processing |
Payload | Contains log of processed payload after transmission |
MDN | Contains the MDN receipt response to a request |
Errors | This is only written in an error is encountered, containing the error. |
All | All of the above |
Messages may contain multiple MIME parts if attachments are present. This setting specifies the maximum number of MIME parts to process. The default value is "100", which means 99 attachments will be processed. Each message contains one MIME part for the body, and one additional MIME part for each attachment. Set this value to "-1" to indicate no restrictions.
If specified, this setting overrides the MDN disposition that was automatically calculated by the component. In most cases this is not necessary but may be used when specifying a custom Disposition header is required. For instance:
as2receiver.Config("MDNDisposition=message-deemed-invalid-due-to-unknown-from-and.or-to-parties");
By default, the component will honor the request of the client, if possible. The MIC will be calculated using the requested algorithm, stored in the MICValue property of MDNReceipt, and reported in the outgoing MDN. If not possible, the MDN will not be signed, and ParseRequest will throw an exception unless ErrorProcessingFlags has been configured to prevent this. The following options are supported:
0 | As Requested |
1 | As Requested Or SHA1 |
2 | SHA1 |
3 | MD5 |
4 | None |
5 | SHA-256 |
6 | SHA-384 |
7 | SHA-512 |
8 | SHA-224 |
9 | As Requested Or SHA-256 |
The property may be set to one of the listed values above to override the client's request, and use the specified signing algorithm. Use extreme caution when doing this; it will result in a non-RFC compliant server.
The name of the user agent performing the disposition. The RFC 2298 recommendation is to use the DNS name of the user agent and the name of the software performing the disposition, for example, "edi-server.nsoftware.com; /n software EDI Server Demo".
MDNSendingMode allows the server software to describe the level of user interaction in sending the MDN. MDNSendingMode corresponds to the "disposition-mode" field in the Disposition Header, as described further in RFC 3335. The following values are supported:
0 | Automatic |
1 | User Configurable |
2 | Manual |
By default, the disposition-mode value will be "automatic-action/MDN-sent-automatically".
MDNWarning defines a warning to appear in the outgoing MDNReceipt. If any errors are returned in ScanResult and not marked as to be allowed in ErrorReportingFlags the errors will take precedence and the warning will not be reported.
MDNWarning should be assigned when allowing the errors returned in ScanResult. The MDNReceipt will indicate successful processing of Request, but will contain a Warning field. The following warnings are defined by the AS2 specifications:
"authentication-failed, processing continued"
Any other warnings are not defined by the specifications and may or may not be understood by the client.
This setting determines whether to normalize line endings before signature verification.
In most cases the signature is verified by calculating a Message Integrity Check (MIC) over the exact data that is received. In some cases other software such as Mendelson AS2 may calculate signatures over a version of the data with normalized line endings. During processing attempts to verify a signature that was created in this manner may lead to one of the following errors:
- Unable to verify content integrity: Message digest mismatch in signature.
- The receipt signature could not be verified: Message digest mismatch in signature.
If one of the errors above is encountered and the received data is expected to be otherwise correct setting this setting to True may resolve the issue by normalizing line endings before verifying the signature.
Note: This should only be set to True if there is a specific reason to do so.
This setting specifies whether CEM certificates are overwritten in CEMCertDir when another certificate with the same name and Id is received. The default value is False.
If AuthScheme is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".
If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.
If ProcessingError is set to "True" before invoking CreateMDNReceipt, a MDN with the disposition "processed/Error: unexpected-processing-error" is returned.
This setting is used while sending an asynchronous MDN.
This setting is used while sending an asynchronous MDN.
This setting is used while sending an asynchronous MDN.
This setting is used while sending an asynchronous MDN.
This setting is used while sending an asynchronous MDN.
The protocol used to sign the outgoing MDNReceipt. The following values are supported:
0 | As Requested |
1 | PKCS7 |
2 | None |
If the client does not request a signature, one will not be provided by default. However, the server may provide one by setting ReceiptSigningProtocol to PKCS7 (1). If the client requests a signature, and the signature protocol is supported by the component, the request must be honored, per RFC specifications.
This property will contain the algorithm(s) requested ("sha1", "md5", "sha-256", etc.) as well as the importance ("required" or "optional") specified by the client. If multiple algorithms are specified, precedence is given to the ones on the left. Formatting is as in RFC 3335, e.g., "optional, sha1, md5".
This setting will contain an empty string if a MIC was not requested.
This property will contain the protocol requested ("pkcs7-signature" or "pgp-signature") as well as the importance ("required" or "optional") specified by the client, as formatted in RFC 3335, e.g., "optional, pkcs7-signature".
This setting will contain an empty string if a signature was not requested.
This config allows for the AS2 message to be read from a file at the specified location on disk. The file can contain either just the body of the AS2 request, or it can contain both the headers and the body.
If the file includes the headers, they should be separated from the body by a double CRLF pair. If the file doesn't include the headers, they will need to be set to the RequestHeadersString property.
This setting is used while processing the received message and causes an exception to be thrown if the message is not intended for the receiver specified by RequireAS2To.
This setting specifies a comma separated list of allowed signature algorithms used in messages verified by the component. By default the setting is empty and any signature algorithm is supported. To restrict the algorithms to one or more values set this setting to a comma separated list. For instance sha1,sha256.
This setting is used while processing the received message and causes an exception to be thrown if the encryption requirement is not met.
This setting is used while processing the received message and enforces a requirement that the EncryptionPaddingScheme be RSAES-OAEP. If the message was encrypted with any other padding scheme the component raises an exception
This setting is used while processing the received message and enforces a requirement that the SenderSignatureScheme be RSASSA-PSS. If the message was signed with any other scheme the component raises an exception
This setting is used while processing the received message and causes an exception to be thrown if the signature requirement is not met.
The human-readable subject to be used for the MDN response.
This will contain the name of the algorithm used to sign the incoming message. Possible values are:
- sha1
- md5
- sha-256
- sha-384
- sha-512
- sha-224
This setting returns the signature scheme used when the incoming message was originally signed. Possible values are:
- RSASSA-PKCS1-v1_5
- RSASSA-PSS
This property will contain the protocol requested ("pkcs7-signature" or "pgp-signature") as well as the importance ("required" or "optional") specified by the client, as formatted in RFC 3335, e.g., "optional, pkcs7-signature".
This setting will contain an empty string if a signature was not requested.
This setting specifies one or more CA certificates to be used when verifying signed messages.
To support multiple CA signing certificates, add all the certificates in the chain by prepending a '+' character to the PEM formatted certificate data. For example, the code below adds two certs to the RootCertificate property.
as2receiver.RootCertificate = cert1;
as2receiver.RootCertificate = "+" + cert2;
In case an asynchronous MDN is requested over SMTP, the sender; i.e., the value of "From".
In case an asynchronous MDN is delivered over SMTP, the address of the server to be used to send it.
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.
This setting controls whether to log a .wrn file or a .err file in the LogDirectory when MDN delivery fails. When set to True and MDN delivery fails a .wrn file is created in the LogDirectory. This allows an application to treat MDN failures as warnings when monitoring log files. When set to False and MDN delivery fails a .err file is created. The default value is False.
Note: This setting is not applicable when calling SendAsyncMDN.
HTTP Config Settings
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.
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.
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.
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.
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]".
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.
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.
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.
If set to True, the URL passed to the component will be URL encoded. The default value is False.
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
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.
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.
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") or HTTP/3 ("3.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.
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.
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. If false, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is false.
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.
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).
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.
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.
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 ("\r\n") .
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.
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 ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting is provided for use by components that do not directly expose Proxy properties.
This configuration setting returns the complete set of raw headers as sent by the client.
This configuration setting contains the result code 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].
This configuration setting contains the contents of the last response from the server.
If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.
This configuration setting returns the complete set of raw headers as received from the server.
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"));
If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
This 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.
This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
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
When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.
This configuration setting is provided for use by components that do not directly expose Firewall properties.
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
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.
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.
Possible 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.
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.
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.
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.
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 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.
The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
This configuration setting 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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
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.
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
If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.
Note: This value is not applicable in Java.
When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this configuration setting is set to False.
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 as follows:
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only 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 configuration setting has no effect if SSLProvider is set to Platform.
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). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
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.
When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) 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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
This configuration 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 Online Certificate Status Protocol (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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
This minimum cipher strength is 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.
Note: This configuration 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 configuration 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 configuration setting.
This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client'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 configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration setting enables the 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 include the following:
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 the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- 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_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.
This configuration setting is used to enable or disable the supported security protocols.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (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 that 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 supported only 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 available only 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, these 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.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.
This configuration setting is applicable only when SSLProvider is set to Internal.
This configuration 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.
This configuration 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 traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
This configuration setting returns the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
This configuration setting returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The following flags are defined (specified in hexadecimal notation). They can be ORed 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 non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and 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 configuration setting should be set only 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 configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This configuration 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 configuration 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 configuration 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.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
This configuration 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)
This configuration 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 roundtrip 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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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"
This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:
- "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)
This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only 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
If AbsoluteTimeout is set to True, any method that 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 User Datagram Protocol (UDP) ports.
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).
This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.
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
When queried, this setting will return a string containing information about the product's build.
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 |
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 |
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.
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 true.
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.
When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all 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 that 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 applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration 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 (AS2Receiver Component)
Note: The starred errors may be ignored by configuring the ErrorProcessingFlags and ErrorReportingFlags of the component.AS2Receiver Errors
701 | Unable to write log file. |
702 | Unable to read HTTP headers. |
703 | Unable to read HTTP message body. |
704 | No message to process. |
705 | No response to send. |
711 | The incoming message was encrypted with an unknown protocol. |
712 | Unable to decrypt message. |
713 | Unable to decompress message. |
721 | An HTTP environment is required to perform this operation. |
731 | *Unable to authenticate the sender. |
732 | *Unable to verify content integrity. |
733 | *Unsupported signature type was requested. |
734 | *Unsupported MIC algorithm(s) were requested. |
741 | You must specify an Certificate. |
751 | I/O error writing log file. |
761 | Unable to mail asynchronous MDN. |
762 | Unable to post asynchronous MDN. |
801 | System error (details follow). |
SMIME Errors
10191 | Invalid index (RecipientIndex). |
10192 | Message decoding error (code). |
10193 | Unexpected message type. |
10194 | Unsupported hashing/signing algorithm. |
10195 | The message does not have any signers. |
10196 | The message signature could not be verified. |
10197 | Could not locate a suitable decryption certificate. |
10198 | The signer certificate could not be found. |
10199 | No signing certificate was supplied for signing the message. |
10201 | The specified certificate was not the one required. |
10202 | The specified certificate could not be found. |
10221 | Could not acquire CSP. |
10222 | Type validation error. |
10223 | Unsupported key size. |
10224 | Unrecognized Content-Type object identifier. |
10225 | Unrecognized public key format. |
10226 | No choices specified. |
10228 | Must specify output stream. |
10280 | Invalid part index. |
10281 | Unknown MIME type. |
10283 | No MIME-boundary found. |
10280 | Error decoding certificate. |