AS3Sender Class

Properties   Methods   Events   Config Settings   Errors  

The AS3Sender class implements an AS3 / EDI-INT client.

Syntax

ipworksedi.as3sender()

Remarks

The AS3Sender component may be used to send EDI or other messages over FTP/S, using the AS3 protocol. It may also be used to verify Message Disposition Notifications (MDNs) returned by the server.

A typical AS3 transaction is as follows:

(1) The sender sends an EDI document to the receiver using FTP. The document may be signed, encrypted, and/or compressed, and a signed or unsigned receipt may be requested.

(2) The receiver decompresses and 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, AS3From and AS3To, EDIDataData, and EDIDataEDIType. You will also need to specify User, Password, and RemoteHost to Logon to the FTP server. After doing this you may send the data by calling Send.

To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data set SigningCert. To encrypt, set RecipientCerts.

TLS/SSL may be enabled by setting the SSLStartMode property. In case your trading partner is using a self-signed certificate it will be necessary to set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.

The message may also be compressed by setting CompressionFormat.

To request a receipt, or Message Disposition Notification (MDN), simply set the MDNTo property. The MDN will be returned to the FTP URL specified. The MDNOptions property may be used to customize the request. By default, the class will request a signed MDN over an SHA1 hash.

Validating AS3 MDNs

AS3 MDNs will be returned asynchronously over a separate connection. You may verify MDNs by invoking ReadReceipt. This will read the receipt from the FTP server (or from the MDNReceipt property). It will determine the MessageId of the original message and determine the originator and recipient of the MDN.

You should then look up your trading partner's certificates as well as the OriginalContentMIC (which you must store externally to verify signed receipts), and invoke VerifyReceipt.

Property List

---

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

AS3From	The identity of the sending system.
AS3To	The identity of the receiving system.
AS3Version	The version of AS3 being used.
Attachments	Collection of files attached to the current message.
CompressionFormat	The compression format (if any) to use.
Connected	This shows whether the class is connected.
EDIData	The EDI or other data to be sent.
EncryptionAlgorithm	The algorithm used to encrypt the EDI data.
Firewall	A set of properties related to firewall access.
FTPLastReply	The last reply from the FTP server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LogDirectory	The path to a directory for logging.
LogFile	The log file written.
MDNOptions	Used to indicate the options requested for the MDN receipt.
MDNReceipt	The MDN receipt returned from the server.
MDNTo	The system to which an MDN should be directed.
MessageId	The Id of the message.
OriginalContentMIC	The Message Integrity Check(s) (one-way hash) of the outgoing message.
Passive	This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.
Password	This is the password used to log in.
ReceiptSignerCert	The public key certificate for the MDN receipt signature.
RecipientCerts	The public key certificates of the recipients for this message.
RemoteHost	This is the domain name or IP address of the FTP server.
RemotePort	This is the port for the FTP service (default is 21).
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
SigningCert	Contains the certificate to use when signing messages.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCert	The server certificate for the last established connection.
SSLStartMode	Determines how the class starts the SSL negotiation. By default, SSL will not be used.
Subject	The subject of the message.
Timeout	A timeout for the class.
User	This property contains the user identifier to use to log in.

Method List

---

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

Abort	The method aborts the current upload or download.
ChangeRemotePath	This method changes the current path on the FTP server.
Config	Sets or retrieves a configuration setting.
DeleteFile	This method removes a file specified by FileName from an FTP server.
GetFileSize	Gets the size of a file on the FTP server.
GetFileTime	Gets the last modification time of a file on the FTP server.
ListDirectory	List the current directory on an FTP server.
ListDirectoryLong	List the current directory on an FTP server.
Logoff	This method is used to log off from the FTP server by posting a QUIT command.
Logon	Logon to the FTP RemoteHost using the current User and Password .
ReadReceipt	Reads and parses (but does not verify) an MDN receipt.
Reset	Resets the state of the control.
Send	Prepares and sends the AS3 message.
SendFTPCommand	Sends the exact command directly to the server.
VerifyReceipt	Verifies an MDN receipt.

Event List

---

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

ConnectionStatus	This event is fired to indicate changes in the connection state.
DirList	This event is fired when a directory entry is received.
EndTransfer	This event is fired when a file finishes downloading or uploading.
Error	Information about errors during data delivery.
Log	Fired with log information while processing a message.
PITrail	This event traces the commands sent to the server, and the respective replies.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	This event fires when a file starts downloading or uploading.
Transfer	This event is fired during the file download or upload.

Config Settings

---

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

CalculateProcessingPercentDone	Whether to show the progress of file processing.
LogFilename	The base name of the log file.
LogonAfterProcessing	Whether to prepare the file before connecting to the FTP server.
ActiveModeIP	Allows the specification of the IP address that the server will connect to for active mode connections.
ActiveModePORTAddress	Allows the specification of the PORT address value for active mode connections.
AppendToLocalFile	Append downloaded files to a local file.
ApplyFileMaskLocally	Whether to filter the directory listing locally or on the server.
AutoSelectDataIP	Automatically select the data connection IP.
CalculatePercentDone	Enables or Disables calculating the percent complete for downloads.
CheckTotalEntry	Whether to ignore directory listing total lines.
DILinger	When set to True, DI connections are terminated gracefully.
DILingerTime	Time in seconds to have the DI connection linger.
FileTimeFormat	The format of file time reported by the server.
IgnoreEntries	Directory entry data to ignore.
MaskSensitive	Masks passwords in logs.
ModeZCompressionLevel	Used to specify the level of compression used.
PortRange	Allows the specification of a port range where the class listens for active mode connections.
PreserveFileTime	Attempts to preserve timestamps when transferring files.
RealTimeUpload	Enables real time uploading.
RealTimeUploadAgeLimit	The age limit in seconds when using RealTimeUpload.
ReusePISSLSessionInDI	Whether the PI SSL session will be reused for the DI connection.
ReuseSSLSessionInDI	Whether the SSL session will be reused for the DI connection.
UseClearChannel	Allows for the Clear Command Channel (CCC) command.
UseClearDataChannel	Allows for the PROT C command.
UseEPSV	Allows extended passive mode.
UseMLSD	Uses listings for machine processing.
UseMLST	Uses single file listing for machine processing.
UseModeZ	Allows compression to be used when transferring data.
UseOldAUTHSSL	Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'.
UseProtWhenImplicit	Sends the PROT P command to the server.
UseRemoteHostAddressForPassive	Instructs the class to use the address specified by RemoteHost when establishing a data connection.
VirtualHostName	Sends the HOST command to the server.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLAcceptAnyServerCert	Whether to trust any certificate presented by the server.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

