# AS2Sender Control The AS2Sender control implements an AS2 / EDI-INT client. ## Syntax **AS2Sender** ## Remarks The AS2Sender component may be used to send EDI or other messages over HTTP/S, using the AS2 protocol. It may also be used to verify synchronous or asynchronous server responses. A typical AS2 transaction is as follows: (1) The sender sends an EDI document to the receiver using HTTP or HTTPS. Typically the document will be signed and encrypted (particularly if SSL is not used). A signed receipt will also be requested. (2) The receiver decrypts the message and verifies the signature. (3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message. **When sending an EDI message**, the client should specify, at a minimum, [AS2From](#as2from-property-as2sender-control) and [AS2To](#as2to-property-as2sender-control), [URL](#url-property-as2sender-control), and [EDIData](#edidata-property-as2sender-control). The [Post](#post-method-as2sender-control) method should then be invoked. **To secure the EDI transmission**, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the control will apply message security if the appropriate certificates are specified. To sign the data, set SigningCert. To encrypt, set RecipientCerts. If the recipient uses different certificates for signing and encryption it will also be necessary to set ReceiptSignerCert. **SSL** will also be used if the scheme in [URL](#url-property-as2sender-control) is "https". If your trading partner is using a self-signed certificate, it will be necessary to set SSLAcceptServerCert or trap the [SSLServerAuthentication](#sslserverauthentication-event-as2sender-control) event to accept the certificate. The message may also be **compressed** by setting [CompressionFormat](#compressionformat-property-as2sender-control). **To request a receipt**, or Message Disposition Notification (MDN), simply set the [MDNTo](#mdnto-property-as2sender-control) property. The [MDNOptions](#mdnoptions-property-as2sender-control) property may be used to customize the request. By default, the control will request a signed MDN over a SHA-256 hash. The control supports both synchronous and asynchronous MDN receipt delivery. By default, the control requests synchronous MDN receipt delivery, and the MDN will be returned in the HTTP reply. To request asynchronous MDN delivery, set the [MDNDeliveryOption](#mdndeliveryoption-property-as2sender-control) to the URL where MDN's are to be delivered. The HTTP reply will automatically be processed by the control. If an MDN was requested, [Post](#post-method-as2sender-control) will validate the MDN and (if signed) establish non-repudiation of receipt. Any errors or warnings will cause the control to throw an exception. In either case, after the EDI transaction is processed successfully, the MDNReceipt will be populated with the appropriate values. **Validating Asynchronous MDNs** The control may also be used to process and verify asynchronous MDNs. To do this, you should invoke [ReadAsyncReceipt](#readasyncreceipt-method-as2sender-control). This will read the receipt from the current HTTP context (or from MDNReceipt, if set manually), and allow you to determine your trading partner's identity and the message ID. You should then set ReceiptSignerCert and [OriginalContentMIC](#originalcontentmic-property-as2sender-control), and finally invoke [VerifyReceipt](#verifyreceipt-method-as2sender-control). ## Property List *The following is the full list of the properties of the control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AS2From](#as2from-property-as2sender-control) | The AS2 Identifier of the sending system. | | [AS2To](#as2to-property-as2sender-control) | The AS2 Identifier of the receiving system. | | [AS2Version](#as2version-property-as2sender-control) | The AS2 protocol version used for outgoing messages. | | [AsyncMDNInfoDir](#asyncmdninfodir-property-as2sender-control) | Path to a directory to store data used in verifying AsyncMDNs. | | [AttachmentCount](#attachmentcount-property-as2sender-control) | The number of records in the Attachment arrays. | | [AttachmentContentType](#attachmentcontenttype-property-as2sender-control) | The MIME content-type of this ediattachment . | | [AttachmentData](#attachmentdata-property-as2sender-control) | This property contains the attachment data. | | [AttachmentFileName](#attachmentfilename-property-as2sender-control) | The file name of the attachment. | | [AttachmentHeaders](#attachmentheaders-property-as2sender-control) | The control fills out Headers each time any of the other properties for that ediattachment are changed. | | [AttachmentName](#attachmentname-property-as2sender-control) | Name is the final name to be associated with the contents of either the Data or FileName properties. | | [CEMCount](#cemcount-property-as2sender-control) | The number of records in the CEM arrays. | | [CEMAccepted](#cemaccepted-property-as2sender-control) | Whether the CEM request is accepted. | | [CEMCertId](#cemcertid-property-as2sender-control) | A user defined identifier for the certificate. | | [CEMCertIssuer](#cemcertissuer-property-as2sender-control) | This property holds the issuer of the certificate. | | [CEMCertSerialNumber](#cemcertserialnumber-property-as2sender-control) | This property holds the serial number of the certificate. | | [CEMCertStore](#cemcertstore-property-as2sender-control) | The name of the certificate store for the certificate. | | [CEMCertStorePassword](#cemcertstorepassword-property-as2sender-control) | 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](#cemcertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [CEMCertSubject](#cemcertsubject-property-as2sender-control) | The subject of the certificate. | | [CEMCertUsage](#cemcertusage-property-as2sender-control) | This property defines which usages are applicable to the certificate. | | [CEMRejectionReason](#cemrejectionreason-property-as2sender-control) | If Accepted is False this property specifies the reason a request was rejected. | | [CEMRespondByDate](#cemrespondbydate-property-as2sender-control) | This property specifies the date by which the other party should respond. | | [CEMResponseURL](#cemresponseurl-property-as2sender-control) | This property defines the URL to which the response should be sent. | | [CompressionFormat](#compressionformat-property-as2sender-control) | The compression format (if any) to use. | | [CookieCount](#cookiecount-property-as2sender-control) | The number of records in the Cookie arrays. | | [CookieDomain](#cookiedomain-property-as2sender-control) | The domain of a received cookie. | | [CookieExpiration](#cookieexpiration-property-as2sender-control) | An expiration time for the cookie (if provided by the server). | | [CookieName](#cookiename-property-as2sender-control) | The name of the cookie. | | [CookiePath](#cookiepath-property-as2sender-control) | A path name to limit the cookie to (if provided by the server). | | [CookieSecure](#cookiesecure-property-as2sender-control) | The security flag of the received cookie. | | [CookieValue](#cookievalue-property-as2sender-control) | The value of the cookie. | | [EDIData](#edidata-property-as2sender-control) | This property contains the EDI payload of the transmission. | | [EDIFileName](#edifilename-property-as2sender-control) | In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission. | | [EDIName](#ediname-property-as2sender-control) | Name is the final name to be associated with the contents of either the Data or FileName properties. | | [EDIType](#editype-property-as2sender-control) | The Content-Type of the EDI message. | | [EncryptionAlgorithm](#encryptionalgorithm-property-as2sender-control) | The algorithm used to encrypt the EDI data. | | [Etag](#etag-property-as2sender-control) | The Etag of the file being sent. | | [FirewallAutoDetect](#firewallautodetect-property-as2sender-control) | Whether to automatically detect and use firewall system settings, if available. | | [FirewallHost](#firewallhost-property-as2sender-control) | The name or IP address of the firewall (optional). | | [FirewallPassword](#firewallpassword-property-as2sender-control) | A password if authentication is to be used when connecting through the firewall. | | [FirewallPort](#firewallport-property-as2sender-control) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [FirewallType](#firewalltype-property-as2sender-control) | The type of firewall to connect through. | | [FirewallUser](#firewalluser-property-as2sender-control) | A username if authentication is to be used when connecting through a firewall. | | [From](#from-property-as2sender-control) | The email address of the HTTP agent (optional). | | [LocalHost](#localhost-property-as2sender-control) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LogDirectory](#logdirectory-property-as2sender-control) | The path to a directory for logging. | | [LogFile](#logfile-property-as2sender-control) | The log file written. | | [MDNDeliveryOption](#mdndeliveryoption-property-as2sender-control) | A URL indicating how the receipt is to be delivered. | | [MDNOptions](#mdnoptions-property-as2sender-control) | Used to indicate the options requested for the MDN receipt. | | [MDNReceiptContent](#mdnreceiptcontent-property-as2sender-control) | This contains the entire content of the MDN Receipt. | | [MDNReceiptHeaderCount](#mdnreceiptheadercount-property-as2sender-control) | The number of headers in the MDN. | | [MDNReceiptHeaderField](#mdnreceiptheaderfield-property-as2sender-control) | The property name of the MDN header currently selected by HeaderIndex . | | [MDNReceiptHeaderIndex](#mdnreceiptheaderindex-property-as2sender-control) | Which MDN header is currently selected to populate HeaderField and HeaderValue . | | [MDNReceiptHeaders](#mdnreceiptheaders-property-as2sender-control) | Headers contains all of the headers of the AS2 MDN Receipt as a single string. | | [MDNReceiptHeaderValue](#mdnreceiptheadervalue-property-as2sender-control) | The value of the MDN header currently selected by HeaderIndex . | | [MDNReceiptMDN](#mdnreceiptmdn-property-as2sender-control) | MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. | | [MDNReceiptMessage](#mdnreceiptmessage-property-as2sender-control) | The human-readable portion of the MDN receipt. | | [MDNReceiptMICValue](#mdnreceiptmicvalue-property-as2sender-control) | The Message Integrity Check(s) (one-way hash) of the original EDI message. | | [MDNReceiptSigningProtocol](#mdnreceiptsigningprotocol-property-as2sender-control) | This property contains the MIME type of the signature used, if any (i. | | [MDNTo](#mdnto-property-as2sender-control) | Used to indicate that a message disposition notification is requested. | | [MessageId](#messageid-property-as2sender-control) | The Id of the message. | | [OriginalContentMIC](#originalcontentmic-property-as2sender-control) | The Message Integrity Check(s) (one-way hash) of the outgoing message. | | [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) | The type of authorization to perform when connecting to the proxy. | | [ProxyAutoDetect](#proxyautodetect-property-as2sender-control) | Whether to automatically detect and use proxy system settings, if available. | | [ProxyPassword](#proxypassword-property-as2sender-control) | A password if authentication is to be used for the proxy. | | [ProxyPort](#proxyport-property-as2sender-control) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [ProxyServer](#proxyserver-property-as2sender-control) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [ProxySSL](#proxyssl-property-as2sender-control) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [ProxyUser](#proxyuser-property-as2sender-control) | A username if authentication is to be used for the proxy. | | [ReceiptSignerCertEffectiveDate](#receiptsignercerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [ReceiptSignerCertEncoded](#receiptsignercertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [ReceiptSignerCertExpirationDate](#receiptsignercertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [ReceiptSignerCertExtendedKeyUsage](#receiptsignercertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [ReceiptSignerCertFingerprint](#receiptsignercertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ReceiptSignerCertFingerprintSHA1](#receiptsignercertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ReceiptSignerCertFingerprintSHA256](#receiptsignercertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ReceiptSignerCertIssuer](#receiptsignercertissuer-property-as2sender-control) | The issuer of the certificate. | | [ReceiptSignerCertPrivateKey](#receiptsignercertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [ReceiptSignerCertPrivateKeyAvailable](#receiptsignercertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [ReceiptSignerCertPrivateKeyContainer](#receiptsignercertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [ReceiptSignerCertPublicKey](#receiptsignercertpublickey-property-as2sender-control) | The public key of the certificate. | | [ReceiptSignerCertPublicKeyAlgorithm](#receiptsignercertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [ReceiptSignerCertPublicKeyLength](#receiptsignercertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [ReceiptSignerCertSerialNumber](#receiptsignercertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [ReceiptSignerCertSignatureAlgorithm](#receiptsignercertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [ReceiptSignerCertStorePassword](#receiptsignercertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ReceiptSignerCertStoreType](#receiptsignercertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [ReceiptSignerCertSubjectAltNames](#receiptsignercertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [ReceiptSignerCertThumbprintMD5](#receiptsignercertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [ReceiptSignerCertThumbprintSHA1](#receiptsignercertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [ReceiptSignerCertThumbprintSHA256](#receiptsignercertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [ReceiptSignerCertUsage](#receiptsignercertusage-property-as2sender-control) | The text description of UsageFlags . | | [ReceiptSignerCertUsageFlags](#receiptsignercertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [ReceiptSignerCertVersion](#receiptsignercertversion-property-as2sender-control) | The certificate's version number. | | [RecipientCertCount](#recipientcertcount-property-as2sender-control) | The number of records in the RecipientCert arrays. | | [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [RecipientCertEncoded](#recipientcertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [RecipientCertExpirationDate](#recipientcertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [RecipientCertFingerprint](#recipientcertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [RecipientCertIssuer](#recipientcertissuer-property-as2sender-control) | The issuer of the certificate. | | [RecipientCertPrivateKey](#recipientcertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [RecipientCertPublicKey](#recipientcertpublickey-property-as2sender-control) | The public key of the certificate. | | [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [RecipientCertSerialNumber](#recipientcertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [RecipientCertStore](#recipientcertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [RecipientCertStorePassword](#recipientcertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [RecipientCertStoreType](#recipientcertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [RecipientCertUsage](#recipientcertusage-property-as2sender-control) | The text description of UsageFlags . | | [RecipientCertUsageFlags](#recipientcertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [RecipientCertVersion](#recipientcertversion-property-as2sender-control) | The certificate's version number. | | [RestartDirectory](#restartdirectory-property-as2sender-control) | The directory to log cached files when using AS2 restart functionality. | | [RolloverSigningCertEffectiveDate](#rolloversigningcerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [RolloverSigningCertEncoded](#rolloversigningcertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [RolloverSigningCertExpirationDate](#rolloversigningcertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [RolloverSigningCertExtendedKeyUsage](#rolloversigningcertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [RolloverSigningCertFingerprint](#rolloversigningcertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [RolloverSigningCertFingerprintSHA1](#rolloversigningcertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [RolloverSigningCertFingerprintSHA256](#rolloversigningcertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [RolloverSigningCertIssuer](#rolloversigningcertissuer-property-as2sender-control) | The issuer of the certificate. | | [RolloverSigningCertPrivateKey](#rolloversigningcertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [RolloverSigningCertPrivateKeyAvailable](#rolloversigningcertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [RolloverSigningCertPrivateKeyContainer](#rolloversigningcertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [RolloverSigningCertPublicKey](#rolloversigningcertpublickey-property-as2sender-control) | The public key of the certificate. | | [RolloverSigningCertPublicKeyAlgorithm](#rolloversigningcertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [RolloverSigningCertPublicKeyLength](#rolloversigningcertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [RolloverSigningCertSerialNumber](#rolloversigningcertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [RolloverSigningCertSignatureAlgorithm](#rolloversigningcertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [RolloverSigningCertStorePassword](#rolloversigningcertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [RolloverSigningCertStoreType](#rolloversigningcertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [RolloverSigningCertSubjectAltNames](#rolloversigningcertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [RolloverSigningCertThumbprintMD5](#rolloversigningcertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [RolloverSigningCertThumbprintSHA1](#rolloversigningcertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [RolloverSigningCertThumbprintSHA256](#rolloversigningcertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [RolloverSigningCertUsage](#rolloversigningcertusage-property-as2sender-control) | The text description of UsageFlags . | | [RolloverSigningCertUsageFlags](#rolloversigningcertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [RolloverSigningCertVersion](#rolloversigningcertversion-property-as2sender-control) | The certificate's version number. | | [SignatureAlgorithm](#signaturealgorithm-property-as2sender-control) | Signature algorithm to be used in outgoing messages. | | [SigningCertEffectiveDate](#signingcerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [SigningCertEncoded](#signingcertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [SigningCertExpirationDate](#signingcertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [SigningCertExtendedKeyUsage](#signingcertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [SigningCertFingerprint](#signingcertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SigningCertFingerprintSHA1](#signingcertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SigningCertFingerprintSHA256](#signingcertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SigningCertIssuer](#signingcertissuer-property-as2sender-control) | The issuer of the certificate. | | [SigningCertPrivateKey](#signingcertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [SigningCertPrivateKeyAvailable](#signingcertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [SigningCertPrivateKeyContainer](#signingcertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [SigningCertPublicKey](#signingcertpublickey-property-as2sender-control) | The public key of the certificate. | | [SigningCertPublicKeyAlgorithm](#signingcertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [SigningCertPublicKeyLength](#signingcertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [SigningCertSerialNumber](#signingcertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [SigningCertSignatureAlgorithm](#signingcertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [SigningCertStore](#signingcertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [SigningCertStorePassword](#signingcertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SigningCertStoreType](#signingcertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [SigningCertSubject](#signingcertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [SigningCertSubjectAltNames](#signingcertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [SigningCertThumbprintMD5](#signingcertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [SigningCertThumbprintSHA1](#signingcertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [SigningCertThumbprintSHA256](#signingcertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [SigningCertUsage](#signingcertusage-property-as2sender-control) | The text description of UsageFlags . | | [SigningCertUsageFlags](#signingcertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [SigningCertVersion](#signingcertversion-property-as2sender-control) | The certificate's version number. | | [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-as2sender-control) | The issuer of the certificate. | | [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-as2sender-control) | The public key of the certificate. | | [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-as2sender-control) | The text description of UsageFlags . | | [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-as2sender-control) | The certificate's version number. | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [SSLCertEncoded](#sslcertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [SSLCertExpirationDate](#sslcertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-as2sender-control) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-as2sender-control) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [SSLCertSubject](#sslcertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-as2sender-control) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-as2sender-control) | The certificate's version number. | | [SSLProvider](#sslprovider-property-as2sender-control) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-as2sender-control) | The date on which this certificate becomes valid. | | [SSLServerCertEncoded](#sslservercertencoded-property-as2sender-control) | The certificate (PEM/Base64 encoded). | | [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-as2sender-control) | The date on which the certificate expires. | | [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-as2sender-control) | A comma-delimited list of extended key usage identifiers. | | [SSLServerCertFingerprint](#sslservercertfingerprint-property-as2sender-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-as2sender-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-as2sender-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLServerCertIssuer](#sslservercertissuer-property-as2sender-control) | The issuer of the certificate. | | [SSLServerCertPrivateKey](#sslservercertprivatekey-property-as2sender-control) | The private key of the certificate (if available). | | [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-as2sender-control) | Whether a PrivateKey is available for the selected certificate. | | [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-as2sender-control) | The name of the PrivateKey container for the certificate (if available). | | [SSLServerCertPublicKey](#sslservercertpublickey-property-as2sender-control) | The public key of the certificate. | | [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-as2sender-control) | The textual description of the certificate's public key algorithm. | | [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-as2sender-control) | The length of the certificate's public key (in bits). | | [SSLServerCertSerialNumber](#sslservercertserialnumber-property-as2sender-control) | The serial number of the certificate encoded as a string. | | [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-as2sender-control) | The text description of the certificate's signature algorithm. | | [SSLServerCertStore](#sslservercertstore-property-as2sender-control) | The name of the certificate store for the client certificate. | | [SSLServerCertStorePassword](#sslservercertstorepassword-property-as2sender-control) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLServerCertStoreType](#sslservercertstoretype-property-as2sender-control) | The type of certificate store for this certificate. | | [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) | The subject of the certificate used for client authentication. | | [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-as2sender-control) | Comma-separated lists of alternative subject names for the certificate. | | [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-as2sender-control) | The MD5 hash of the certificate. | | [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-as2sender-control) | The SHA-1 hash of the certificate. | | [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-as2sender-control) | The SHA-256 hash of the certificate. | | [SSLServerCertUsage](#sslservercertusage-property-as2sender-control) | The text description of UsageFlags . | | [SSLServerCertUsageFlags](#sslservercertusageflags-property-as2sender-control) | The flags that show intended use for the certificate. | | [SSLServerCertVersion](#sslservercertversion-property-as2sender-control) | The certificate's version number. | | [Subject](#subject-property-as2sender-control) | The subject of the message. | | [Timeout](#timeout-property-as2sender-control) | The timeout for the control. | | [URL](#url-property-as2sender-control) | The URL to which the request is made. | | [UseOAEP](#useoaep-property-as2sender-control) | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). | | [UsePSS](#usepss-property-as2sender-control) | This property specifies whether or not RSA-PSS will be used during signing and verification. | | [UserAgent](#useragent-property-as2sender-control) | Information about the user agent. | ## Method List *The following is the full list of the methods of the control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-as2sender-control) | Sets or retrieves a configuration setting. | | [DoEvents](#doevents-method-as2sender-control) | This method processes events from the internal message queue. | | [Interrupt](#interrupt-method-as2sender-control) | This method interrupts the current method. | | [Post](#post-method-as2sender-control) | Post data to the AS2 server, and check the receipt. | | [ReadAsyncReceipt](#readasyncreceipt-method-as2sender-control) | Reads an asynchronous MDN receipt from the current HTTP session. | | [Reset](#reset-method-as2sender-control) | Resets the state of the control. | | [Restart](#restart-method-as2sender-control) | Restart sending of the file specified by the Etag property. | | [SendCEMRequest](#sendcemrequest-method-as2sender-control) | Sends a Certificate Exchange Messaging (CEM) request. | | [SendCEMResponse](#sendcemresponse-method-as2sender-control) | Sends a Certificate Exchange Messaging (CEM) response. | | [SetRequestHeader](#setrequestheader-method-as2sender-control) | Allows the user to set or add arbitrary HTTP request headers. | | [SetTPInfo](#settpinfo-method-as2sender-control) | A convenient way to set AS2 communication parameters using XML strings. | | [VerifyReceipt](#verifyreceipt-method-as2sender-control) | Verifies an asynchronous MDN receipt. | ## Event List *The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-as2sender-control) | Fired immediately after a connection completes (or fails). | | [Disconnected](#disconnected-event-as2sender-control) | Fired when a connection is closed. | | [EndTransfer](#endtransfer-event-as2sender-control) | Fired when a document finishes transferring. | | [Error](#error-event-as2sender-control) | Fired when information is available about errors during data delivery. | | [Header](#header-event-as2sender-control) | Fired every time a header line comes in. | | [Log](#log-event-as2sender-control) | Fired with log information while processing a message. | | [SetCookie](#setcookie-event-as2sender-control) | Fired for every cookie set by the server. | | [SSLServerAuthentication](#sslserverauthentication-event-as2sender-control) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-as2sender-control) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-as2sender-control) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-as2sender-control) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the control with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowMDNWarnings](#AllowMDNWarnings) | Whether to fail on MDN warnings. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [AuthScheme](#AuthScheme) | The authorization scheme to be used when server authorization is to be performed. | | [EncodeToTempDir](#EncodeToTempDir) | Whether to use temporary files when creating messages. | | [IgnoreLoggingErrors](#IgnoreLoggingErrors) | Whether to ignore errors that occur when writing to the log. | | [IncludeHeaders](#IncludeHeaders) | Whether headers are included when posting to a file. | | [LogDebug](#LogDebug) | Whether to log debug data. | | [LogFilename](#LogFilename) | The base name of the log file. | | [LogOptions](#LogOptions) | The information to be written to log files. | | [MDNDisposition](#MDNDisposition) | Returns the Disposition header of the MDN. | | [MessageHeaders](#MessageHeaders) | Returns the headers of the message. | | [NormalizeMIC](#NormalizeMIC) | Whether to normalize line endings before calculating the MIC. | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used when encrypting a key. | | [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters to be used when encrypting a key. | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used when encrypting a key. | | [Password](#Password) | A password if authentication is to be used. | | [PostToFile](#PostToFile) | Creates the message on disk. | | [RequiredSignatureAlgorithms](#RequiredSignatureAlgorithms) | Specifies a list of acceptable signature algorithms. | | [User](#User) | A user name if authentication is to be used. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the control. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the control will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the control. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the control. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the control whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the control binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AS2From Property ([AS2Sender](#as2sender-control) Control) The AS2 Identifier of the sending system. ## Syntax ```text as2sendercontrol.AS2From[=string] ``` ## Default Value "" ## Remarks May be company name, DUNS number, or anything agreed on by trading partners. Required. ## Data Type String # AS2To Property ([AS2Sender](#as2sender-control) Control) The AS2 Identifier of the receiving system. ## Syntax ```text as2sendercontrol.AS2To[=string] ``` ## Default Value "" ## Remarks May be company name, DUNS number, or anything agreed on by trading partners. Required. ## Data Type String # AS2Version Property ([AS2Sender](#as2sender-control) Control) The AS2 protocol version used for outgoing messages. ## Syntax ```text as2sendercontrol.AS2Version[=string] ``` ## Default Value "1.2" ## Remarks *AS2Version* specifies the AS2 protocol version declared in the AS2-Version header of outgoing messages. Valid values are "1.0", "1.1", "1.2" (default), and "1.3". When set to "1.3", the following requirements apply: - [SignatureAlgorithm](#signaturealgorithm-property-as2sender-control) and the requested MDN MIC algorithm specified by [MDNOptions](#mdnoptions-property-as2sender-control) must use SHA-256, SHA-384, or SHA-512. MD5, SHA-1, and SHA-224 are not permitted. - [EncryptionAlgorithm](#encryptionalgorithm-property-as2sender-control) may not be DES or 3DES. Use one of the AES options instead, such as "AESCBC256" (the default). - An AS2-Product header identifying the sending software is included in each outgoing message. MDNs received in response to AS2 1.3 messages are also subject to these requirements. An MDN signed using MD5, SHA-1, or SHA-224 is rejected. Versions "1.0", "1.1", and "1.2" continue to permit legacy algorithms for compatibility with existing trading partners. ## Data Type String # AsyncMDNInfoDir Property ([AS2Sender](#as2sender-control) Control) Path to a directory to store data used in verifying AsyncMDNs. ## Syntax ```text as2sendercontrol.AsyncMDNInfoDir[=string] ``` ## Default Value "" ## Remarks If [Post](#post-method-as2sender-control) is invoked after setting AsyncMDNInfoDir and an asynchronous MDN is requested, the control stores the data required to verify AsyncMDNs in a file in the specified directory. The name of the file is the [MessageId](#messageid-property-as2sender-control) of the outgoing message. AsyncMDNInfoDir is also used while verifying asynchronous MDNs using [VerifyReceipt](#verifyreceipt-method-as2sender-control). The properties required to process AsyncMDNs, namely [OriginalContentMIC](#originalcontentmic-property-as2sender-control) and [MDNOptions](#mdnoptions-property-as2sender-control), are automatically read from the file saved at the time of sending the original message. ## Data Type String # AttachmentCount Property ([AS2Sender](#as2sender-control) Control) The number of records in the Attachment arrays. ## Syntax ```text as2sendercontrol.AttachmentCount[=integer] ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [AttachmentContentType](#attachmentcontenttype-property-as2sender-control) - [AttachmentData](#attachmentdata-property-as2sender-control) - [AttachmentFileName](#attachmentfilename-property-as2sender-control) - [AttachmentHeaders](#attachmentheaders-property-as2sender-control) - [AttachmentName](#attachmentname-property-as2sender-control) The array indices start at *0* and end at *AttachmentCount - 1*. This property is not available at design time. ## Data Type Integer # AttachmentContentType Property ([AS2Sender](#as2sender-control) Control) The MIME content-type of this ediattachment . ## Syntax ```text as2sendercontrol.AttachmentContentType(AttachmentIndex)[=string] ``` ## Default Value "" ## Remarks The MIME content-type of this [EDIAttachment](#Type_EDIAttachment). The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # AttachmentData Property ([AS2Sender](#as2sender-control) Control) This property contains the attachment data. ## Syntax ```text as2sendercontrol.AttachmentData(AttachmentIndex)[=string] ``` ## Default Value "" ## Remarks This property contains the attachment data. In a receiver, the control decodes the attachment to the [AttachmentData](#attachmentdata-property-as2sender-control) property when [AttachmentData](#attachmentdata-property-as2sender-control)'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](#attachmentcount-property-as2sender-control) property. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.AttachmentDataB**. This property is not available at design time. ## Data Type Binary String # AttachmentFileName Property ([AS2Sender](#as2sender-control) Control) The file name of the attachment. ## Syntax ```text as2sendercontrol.AttachmentFileName(AttachmentIndex)[=string] ``` ## 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](#attachmentheaders-property-as2sender-control). The *AttachmentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttachmentCount](#attachmentcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # AttachmentHeaders Property ([AS2Sender](#as2sender-control) Control) The control fills out Headers each time any of the other properties for that ediattachment are changed. ## Syntax ```text as2sendercontrol.AttachmentHeaders(AttachmentIndex)[=string] ``` ## Default Value "" ## Remarks The control fills out [AttachmentHeaders](#attachmentheaders-property-as2sender-control) each time any of the other properties for that [EDIAttachment](#Type_EDIAttachment) are changed. If additional headers are needed they should be appended after all the other properties for that [EDIAttachment](#Type_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](#attachmentcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # AttachmentName Property ([AS2Sender](#as2sender-control) Control) Name is the final name to be associated with the contents of either the Data or FileName properties. ## Syntax ```text as2sendercontrol.AttachmentName(AttachmentIndex)[=string] ``` ## Default Value "" ## Remarks [AttachmentName](#attachmentname-property-as2sender-control) is the final name to be associated with the contents of either the [AttachmentData](#attachmentdata-property-as2sender-control) or [AttachmentFileName](#attachmentfilename-property-as2sender-control) 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](#attachmentcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMCount Property ([AS2Sender](#as2sender-control) Control) The number of records in the CEM arrays. ## Syntax ```text as2sendercontrol.CEMCount[=integer] ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CEMAccepted](#cemaccepted-property-as2sender-control) - [CEMCertId](#cemcertid-property-as2sender-control) - [CEMCertIssuer](#cemcertissuer-property-as2sender-control) - [CEMCertSerialNumber](#cemcertserialnumber-property-as2sender-control) - [CEMCertStore](#cemcertstore-property-as2sender-control) - [CEMCertStorePassword](#cemcertstorepassword-property-as2sender-control) - [CEMCertStoreType](#cemcertstoretype-property-as2sender-control) - [CEMCertSubject](#cemcertsubject-property-as2sender-control) - [CEMCertUsage](#cemcertusage-property-as2sender-control) - [CEMRejectionReason](#cemrejectionreason-property-as2sender-control) - [CEMRespondByDate](#cemrespondbydate-property-as2sender-control) - [CEMResponseURL](#cemresponseurl-property-as2sender-control) The array indices start at *0* and end at *CEMCount - 1*. This property is not available at design time. ## Data Type Integer # CEMAccepted Property ([AS2Sender](#as2sender-control) Control) Whether the CEM request is accepted. ## Syntax ```text as2sendercontrol.CEMAccepted(CEMIndex)[=boolean] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type Boolean # CEMCertId Property ([AS2Sender](#as2sender-control) Control) A user defined identifier for the certificate. ## Syntax ```text as2sendercontrol.CEMCertId(CEMIndex)[=string] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMCertIssuer Property ([AS2Sender](#as2sender-control) Control) This property holds the issuer of the certificate. ## Syntax ```text as2sendercontrol.CEMCertIssuer(CEMIndex)[=string] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMCertSerialNumber Property ([AS2Sender](#as2sender-control) Control) This property holds the serial number of the certificate. ## Syntax ```text as2sendercontrol.CEMCertSerialNumber(CEMIndex)[=string] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMCertStore Property ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the certificate. ## Syntax ```text as2sendercontrol.CEMCertStore(CEMIndex)[=string] ``` ## 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](#cemcertstoretype-property-as2sender-control). 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](#cemcount-property-as2sender-control) property. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.CEMCertStoreB**. This property is not available at design time. ## Data Type Binary String # CEMCertStorePassword Property ([AS2Sender](#as2sender-control) Control) 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 ```text as2sendercontrol.CEMCertStorePassword(CEMIndex)[=string] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMCertStoreType Property ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.CEMCertStoreType(CEMIndex)[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [CEMStoreType](#AS2Sender_p_CEMStoreType), the full path of the PKCS#11 DLL as the [CEMStore](#AS2Sender_p_CEMStore), and the PIN as the [CEMStorePassword](#AS2Sender_p_CEMStorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [CEMStore](#AS2Sender_p_CEMStore) and set [CEMStorePassword](#AS2Sender_p_CEMStorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type Integer # CEMCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate. ## Syntax ```text as2sendercontrol.CEMCertSubject(CEMIndex)[=string] ``` ## 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=example@email.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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMCertUsage Property ([AS2Sender](#as2sender-control) Control) This property defines which usages are applicable to the certificate. ## Syntax ```text as2sendercontrol.CEMCertUsage(CEMIndex)[=integer] ``` ## 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 default value is "15", meaning all usages are allowed. The *CEMIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CEMCount](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type Integer # CEMRejectionReason Property ([AS2Sender](#as2sender-control) Control) If Accepted is False this property specifies the reason a request was rejected. ## Syntax ```text as2sendercontrol.CEMRejectionReason(CEMIndex)[=string] ``` ## Default Value "" ## Remarks If [CEMAccepted](#cemaccepted-property-as2sender-control) 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMRespondByDate Property ([AS2Sender](#as2sender-control) Control) This property specifies the date by which the other party should respond. ## Syntax ```text as2sendercontrol.CEMRespondByDate(CEMIndex)[=string] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CEMResponseURL Property ([AS2Sender](#as2sender-control) Control) This property defines the URL to which the response should be sent. ## Syntax ```text as2sendercontrol.CEMResponseURL(CEMIndex)[=string] ``` ## 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](#cemcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CompressionFormat Property ([AS2Sender](#as2sender-control) Control) The compression format (if any) to use. ## Syntax ```text as2sendercontrol.CompressionFormat[=integer] ``` ## Possible Values ```text tcfNone(0), tcfZLIB(1) ``` ## Default Value 0 ## Remarks By default, outgoing data will not be compressed. Setting this property will instruct the control to compress the outgoing data using the indicated format. Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required. The compression algorithm used is **Zlib**, as required by RFC 3274 and defined in RFCs 1950 and 1951. ## Data Type Integer # CookieCount Property ([AS2Sender](#as2sender-control) Control) The number of records in the Cookie arrays. ## Syntax ```text as2sendercontrol.CookieCount[=integer] ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CookieDomain](#cookiedomain-property-as2sender-control) - [CookieExpiration](#cookieexpiration-property-as2sender-control) - [CookieName](#cookiename-property-as2sender-control) - [CookiePath](#cookiepath-property-as2sender-control) - [CookieSecure](#cookiesecure-property-as2sender-control) - [CookieValue](#cookievalue-property-as2sender-control) The array indices start at *0* and end at *CookieCount - 1*. This property is not available at design time. ## Data Type Integer # CookieDomain Property ([AS2Sender](#as2sender-control) Control) The domain of a received cookie. ## Syntax ```text as2sendercontrol.CookieDomain(CookieIndex) ``` ## Default Value "" ## Remarks The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # CookieExpiration Property ([AS2Sender](#as2sender-control) Control) An expiration time for the cookie (if provided by the server). ## Syntax ```text as2sendercontrol.CookieExpiration(CookieIndex) ``` ## Default Value "" ## Remarks An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # CookieName Property ([AS2Sender](#as2sender-control) Control) The name of the cookie. ## Syntax ```text as2sendercontrol.CookieName(CookieIndex)[=string] ``` ## Default Value "" ## Remarks The name of the cookie. This property, along with [CookieValue](#cookievalue-property-as2sender-control), stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # CookiePath Property ([AS2Sender](#as2sender-control) Control) A path name to limit the cookie to (if provided by the server). ## Syntax ```text as2sendercontrol.CookiePath(CookieIndex) ``` ## Default Value "" ## Remarks A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # CookieSecure Property ([AS2Sender](#as2sender-control) Control) The security flag of the received cookie. ## Syntax ```text as2sendercontrol.CookieSecure(CookieIndex) ``` ## Default Value False ## Remarks The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type Boolean # CookieValue Property ([AS2Sender](#as2sender-control) Control) The value of the cookie. ## Syntax ```text as2sendercontrol.CookieValue(CookieIndex)[=string] ``` ## Default Value "" ## Remarks The value of the cookie. A corresponding value is associated with the cookie specified by [CookieName](#cookiename-property-as2sender-control). This property holds that value. The SetCookie event provides the cookies set by the server. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookiecount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # EDIData Property ([AS2Sender](#as2sender-control) Control) This property contains the EDI payload of the transmission. ## Syntax ```text as2sendercontrol.EDIData[=string] ``` ## 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](#AS2Sender_p_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. The EDI message to send. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.EDIDataB**. This property is not available at design time. ## Data Type Binary String # EDIFileName Property ([AS2Sender](#as2sender-control) Control) In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission. ## Syntax ```text as2sendercontrol.EDIFileName[=string] ``` ## Default Value "" ## Remarks In a sender, if [EDIFileName](#edifilename-property-as2sender-control) is specified, the file specified will be used for the EDI payload of the transmission. [EDIName](#ediname-property-as2sender-control) 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](#AS2Sender_p_EDIOutputStream) is set, the data will be written to the stream and this property will not be populated. This property is not available at design time. ## Data Type String # EDIName Property ([AS2Sender](#as2sender-control) Control) Name is the final name to be associated with the contents of either the Data or FileName properties. ## Syntax ```text as2sendercontrol.EDIName[=string] ``` ## Default Value "rfc1767.edi" ## Remarks [EDIName](#ediname-property-as2sender-control) is the final name to be associated with the contents of either the [EDIData](#edidata-property-as2sender-control) or [EDIFileName](#edifilename-property-as2sender-control) properties. This corresponds to the *filename* attribute of the *Content-Disposition* header for the EDI payload. When constructing EDI data to be sent, [EDIName](#ediname-property-as2sender-control) will be set to the same value as [EDIFileName](#edifilename-property-as2sender-control), but can be overridden after setting [EDIFileName](#edifilename-property-as2sender-control) to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, [EDIName](#ediname-property-as2sender-control) will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header. This property is not available at design time. ## Data Type String # EDIType Property ([AS2Sender](#as2sender-control) Control) The Content-Type of the EDI message. ## Syntax ```text as2sendercontrol.EDIType[=string] ``` ## 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 not available at design time. ## Data Type String # EncryptionAlgorithm Property ([AS2Sender](#as2sender-control) Control) The algorithm used to encrypt the EDI data. ## Syntax ```text as2sendercontrol.EncryptionAlgorithm[=string] ``` ## Default Value "AESCBC256" ## Remarks If RecipientCerts contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted. The control supports **"AESCBC256"**, or industry-standard 256-bit AES-CBC encryption, by default. The control supports **"AES"** encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability. Possible values are: - 3DES - DES - AESCBC128 - AESCBC192 - AESCBC256 (default) - AESGCM128 - AESGCM192 - AESGCM256 ## Data Type String # Etag Property ([AS2Sender](#as2sender-control) Control) The Etag of the file being sent. ## Syntax ```text as2sendercontrol.Etag[=string] ``` ## Default Value "" ## Remarks This specifies the Etag for the file. This value should be set to an empty string the first time a file is sent using the [Restart](#restart-method-as2sender-control) command. The control will generate a unique Etag based on the processed contents of the file and set this property when sending begins. If a file is interrupted, this value must be set when [Restart](#restart-method-as2sender-control) is called to resume transfer of the already processed file. ## Data Type String # FirewallAutoDetect Property ([AS2Sender](#as2sender-control) Control) Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text as2sendercontrol.FirewallAutoDetect[=boolean] ``` ## Default Value False ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type Boolean # FirewallHost Property ([AS2Sender](#as2sender-control) Control) The name or IP address of the firewall (optional). ## Syntax ```text as2sendercontrol.FirewallHost[=string] ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-as2sender-control) 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 control fails with an error. ## Data Type String # FirewallPassword Property ([AS2Sender](#as2sender-control) Control) A password if authentication is to be used when connecting through the firewall. ## Syntax ```text as2sendercontrol.FirewallPassword[=string] ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-as2sender-control) is specified, the [FirewallUser](#firewalluser-property-as2sender-control) and [FirewallPassword](#firewallpassword-property-as2sender-control) properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error. ## Data Type String # FirewallPort Property ([AS2Sender](#as2sender-control) Control) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text as2sendercontrol.FirewallPort[=integer] ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-as2sender-control). See the description of the [FirewallHost](#firewallhost-property-as2sender-control) property for details. NOTE: This property is set automatically when [FirewallType](#firewalltype-property-as2sender-control) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-as2sender-control) property for details. ## Data Type Integer # FirewallType Property ([AS2Sender](#as2sender-control) Control) The type of firewall to connect through. ## Syntax ```text as2sendercontrol.FirewallType[=integer] ``` ## Possible Values ```text fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10) ``` ## Default Value 0 ## 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](#firewallport-property-as2sender-control) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-as2sender-control) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-as2sender-control) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-as2sender-control) is set to 1080. | ## Data Type Integer # FirewallUser Property ([AS2Sender](#as2sender-control) Control) A username if authentication is to be used when connecting through a firewall. ## Syntax ```text as2sendercontrol.FirewallUser[=string] ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-as2sender-control) is specified, this property and the [FirewallPassword](#firewallpassword-property-as2sender-control) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the control fails with an error. ## Data Type String # From Property ([AS2Sender](#as2sender-control) Control) The email address of the HTTP agent (optional). ## Syntax ```text as2sendercontrol.From[=string] ``` ## Default Value "" ## Remarks If the From property contains a non-empty string, an HTTP *From:* header is added to the request. This header generally gives the email address of the requester of the document. This property is not available at design time. ## Data Type String # LocalHost Property ([AS2Sender](#as2sender-control) Control) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text as2sendercontrol.LocalHost[=string] ``` ## 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 control initiate connections (or accept in the case of server controls) 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 control 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. 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 control initiate connections (or accept in the case of server controls) 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 control 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 ([AS2Sender](#as2sender-control) Control) The path to a directory for logging. ## Syntax ```text as2sendercontrol.LogDirectory[=string] ``` ## 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 control will log the complete text of the outgoing request and the incoming response. The control 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 outgoing request, after security options have been applied | | Payload (.dat) | Contains log of unsecured payload prior to transmission | | MDN Receipt (.mdn) | For synchronous requests or asynchronous receipts verified with [VerifyReceipt](#verifyreceipt-method-as2sender-control), contains MDN receipt. | | 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](#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 control 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 control. 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](#logfile-property-as2sender-control) 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 ([AS2Sender](#as2sender-control) Control) The log file written. ## Syntax ```text as2sendercontrol.LogFile ``` ## Default Value "" ## Remarks If [LogDirectory](#logdirectory-property-as2sender-control) is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files written, minus the extension. The control 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 outgoing request, after security options have been applied | | Payload (.dat) | Contains the unsecured payload data prior to transmission | | MDN Receipt (.mdn) | For synchronous requests or asynchronous receipts verified with [VerifyReceipt](#verifyreceipt-method-as2sender-control). This contains the MDN receipt. | | Error (.err) | This is only written if an error is encountered and will contain the error. | This property is read-only. ## Data Type String # MDNDeliveryOption Property ([AS2Sender](#as2sender-control) Control) A URL indicating how the receipt is to be delivered. ## Syntax ```text as2sendercontrol.MDNDeliveryOption[=string] ``` ## Default Value "" ## Remarks The default mode of operation is for the receipt to be returned synchronously within the HTTP reply. By specifying a valid URL, the user may request asynchronous delivery instead. The URL indicates the destination for the reply, and may use any appropriate protocol, such as "http", "https", or "mailto". If MDNDeliveryOption is set to an empty string, the receipt will be returned synchronously, and will be processed automatically by the control. Clients requesting asynchronous delivery should provide their own processing for reading receipts. ## Data Type String # MDNOptions Property ([AS2Sender](#as2sender-control) Control) Used to indicate the options requested for the MDN receipt. ## Syntax ```text as2sendercontrol.MDNOptions[=string] ``` ## Default Value "signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256" ## Remarks By default, the control will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard. Set MDNOptions to an empty string to request an unsigned receipt. This property will automatically be updated when [SignatureAlgorithm](#signaturealgorithm-property-as2sender-control) is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value. The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm. When [AS2Version](#as2version-property-as2sender-control) is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed in the requested MIC algorithms. SHA-256, SHA-384, or SHA-512 are recommended instead. ## Data Type String # MDNReceiptContent Property ([AS2Sender](#as2sender-control) Control) This contains the entire content of the MDN Receipt. ## Syntax ```text as2sendercontrol.MDNReceiptContent[=string] ``` ## Default Value "" ## Remarks This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable [MDNReceiptMDN](#mdnreceiptmdn-property-as2sender-control) (Message Disposition Notification) and a human readable [MDNReceiptMessage](#mdnreceiptmessage-property-as2sender-control), which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.MDNReceiptContentB**. ## Data Type Binary String # MDNReceiptHeaderCount Property ([AS2Sender](#as2sender-control) Control) The number of headers in the MDN. ## Syntax ```text as2sendercontrol.MDNReceiptHeaderCount ``` ## 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 ([AS2Sender](#as2sender-control) Control) The property name of the MDN header currently selected by HeaderIndex . ## Syntax ```text as2sendercontrol.MDNReceiptHeaderField ``` ## Default Value "" ## Remarks The field name of the MDN header currently selected by [MDNReceiptHeaderIndex](#mdnreceiptheaderindex-property-as2sender-control). This property is read-only and not available at design time. ## Data Type String # MDNReceiptHeaderIndex Property ([AS2Sender](#as2sender-control) Control) Which MDN header is currently selected to populate HeaderField and HeaderValue . ## Syntax ```text as2sendercontrol.MDNReceiptHeaderIndex[=integer] ``` ## Default Value 0 ## Remarks Which MDN header is currently selected to populate [MDNReceiptHeaderField](#mdnreceiptheaderfield-property-as2sender-control) and [MDNReceiptHeaderValue](#mdnreceiptheadervalue-property-as2sender-control). Valid values are 0 to [MDNReceiptHeaderCount](#mdnreceiptheadercount-property-as2sender-control) - 1. This property is not available at design time. ## Data Type Integer # MDNReceiptHeaders Property ([AS2Sender](#as2sender-control) Control) Headers contains all of the headers of the AS2 MDN Receipt as a single string. ## Syntax ```text as2sendercontrol.MDNReceiptHeaders[=string] ``` ## 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](#mdnreceiptheadercount-property-as2sender-control), [MDNReceiptHeaderIndex](#mdnreceiptheaderindex-property-as2sender-control), [MDNReceiptHeaderField](#mdnreceiptheaderfield-property-as2sender-control), and [MDNReceiptHeaderValue](#mdnreceiptheadervalue-property-as2sender-control) to easily iterate through each individual header. ## Data Type String # MDNReceiptHeaderValue Property ([AS2Sender](#as2sender-control) Control) The value of the MDN header currently selected by HeaderIndex . ## Syntax ```text as2sendercontrol.MDNReceiptHeaderValue ``` ## Default Value "" ## Remarks The value of the MDN header currently selected by [MDNReceiptHeaderIndex](#mdnreceiptheaderindex-property-as2sender-control). This property is read-only and not available at design time. ## Data Type String # MDNReceiptMDN Property ([AS2Sender](#as2sender-control) Control) MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. ## Syntax ```text as2sendercontrol.MDNReceiptMDN ``` ## 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 ([AS2Sender](#as2sender-control) Control) The human-readable portion of the MDN receipt. ## Syntax ```text as2sendercontrol.MDNReceiptMessage ``` ## 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 ([AS2Sender](#as2sender-control) Control) The Message Integrity Check(s) (one-way hash) of the original EDI message. ## Syntax ```text as2sendercontrol.MDNReceiptMICValue ``` ## 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., ```plaintext w7AguNJEmhF/qIjJw6LnnA==, md5 ``` . This property is read-only. ## Data Type String # MDNReceiptSigningProtocol Property ([AS2Sender](#as2sender-control) Control) This property contains the MIME type of the signature used, if any (i. ## Syntax ```text as2sendercontrol.MDNReceiptSigningProtocol ``` ## Default Value "" ## Remarks This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this [MDNReceipt](#Type_MDNReceipt). It will contain an empty string if the receipt is unsigned. This property is read-only. ## Data Type String # MDNTo Property ([AS2Sender](#as2sender-control) Control) Used to indicate that a message disposition notification is requested. ## Syntax ```text as2sendercontrol.MDNTo[=string] ``` ## Default Value "" ## Remarks If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. The value may be an email address, URL, etc., and while its presence is used to determine whether or not an MDN is sent, the value itself will typically be ignored by the server. By default, the control will request a PKCS#7 signature and synchronous delivery. You may set [MDNDeliveryOption](#mdndeliveryoption-property-as2sender-control) to request an asynchronous MDN, and you may set [MDNOptions](#mdnoptions-property-as2sender-control) to request a different type of signature, or no signature at all. ## Data Type String # MessageId Property ([AS2Sender](#as2sender-control) Control) The Id of the message. ## Syntax ```text as2sendercontrol.MessageId[=string] ``` ## Default Value "" ## Remarks The Id format is as in RFC 2822: *id-left@id-right* . A unique Id will automatically be generated on startup. Sending a message will reset *id-left* if the **MessageId** has been used in the previous message. If you set MessageId to a string of the form "@(id-right)" a unique *id-left* will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same *id-right*. After an MDNReceipt is returned or set, MessageId will contain the *Original-Message-ID* found in the MDN Receipt. This property is not available at design time. ## Data Type String # OriginalContentMIC Property ([AS2Sender](#as2sender-control) Control) The Message Integrity Check(s) (one-way hash) of the outgoing message. ## Syntax ```text as2sendercontrol.OriginalContentMIC[=string] ``` ## Default Value "" ## Remarks A MIC will be calculated over the outgoing message using the same algorithm in the [SignatureAlgorithm](#signaturealgorithm-property-as2sender-control) configuration used to sign the message. The property will be set when [Post](#post-method-as2sender-control) (in AS3, Send) is invoked, and the MIC will automatically be checked against the Original-Content-MIC in the MDN for synchronous MDNs. The format is in RFC 3335, i.e. ```plaintext w7AguNJEmhF/qIjJw6LnnA==, md5 ``` , with a newline at the end. If you are requesting an asynchronous MDN, you must save this value externally so that it can be loaded when the MDN is received (you may also use [AsyncMDNInfoDir](#asyncmdninfodir-property-as2sender-control)). ## Data Type String # ProxyAuthScheme Property ([AS2Sender](#as2sender-control) Control) The type of authorization to perform when connecting to the proxy. ## Syntax ```text as2sendercontrol.ProxyAuthScheme[=integer] ``` ## Possible Values ```text authBasic(0), authDigest(1), authProprietary(2), authNone(3), authNtlm(4), authNegotiate(5) ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are set. [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) should be set to authNone (3) when no authentication is expected. By default, [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is authBasic (0), and if the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are set, the control will attempt basic authentication. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to authDigest (1), digest authentication will be attempted instead. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control). ## Data Type Integer # ProxyAutoDetect Property ([AS2Sender](#as2sender-control) Control) Whether to automatically detect and use proxy system settings, if available. ## Syntax ```text as2sendercontrol.ProxyAutoDetect[=boolean] ``` ## Default Value False ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *False*. ## Data Type Boolean # ProxyPassword Property ([AS2Sender](#as2sender-control) Control) A password if authentication is to be used for the proxy. ## Syntax ```text as2sendercontrol.ProxyPassword[=string] ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are used to respond to the Digest Authentication challenge from the server. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are used to authenticate through NTLM negotiation. ## Data Type String # ProxyPort Property ([AS2Sender](#as2sender-control) Control) The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax ```text as2sendercontrol.ProxyPort[=integer] ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [ProxyServer](#proxyserver-property-as2sender-control) (default 80). See the description of the [ProxyServer](#proxyserver-property-as2sender-control) property for details. ## Data Type Integer # ProxyServer Property ([AS2Sender](#as2sender-control) Control) If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax ```text as2sendercontrol.ProxyServer[=string] ``` ## Default Value "" ## Remarks If a proxy [ProxyServer](#proxyserver-property-as2sender-control) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [ProxyServer](#proxyserver-property-as2sender-control) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [ProxyServer](#proxyserver-property-as2sender-control) property is set to the corresponding address. If the search is not successful, an error is returned. ## Data Type String # ProxySSL Property ([AS2Sender](#as2sender-control) Control) When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax ```text as2sendercontrol.ProxySSL[=integer] ``` ## Possible Values ```text psAutomatic(0), psAlways(1), psNever(2), psTunnel(3) ``` ## Default Value 0 ## Remarks When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the control will use the psTunnel option. If the URL is an http URL, the control will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | ## Data Type Integer # ProxyUser Property ([AS2Sender](#as2sender-control) Control) A username if authentication is to be used for the proxy. ## Syntax ```text as2sendercontrol.ProxyUser[=string] ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to Basic Authentication, the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to Digest Authentication, the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are used to respond to the Digest Authentication challenge from the server. If [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control) is set to NTLM Authentication, the [ProxyUser](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) properties are used to authenticate through NTLM negotiation. ## Data Type String # ReceiptSignerCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.ReceiptSignerCertEffectiveDate ``` ## 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 # ReceiptSignerCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.ReceiptSignerCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control) and [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [ReceiptSignerCertEncoded](#receiptsignercertencoded-property-as2sender-control) is set, a search is initiated in the current [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.ReceiptSignerCertEncodedB**. This property is not available at design time. ## Data Type Binary String # ReceiptSignerCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.ReceiptSignerCertExpirationDate ``` ## 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 # ReceiptSignerCertExtendedKeyUsage Property ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.ReceiptSignerCertExtendedKeyUsage ``` ## 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 # ReceiptSignerCertFingerprint Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertFingerprint ``` ## 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 # ReceiptSignerCertFingerprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertFingerprintSHA1 ``` ## 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 # ReceiptSignerCertFingerprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertFingerprintSHA256 ``` ## 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 # ReceiptSignerCertIssuer Property ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertIssuer ``` ## 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 # ReceiptSignerCertPrivateKey Property ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.ReceiptSignerCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ReceiptSignerCertPrivateKey](#receiptsignercertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [ReceiptSignerCertPrivateKey](#receiptsignercertprivatekey-property-as2sender-control) returns an empty string. This property is read-only. ## Data Type String # ReceiptSignerCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [ReceiptSignerCertPrivateKey](#receiptsignercertprivatekey-property-as2sender-control) is available for the selected certificate. If [ReceiptSignerCertPrivateKeyAvailable](#receiptsignercertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # ReceiptSignerCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.ReceiptSignerCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [ReceiptSignerCertPrivateKey](#receiptsignercertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ReceiptSignerCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertPublicKey ``` ## 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 # ReceiptSignerCertPublicKeyAlgorithm Property ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.ReceiptSignerCertPublicKeyAlgorithm ``` ## 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 # ReceiptSignerCertPublicKeyLength Property ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.ReceiptSignerCertPublicKeyLength ``` ## 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 # ReceiptSignerCertSerialNumber Property ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.ReceiptSignerCertSerialNumber ``` ## 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 # ReceiptSignerCertSignatureAlgorithm Property ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.ReceiptSignerCertSignatureAlgorithm ``` ## 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 # ReceiptSignerCertStore Property ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ReceiptSignerCertStoreType](#receiptsignercertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control). If the store is password-protected, specify the password in [ReceiptSignerCertStorePassword](#receiptsignercertstorepassword-property-as2sender-control). [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control) is used in conjunction with the [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) property to specify client certificates. If [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control) has a value, and [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) or [ReceiptSignerCertEncoded](#receiptsignercertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [ReceiptSignerCertSubject](#receiptsignercertsubject-property-as2sender-control) 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). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.ReceiptSignerCertStoreB**. ## Data Type Binary String # ReceiptSignerCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.ReceiptSignerCertStorePassword[=string] ``` ## 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 # ReceiptSignerCertStoreType Property ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertStoreType[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ReceiptSignerCertStoreType](#receiptsignercertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control), and the PIN as the [ReceiptSignerCertStorePassword](#receiptsignercertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ReceiptSignerCertStore](#receiptsignercertstore-property-as2sender-control) and set [ReceiptSignerCertStorePassword](#receiptsignercertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # ReceiptSignerCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.ReceiptSignerCertSubject[=string] ``` ## 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=example@email.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 # ReceiptSignerCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ReceiptSignerCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertThumbprintMD5 ``` ## 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 # ReceiptSignerCertThumbprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertThumbprintSHA1 ``` ## 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 # ReceiptSignerCertThumbprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertThumbprintSHA256 ``` ## 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 # ReceiptSignerCertUsage Property ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.ReceiptSignerCertUsage ``` ## Default Value "" ## Remarks The text description of [ReceiptSignerCertUsageFlags](#receiptsignercertusageflags-property-as2sender-control). 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 # ReceiptSignerCertUsageFlags Property ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.ReceiptSignerCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ReceiptSignerCertUsageFlags](#receiptsignercertusageflags-property-as2sender-control) 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 [ReceiptSignerCertUsage](#receiptsignercertusage-property-as2sender-control) property for a text representation of [ReceiptSignerCertUsageFlags](#receiptsignercertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # ReceiptSignerCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.ReceiptSignerCertVersion ``` ## 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 # RecipientCertCount Property ([AS2Sender](#as2sender-control) Control) The number of records in the RecipientCert arrays. ## Syntax ```text as2sendercontrol.RecipientCertCount[=integer] ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-as2sender-control) - [RecipientCertEncoded](#recipientcertencoded-property-as2sender-control) - [RecipientCertExpirationDate](#recipientcertexpirationdate-property-as2sender-control) - [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-as2sender-control) - [RecipientCertFingerprint](#recipientcertfingerprint-property-as2sender-control) - [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-as2sender-control) - [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-as2sender-control) - [RecipientCertIssuer](#recipientcertissuer-property-as2sender-control) - [RecipientCertPrivateKey](#recipientcertprivatekey-property-as2sender-control) - [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-as2sender-control) - [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-as2sender-control) - [RecipientCertPublicKey](#recipientcertpublickey-property-as2sender-control) - [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-as2sender-control) - [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-as2sender-control) - [RecipientCertSerialNumber](#recipientcertserialnumber-property-as2sender-control) - [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-as2sender-control) - [RecipientCertStore](#recipientcertstore-property-as2sender-control) - [RecipientCertStorePassword](#recipientcertstorepassword-property-as2sender-control) - [RecipientCertStoreType](#recipientcertstoretype-property-as2sender-control) - [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) - [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-as2sender-control) - [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-as2sender-control) - [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-as2sender-control) - [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-as2sender-control) - [RecipientCertUsage](#recipientcertusage-property-as2sender-control) - [RecipientCertUsageFlags](#recipientcertusageflags-property-as2sender-control) - [RecipientCertVersion](#recipientcertversion-property-as2sender-control) The array indices start at *0* and end at *RecipientCertCount - 1*. This property is not available at design time. ## Data Type Integer # RecipientCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.RecipientCertEffectiveDate(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.RecipientCertEncoded(RecipientCertIndex)[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [RecipientCertStore](#recipientcertstore-property-as2sender-control) and [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [RecipientCertEncoded](#recipientcertencoded-property-as2sender-control) is set, a search is initiated in the current [RecipientCertStore](#recipientcertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) is set to an empty string. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.RecipientCertEncodedB**. This property is not available at design time. ## Data Type Binary String # RecipientCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.RecipientCertExpirationDate(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertExtendedKeyUsage Property ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.RecipientCertExtendedKeyUsage(RecipientCertIndex) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprint Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertFingerprint(RecipientCertIndex) ``` ## 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* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertFingerprintSHA1(RecipientCertIndex) ``` ## 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* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertFingerprintSHA256(RecipientCertIndex) ``` ## 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* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertIssuer Property ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertIssuer(RecipientCertIndex) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPrivateKey Property ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.RecipientCertPrivateKey(RecipientCertIndex) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [RecipientCertPrivateKey](#recipientcertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [RecipientCertPrivateKey](#recipientcertprivatekey-property-as2sender-control) returns an empty string. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.RecipientCertPrivateKeyAvailable(RecipientCertIndex) ``` ## Default Value False ## Remarks Whether a [RecipientCertPrivateKey](#recipientcertprivatekey-property-as2sender-control) is available for the selected certificate. If [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type Boolean # RecipientCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.RecipientCertPrivateKeyContainer(RecipientCertIndex) ``` ## Default Value "" ## Remarks The name of the [RecipientCertPrivateKey](#recipientcertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertPublicKey(RecipientCertIndex) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKeyAlgorithm Property ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.RecipientCertPublicKeyAlgorithm(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKeyLength Property ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.RecipientCertPublicKeyLength(RecipientCertIndex) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type Integer # RecipientCertSerialNumber Property ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.RecipientCertSerialNumber(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertSignatureAlgorithm Property ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.RecipientCertSignatureAlgorithm(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertStore Property ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.RecipientCertStore(RecipientCertIndex)[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [RecipientCertStoreType](#recipientcertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [RecipientCertStore](#recipientcertstore-property-as2sender-control). If the store is password-protected, specify the password in [RecipientCertStorePassword](#recipientcertstorepassword-property-as2sender-control). [RecipientCertStore](#recipientcertstore-property-as2sender-control) is used in conjunction with the [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) property to specify client certificates. If [RecipientCertStore](#recipientcertstore-property-as2sender-control) has a value, and [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) or [RecipientCertEncoded](#recipientcertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [RecipientCertSubject](#recipientcertsubject-property-as2sender-control) 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). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.RecipientCertStoreB**. This property is not available at design time. ## Data Type Binary String # RecipientCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.RecipientCertStorePassword(RecipientCertIndex)[=string] ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # RecipientCertStoreType Property ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.RecipientCertStoreType(RecipientCertIndex)[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [RecipientCertStoreType](#recipientcertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [RecipientCertStore](#recipientcertstore-property-as2sender-control), and the PIN as the [RecipientCertStorePassword](#recipientcertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [RecipientCertStore](#recipientcertstore-property-as2sender-control) and set [RecipientCertStorePassword](#recipientcertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is not available at design time. ## Data Type Integer # RecipientCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.RecipientCertSubject(RecipientCertIndex)[=string] ``` ## 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=example@email.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 *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is not available at design time. ## Data Type String # RecipientCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.RecipientCertSubjectAltNames(RecipientCertIndex) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertThumbprintMD5(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertThumbprintSHA1(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.RecipientCertThumbprintSHA256(RecipientCertIndex) ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertUsage Property ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.RecipientCertUsage(RecipientCertIndex) ``` ## Default Value "" ## Remarks The text description of [RecipientCertUsageFlags](#recipientcertusageflags-property-as2sender-control). 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertUsageFlags Property ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.RecipientCertUsageFlags(RecipientCertIndex) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [RecipientCertUsageFlags](#recipientcertusageflags-property-as2sender-control) 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 [RecipientCertUsage](#recipientcertusage-property-as2sender-control) property for a text representation of [RecipientCertUsageFlags](#recipientcertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type Integer # RecipientCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.RecipientCertVersion(RecipientCertIndex) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipientcertcount-property-as2sender-control) property. This property is read-only and not available at design time. ## Data Type String # RestartDirectory Property ([AS2Sender](#as2sender-control) Control) The directory to log cached files when using AS2 restart functionality. ## Syntax ```text as2sendercontrol.RestartDirectory[=string] ``` ## Default Value "" ## Remarks If this property is set, the control will cache all data to the RestartDirectory. Thus, when sending a file is interrupted, the control can restart the transmission of the file starting where it was interrupted. To use this functionality, simply set the RestartDirectory and call [Restart](#restart-method-as2sender-control). When using restart functionality, the data is completely processed to the RestartDirectory before sending begins. NOTE: This directory will not automatically be cleaned up. ## Data Type String # RolloverSigningCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.RolloverSigningCertEffectiveDate ``` ## 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 # RolloverSigningCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.RolloverSigningCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control) and [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [RolloverSigningCertEncoded](#rolloversigningcertencoded-property-as2sender-control) is set, a search is initiated in the current [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.RolloverSigningCertEncodedB**. This property is not available at design time. ## Data Type Binary String # RolloverSigningCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.RolloverSigningCertExpirationDate ``` ## 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 # RolloverSigningCertExtendedKeyUsage Property ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.RolloverSigningCertExtendedKeyUsage ``` ## 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 # RolloverSigningCertFingerprint Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertFingerprint ``` ## 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 # RolloverSigningCertFingerprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertFingerprintSHA1 ``` ## 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 # RolloverSigningCertFingerprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertFingerprintSHA256 ``` ## 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 # RolloverSigningCertIssuer Property ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertIssuer ``` ## 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 # RolloverSigningCertPrivateKey Property ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.RolloverSigningCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [RolloverSigningCertPrivateKey](#rolloversigningcertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [RolloverSigningCertPrivateKey](#rolloversigningcertprivatekey-property-as2sender-control) returns an empty string. This property is read-only. ## Data Type String # RolloverSigningCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [RolloverSigningCertPrivateKey](#rolloversigningcertprivatekey-property-as2sender-control) is available for the selected certificate. If [RolloverSigningCertPrivateKeyAvailable](#rolloversigningcertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # RolloverSigningCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.RolloverSigningCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [RolloverSigningCertPrivateKey](#rolloversigningcertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # RolloverSigningCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertPublicKey ``` ## 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 # RolloverSigningCertPublicKeyAlgorithm Property ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.RolloverSigningCertPublicKeyAlgorithm ``` ## 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 # RolloverSigningCertPublicKeyLength Property ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.RolloverSigningCertPublicKeyLength ``` ## 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 # RolloverSigningCertSerialNumber Property ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.RolloverSigningCertSerialNumber ``` ## 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 # RolloverSigningCertSignatureAlgorithm Property ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.RolloverSigningCertSignatureAlgorithm ``` ## 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 # RolloverSigningCertStore Property ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [RolloverSigningCertStoreType](#rolloversigningcertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control). If the store is password-protected, specify the password in [RolloverSigningCertStorePassword](#rolloversigningcertstorepassword-property-as2sender-control). [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control) is used in conjunction with the [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) property to specify client certificates. If [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control) has a value, and [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) or [RolloverSigningCertEncoded](#rolloversigningcertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [RolloverSigningCertSubject](#rolloversigningcertsubject-property-as2sender-control) 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). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.RolloverSigningCertStoreB**. ## Data Type Binary String # RolloverSigningCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.RolloverSigningCertStorePassword[=string] ``` ## 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 # RolloverSigningCertStoreType Property ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertStoreType[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [RolloverSigningCertStoreType](#rolloversigningcertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control), and the PIN as the [RolloverSigningCertStorePassword](#rolloversigningcertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [RolloverSigningCertStore](#rolloversigningcertstore-property-as2sender-control) and set [RolloverSigningCertStorePassword](#rolloversigningcertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # RolloverSigningCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.RolloverSigningCertSubject[=string] ``` ## 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=example@email.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 # RolloverSigningCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # RolloverSigningCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertThumbprintMD5 ``` ## 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 # RolloverSigningCertThumbprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertThumbprintSHA1 ``` ## 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 # RolloverSigningCertThumbprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertThumbprintSHA256 ``` ## 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 # RolloverSigningCertUsage Property ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.RolloverSigningCertUsage ``` ## Default Value "" ## Remarks The text description of [RolloverSigningCertUsageFlags](#rolloversigningcertusageflags-property-as2sender-control). 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 # RolloverSigningCertUsageFlags Property ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.RolloverSigningCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [RolloverSigningCertUsageFlags](#rolloversigningcertusageflags-property-as2sender-control) 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 [RolloverSigningCertUsage](#rolloversigningcertusage-property-as2sender-control) property for a text representation of [RolloverSigningCertUsageFlags](#rolloversigningcertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # RolloverSigningCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.RolloverSigningCertVersion ``` ## 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 # SignatureAlgorithm Property ([AS2Sender](#as2sender-control) Control) Signature algorithm to be used in outgoing messages. ## Syntax ```text as2sendercontrol.SignatureAlgorithm[=string] ``` ## Default Value "sha-256" ## Remarks *Signature Algorithm* can be set to indicate the preferred signing algorithm. Possible values are: - sha1 - md5 - sha-256 (or sha256) (default) - sha-384 (or sha384) - sha-512 (or sha512) - sha-224 (or sha224) The default value is "sha-256". When this property is set the [MDNOptions](#mdnoptions-property-as2sender-control) property is automatically updated to request the MDN receipt be signed with the same algorithm. When [AS2Version](#as2version-property-as2sender-control) is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed for generated messages. "sha-256", "sha-384", or "sha-512" are recommended instead. ## Data Type String # SigningCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.SigningCertEffectiveDate ``` ## 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 # SigningCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.SigningCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SigningCertStore](#signingcertstore-property-as2sender-control) and [SigningCertSubject](#signingcertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [SigningCertEncoded](#signingcertencoded-property-as2sender-control) is set, a search is initiated in the current [SigningCertStore](#signingcertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [SigningCertSubject](#signingcertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [SigningCertSubject](#signingcertsubject-property-as2sender-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SigningCertEncodedB**. This property is not available at design time. ## Data Type Binary String # SigningCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.SigningCertExpirationDate ``` ## 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 # SigningCertExtendedKeyUsage Property ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.SigningCertExtendedKeyUsage ``` ## 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 # SigningCertFingerprint Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SigningCertFingerprint ``` ## 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 # SigningCertFingerprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SigningCertFingerprintSHA1 ``` ## 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 # SigningCertFingerprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SigningCertFingerprintSHA256 ``` ## 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 # SigningCertIssuer Property ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.SigningCertIssuer ``` ## 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 # SigningCertPrivateKey Property ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.SigningCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SigningCertPrivateKey](#signingcertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [SigningCertPrivateKey](#signingcertprivatekey-property-as2sender-control) returns an empty string. This property is read-only. ## Data Type String # SigningCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.SigningCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SigningCertPrivateKey](#signingcertprivatekey-property-as2sender-control) is available for the selected certificate. If [SigningCertPrivateKeyAvailable](#signingcertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SigningCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.SigningCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SigningCertPrivateKey](#signingcertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SigningCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.SigningCertPublicKey ``` ## 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 # SigningCertPublicKeyAlgorithm Property ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.SigningCertPublicKeyAlgorithm ``` ## 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 # SigningCertPublicKeyLength Property ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.SigningCertPublicKeyLength ``` ## 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 # SigningCertSerialNumber Property ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.SigningCertSerialNumber ``` ## 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 # SigningCertSignatureAlgorithm Property ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.SigningCertSignatureAlgorithm ``` ## 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 # SigningCertStore Property ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.SigningCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SigningCertStoreType](#signingcertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [SigningCertStore](#signingcertstore-property-as2sender-control). If the store is password-protected, specify the password in [SigningCertStorePassword](#signingcertstorepassword-property-as2sender-control). [SigningCertStore](#signingcertstore-property-as2sender-control) is used in conjunction with the [SigningCertSubject](#signingcertsubject-property-as2sender-control) property to specify client certificates. If [SigningCertStore](#signingcertstore-property-as2sender-control) has a value, and [SigningCertSubject](#signingcertsubject-property-as2sender-control) or [SigningCertEncoded](#signingcertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [SigningCertSubject](#signingcertsubject-property-as2sender-control) 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). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SigningCertStoreB**. ## Data Type Binary String # SigningCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.SigningCertStorePassword[=string] ``` ## 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 # SigningCertStoreType Property ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.SigningCertStoreType[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SigningCertStoreType](#signingcertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [SigningCertStore](#signingcertstore-property-as2sender-control), and the PIN as the [SigningCertStorePassword](#signingcertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SigningCertStore](#signingcertstore-property-as2sender-control) and set [SigningCertStorePassword](#signingcertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # SigningCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.SigningCertSubject[=string] ``` ## 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=example@email.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 # SigningCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.SigningCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SigningCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.SigningCertThumbprintMD5 ``` ## 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 # SigningCertThumbprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.SigningCertThumbprintSHA1 ``` ## 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 # SigningCertThumbprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.SigningCertThumbprintSHA256 ``` ## 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 # SigningCertUsage Property ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.SigningCertUsage ``` ## Default Value "" ## Remarks The text description of [SigningCertUsageFlags](#signingcertusageflags-property-as2sender-control). 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 # SigningCertUsageFlags Property ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.SigningCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SigningCertUsageFlags](#signingcertusageflags-property-as2sender-control) 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 [SigningCertUsage](#signingcertusage-property-as2sender-control) property for a text representation of [SigningCertUsageFlags](#signingcertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SigningCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.SigningCertVersion ``` ## 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 # SSLAcceptServerCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertEffectiveDate ``` ## 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 # SSLAcceptServerCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.SSLAcceptServerCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-as2sender-control) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLAcceptServerCertEncodedB**. This property is not available at design time. ## Data Type Binary String # SSLAcceptServerCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertExpirationDate ``` ## 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 ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertExtendedKeyUsage ``` ## 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 ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertFingerprint ``` ## 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 ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertFingerprintSHA1 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertFingerprintSHA256 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertIssuer ``` ## 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 ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.SSLAcceptServerCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-as2sender-control) returns an empty string. This property is read-only. ## Data Type String # SSLAcceptServerCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-as2sender-control) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLAcceptServerCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.SSLAcceptServerCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLAcceptServerCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertPublicKey ``` ## 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 ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertPublicKeyAlgorithm ``` ## 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 ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.SSLAcceptServerCertPublicKeyLength ``` ## 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 ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertSerialNumber ``` ## 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 ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertSignatureAlgorithm ``` ## 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 ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-as2sender-control). [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-as2sender-control) 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). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLAcceptServerCertStoreB**. ## Data Type Binary String # SSLAcceptServerCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertStorePassword[=string] ``` ## 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 ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertStoreType[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-as2sender-control) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # SSLAcceptServerCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertSubject[=string] ``` ## 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=example@email.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 # SSLAcceptServerCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLAcceptServerCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertThumbprintMD5 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertThumbprintSHA1 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertThumbprintSHA256 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.SSLAcceptServerCertUsage ``` ## Default Value "" ## Remarks The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-as2sender-control). 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 ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-as2sender-control) 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](#sslacceptservercertusage-property-as2sender-control) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLAcceptServerCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.SSLAcceptServerCertVersion ``` ## 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 # SSLCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.SSLCertEffectiveDate ``` ## 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 # SSLCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.SSLCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-as2sender-control) and [SSLCertSubject](#sslcertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-as2sender-control) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-as2sender-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLCertEncodedB**. This property is not available at design time. ## Data Type Binary String # SSLCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.SSLCertExpirationDate ``` ## 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 ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.SSLCertExtendedKeyUsage ``` ## 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 ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLCertFingerprint ``` ## 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 ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLCertFingerprintSHA1 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLCertFingerprintSHA256 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.SSLCertIssuer ``` ## 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 ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.SSLCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-as2sender-control) returns an empty string. This property is read-only. ## Data Type String # SSLCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.SSLCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-as2sender-control) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.SSLCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.SSLCertPublicKey ``` ## 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 ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.SSLCertPublicKeyAlgorithm ``` ## 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 ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.SSLCertPublicKeyLength ``` ## 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 ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.SSLCertSerialNumber ``` ## 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 ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.SSLCertSignatureAlgorithm ``` ## 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 ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.SSLCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-as2sender-control). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-as2sender-control). [SSLCertStore](#sslcertstore-property-as2sender-control) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-as2sender-control) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-as2sender-control) has a value, and [SSLCertSubject](#sslcertsubject-property-as2sender-control) or [SSLCertEncoded](#sslcertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-as2sender-control) 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). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLCertStoreB**. ## Data Type Binary String # SSLCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.SSLCertStorePassword[=string] ``` ## 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 ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.SSLCertStoreType[=integer] ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-as2sender-control), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-as2sender-control) and set [SSLCertStorePassword](#sslcertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # SSLCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.SSLCertSubject[=string] ``` ## 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=example@email.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 # SSLCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.SSLCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLCertThumbprintMD5 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLCertThumbprintSHA1 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLCertThumbprintSHA256 ``` ## 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 ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.SSLCertUsage ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-as2sender-control). 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 ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.SSLCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-as2sender-control) 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](#sslcertusage-property-as2sender-control) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.SSLCertVersion ``` ## 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 # SSLProvider Property ([AS2Sender](#as2sender-control) Control) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text as2sendercontrol.SSLProvider[=integer] ``` ## Possible Values ```text sslpAutomatic(0), sslpPlatform(1), sslpInternal(2) ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform. When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the control will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type Integer # SSLServerCertEffectiveDate Property ([AS2Sender](#as2sender-control) Control) The date on which this certificate becomes valid. ## Syntax ```text as2sendercontrol.SSLServerCertEffectiveDate ``` ## 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 # SSLServerCertEncoded Property ([AS2Sender](#as2sender-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text as2sendercontrol.SSLServerCertEncoded ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-as2sender-control) and [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) properties also may be used to specify a certificate. When [SSLServerCertEncoded](#sslservercertencoded-property-as2sender-control) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-as2sender-control) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) is set to an empty string. To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLServerCertEncodedB**. This property is read-only and not available at design time. ## Data Type Binary String # SSLServerCertExpirationDate Property ([AS2Sender](#as2sender-control) Control) The date on which the certificate expires. ## Syntax ```text as2sendercontrol.SSLServerCertExpirationDate ``` ## 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 # SSLServerCertExtendedKeyUsage Property ([AS2Sender](#as2sender-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text as2sendercontrol.SSLServerCertExtendedKeyUsage ``` ## 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 # SSLServerCertFingerprint Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertFingerprint ``` ## 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 # SSLServerCertFingerprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertFingerprintSHA1 ``` ## 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 # SSLServerCertFingerprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertFingerprintSHA256 ``` ## 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 # SSLServerCertIssuer Property ([AS2Sender](#as2sender-control) Control) The issuer of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertIssuer ``` ## 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 # SSLServerCertPrivateKey Property ([AS2Sender](#as2sender-control) Control) The private key of the certificate (if available). ## Syntax ```text as2sendercontrol.SSLServerCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-as2sender-control) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-as2sender-control) returns an empty string. This property is read-only. ## Data Type String # SSLServerCertPrivateKeyAvailable Property ([AS2Sender](#as2sender-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text as2sendercontrol.SSLServerCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-as2sender-control) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-as2sender-control) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SSLServerCertPrivateKeyContainer Property ([AS2Sender](#as2sender-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text as2sendercontrol.SSLServerCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-as2sender-control) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SSLServerCertPublicKey Property ([AS2Sender](#as2sender-control) Control) The public key of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertPublicKey ``` ## 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 # SSLServerCertPublicKeyAlgorithm Property ([AS2Sender](#as2sender-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text as2sendercontrol.SSLServerCertPublicKeyAlgorithm ``` ## 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 # SSLServerCertPublicKeyLength Property ([AS2Sender](#as2sender-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text as2sendercontrol.SSLServerCertPublicKeyLength ``` ## 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 # SSLServerCertSerialNumber Property ([AS2Sender](#as2sender-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text as2sendercontrol.SSLServerCertSerialNumber ``` ## 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 # SSLServerCertSignatureAlgorithm Property ([AS2Sender](#as2sender-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text as2sendercontrol.SSLServerCertSignatureAlgorithm ``` ## 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 # SSLServerCertStore Property ([AS2Sender](#as2sender-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text as2sendercontrol.SSLServerCertStore ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLServerCertStoreType](#sslservercertstoretype-property-as2sender-control) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-as2sender-control). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-as2sender-control). [SSLServerCertStore](#sslservercertstore-property-as2sender-control) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-as2sender-control) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) or [SSLServerCertEncoded](#sslservercertencoded-property-as2sender-control) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-as2sender-control) 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). To read or write binary data to the property, a Variant (Byte Array) version is provided in **.SSLServerCertStoreB**. This property is read-only. ## Data Type Binary String # SSLServerCertStorePassword Property ([AS2Sender](#as2sender-control) Control) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text as2sendercontrol.SSLServerCertStorePassword ``` ## 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 read-only. ## Data Type String # SSLServerCertStoreType Property ([AS2Sender](#as2sender-control) Control) The type of certificate store for this certificate. ## Syntax ```text as2sendercontrol.SSLServerCertStoreType ``` ## Possible Values ```text 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 0 ## Remarks The type of certificate store for this certificate. The control supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the control will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-as2sender-control), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-as2sender-control), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-as2sender-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-as2sender-control) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-as2sender-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 read-only. ## Data Type Integer # SSLServerCertSubject Property ([AS2Sender](#as2sender-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text as2sendercontrol.SSLServerCertSubject ``` ## 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=example@email.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 read-only. ## Data Type String # SSLServerCertSubjectAltNames Property ([AS2Sender](#as2sender-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SSLServerCertThumbprintMD5 Property ([AS2Sender](#as2sender-control) Control) The MD5 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertThumbprintMD5 ``` ## 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 # SSLServerCertThumbprintSHA1 Property ([AS2Sender](#as2sender-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertThumbprintSHA1 ``` ## 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 # SSLServerCertThumbprintSHA256 Property ([AS2Sender](#as2sender-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertThumbprintSHA256 ``` ## 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 # SSLServerCertUsage Property ([AS2Sender](#as2sender-control) Control) The text description of UsageFlags . ## Syntax ```text as2sendercontrol.SSLServerCertUsage ``` ## Default Value "" ## Remarks The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-as2sender-control). 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 # SSLServerCertUsageFlags Property ([AS2Sender](#as2sender-control) Control) The flags that show intended use for the certificate. ## Syntax ```text as2sendercontrol.SSLServerCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-as2sender-control) 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 [SSLServerCertUsage](#sslservercertusage-property-as2sender-control) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-as2sender-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SSLServerCertVersion Property ([AS2Sender](#as2sender-control) Control) The certificate's version number. ## Syntax ```text as2sendercontrol.SSLServerCertVersion ``` ## 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 # Subject Property ([AS2Sender](#as2sender-control) Control) The subject of the message. ## Syntax ```text as2sendercontrol.Subject[=string] ``` ## Default Value "" ## Remarks The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer. ## Data Type String # Timeout Property ([AS2Sender](#as2sender-control) Control) The timeout for the control. ## Syntax ```text as2sendercontrol.Timeout[=integer] ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the control will wait for the operation to complete before returning control. The control will use [DoEvents](#doevents-method-as2sender-control) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the control fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. ## Data Type Integer # URL Property ([AS2Sender](#as2sender-control) Control) The URL to which the request is made. ## Syntax ```text as2sendercontrol.URL[=string] ``` ## Default Value "" ## Remarks This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https". ## Data Type String # UseOAEP Property ([AS2Sender](#as2sender-control) Control) This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). ## Syntax ```text as2sendercontrol.UseOAEP[=boolean] ``` ## Default Value False ## Remarks This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the control will use PKCS1. To specify nondefault OAEP options, please see [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm), [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm), and [OAEPParams](#OAEPParams) ## Data Type Boolean # UsePSS Property ([AS2Sender](#as2sender-control) Control) This property specifies whether or not RSA-PSS will be used during signing and verification. ## Syntax ```text as2sendercontrol.UsePSS[=boolean] ``` ## 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 # UserAgent Property ([AS2Sender](#as2sender-control) Control) Information about the user agent. ## Syntax ```text as2sendercontrol.UserAgent[=string] ``` ## Default Value "IPWorks EDI AS2Sender Component - www.nsoftware.com" ## Remarks You may override the default with the name and version of your software. ## Data Type String # Config Method ([AS2Sender](#as2sender-control) Control) Sets or retrieves a configuration setting. ## Syntax ```text as2sendercontrol.Config ConfigurationString ``` ## Remarks Config is a generic method available in every control. It is used to set and retrieve [configuration settings](#config-settings-as2sender-control) for the control. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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](#config-settings-as2sender-control), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoEvents Method ([AS2Sender](#as2sender-control) Control) This method processes events from the internal message queue. ## Syntax ```text as2sendercontrol.DoEvents ``` ## Remarks When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Interrupt Method ([AS2Sender](#as2sender-control) Control) This method interrupts the current method. ## Syntax ```text as2sendercontrol.Interrupt ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # Post Method ([AS2Sender](#as2sender-control) Control) Post data to the AS2 server, and check the receipt. ## Syntax ```text as2sendercontrol.Post ``` ## Remarks Post data to the server. The reply will also be checked, and if a synchronous MDN was requested (i.e., [MDNTo](#mdnto-property-as2sender-control) is not empty), it will be validated. After the method finishes, the MDNReceipt, [ReceiptSigningProtocol](#ReceiptSigningProtocol), and ReceiptSignerCert properties will be populated with the appropriate values. The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN. If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal. # ReadAsyncReceipt Method ([AS2Sender](#as2sender-control) Control) Reads an asynchronous MDN receipt from the current HTTP session. ## Syntax ```text as2sendercontrol.ReadAsyncReceipt ``` ## Remarks This method is reserved for future use. Instead, assign the body and headers of the request to [MDNReceiptContent](#mdnreceiptcontent-property-as2sender-control) and [MDNReceiptHeaders](#mdnreceiptheaders-property-as2sender-control), in that order. Setting [MDNReceiptHeaders](#mdnreceiptheaders-property-as2sender-control) will parse the receipt automatically. # Reset Method ([AS2Sender](#as2sender-control) Control) Resets the state of the control. ## Syntax ```text as2sendercontrol.Reset ``` ## Remarks Resets all HTTP headers as well as [EDIData](#edidata-property-as2sender-control), etc. After invoking this method the control may be reused as if it were newly created. # Restart Method ([AS2Sender](#as2sender-control) Control) Restart sending of the file specified by the Etag property. ## Syntax ```text as2sendercontrol.Restart ``` ## Remarks This method should be called when using the AS2 restart functionality. When called, the control will process the file and cache the processed contents to the [RestartDirectory](#restartdirectory-property-as2sender-control). Before sending, the [Etag](#etag-property-as2sender-control) property will be populated with a unique [Etag](#etag-property-as2sender-control) which identifies the processed file. If sending is interrupted or fails, this method should be called to restart sending of the previously processed file starting where the interruption occurred. In order to restart from the last transfer, the [Etag](#etag-property-as2sender-control) must be populated with the value from the last connection. NOTE: When using restart functionality, the data is completely processed to the [RestartDirectory](#restartdirectory-property-as2sender-control) before sending begins. # SendCEMRequest Method ([AS2Sender](#as2sender-control) Control) Sends a Certificate Exchange Messaging (CEM) request. ## Syntax ```text as2sendercontrol.SendCEMRequest RequestId ``` ## Remarks This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails. Certificate Exchange Messaging (CEM) allows for new certificates to be sent to a recipient and be automatically updated. This removes the requirement to manually send new certificates to a partner via email or other means. When both sides support this functionality updating certificates can be accomplished in a short period of time. To prepare a CEM request populate the CEMDetails collection with at least one certificate. For instance if the certificate of the application will be updated soon, the CEMDetails may be populated with the corresponding public certificate to be sent to your partner. CEMDetails should only contain public certificates. Set [CEMRespondByDate](#cemrespondbydate-property-as2sender-control) to the date by which you expect a response. 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". Optionally set [CEMCertId](#cemcertid-property-as2sender-control) to a friendly identifier that the partner may use to help understand the purpose of the new certificate. For instance "New.Encryption.Cert.2014". Set [CEMResponseURL](#cemresponseurl-property-as2sender-control) to the publicly accessible URL where the CEM response will be sent after the partner processes it. The **RequestId** parameter uniquely identifies this CEM request and must be saved for use later when receiving the CEM response. When calling this method the applicable CEMDetails properties are: - [CEMCertStoreType](#cemcertstoretype-property-as2sender-control) - [CEMCertStore](#cemcertstore-property-as2sender-control) - [CEMCertStorePassword](#cemcertstorepassword-property-as2sender-control) - [CEMCertSubject](#cemcertsubject-property-as2sender-control) - [CEMRespondByDate](#cemrespondbydate-property-as2sender-control) - [CEMResponseURL](#cemresponseurl-property-as2sender-control) - [CEMCertUsage](#cemcertusage-property-as2sender-control) (optional) - [CEMCertId](#cemcertid-property-as2sender-control) (optional) # SendCEMResponse Method ([AS2Sender](#as2sender-control) Control) Sends a Certificate Exchange Messaging (CEM) response. ## Syntax ```text as2sendercontrol.SendCEMResponse RequestId ``` ## Remarks This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails. A CEM request must have previously been received using AS2Receiver. To send the CEM response, populate CEMDetails with the certificate information and decide whether to accept or reject the request. The following properties may be set to specify the certificate: - [CEMCertStoreType](#cemcertstoretype-property-as2sender-control) - [CEMCertStore](#cemcertstore-property-as2sender-control) - [CEMCertSubject](#cemcertsubject-property-as2sender-control) Alternatively, the certificate information may be set: - [CEMCertIssuer](#cemcertissuer-property-as2sender-control) - [CEMCertSerialNumber](#cemcertserialnumber-property-as2sender-control) After specifying the certificate information choose whether to accept or reject the request. To accept the request set [CEMAccepted](#cemaccepted-property-as2sender-control) to True. To reject the request set [CEMAccepted](#cemaccepted-property-as2sender-control) to False and specify a reason in [CEMRejectionReason](#cemrejectionreason-property-as2sender-control). Call SendCEMResponse and pass the CEM request Id that was retrieved from the request. # SetRequestHeader Method ([AS2Sender](#as2sender-control) Control) Allows the user to set or add arbitrary HTTP request headers. ## Syntax ```text as2sendercontrol.SetRequestHeader HeaderName, HeaderValue ``` ## Remarks *HeaderName* should contain the header name, and *HeaderValue* should contain its value. Use this to set headers such as *To*, *Date*, etc. Note that a default value for *Date* will automatically be determined and this method may be used to override the default. **SetRequestHeader** may be used to set any header except for the following: *AS2-To*, *AS2-From*, *AS2-Version*, *Subject*, *Message-Id*, *Disposition-Notification-To*, *Disposition-Notification-Options*, *Receipt-Delivery-Option*, *Host*, *Content-Length*. # SetTPInfo Method ([AS2Sender](#as2sender-control) Control) A convenient way to set AS2 communication parameters using XML strings. ## Syntax ```text as2sendercontrol.SetTPInfo 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](AS2ProfileMgr.md#AS2ProfileMgr). The "self" information should always precede the partner information as shown below. ```text AS2Sender as2sender = new AS2Sender(); AS2Profilemgr mgr = new AS2Profilemgr(); mgr.DataDir = @"C:\as2data"; as2sender.SetTPInfo(mgr.GetTPInfo("self")); as2sender.SetTPInfo(mgr.GetTPInfo("partnerOrg")); as2sender.EDIFile = @"C:\as2Data.x12"; as2sender.Post(); ``` # VerifyReceipt Method ([AS2Sender](#as2sender-control) Control) Verifies an asynchronous MDN receipt. ## Syntax ```text as2sendercontrol.VerifyReceipt ``` ## Remarks **VerifyReceipt** verifies the receipt in MDNReceipt against [OriginalContentMIC](#originalcontentmic-property-as2sender-control), [MessageId](#messageid-property-as2sender-control) and the preferences specified in [MDNOptions](#mdnoptions-property-as2sender-control). The method operates similarly to [Post](#post-method-as2sender-control): After the method finishes, the MDNReceipt, [ReceiptSigningProtocol](#ReceiptSigningProtocol), and ReceiptSignerCert properties will be populated with the appropriate values. The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN. If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal. This method should be used to verify receipts received asynchronously; i.e., not in the HTTP reply to a POST. When posting, asynchronous MDN delivery may be requested by setting [MDNDeliveryOption](#mdndeliveryoption-property-as2sender-control). # Connected Event ([AS2Sender](#as2sender-control) Control) Fired immediately after a connection completes (or fails). ## Syntax ```text Sub as2sendercontrol_Connected(StatusCode As Integer, Description As String) ``` ## Remarks If the connection is made normally, *StatusCode* is 0 and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value. Please refer to the [Error Codes](#trappable-errors-as2sender-control) section for more information. # Disconnected Event ([AS2Sender](#as2sender-control) Control) Fired when a connection is closed. ## Syntax ```text Sub as2sendercontrol_Disconnected(StatusCode As Integer, Description As String) ``` ## Remarks If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value. Please refer to the [Error Codes](#trappable-errors-as2sender-control) section for more information. # EndTransfer Event ([AS2Sender](#as2sender-control) Control) Fired when a document finishes transferring. ## Syntax ```text Sub as2sendercontrol_EndTransfer(Direction As Integer) ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([AS2Sender](#as2sender-control) Control) Fired when information is available about errors during data delivery. ## Syntax ```text Sub as2sendercontrol_Error(ErrorCode As Integer, Description As String) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error. 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](#trappable-errors-as2sender-control) section. # Header Event ([AS2Sender](#as2sender-control) Control) Fired every time a header line comes in. ## Syntax ```text Sub as2sendercontrol_Header(Field As String, Value As String) ``` ## Remarks The *Field* parameter contains the name of the HTTP header (same case as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains an empty string. Note that only the top-level headers will be returned through this event, and that they are available through the ReplyHeaders property. The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # Log Event ([AS2Sender](#as2sender-control) Control) Fired with log information while processing a message. ## Syntax ```text Sub as2sendercontrol_Log(LogType As String, LogMessage As String) ``` ## Remarks This event fires once for each log message generated by the control. The verbosity is controlled by the [LogLevel](#LogLevel) setting. Log messages available through this event correspond to log files written to [LogDirectory](#logdirectory-property-as2sender-control). This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of [LogDirectory](#logdirectory-property-as2sender-control) (i.e. when [LogDirectory](#logdirectory-property-as2sender-control) 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](#LogDebug) is True. | | "DAT.ENCRYPT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.COMPRESS" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.SIGN" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.DECRYPT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.DECOMPRESS" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.VERIFY" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.DEBUG" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | # SetCookie Event ([AS2Sender](#as2sender-control) Control) Fired for every cookie set by the server. ## Syntax ```text Sub as2sendercontrol_SetCookie(Name As String, Value As String, Expires As String, Domain As String, Path As String, Secure As Boolean) ``` ## Remarks This event is fired for every *Set-Cookie:* header received from the HTTP server. The *Name* parameter contains the name of the cookie, with the corresponding value supplied in the *Value* parameter. The *Expires* parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the *Expires* parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session. The *Domain* parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the *Domain* parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain. The *Path* parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the *Path* parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path. The *Secure* parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection. # SSLServerAuthentication Event ([AS2Sender](#as2sender-control) Control) Fired after the server presents its certificate to the client. ## Syntax ```text Sub as2sendercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean) ``` ## Remarks This event is where the client can decide whether to continue with the connection process or not. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string "OK"). # SSLStatus Event ([AS2Sender](#as2sender-control) Control) Fired when secure connection progress messages are available. ## Syntax ```text Sub as2sendercontrol_SSLStatus(Message As String) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([AS2Sender](#as2sender-control) Control) Fired when a document starts transferring (after the headers). ## Syntax ```text Sub as2sendercontrol_StartTransfer(Direction As Integer) ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Transfer Event ([AS2Sender](#as2sender-control) Control) Fired while a document transfers (delivers document). ## Syntax ```text Sub as2sendercontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String) ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Config Settings ([AS2Sender](#as2sender-control) Control) The control 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 control, access to these *internal properties* is provided through the [Config](#config-method-as2sender-control) method. ### AS2Sender Config Settings **AllowMDNWarnings**: Whether to fail on MDN warnings.When processing MDNs this setting determines if the control throws an exception when a MDN warning is processed. By default this value is False and MDN warnings other than duplicate files warnings will result in an exception. If set to True all MDN warnings will be allowed and processing will continue as normal. Check [MDNDisposition](#MDNDisposition) to process the warning manually in this case. **Authorization**: The Authorization string to be sent to the server. If the [Authorization](#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 control can be extended with other security schemes in addition to the authorization schemes already implemented by the control. The [AuthScheme](#AuthScheme); setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#User) and [Password](#Password) are set, they are Base64 encoded, and the result is put in the **Authorization** setting in the form "Basic [encoded-user-password]". **AuthScheme**: The authorization scheme to be used when server authorization is to be performed. Use the [AuthScheme](#AuthScheme) property to tell the component which type of authorization to perform when the [User](#User) and [Password](#Password) properties are set. Possible values are: | | | | --- | --- | | 0 (default) | Basic | | 1 | Digest | | 2 | Proprietary | | 3 | None | | 4 | NTLM | | 5 | Negotiate | | 6 | OAuth | By default, [AuthScheme](#AuthScheme) is Basic (0), and if the [User](#User) and [Password](#Password) configuration settings are set, the component will attempt basic authentication. If AuthScheme is set to Digest (1), digest authentication will be attempted instead. For security reasons, setting this value will clear the values of [User](#User) and [Password](#Password). **EncodeToTempDir**: Whether to use temporary files when creating messages.This setting determines if temporary files are used when creating messages. By default this value is not set and messages are created in memory before posting. When working with very large files this can cause substantial memory usage. To avoid memory overhead when working with large files set this to a relative or absolute path to a directory on disk. When [Post](#post-method-as2sender-control) is called the control will create a file in the specified directory during processing. **IgnoreLoggingErrors**: Whether to ignore errors that occur when writing to the log.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. **IncludeHeaders**: Whether headers are included when posting to a file.This setting determines if headers are included in the file when using [PostToFile](#PostToFile). By default this value is true. When set to False headers are not included in the content written to the file. When set to False this also allows data to be streamed directly to the file specified by [PostToFile](#PostToFile) without any substantial memory overhead or the use of [EncodeToTempDir](#EncodeToTempDir). After posting to a file check the [MessageHeaders](#MessageHeaders) to obtain the headers. This setting should only be used when [PostToFile](#PostToFile) is set. **LogDebug**: Whether to log debug data.This setting specifies whether to log debug data. When set to True the control will create additional files in the [LogDirectory](#logdirectory-property-as2sender-control). 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. **LogFilename**: The base name of the log file.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. **LogOptions**: The information to be written to log files. When [LogDirectory](#logdirectory-property-as2sender-control) 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 outgoing transmission, with applied security options | | Payload | Contains log of unsecured payload prior to transmission | | Response | For synchronous requests or asynchronous receipts verified with [VerifyReceipt](#verifyreceipt-method-as2sender-control), contains MDN receipt, if sent. For asynchronous requests, contains server acknowledgement. | | Errors | A separate file with a .err extension is written when an error is encountered. | | All | All of the above | **MDNDisposition**: Returns the Disposition header of the MDN.This setting returns the Disposition header value from the MDN. **MessageHeaders**: Returns the headers of the message.This setting returns the headers of the generated message when [IncludeHeaders](#IncludeHeaders) is False and [PostToFile](#PostToFile) is set. It should not be used in any other cases. **NormalizeMIC**: Whether to normalize line endings before calculating the MIC.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. **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used when encrypting a key.When [UseOAEP](#useoaep-property-as2sender-control) is True, this algorithm specifies the MGF1 hash algorithm used for the encryption key by RSA OAEP. Possible values are: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" Note: An empty string value indicates that the algorithm specified by [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is used as the RSA hash algorithm as well. **OAEPParams**: The hex encoded OAEP parameters to be used when encrypting a key.This setting is optional and should only be specified if OAEP parameters need to be explicitly set. The value specified should be a hex string. By default this setting is unspecified. **OAEPRSAHashAlgorithm**: The RSA hash algorithm used when encrypting a key.When [UseOAEP](#useoaep-property-as2sender-control) is True, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the AS4 message content. Possible values are: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" **Password**: A password if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server. The [User](#User) and [Password](#Password) properties must be set only after the [URL](#url-property-as2sender-control) property is set. When the [URL](#url-property-as2sender-control) property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared. **PostToFile**: Creates the message on disk.This setting allows for the message to be created on disk without actually being sent. This is useful in certain situations to prepare the message where it is sent by a different transport mechanism at a later time. This should be set to a relative or absolute file path including the filename. When this is set the control will immediately start processing the message and writing to the specified file. **RequiredSignatureAlgorithms**: Specifies a list of acceptable signature algorithms.This setting specifies a comma separated list of allowed signature algorithms used in messages verified by the control. 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*. **User**: A user name if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server. The [User](#User) and [Password](#Password) properties must be set only after the [URL](#url-property-as2sender-control) property is set. When the [URL](#url-property-as2sender-control) property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the control 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 control only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the control will accept compressed data. It then will uncompress the data it has received. The control will handle data compressed by both gzip and deflate compression algorithms. When True, the control adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the control will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the control fails with an error if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#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 control can be extended with other security schemes in addition to the authorization schemes already implemented by the control. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-as2sender-control) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the control.If set to True, the URL passed to the control will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the control returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [URL](#url-property-as2sender-control) for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new [URL](#url-property-as2sender-control) is retrieved automatically only if the URL Scheme is the same; otherwise, the control fails with an error. **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 control fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the control will perform a GET on the new location.The default value is False. If set to True, the control will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the control.This property specifies the HTTP version used by the control. 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 control 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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *False*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-as2sender-control) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the control will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the control will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*Chr$(13) & Chr$(10)*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the control beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#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](#proxyuser-property-as2sender-control) and [ProxyPassword](#proxypassword-property-as2sender-control) are specified, this value is calculated using the algorithm specified by [ProxyAuthScheme](#proxyauthscheme-property-as2sender-control). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by controls that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by controls that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by controls that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by controls that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by controls that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the control.If [TransferredDataLimit](#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 control. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the control 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 control will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the control will attempt to use the Proxy auto-config URL when establishing a connection and [ProxyAutoDetect](#proxyautodetect-property-as2sender-control) is set to *True*. When *True* (default), the control will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the control will use [Timeout](#timeout-property-as2sender-control) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the control will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the control will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the Connected operation as a whole. **FirewallAutoDetect**: Tells the control whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by controls that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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 controls that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error. NOTE: This setting is provided for use by controls that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by controls that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by controls that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the control fails with an error. NOTE: This setting is provided for use by controls that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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 control returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-as2sender-control) 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 control initiate connections (or accept in the case of server controls) only through that interface. If the control is connected, the [LocalHost](#localhost-property-as2sender-control) 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). **LocalPort**: The port in the local host where the control binds. This configuration setting must be set before a connection is attempted. It instructs the control 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**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#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](#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](#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](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When 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. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the control will use IPv4 exclusively. When set to *1*, the control will use IPv6 exclusively. To instruct the control 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 | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-as2sender-control) 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](#sslstatus-event-as2sender-control) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-as2sender-control) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). 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. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by 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. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the control 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 control is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-as2sender-control) 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: ```text -----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----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the control will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the control will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The control 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 control fails with an error. When set to 0 (default), the CRL check will not be performed by the control. 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. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the control will use OCSP to check the validity of the server certificate. If set to 1 or 2, the control will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The control 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 control fails with an error. When set to 0 (default), the control 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. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. 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](#sslstatus-event-as2sender-control) 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#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: ```text -----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----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.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 control will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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](#sslprovider-property-as2sender-control) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-as2sender-control) 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 Example values when [SSLProvider](#sslprovider-property-as2sender-control) is set to *Internal*include the following: ```text 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](#sslprovider-property-as2sender-control) 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](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.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 control will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-as2sender-control) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-as2sender-control) 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](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#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 control when the [SSLProvider](#sslprovider-property-as2sender-control) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-as2sender-control) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.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](#sslprovider-property-as2sender-control) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-as2sender-control) 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](#sslserverauthentication-event-as2sender-control) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-as2sender-control) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the control 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 control will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-as2sender-control) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.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: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.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: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.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: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.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: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.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: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.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: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.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. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#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: ```text -----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----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-as2sender-control) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the control 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 control fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp 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. **TLS12SupportedGroups**: The supported groups for ECC.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](#sslprovider-property-as2sender-control) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This 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" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.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) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.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,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* 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) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-as2sender-control) 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. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the 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 control is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. 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 control 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 **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the control will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the control 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 ([AS2Sender](#as2sender-control) Control) ### AS2Sender Errors | | | | --- | --- | | 20119 | Firewall Error. Error description contains detailed message. | | 20144 | Busy performing current action. | | 20152 | HTTP protocol error. The error message has the server response. | | 20153 | No server specified in [URL](#url-property-as2sender-control) | | 20154 | Specified [URL](#url-property-as2sender-control) scheme is invalid. | | 20284 | No MIME-boundary found. | | 20502 | Unable to parse the receipt. | | 20503 | The receipt is signed with an unsupported signature format (details follow). | | 20512 | Unsupported compression algorithm requested. | | 20522 | A Message Integrity Check was requested, but not provided in the MDN. | | 20523 | The Message Integrity Check returned in the MDN is incorrect. | | 20524 | Unable to parse Message Integrity Check. | | 20525 | Unrequested hashing algorithm used (check MDNOptions). | | 20526 | The Message ID returned in the MDN does not match. | | 20532 | The receipt was unsigned, and a signed receipt was expected. | | 20533 | The receipt signature could not be verified. | | 20534 | An MDN was expected in the HTTP reply, but was not returned. | | 20601 | Failure reported in MDN: Unsupported signing protocol. | | 20602 | Failure reported in MDN: Unsupported MIC algorithms. | | 20603 | Failure reported in MDN: Other (details follow). | | 20612 | Error reported in MDN: Decryption failed. | | 20613 | Error reported in MDN: Authentication failed. | | 20614 | Error reported in MDN: Could not verify content integrity. | | 20615 | Error reported in MDN: Unexpected processing error. | | 20616 | Error reported in MDN: Other (details follow). | | 20722 | Warning reported in MDN: Authentication failed, processing continued by receiver. | | 20723 | Warning reported in MDN: Other (details follow). | | 20832 | I/O Error (details follow). | ### SMIME Errors | | | | --- | --- | | 25192 | Invalid index (RecipientIndex). | | 25193 | Message decoding error (code). | | 25194 | Unexpected message type. | | 25195 | Unsupported hashing/signing algorithm. | | 25196 | The message does not have any signers. | | 25197 | The message signature could not be verified. | | 25198 | Could not locate a suitable decryption certificate. | | 25199 | The signer certificate could not be found. | | 25200 | No signing certificate was supplied for signing the message. | | 25202 | The specified certificate was not the one required. | | 25203 | The specified certificate could not be found. | | 25222 | Could not acquire CSP. | | 25223 | Type validation error. | | 25224 | Unsupported key size. | | 25225 | Unrecognized Content-Type object identifier. | | 25226 | Unrecognized public key format. | | 25227 | No choices specified. | | 25229 | Must specify output stream. | | 25281 | Invalid part index. | | 25282 | Unknown MIME type. | | 25284 | No MIME-boundary found. | | 25281 | Error decoding certificate. |