AS3Sender.AS3From Property

The identity of the sending system.

Syntax

 getAS3From(): string;

 setAS3From(AS3From: string): void;

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

AS3Sender.AS3To Property

The identity of the receiving system.

Syntax

 getAS3To(): string;

 setAS3To(AS3To: string): void;

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

AS3Sender.AS3Version Property

The version of AS3 being used.

Syntax

 getAS3Version(): string;

 setAS3Version(AS3Version: string): void;

Default Value

"1.0"

Remarks

The version of AS3 being used. Should be "1.0".

AS3Sender.Attachments Property

Collection of files attached to the current message.

Syntax

 getAttachments(): EDIAttachmentList;

 setAttachments(attachments: EDIAttachmentList): void;

Default Value

Remarks

When a call to Send is made, the class will attach the files referenced by each EDIAttachment in this collection to the EDIData.

This property is not available at design time.

AS3Sender.CompressionFormat Property

The compression format (if any) to use.

Syntax

 getCompressionFormat(): As3senderCompressionFormats;

 setCompressionFormat(compressionFormat: As3senderCompressionFormats): void;

enum As3senderCompressionFormats {
  cfNone,
  cfZLIB
}

Default Value

0

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the class 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.

AS3Sender.Connected Property

This shows whether the class is connected.

Syntax

 isConnected(): boolean;

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

AS3Sender.EDIData Property

The EDI or other data to be sent.

Syntax

 getEDIData(): EDIData;

 setEDIData(EDIData: EDIData): void;

Default Value

Remarks

The EDI message to send.

This property is not available at design time.

AS3Sender.EncryptionAlgorithm Property

The algorithm used to encrypt the EDI data.

Syntax

 getEncryptionAlgorithm(): string;

 setEncryptionAlgorithm(encryptionAlgorithm: string): void;

Default Value

"3DES"

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 class supports "3DES", or industry-standard 168-bit Triple-DES encryption.

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

Possible values are:

• 3DES (default)
• DES
• AESCBC128
• AESCBC192
• AESCBC256
• AESGCM128
• AESGCM192
• AESGCM256

AS3Sender.Firewall Property

A set of properties related to firewall access.

Syntax

 getFirewall(): Firewall;

 setFirewall(firewall: Firewall): void;

Default Value

Remarks

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

AS3Sender.FTPLastReply Property

The last reply from the FTP server.

Syntax

 getFTPLastReply(): string;

Default Value

""

Remarks

The last reply from the FTP server.

This property is read-only.

AS3Sender.LocalHost Property

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

Syntax

 getLocalHost(): string;

 setLocalHost(localHost: string): void;

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

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

AS3Sender.LogDirectory Property

The path to a directory for logging.

Syntax

 getLogDirectory(): string;

 setLogDirectory(logDirectory: string): void;

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 class will log the original EDI data, the complete text of the outgoing request and the incoming response.

The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS3 messages created or downloaded by the class will be written with extension ".as3", and MDNs created or downloaded will be written with extension ".as3-mdn".

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

If logs cannot be written an exception will be thrown.

AS3Sender.LogFile Property

The log file written.

Syntax

 getLogFile(): string;

Default Value

""

Remarks

In case LogDirectory is specified two log files will be written in the specified directory and LogFile will contain the path.

LogFile will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename LogFile + ".log", and any EDI data read will be written with filename LogFile + ".dat". Raw AS3 messages and MDNs will also be written with extensions ".as3" and ".as3-mdn".

This property is read-only.

AS3Sender.MDNOptions Property

Used to indicate the options requested for the MDN receipt.

Syntax

 getMDNOptions(): string;

 setMDNOptions(MDNOptions: string): void;

Default Value

"signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256"

Remarks

By default, the class 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 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.

AS3Sender.MDNReceipt Property

The MDN receipt returned from the server.

Syntax

 getMDNReceipt(): MDNReceipt;

 setMDNReceipt(MDNReceipt: MDNReceipt): void;

Default Value

Remarks

This property will contain an instance of MDNReceipt with the complete MDN receipt returned from the AS2 receiver. The receipt will be a signed or unsigned multipart/report in MIME format. For synchronous MDN requests, this property is populated automatically after the call to Post. If an asynchronous MDN is sent over HTTP, it may be read from the HTTP context by calling ReadAsyncReceipt, or it may be set manually.

When MDNReceipt is set to a valid MDN receipt, the originator of the receipt will be stored in AS2To, the intended recipient (presumably your system) will be stored in AS2From, and the original message ID will be stored in MessageId.

If you are processing a MDN receipt asynchronously, you can use the values to look up the original message and validate the receipt. Set the OriginalContentMIC, MDNOptions, and ReceiptSignerCert to the values originally computed when the message was sent (if you are requesting async MDNs you must save this information externally.). You can then validate the asynchronous receipt by invoking VerifyReceipt.

Alternatively, AsyncMDNInfoDir may be set in place of OriginalContentMIC, MessageId, and MDNOptions (provided it was set to the same value when the message was sent). If AsyncMDNInfoDir was specified when the message was sent, the class would have saved OriginalContentMIC and MDNOptions to a file identified by the MessageId for the transmission. These properties are read from the file matching the MessageId in the MDNReceipt automatically if AsyncMDNInfoDir is specified.

Note: MDNReceipt must be populated prior to calling VerifyReceipt.

AS3Sender.MDNTo Property

The system to which an MDN should be directed.

Syntax

 getMDNTo(): string;

 setMDNTo(MDNTo: string): void;

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. You should specify a valid FTP URL for the request, e.g., "ftp://123.0.0.1".

By default, the class will request a PKCS#7 signature signed over SHA-1. You may set MDNOptions to customize this.

AS3Sender.MessageId Property

The Id of the message.

Syntax

 getMessageId(): string;

 setMessageId(messageId: string): void;

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.

AS3Sender.OriginalContentMIC Property

The Message Integrity Check(s) (one-way hash) of the outgoing message.

Syntax

 getOriginalContentMIC(): string;

 setOriginalContentMIC(originalContentMIC: string): void;

Default Value

""

Remarks

A MIC will be calculated over the outgoing message using the same algorithm in the SignatureAlgorithm configuration used to sign the message. The property will be set when Post (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. "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).

AS3Sender.Passive Property

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

Syntax

 isPassive(): boolean;

 setPassive(passive: boolean): void;

Default Value

TRUE

Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If Passive is set to TRUE, the class will use the PASV command instead of the PORT command and thus will direct the server into a passive mode: connections are initiated only by the client.

AS3Sender.Password Property

This is the password used to log in.

Syntax

 getPassword(): string;

 setPassword(password: string): void;

Default Value

""

Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

AS3Sender.ReceiptSignerCert Property

The public key certificate for the MDN receipt signature.

Syntax

 getReceiptSignerCert(): Certificate;

 setReceiptSignerCert(receiptSignerCert: Certificate): void;

Default Value

Remarks

Ordinarily, if your trading partner uses the same certificate for both signing and encryption, the certificate specified in RecipientCert is used for both encryption and verifying the receipt signature.

If your trading partner uses different certificates for signing and encryption, you must set this property to the public key for you partner's signing certificate before invoking Post.

After invoking Post or VerifyReceipt, this will contain the certificate used to sign the receipt, if the receipt is signed.

If set, this property should be a public key instance of Certificate.

AS3Sender.RecipientCerts Property

The public key certificates of the recipients for this message.

Syntax

 getRecipientCerts(): CertificateList;

 setRecipientCerts(recipientCerts: CertificateList): void;

Default Value

Remarks

The encryption certificates of the recipients. If this property is specified, the message content will be encrypted using the algorithm given by EncryptingAlgorithm.

This property will also be used to verify signed receipts if ReceiptSignerCert is not specified. In this case, it will use the first certificate found in the collection, if one exists. If your trading partner uses different certificates for signing and encryption, you should set RecipientCerts to the encryption certificate(s) and ReceiptSignerCert to the signing certificate.

If the class is unable to verify a signature make sure RecipientCerts are set appropriately.

If set, this property should could contain public key instances of Certificate.

This property is not available at design time.

AS3Sender.RemoteHost Property

This is the domain name or IP address of the FTP server.

Syntax

 getRemoteHost(): string;

 setRemoteHost(remoteHost: string): void;

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

AS3Sender.RemotePort Property

This is the port for the FTP service (default is 21).

Syntax

 getRemotePort(): number;

 setRemotePort(remotePort: number): void;

Default Value

21

Remarks

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 990 (please see the SSLStartMode property for more information).

This property is not available at design time.

AS3Sender.SignatureAlgorithm Property

Signature algorithm to be used in outgoing messages.

Syntax

 getSignatureAlgorithm(): string;

 setSignatureAlgorithm(signatureAlgorithm: string): void;

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 property is automatically updated to request the MDN receipt be signed with the same algorithm.

AS3Sender.SigningCert Property

Contains the certificate to use when signing messages.

Syntax

 getSigningCert(): Certificate;

 setSigningCert(signingCert: Certificate): void;

Default Value

Remarks

This is your signing certificate. If this property is specified, the message content will be signed using the algorithm given by SignatureAlgorithm.

If set, this property should be a private key instance of Certificate.

AS3Sender.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

 getSSLAcceptServerCert(): Certificate;

 setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

AS3Sender.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

 getSSLCert(): Certificate;

 setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

AS3Sender.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

 getSSLProvider(): As3senderSSLProviders;

 setSSLProvider(SSLProvider: As3senderSSLProviders): void;

enum As3senderSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

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 class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

Additional Notes

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

When Automatic is selected the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

AS3Sender.SSLServerCert Property

The server certificate for the last established connection.

Syntax

 getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

AS3Sender.SSLStartMode Property

Determines how the class starts the SSL negotiation. By default, SSL will not be used.

Syntax

 getSSLStartMode(): As3senderSSLStartModes;

 setSSLStartMode(SSLStartMode: As3senderSSLStartModes): void;

enum As3senderSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic - default)	If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)	The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)	The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone)	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

AS3Sender.Subject Property

The subject of the message.

Syntax

 getSubject(): string;

 setSubject(subject: string): void;

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.

AS3Sender.Timeout Property

A timeout for the class.

Syntax

 getTimeout(): number;

 setTimeout(timeout: number): void;

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 class will wait for the operation to complete before returning control.

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

If Timeout expires, and the operation is not yet complete, the class .

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

The default value for the Timeout property is 60 seconds.

AS3Sender.User Property

This property contains the user identifier to use to log in.

Syntax

 getUser(): string;

 setUser(user: string): void;

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

AS3Sender.abort Method

The method aborts the current upload or download.

Syntax

async as3sender.abort(): Promise<void>

Remarks

This method sends an ABOR command to the FTP server. It is used to interrupt file uploads and downloads.

AS3Sender.changeRemotePath Method

This method changes the current path on the FTP server.

Syntax

async as3sender.changeRemotePath(remotePath : string): Promise<void>

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

AS3Sender.config Method

Sets or retrieves a configuration setting.

Syntax

async as3sender.config(configurationString : string): Promise<string>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

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

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

AS3Sender.deleteFile Method

This method removes a file specified by FileName from an FTP server.

Syntax

async as3sender.deleteFile(fileName : string): Promise<void>

Remarks

This method is used to remove a file specified by FileName from an FTP server. The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to remote path set by ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

AS3Sender.getFileSize Method

Gets the size of a file on the FTP server.

Syntax

async as3sender.getFileSize(fileName : string): Promise<void>

Remarks

Gets the size of the file specified by FileName and RemotePath on the FTP server.

AS3Sender.getFileTime Method

Gets the last modification time of a file on the FTP server.

Syntax

async as3sender.getFileTime(fileName : string): Promise<void>

Remarks

Gets the last modification time of the file specified by FileName and RemotePath on the FTP server.

AS3Sender.listDirectory Method

List the current directory on an FTP server.

Syntax

async as3sender.listDirectory(filesToList : string): Promise<void>

Remarks

A listing is requested for the directory or file mask specified in FilesToList. This can be an absolute path on the server, a path relative to RemotePath, or a file mask. The file listing is received through the DirList event.

Similar to ListDirectoryLong, except only file names are returned. If no FTP session is in place, one is automatically created by first calling the Logon method.

AS3Sender.listDirectoryLong Method

List the current directory on an FTP server.

Syntax

async as3sender.listDirectoryLong(filesToList : string): Promise<void>

Remarks

A listing is requested for the directory or file mask specified in FilesToList. This can be an absolute path on the server, a path relative to RemotePath, or a file mask. The file listing is received through the DirList event. Extended file information is returned.

If no FTP session is in place, one is automatically created by first calling the Logon method.

AS3Sender.logoff Method

This method is used to log off from the FTP server by posting a QUIT command.

Syntax

async as3sender.logoff(): Promise<void>

Remarks

This method is used to log off from the FTP server by posting a QUIT command. If that fails, the connection is terminated by the local host.

AS3Sender.logon Method

Logon to the FTP RemoteHost using the current User and Password .

Syntax

async as3sender.logon(): Promise<void>

Remarks

Logon to the FTP server using the current User and Password. If an SSL (TLS) connection is required, you should first set SSLStartMode.

Example (Logging On)

FTPControl.RemoteHost = "ftpserver" FTPControl.User = "username" FTPControl.Password = "password" FTPControl.Logon()

AS3Sender.readReceipt Method

Reads and parses (but does not verify) an MDN receipt.

Syntax

async as3sender.readReceipt(filename : string): Promise<void>

Remarks

ReadReceipt will retrieve the file specified by Filename from the FTP server, and attempt to parse it as an MDN receipt. If the file is a valid MDN receipt, the class will determine the originator of the receipt and the MessageId of the original message. The originator of the receipt will be stored in AS3To, the intended recipient (presumably your system) will be stored in AS3From, and the original message Id will be stored in MessageId.

Pass in an empty string to skip the FTP transfer, and process the receipt specified by the MDNReceipt property instead.

You should then look up the original message and set OriginalContentMIC to the value of OriginalContentMIC originally computed when the message was sent (you will need to save this information externally). You should also set RecipientCert based on the value of AS3To if necessary. Also, set MDNOptions to the value used when making the original request.

Finally, VerifyReceipt should be used to verify the receipt.

AS3Sender.reset Method

Resets the state of the control.

Syntax

async as3sender.reset(): Promise<void>

Remarks

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

AS3Sender.send Method

Prepares and sends the AS3 message.

Syntax

async as3sender.send(filename : string): Promise<void>

Remarks

Invoking Send will prepare and send the AS3 message. It will be signed if SigningCert is set, encrypted if RecipientCert is set, and compressed if CompressionFormat is set. A receipt will be requested if MDNTo is set.

Prior to sending, you may Logon to the FTP server and navigate to the desired RemotePath. If you have not created an FTP connection already then Send will attempt to establish one.

Filename should contain the name of the file that will be written on the AS3/FTP server. You may leave Filename blank to allow the class to determine an appropriate name.

AS3Sender.sendFTPCommand Method

Sends the exact command directly to the server.

Syntax

async as3sender.sendFTPCommand(command : string): Promise<void>

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the FTPLastReply property and/or monitor the PITrail event to obtain the server's response.

AS3Sender.verifyReceipt Method

Verifies an MDN receipt.

Syntax

async as3sender.verifyReceipt(): Promise<void>

Remarks

VerifyReceipt verifies the receipt in MDNReceipt against the values of OriginalContentMIC and MessageId and the preferences specified in MDNOptions. The method operates similarly to Post: After the method finishes, the MDNReceipt, 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.

You should first invoke ReadReceipt when it is not known which message the receipt is in response to. This will allow you to determine the original MessageId and originator of the receipt before trying to verify it.

AS3Sender.ConnectionStatus Event

This event is fired to indicate changes in the connection state.

Syntax

as3sender.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

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.

AS3Sender.DirList Event

This event is fired when a directory entry is received.

Syntax

as3sender.on('DirList', listener: (e: {readonly dirEntry: string, readonly fileName: string, readonly isDir: boolean, readonly fileSize: number, readonly fileTime: string}) => void )

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called and includes extended file information when ListDirectoryLong is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectoryLong method. Except for FileName, these parameters are empty when a short "List Directory" is performed.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

AS3Sender.EndTransfer Event

This event is fired when a file finishes downloading or uploading.

Syntax

as3sender.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

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

AS3Sender.Error Event

Information about errors during data delivery.

Syntax

as3sender.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

AS3Sender.Log Event

Fired with log information while processing a message.

Syntax

as3sender.on('Log', listener: (e: {readonly logType: string, readonly logMessage: string, readonly logMessageB: Uint8Array}) => void )

Remarks

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

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

The LogMessage event parameter holds the raw log data.

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

"LOG"	Information about the status of the process.
"ERR"	An error was encountered.
"DAT"	The EDI payload.
"REQ"	The raw request
"MDN"	The MDN response.
"DEBUG"	Debug information.
"DAT.INPUT"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.ENCRYPT"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.COMPRESS"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.SIGN"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DECRYPT"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DECOMPRESS"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.VERIFY"	Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DEBUG"	Debug information when processing payload. Only applicable when LogDebug is True.

AS3Sender.PITrail Event

This event traces the commands sent to the server, and the respective replies.

Syntax

as3sender.on('PITrail', listener: (e: {readonly direction: number, readonly message: string}) => void )

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

0 (Client)	The Message originates from the client.
1 (Server)	The Message originates from the server.
2 (Info)	The Message is an informative message originating from the client software (the class code).

AS3Sender.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

as3sender.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string "OK"). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before intiating the connection.

AS3Sender.SSLStatus Event

Shows the progress of the secure connection.

Syntax

as3sender.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

AS3Sender.StartTransfer Event

This event fires when a file starts downloading or uploading.

Syntax

as3sender.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

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

AS3Sender.Transfer Event

This event is fired during the file download or upload.

Syntax

as3sender.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate string	This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.
Encoded Uint8Array	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
EncodedB byte[]	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
ExpirationDate string	This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00.
ExtendedKeyUsage string	This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint string	This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1 string	This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. 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
FingerprintSHA256 string	This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. 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
Issuer string	This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
KeyPassword string	This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys. Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .
PrivateKey string	This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The may be available but not exportable. In this case, returns an empty string.
PrivateKeyAvailable boolean	This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer string	This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey string	This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm string	This property contains 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.
PublicKeyLength number	This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber string	This is 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.
SignatureAlgorithm string	The property contains 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.
Store Uint8Array	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StoreB byte[]	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StorePassword string	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType CertStoreTypes	This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values: 0 (cstUser - default) For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. 1 (cstMachine) For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. 2 (cstPFXFile) The certificate store is the name of a PFX (PKCS12) file containing certificates. 3 (cstPFXBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. 4 (cstJKSFile) The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. 5 (cstJKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. 6 (cstPEMKeyFile) The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. 7 (cstPEMKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. 8 (cstPublicKeyFile) The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. 9 (cstPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. 10 (cstSSHPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. 11 (cstP7BFile) The certificate store is the name of a PKCS7 file containing certificates. 12 (cstP7BBlob) The certificate store is a string (binary) representing a certificate store in PKCS7 format. 13 (cstSSHPublicKeyFile) The certificate store is the name of a file that contains an SSH-style public key. 14 (cstPPKFile) The certificate store is the name of a file that contains a PPK (PuTTY Private Key). 15 (cstPPKBlob) The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). 16 (cstXMLFile) The certificate store is the name of a file that contains a certificate in XML format. 17 (cstXMLBlob) The certificate store is a string that contains a certificate in XML format. 18 (cstJWKFile) The certificate store is the name of a file that contains a JWK (JSON Web Key). 19 (cstJWKBlob) The certificate store is a string that contains a JWK (JSON Web Key). 21 (cstBCFKSFile) The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. 22 (cstBCFKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. 23 (cstPKCS11) The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); 99 (cstAuto) The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.
Subject string	This is the subject of the certificate used for client authentication. This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below. Field Meaning CN Common Name. This is commonly a host name like www.server.com. O Organization OU Organizational Unit L Locality S State C Country E Email Address If a field value contains a comma it must be quoted.
SubjectAltNames string	This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5 string	This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA1 string	This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA256 string	This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.
Usage string	This property contains the text description of . This value will be of one or more of the following strings and will be separated by commas: Digital Signatures Key Authentication Key Encryption Data Encryption Key Agreement Certificate Signing Key Signing If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags number	This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags: 0x80 Digital Signatures 0x40 Key Authentication 0x20 Key Encryption 0x10 Data Encryption 0x08 Key Agreement 0x04 Certificate Signing 0x02 Key Signing Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL.
Version string	This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

EDIAttachment Type

This describes the file being attached.

Remarks

Information about the file's location that is being attached to the message is contained here.

Fields

ContentType string	The MIME content-type of this EDIAttachment.
Data Uint8Array	This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment.
DataB byte[]	This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment.
Filename string	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 .
Headers string	The class fills out each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.
Name string	is the final name to be associated with the contents of either the or properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

Constructors

public EDIAttachment();

public EDIAttachment(String filename);

public EDIAttachment(String filename, String contentType);

public EDIAttachment(String filename, String contentType, String headers);

EDIData Type

The EDI payload of the AS2 message.

Remarks

The EDI payload of the AS2 message.

Fields

Data Uint8Array	This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and 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.
DataB byte[]	This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and 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.
EDIType string	The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".
Filename string	In a sender, if is specified, the file specified will be used for the EDI payload of the transmission. 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 is set, the data will be written to the stream and this property will not be populated.
Name string	is the final name to be associated with the contents of either the or properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload. When constructing EDI data to be sent, will be set to the same value as , but can be overridden after setting to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

Constructors

public EDIData();

public EDIData(byte[] data, String EDIType);

public EDIData(String filename, String EDIType);

Firewall Type

This is the firewall the class will connect through.

Remarks

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

Fields

AutoDetect boolean	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType FirewallTypes	This property determines the type of firewall to connect through. The applicable values are as follows: fwNone (0) No firewall (default setting). fwTunnel (1) Connect through a tunneling proxy. is set to 80. fwSOCKS4 (2) Connect through a SOCKS4 Proxy. is set to 1080. fwSOCKS5 (3) Connect through a SOCKS5 Proxy. is set to 1080. fwSOCKS4A (10) Connect through a SOCKS4A Proxy. is set to 1080.
Host string	This property contains the name or IP address of firewall (optional). If a 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 class .
Password string	This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
Port number	This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details. Note: This property is set automatically when is set to a valid value. See the description of the property for details.
User string	This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

Constructors

public Firewall();

MDNReceipt Type

The complete MDN Receipt returned by the receiver.

Remarks

The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature.

Fields

Content Uint8Array	This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.
ContentB byte[]	This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.
HeaderCount number	The number of headers in the MDN.
HeaderField string	The field name of the MDN header currently selected by .
HeaderIndex number	Which MDN header is currently selected to populate and . Valid values are 0 to - 1.
Headers string	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 , , , and to easily iterate through each individual header.
HeaderValue string	The value of the MDN header currently selected by .
MDN string	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.
Message string	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.
MICValue string	The Message Integrity Check(s) (one-way hash) of the original EDI message. An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed. The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".
SigningProtocol string	This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.

Constructors

public MDNReceipt();

public MDNReceipt(String headers, byte[] content);

Config Settings (class ipworksedi.as3sender)

The class 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 class, access to these internal properties is provided through the Config method.

AS3Sender Config Settings

CalculateProcessingPercentDone:   Whether to show the progress of file processing. When set to True the class will display the progress of file processing (encrypting and signing) through the StartTransfer, Transfer, and EndTransfer events. The default value is False.

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.

LogonAfterProcessing:   Whether to prepare the file before connecting to the FTP server. This setting controls whether the class connects to the FTP server before or after processing the file to be sent. When set to True the class will perform any signing and encrypting operations to prepare the file before connecting to the FTP server. When set to False the class will connect and then prepare the file immediately before upload. The default value is False.

FTP Config Settings

ActiveModeIP:   Allows the specification of the IP address that the server will connect to for active mode connections. The ActiveModeIP configuration setting can be used to specify the IP address that the server will connect to when using an active mode configuration (Passive = False). When this configuration setting is set, the port number where the component listens for active mode connections will still be managed by the component. The PortRange also can be used to ensure that the correct port is used by the client. Note: This configuration setting will be ignored if ActiveModePORTAddress is also specified.

ActiveModePORTAddress:   Allows the specification of the PORT address value for active mode connections. When using an active mode configuration (Passive = False) with a firewall, it may be necessary to specify the actual PORT value to be sent to the server. ActiveModePORTAddress takes the protocol-level parameter in the form "a,b,c,d,e,f" where "a,b,c,d" is the external IP address separated by commas, and e and f represent, respectively, the high-byte (divide by 256) and the low-byte (mod 256) values of the external port where the FTP client is listening. This configuration setting must be used in conjunction with PortRange to ensure that the correct port is used by the client.

AppendToLocalFile:   Append downloaded files to a local file. If set to True, the downloaded files will be appended to the file specified in LocalFile.

ApplyFileMaskLocally:   Whether to filter the directory listing locally or on the server. If set to true any filemask provided to RemoteFile will be applied locally, after the server has returned the results. When set to false (default), the value in RemoteFile will be sent to the server as part of the relevant listing command. Because using filemasks with list commands is not standardized, some servers do not support them and will return an error.

AutoSelectDataIP:   Automatically select the data connection IP. This setting controls the selection logic of the data connection. By default, this value is True and the class will attempt to determine the best IP for the data connection based on the returned value from the server. It is recommended to leave this value set to True unless there is a reason to disable it. In many cases, FTP servers are not configured to return a valid public IP in the PASV response. When Secure Sockets Layer/Transport Layer Security (SSL/TLS) is used any network address translation (NAT) done by the firewall cannot occur. The result is the client may receive an IP that is not accessible. This setting is designed to allow the connection to succeed in as many cases as possible. When the IP for the data connection is received from the server, the class will inspect the value. If the received value is not within the known private IP ranges, the class will use it, assuming it is a valid public IP. If the received value is a private IP, the class will instead assume the data connection should be established to the same IP as the command connection (true in almost all cases). When this setting is False, the class will not perform any checks on the received value. When set to False, UseRemoteHostAddressForPassive is applicable.

CalculatePercentDone:   Enables or Disables calculating the percent complete for downloads. When set to true (default), the class sends an FTP SIZE command to retrieve the file size before beginning a download. When downloading a large quantity of small files, performance may be increased by disabling this feature.

CheckTotalEntry:   Whether to ignore directory listing total lines. Some servers will include "total" information when returning a directory listing that contains non-entry data. When CheckTotalEntry is set to True (default), the component will ignore lines beginning with "total" to account for this. In some cases, it may be desirable to include these lines in the resulting DirList data; this can be done by setting this configuration setting to False.

DILinger:   When set to True, DI connections are terminated gracefully. This property controls how the DI connection is closed. The default is True. In the case that DILinger is True (default), follow two scenarios to determine how long the connection will linger. In the first scenario, if DILingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, DILingerTime is a positive value, the system will attempt to send pending data until the specified DILingerTime 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 class 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

DILingerTime:   Time in seconds to have the DI connection linger. LingerTime is the time, in seconds, to let the socket connection linger. This value is 0 by default, which means it will use the default IP timeout.

FileTimeFormat:   The format of file time reported by the server. The default value is "M/d/yyyy hh:mm:ss tt". When set, the class will format the time returned by the server when calling the QueryFileTime method. To disable all formatting, set this to empty string. Note: This setting applies only when calling QueryFileTime. It does not apply to the FileTime parameter of the DirList event.

IgnoreEntries:   Directory entry data to ignore. Sometimes the FTP server will return data in a directory listing that is not entry data and can be ignored. The IgnoreEntries configuration setting takes a comma-separated list of entries to ignore. Only the beginning of the entries need to be specified and correct case is not required.

MaskSensitive:   Masks passwords in logs. The default value is False. When set to True, the class will mask passwords that otherwise would appear in its logs.

ModeZCompressionLevel:   Used to specify the level of compression used. The default value is 7. Valid values range from 0 to 9. A higher value indicates that a higher compression level is being used. This is valid only when UseModeZ is set to True. Note: When this setting is specified the class immediately performs an action. Use the ConfigAsync method in order to avoid blocking execution.

PortRange:   Allows the specification of a port range where the class listens for active mode connections. When set to use active mode (Passive = False), the class uses any available port to listen to incoming connections from the server. You can override this behavior by setting PortRange to a value containing the range of ports the class will be listening to. The range is provided as start-end, for instance: "1024-" stands for anything higher than 1024, "1024-2048" stands for ports between 1024 and 2048 inclusive, "4000-4010, 50000-50010" stands for ports between 4000 and 4010 or between 50000 and 50010.

PreserveFileTime:   Attempts to preserve timestamps when transferring files. When set to True, the class will try to preserve timestamps when transferring files. The MDTM command is used when downloading, and the MFTM command is used when uploading. The server must support these commands for this to work and is False by default.

RealTimeUpload:   Enables real time uploading. When this value is set to True, the class will upload the data in the file specified by LocalFile and continue monitoring LocalFile for additional data to upload until no new data is found for RealTimeUploadAgeLimit seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is False.

RealTimeUploadAgeLimit:   The age limit in seconds when using RealTimeUpload. This value is only applicable when RealTimeUpload is set to "True". This specifies the number of seconds for which the class will monitor LocalFile for new data to upload. If this limit is reached and no new data are found in LocalFile the upload will complete. The default value is "1".

ReusePISSLSessionInDI:   Whether the PI SSL session will be reused for the DI connection. When set to True (default), the class will reuse the PI SSL session when creating the DI connection. When set to False, the class will create a separate SSL session for the DI connection. The default value is True.

ReuseSSLSessionInDI:   Whether the SSL session will be reused for the DI connection. When set to True (default), the class will ask the server to reuse the existing DI Secure Sockets Layer (SSL) session. When set to False, a new SSL session will always be created for the DI connection.

UseClearChannel:   Allows for the Clear Command Channel (CCC) command. When this is set, the class will send the CCC command to the server requesting a clear (unprotected) command channel.

UseClearDataChannel:   Allows for the PROT C command. When this is set, the class will use a clear (unprotected) data channel by sending the PROT C command to the server.

UseEPSV:   Allows extended passive mode. When this is set, the extended passive mode will be used.

UseMLSD:   Uses listings for machine processing. When this is set to True, the class will list files in the directory using the MLSD command. This command is an extension to the protocol that defines a more standardized and reliable directory listing format. Not all servers support this command. The default value is False. When set to True, set RemoteFile to the filemask and call either ListDirectory or ListDirectoryLong. There is no difference between the two methods when this setting is enabled.

UseMLST:   Uses single file listing for machine processing. This setting is similar to UseMLSD except that it is valid only for a single file. When this is set to True, the class will list the file or folder specified by RemoteFile. If RemoteFile is not set, a listing for the current directory will be returned. This command is an extension to the protocol, which defines a more standardized and reliable directory listing format, but does so only for a single file or folder. Not all servers support this command. The default value is False. When set to True, set RemoteFile to the file or folder you wish to get information about and call either ListDirectory or ListDirectoryLong. There is no difference between the two methods when this setting is enabled. When both UseMLSD and UseMLST are set, UseMLSD takes precedence.

UseModeZ:   Allows compression to be used when transferring data. The default value is False. When set to True, the class will issue the MODE Z command to the FTP server. This will enable deflate compression so that all data transferred are first compressed either by the server (when downloading) or by the class (when uploading). Note: Not all servers support this feature. Note: When this setting is specified the class immediately performs an action. Use the ConfigAsync method in order to avoid blocking execution.

UseOldAUTHSSL:   Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'. By default, the class uses the standard AUTH TLS command to initiate the SSL handshake with the server. This configuration setting is included for optional support of older servers that support only the AUTH SSL command. Note: Using AUTH SSL instead of AUTH TLS is strongly discouraged because of potential security vulnerabilities. If you must use this configuration setting, please do so very carefully.

UseProtWhenImplicit:   Sends the PROT P command to the server. When SSLStartMode is set to sslImplicit, setting this to True will instruct the class to send the PROT P command to the server. This explicitly tells the server that the data channel will be protected. The default value is True.

UseRemoteHostAddressForPassive:   Instructs the class to use the address specified by RemoteHost when establishing a data connection. When this setting is True, the class will use the address specified by RemoteHost when establishing a data connection for directory listings and file transfers. This setting is applicable only when AutoSelectDataIP is set to False. When this setting is False (default) and AutoSelectDataIP is also False, the class will use the IP address returned by the server when establishing a data connection. This setting is not applicable when Passive is set to False (Active mode).

VirtualHostName:   Sends the HOST command to the server. Defined in RFC 7151, the HOST command allows user-FTP processes to specify which virtual host to connect to for a server-FTP process that is handling requests for multiple virtual hosts on a single IP address. When this configuration setting is set, the HOST command is sent to the server before authenticating.

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 class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available. This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting. If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;. The FirewallPort is set automatically when FirewallType is set to a valid value. Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through. The appropriate values are as follows: 0 No firewall (default setting). 1 Connect through a tunneling proxy. FirewallPort is set to 80. 2 Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. 3 Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. 10 Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. Note: This value is not applicable in macOS.

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

Linger:   When set to True, connections are terminated gracefully. This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

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

LocalHost:   The name of the local host through which connections are initiated or accepted. The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address. In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds. This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found. MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second. This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy. This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled. If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets. Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets. When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this config is set to false.

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

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API. When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes. When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform.

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

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application. This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL. This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG). This functionality is available only when the provider is OpenSSL. By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused. If set to true, the class 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 class is the same.

SSLAcceptAnyServerCert:   Whether to trust any certificate presented by the server. This setting disables all certificate verification when set to True. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication. This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

SSLCipherStrength:   The minimum cipher strength used for bulk encryption. This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation. The enabled cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include: CALG_3DES CALG_3DES_112 CALG_AES CALG_AES_128 CALG_AES_192 CALG_AES_256 CALG_AGREEDKEY_ANY CALG_CYLINK_MEK CALG_DES CALG_DESX CALG_DH_EPHEM CALG_DH_SF CALG_DSS_SIGN CALG_ECDH CALG_ECDH_EPHEM CALG_ECDSA CALG_ECMQV CALG_HASH_REPLACE_OWF CALG_HUGHES_MD5 CALG_HMAC CALG_KEA_KEYX CALG_MAC CALG_MD2 CALG_MD4 CALG_MD5 CALG_NO_SIGN CALG_OID_INFO_CNG_ONLY CALG_OID_INFO_PARAMETERS CALG_PCT1_MASTER CALG_RC2 CALG_RC4 CALG_RC5 CALG_RSA_KEYX CALG_RSA_SIGN CALG_SCHANNEL_ENC_KEY CALG_SCHANNEL_MAC_KEY CALG_SCHANNEL_MASTER_HASH CALG_SEAL CALG_SHA CALG_SHA1 CALG_SHA_256 CALG_SHA_384 CALG_SHA_512 CALG_SKIPJACK CALG_SSL2_MASTER CALG_SSL3_MASTER CALG_SSL3_SHAMD5 CALG_TEK CALG_TLS1_MASTER CALG_TLS1PRF Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA TLS_DHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_RSA_WITH_AES_256_CBC_SHA TLS_DHE_DSS_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_DSS_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_DES_CBC_SHA TLS_DHE_RSA_WITH_DES_CBC_SHA TLS_DHE_DSS_WITH_DES_CBC_SHA TLS_RSA_WITH_RC4_128_MD5 TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols. Used to enable/disable the supported security protocols. Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values: TLS1.3 12288 (Hex 3000) TLS1.2 3072 (Hex C00) (Default) TLS1.1 768 (Hex 300) (Default) TLS1 192 (Hex C0) (Default) SSL3 48 (Hex 30) SSL2 12 (Hex 0C) SSLEnabledProtocols - TLS 1.3 Notes In the JavaScript edition the platform implementation is used when TLS 1.3 is enabled and SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported. This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension. This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event. This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event. If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes. This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength. Returns the strength of the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake represented as a single string. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm. Returns the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength. Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version. Returns the protocol version negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions: 0x00000001 Ignore time validity status of certificate. 0x00000002 Ignore time validity status of CTL. 0x00000004 Ignore non-nested certificate times. 0x00000010 Allow unknown Certificate Authority. 0x00000020 Ignore wrong certificate usage. 0x00000100 Ignore unknown certificate revocation status. 0x00000200 Ignore unknown CTL signer revocation status. 0x00000400 Ignore unknown Certificate Authority revocation status. 0x00000800 Ignore unknown Root revocation status. 0x00008000 Allow test Root certificate. 0x00004000 Trust test Root certificate. 0x80000000 Ignore non-matching CN (certificate CN not-matching server name). This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation. This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class . The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa. In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC. This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC. The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported: "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" "ffdhe_6144" "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms. This setting holds a comma separated list of allowed signature algorithms. Possible values are: "ed25519" (default) "ed448" (default) "ecdsa_secp256r1_sha256" (default) "ecdsa_secp384r1_sha384" (default) "ecdsa_secp521r1_sha512" (default) "rsa_pkcs1_sha256" (default) "rsa_pkcs1_sha384" (default) "rsa_pkcs1_sha512" (default) "rsa_pss_sha256" (default) "rsa_pss_sha384" (default) "rsa_pss_sha512" (default) The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" (default) "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default) "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" (default) "ffdhe_6144" (default) "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts. If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout. Note: This option is not valid for UDP ports.

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

InBufferSize:   The size in bytes of the incoming queue of the socket. This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket. This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

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

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

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: Product: The product the license is for. Product Key: The key the license was generated from. License Source: Where the license was found (e.g., RuntimeLicense, License File). License Type: The type of license installed (e.g., Royalty Free, Single Server). Last Valid Build: The last valid build number for which the license will work.

MaskSensitive:   Whether sensitive data is masked in log messages. In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false. This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this setting to true tells the class 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 (class ipworksedi.as3sender)

AS3Sender Errors

	901   You must specify ReceiptContent or a filename.
	903   You must specify the remote filename.
	501   Unable to verify receipt signature.
	502   Incorrect Received-Content-MIC in receipt.
	504   Bad or unsupported receipt format. Error description contains detailed message.
	601   Unsupported signature algorithm.
	602   Warning: Error description contains detailed message.

FTP Errors

	118   Firewall error. The error description contains detailed information.
	141   FTP error. The error message contains the server reply.
	142   Communication error. The error message contains the description.
	143   Busy executing current method.
	144   Local file error. The error description contains detailed information.
	145   Can't open LocalFile for reading.
	146   No RemoteFile specified while uploading.
	147   Data interface error. The error description contains detailed information.
	148   LocalFile already exists and overwrite is False.
	149   Windows message queue dropped a message (typically due to heavy load).
	301   Operation is interrupted.
	302   Can't open local file.
	311   Accept failed for data connection.
	312   Asynchronous select failed for data connection.

TCPClient Errors

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

TCP/IP Errors

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

SMIME Errors

	10191   Invalid index (RecipientIndex).
	10192   Message decoding error (code).
	10193   Unexpected message type.
	10194   Unsupported hashing/signing algorithm.
	10195   The message does not have any signers.
	10196   The message signature could not be verified.
	10197   Could not locate a suitable decryption certificate.
	10198   The signer certificate could not be found.
	10199   No signing certificate was supplied for signing the message.
	10201   The specified certificate was not the one required.
	10202   The specified certificate could not be found.
	10221   Could not acquire CSP.
	10222   Type validation error.
	10223   Unsupported key size.
	10224   Unrecognized Content-Type object identifier.
	10225   Unrecognized public key format.
	10226   No choices specified.
	10228   Must specify output stream.
	10280   Invalid part index.
	10281   Unknown MIME type.
	10283   No MIME-boundary found.
	10280   Error decoding certificate.