AS3Sender Component

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, EDIData, and EDIType. 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

AS3From Property (AS3Sender Component)

The identity of the sending system.

Syntax

func (obj *AS3Sender) AS3From() (string, error)
func (obj *AS3Sender) SetAS3From(value string) error

Default Value

""

Remarks

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

Required.

Data Type

string

AS3To Property (AS3Sender Component)

The identity of the receiving system.

Syntax

func (obj *AS3Sender) AS3To() (string, error)
func (obj *AS3Sender) SetAS3To(value string) error

Default Value

""

Remarks

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

Required.

Data Type

string

AS3Version Property (AS3Sender Component)

The version of AS3 being used.

Syntax

func (obj *AS3Sender) AS3Version() (string, error)
func (obj *AS3Sender) SetAS3Version(value string) error

Default Value

"1.0"

Remarks

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

Data Type

string

AttachmentCount Property (AS3Sender Component)

The number of records in the Attachment arrays.

Syntax

func (obj *AS3Sender) AttachmentCount() (int32, error)
func (obj *AS3Sender) SetAttachmentCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFileName
• AttachmentHeaders
• AttachmentName

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

Data Type

int32

AttachmentContentType Property (AS3Sender Component)

The MIME content-type of this ediattachment .

Syntax

func (obj *AS3Sender) AttachmentContentType(AttachmentIndex int32) (string, error)
func (obj *AS3Sender) SetAttachmentContentType(AttachmentIndex int32, value string) error

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

string

AttachmentData Property (AS3Sender Component)

This property contains the attachment data.

Syntax

func (obj *AS3Sender) AttachmentData(AttachmentIndex int32) ([]byte, error)
func (obj *AS3Sender) SetAttachmentData(AttachmentIndex int32, value []byte) error

Default Value

""

Remarks

This property contains the attachment data.

In a receiver, the component decodes the attachment to the AttachmentData property when AttachmentData's value is first queried. This property will contain the full decrypted text of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

[]byte

AttachmentFileName Property (AS3Sender Component)

The file name of the attachment.

Syntax

func (obj *AS3Sender) AttachmentFileName(AttachmentIndex int32) (string, error)
func (obj *AS3Sender) SetAttachmentFileName(AttachmentIndex int32, value string) error

Default Value

""

Remarks

The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the AttachmentHeaders.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

string

AttachmentHeaders Property (AS3Sender Component)

The class fills out Headers each time any of the other properties for that ediattachment are changed.

Syntax

func (obj *AS3Sender) AttachmentHeaders(AttachmentIndex int32) (string, error)
func (obj *AS3Sender) SetAttachmentHeaders(AttachmentIndex int32, value string) error

Default Value

""

Remarks

The component fills out AttachmentHeaders each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other properties for that EDIAttachment are set.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

string

AttachmentName Property (AS3Sender Component)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

func (obj *AS3Sender) AttachmentName(AttachmentIndex int32) (string, error)
func (obj *AS3Sender) SetAttachmentName(AttachmentIndex int32, value string) error

Default Value

""

Remarks

AttachmentName is the final name to be associated with the contents of either the AttachmentData or AttachmentFileName properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

string

CompressionFormat Property (AS3Sender Component)

The compression format (if any) to use.

Syntax

func (obj *AS3Sender) CompressionFormat() (int32, error)
func (obj *AS3Sender) SetCompressionFormat(value int32) error

Possible Values

0   // None
1   // ZLIB

Default Value

0

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the component to compress the outgoing data using the indicated format.

Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required.

The compression algorithm used is Zlib, as required by RFC 3274 and defined in RFCs 1950 and 1951.

Data Type

int32

Connected Property (AS3Sender Component)

Whether the class is connected.

Syntax

func (obj *AS3Sender) Connected() (bool, error)

Default Value

false

Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only.

Data Type

bool

EDIData Property (AS3Sender Component)

This property contains the EDI payload of the transmission.

Syntax

func (obj *AS3Sender) EDIData() ([]byte, error)
func (obj *AS3Sender) SetEDIData(value []byte) error

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.

Data Type

[]byte

EDIType Property (AS3Sender Component)

The Content-Type of the EDI message.

Syntax

func (obj *AS3Sender) EDIType() (string, error)
func (obj *AS3Sender) SetEDIType(value string) error

Default Value

""

Remarks

The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".

Data Type

string

EDIName Property (AS3Sender Component)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

func (obj *AS3Sender) EDIName() (string, error)
func (obj *AS3Sender) SetEDIName(value string) error

Default Value

"rfc1767.edi"

Remarks

EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

Data Type

string

EDIFileName Property (AS3Sender Component)

In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

func (obj *AS3Sender) EDIFileName() (string, error)
func (obj *AS3Sender) SetEDIFileName(value string) error

Default Value

""

Remarks

In a sender, if EDIFileName is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.

In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.

Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.

Data Type

string

EncryptionAlgorithm Property (AS3Sender Component)

The algorithm used to encrypt the EDI data.

Syntax

func (obj *AS3Sender) EncryptionAlgorithm() (string, error)
func (obj *AS3Sender) SetEncryptionAlgorithm(value string) error

Default Value

"AESCBC256"

Remarks

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

The component supports "AESCBC256", or industry-standard 256-bit AES-CBC encryption, by default.

The component supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability.

Possible values are:

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

Data Type

string

FirewallAutoDetect Property (AS3Sender Component)

Whether to automatically detect and use firewall system settings, if available.

Syntax

func (obj *AS3Sender) FirewallAutoDetect() (bool, error)
func (obj *AS3Sender) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

FirewallType Property (AS3Sender Component)

The type of firewall to connect through.

Syntax

func (obj *AS3Sender) FirewallType() (int32, error)
func (obj *AS3Sender) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

int32

FirewallHost Property (AS3Sender Component)

The name or IP address of the firewall (optional).

Syntax

func (obj *AS3Sender) FirewallHost() (string, error)
func (obj *AS3Sender) SetFirewallHost(value string) error

Default Value

""

Remarks

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

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

Data Type

string

FirewallPassword Property (AS3Sender Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

func (obj *AS3Sender) FirewallPassword() (string, error)
func (obj *AS3Sender) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component fails with an error.

Data Type

string

FirewallPort Property (AS3Sender Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

func (obj *AS3Sender) FirewallPort() (int32, error)
func (obj *AS3Sender) SetFirewallPort(value int32) error

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

int32

FirewallUser Property (AS3Sender Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

func (obj *AS3Sender) FirewallUser() (string, error)
func (obj *AS3Sender) SetFirewallUser(value string) error

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component fails with an error.

Data Type

string

FTPLastReply Property (AS3Sender Component)

The last reply from the FTP server.

Syntax

func (obj *AS3Sender) FTPLastReply() (string, error)

Default Value

""

Remarks

The last reply from the FTP server.

This property is read-only.

Data Type

string

LocalHost Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) LocalHost() (string, error)
func (obj *AS3Sender) SetLocalHost(value string) error

Default Value

""

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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

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

Data Type

string

LogDirectory Property (AS3Sender Component)

The path to a directory for logging.

Syntax

func (obj *AS3Sender) LogDirectory() (string, error)
func (obj *AS3Sender) SetLogDirectory(value string) error

Default Value

""

Remarks

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

The component 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 component 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 component. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".

If logs cannot be written an exception will be thrown.

Data Type

string

LogFile Property (AS3Sender Component)

The log file written.

Syntax

func (obj *AS3Sender) LogFile() (string, error)

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.

Data Type

string

MDNOptions Property (AS3Sender Component)

Used to indicate the options requested for the MDN receipt.

Syntax

func (obj *AS3Sender) MDNOptions() (string, error)
func (obj *AS3Sender) SetMDNOptions(value string) error

Default Value

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

Remarks

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

When AS2Version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed in the requested MIC algorithms. SHA-256, SHA-384, or SHA-512 are recommended instead.

Data Type

string

MDNReceiptContent Property (AS3Sender Component)

This contains the entire content of the MDN Receipt.

Syntax

func (obj *AS3Sender) MDNReceiptContent() ([]byte, error)
func (obj *AS3Sender) SetMDNReceiptContent(value []byte) error

Default Value

""

Remarks

This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable MDNReceiptMDN (Message Disposition Notification) and a human readable MDNReceiptMessage, which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

Data Type

[]byte

MDNReceiptHeaderCount Property (AS3Sender Component)

The number of headers in the MDN.

Syntax

func (obj *AS3Sender) MDNReceiptHeaderCount() (int32, error)

Default Value

0

Remarks

The number of headers in the MDN.

This property is read-only.

Data Type

int32

MDNReceiptHeaderField Property (AS3Sender Component)

The property name of the MDN header currently selected by HeaderIndex .

Syntax

func (obj *AS3Sender) MDNReceiptHeaderField() (string, error)

Default Value

""

Remarks

The field name of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only.

Data Type

string

MDNReceiptHeaderIndex Property (AS3Sender Component)

Which MDN header is currently selected to populate HeaderField and HeaderValue .

Syntax

func (obj *AS3Sender) MDNReceiptHeaderIndex() (int32, error)
func (obj *AS3Sender) SetMDNReceiptHeaderIndex(value int32) error

Default Value

0

Remarks

Which MDN header is currently selected to populate MDNReceiptHeaderField and MDNReceiptHeaderValue.

Valid values are 0 to MDNReceiptHeaderCount - 1.

Data Type

int32

MDNReceiptHeaders Property (AS3Sender Component)

Headers contains all of the headers of the AS2 MDN Receipt as a single string.

Syntax

func (obj *AS3Sender) MDNReceiptHeaders() (string, error)
func (obj *AS3Sender) SetMDNReceiptHeaders(value string) error

Default Value

""

Remarks

Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).

You can also use MDNReceiptHeaderCount, MDNReceiptHeaderIndex, MDNReceiptHeaderField, and MDNReceiptHeaderValue to easily iterate through each individual header.

Data Type

string

MDNReceiptHeaderValue Property (AS3Sender Component)

The value of the MDN header currently selected by HeaderIndex .

Syntax

func (obj *AS3Sender) MDNReceiptHeaderValue() (string, error)

Default Value

""

Remarks

The value of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only.

Data Type

string

MDNReceiptMDN Property (AS3Sender Component)

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.

Syntax

func (obj *AS3Sender) MDNReceiptMDN() (string, error)

Default Value

""

Remarks

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.

This property is read-only.

Data Type

string

MDNReceiptMessage Property (AS3Sender Component)

The human-readable portion of the MDN receipt.

Syntax

func (obj *AS3Sender) MDNReceiptMessage() (string, error)

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.

This property is read-only.

Data Type

string

MDNReceiptMICValue Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) MDNReceiptMICValue() (string, error)

Default Value

""

Remarks

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

An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., w7AguNJEmhF/qIjJw6LnnA==, md5.

This property is read-only.

Data Type

string

MDNReceiptSigningProtocol Property (AS3Sender Component)

This property contains the MIME type of the signature used, if any (i.

Syntax

func (obj *AS3Sender) MDNReceiptSigningProtocol() (string, error)

Default Value

""

Remarks

This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.

This property is read-only.

Data Type

string

MDNTo Property (AS3Sender Component)

The system to which an MDN should be directed.

Syntax

func (obj *AS3Sender) MDNTo() (string, error)
func (obj *AS3Sender) SetMDNTo(value string) error

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 component will request a PKCS#7 signature signed over SHA-1. You may set MDNOptions to customize this.

Data Type

string

MessageId Property (AS3Sender Component)

The Id of the message.

Syntax

func (obj *AS3Sender) MessageId() (string, error)
func (obj *AS3Sender) SetMessageId(value string) error

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.

Data Type

string

OriginalContentMIC Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) OriginalContentMIC() (string, error)
func (obj *AS3Sender) SetOriginalContentMIC(value string) error

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

Data Type

string

Passive Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) Passive() (bool, error)
func (obj *AS3Sender) SetPassive(value bool) error

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 component expects them to be. If Passive is set to TRUE, the component 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.

Data Type

bool

Password Property (AS3Sender Component)

This is the password used to log in.

Syntax

func (obj *AS3Sender) Password() (string, error)
func (obj *AS3Sender) SetPassword(value string) error

Default Value

""

Remarks

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

Data Type

string

ReceiptSignerCertEffectiveDate Property (AS3Sender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *AS3Sender) ReceiptSignerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

ReceiptSignerCertExpirationDate Property (AS3Sender Component)

The date on which the certificate expires.

Syntax

func (obj *AS3Sender) ReceiptSignerCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

ReceiptSignerCertExtendedKeyUsage Property (AS3Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *AS3Sender) ReceiptSignerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

ReceiptSignerCertFingerprint Property (AS3Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

ReceiptSignerCertFingerprintSHA1 Property (AS3Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

ReceiptSignerCertFingerprintSHA256 Property (AS3Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

ReceiptSignerCertIssuer Property (AS3Sender Component)

The issuer of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

ReceiptSignerCertPrivateKey Property (AS3Sender Component)

The private key of the certificate (if available).

Syntax

func (obj *AS3Sender) ReceiptSignerCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ReceiptSignerCertPrivateKey may be available but not exportable. In this case, ReceiptSignerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

ReceiptSignerCertPrivateKeyAvailable Property (AS3Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a ReceiptSignerCertPrivateKey is available for the selected certificate. If ReceiptSignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ReceiptSignerCertPrivateKeyContainer Property (AS3Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *AS3Sender) ReceiptSignerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the ReceiptSignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

ReceiptSignerCertPublicKey Property (AS3Sender Component)

The public key of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

ReceiptSignerCertPublicKeyAlgorithm Property (AS3Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *AS3Sender) ReceiptSignerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

ReceiptSignerCertPublicKeyLength Property (AS3Sender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *AS3Sender) ReceiptSignerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

ReceiptSignerCertSerialNumber Property (AS3Sender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *AS3Sender) ReceiptSignerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

ReceiptSignerCertSignatureAlgorithm Property (AS3Sender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *AS3Sender) ReceiptSignerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

ReceiptSignerCertStore Property (AS3Sender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertStore() ([]byte, error)
func (obj *AS3Sender) SetReceiptSignerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ReceiptSignerCertStoreType property denotes the type of the certificate store specified by ReceiptSignerCertStore. If the store is password-protected, specify the password in ReceiptSignerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

ReceiptSignerCertStorePassword Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) ReceiptSignerCertStorePassword() (string, error)
func (obj *AS3Sender) SetReceiptSignerCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

ReceiptSignerCertStoreType Property (AS3Sender Component)

The type of certificate store for this certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertStoreType() (int32, error)
func (obj *AS3Sender) SetReceiptSignerCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

ReceiptSignerCertSubjectAltNames Property (AS3Sender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

ReceiptSignerCertThumbprintMD5 Property (AS3Sender Component)

The MD5 hash of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

ReceiptSignerCertThumbprintSHA1 Property (AS3Sender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

ReceiptSignerCertThumbprintSHA256 Property (AS3Sender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

ReceiptSignerCertUsage Property (AS3Sender Component)

The text description of UsageFlags .

Syntax

func (obj *AS3Sender) ReceiptSignerCertUsage() (string, error)

Default Value

""

Remarks

The text description of ReceiptSignerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

ReceiptSignerCertUsageFlags Property (AS3Sender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *AS3Sender) ReceiptSignerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ReceiptSignerCertUsageFlags is a combination of the following flags:

Please see the ReceiptSignerCertUsage property for a text representation of ReceiptSignerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

ReceiptSignerCertVersion Property (AS3Sender Component)

The certificate's version number.

Syntax

func (obj *AS3Sender) ReceiptSignerCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

ReceiptSignerCertSubject Property (AS3Sender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *AS3Sender) ReceiptSignerCertSubject() (string, error)
func (obj *AS3Sender) SetReceiptSignerCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

Data Type

string

ReceiptSignerCertEncoded Property (AS3Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *AS3Sender) ReceiptSignerCertEncoded() ([]byte, error)
func (obj *AS3Sender) SetReceiptSignerCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ReceiptSignerCertStore and ReceiptSignerCertSubject properties also may be used to specify a certificate.

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

Data Type

[]byte

RecipientCertCount Property (AS3Sender Component)

The number of records in the RecipientCert arrays.

Syntax

func (obj *AS3Sender) RecipientCertCount() (int32, error)
func (obj *AS3Sender) SetRecipientCertCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEffectiveDate
• RecipientCertEncoded
• RecipientCertExpirationDate
• RecipientCertExtendedKeyUsage
• RecipientCertFingerprint
• RecipientCertFingerprintSHA1
• RecipientCertFingerprintSHA256
• RecipientCertIssuer
• RecipientCertPrivateKey
• RecipientCertPrivateKeyAvailable
• RecipientCertPrivateKeyContainer
• RecipientCertPublicKey
• RecipientCertPublicKeyAlgorithm
• RecipientCertPublicKeyLength
• RecipientCertSerialNumber
• RecipientCertSignatureAlgorithm
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject
• RecipientCertSubjectAltNames
• RecipientCertThumbprintMD5
• RecipientCertThumbprintSHA1
• RecipientCertThumbprintSHA256
• RecipientCertUsage
• RecipientCertUsageFlags
• RecipientCertVersion

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

Data Type

int32

RecipientCertEffectiveDate Property (AS3Sender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *AS3Sender) RecipientCertEffectiveDate(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

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

This property is read-only.

Data Type

string

RecipientCertExpirationDate Property (AS3Sender Component)

The date on which the certificate expires.

Syntax

func (obj *AS3Sender) RecipientCertExpirationDate(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

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

This property is read-only.

Data Type

string

RecipientCertExtendedKeyUsage Property (AS3Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *AS3Sender) RecipientCertExtendedKeyUsage(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

This property is read-only.

Data Type

string

RecipientCertFingerprint Property (AS3Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertFingerprint(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

This property is read-only.

Data Type

string

RecipientCertFingerprintSHA1 Property (AS3Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertFingerprintSHA1(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

This property is read-only.

Data Type

string

RecipientCertFingerprintSHA256 Property (AS3Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertFingerprintSHA256(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

This property is read-only.

Data Type

string

RecipientCertIssuer Property (AS3Sender Component)

The issuer of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertIssuer(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

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

This property is read-only.

Data Type

string

RecipientCertPrivateKey Property (AS3Sender Component)

The private key of the certificate (if available).

Syntax

func (obj *AS3Sender) RecipientCertPrivateKey(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The RecipientCertPrivateKey may be available but not exportable. In this case, RecipientCertPrivateKey returns an empty string.

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

This property is read-only.

Data Type

string

RecipientCertPrivateKeyAvailable Property (AS3Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *AS3Sender) RecipientCertPrivateKeyAvailable(RecipientCertIndex int32) (bool, error)

Default Value

false

Remarks

Whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

This property is read-only.

Data Type

bool

RecipientCertPrivateKeyContainer Property (AS3Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *AS3Sender) RecipientCertPrivateKeyContainer(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The name of the RecipientCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

This property is read-only.

Data Type

string

RecipientCertPublicKey Property (AS3Sender Component)

The public key of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertPublicKey(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

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

This property is read-only.

Data Type

string

RecipientCertPublicKeyAlgorithm Property (AS3Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *AS3Sender) RecipientCertPublicKeyAlgorithm(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

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

This property is read-only.

Data Type

string

RecipientCertPublicKeyLength Property (AS3Sender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *AS3Sender) RecipientCertPublicKeyLength(RecipientCertIndex int32) (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

This property is read-only.

Data Type

int32

RecipientCertSerialNumber Property (AS3Sender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *AS3Sender) RecipientCertSerialNumber(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

This property is read-only.

Data Type

string

RecipientCertSignatureAlgorithm Property (AS3Sender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *AS3Sender) RecipientCertSignatureAlgorithm(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

This property is read-only.

Data Type

string

RecipientCertStore Property (AS3Sender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *AS3Sender) RecipientCertStore(RecipientCertIndex int32) ([]byte, error)
func (obj *AS3Sender) SetRecipientCertStore(RecipientCertIndex int32, value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password-protected, specify the password in RecipientCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

Data Type

[]byte

RecipientCertStorePassword Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) RecipientCertStorePassword(RecipientCertIndex int32) (string, error)
func (obj *AS3Sender) SetRecipientCertStorePassword(RecipientCertIndex int32, value string) error

Default Value

""

Remarks

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

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

Data Type

string

RecipientCertStoreType Property (AS3Sender Component)

The type of certificate store for this certificate.

Syntax

func (obj *AS3Sender) RecipientCertStoreType(RecipientCertIndex int32) (int32, error)
func (obj *AS3Sender) SetRecipientCertStoreType(RecipientCertIndex int32, value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

Data Type

int32

RecipientCertSubjectAltNames Property (AS3Sender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *AS3Sender) RecipientCertSubjectAltNames(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

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

This property is read-only.

Data Type

string

RecipientCertThumbprintMD5 Property (AS3Sender Component)

The MD5 hash of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertThumbprintMD5(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

This property is read-only.

Data Type

string

RecipientCertThumbprintSHA1 Property (AS3Sender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertThumbprintSHA1(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

This property is read-only.

Data Type

string

RecipientCertThumbprintSHA256 Property (AS3Sender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *AS3Sender) RecipientCertThumbprintSHA256(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

This property is read-only.

Data Type

string

RecipientCertUsage Property (AS3Sender Component)

The text description of UsageFlags .

Syntax

func (obj *AS3Sender) RecipientCertUsage(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The text description of RecipientCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

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

This property is read-only.

Data Type

string

RecipientCertUsageFlags Property (AS3Sender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *AS3Sender) RecipientCertUsageFlags(RecipientCertIndex int32) (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of RecipientCertUsageFlags is a combination of the following flags:

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

This property is read-only.

Data Type

int32

RecipientCertVersion Property (AS3Sender Component)

The certificate's version number.

Syntax

func (obj *AS3Sender) RecipientCertVersion(RecipientCertIndex int32) (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

This property is read-only.

Data Type

string

RecipientCertSubject Property (AS3Sender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *AS3Sender) RecipientCertSubject(RecipientCertIndex int32) (string, error)
func (obj *AS3Sender) SetRecipientCertSubject(RecipientCertIndex int32, value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

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

Data Type

string

RecipientCertEncoded Property (AS3Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *AS3Sender) RecipientCertEncoded(RecipientCertIndex int32) ([]byte, error)
func (obj *AS3Sender) SetRecipientCertEncoded(RecipientCertIndex int32, value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

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

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

Data Type

[]byte

RemoteHost Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) RemoteHost() (string, error)
func (obj *AS3Sender) SetRemoteHost(value string) error

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

Data Type

string

RemotePort Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) RemotePort() (int32, error)
func (obj *AS3Sender) SetRemotePort(value int32) error

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

Data Type

int32

SignatureAlgorithm Property (AS3Sender Component)

Signature algorithm to be used in outgoing messages.

Syntax

func (obj *AS3Sender) SignatureAlgorithm() (string, error)
func (obj *AS3Sender) SetSignatureAlgorithm(value string) error

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.

When AS2Version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed for generated messages. "sha-256", "sha-384", or "sha-512" are recommended instead.

Data Type

string

SigningCertEffectiveDate Property (AS3Sender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *AS3Sender) SigningCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SigningCertExpirationDate Property (AS3Sender Component)

The date on which the certificate expires.

Syntax

func (obj *AS3Sender) SigningCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SigningCertExtendedKeyUsage Property (AS3Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *AS3Sender) SigningCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SigningCertFingerprint Property (AS3Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SigningCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SigningCertFingerprintSHA1 Property (AS3Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SigningCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SigningCertFingerprintSHA256 Property (AS3Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SigningCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SigningCertIssuer Property (AS3Sender Component)

The issuer of the certificate.

Syntax

func (obj *AS3Sender) SigningCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SigningCertPrivateKey Property (AS3Sender Component)

The private key of the certificate (if available).

Syntax

func (obj *AS3Sender) SigningCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SigningCertPrivateKey may be available but not exportable. In this case, SigningCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SigningCertPrivateKeyAvailable Property (AS3Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *AS3Sender) SigningCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SigningCertPrivateKey is available for the selected certificate. If SigningCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SigningCertPrivateKeyContainer Property (AS3Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *AS3Sender) SigningCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SigningCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SigningCertPublicKey Property (AS3Sender Component)

The public key of the certificate.

Syntax

func (obj *AS3Sender) SigningCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SigningCertPublicKeyAlgorithm Property (AS3Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *AS3Sender) SigningCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SigningCertPublicKeyLength Property (AS3Sender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *AS3Sender) SigningCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SigningCertSerialNumber Property (AS3Sender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *AS3Sender) SigningCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SigningCertSignatureAlgorithm Property (AS3Sender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *AS3Sender) SigningCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SigningCertStore Property (AS3Sender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *AS3Sender) SigningCertStore() ([]byte, error)
func (obj *AS3Sender) SetSigningCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password-protected, specify the password in SigningCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SigningCertStorePassword Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) SigningCertStorePassword() (string, error)
func (obj *AS3Sender) SetSigningCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SigningCertStoreType Property (AS3Sender Component)

The type of certificate store for this certificate.

Syntax

func (obj *AS3Sender) SigningCertStoreType() (int32, error)
func (obj *AS3Sender) SetSigningCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

SigningCertSubjectAltNames Property (AS3Sender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *AS3Sender) SigningCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SigningCertThumbprintMD5 Property (AS3Sender Component)

The MD5 hash of the certificate.

Syntax

func (obj *AS3Sender) SigningCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SigningCertThumbprintSHA1 Property (AS3Sender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *AS3Sender) SigningCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SigningCertThumbprintSHA256 Property (AS3Sender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *AS3Sender) SigningCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SigningCertUsage Property (AS3Sender Component)

The text description of UsageFlags .

Syntax

func (obj *AS3Sender) SigningCertUsage() (string, error)

Default Value

""

Remarks

The text description of SigningCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SigningCertUsageFlags Property (AS3Sender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *AS3Sender) SigningCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SigningCertUsageFlags is a combination of the following flags:

Please see the SigningCertUsage property for a text representation of SigningCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SigningCertVersion Property (AS3Sender Component)

The certificate's version number.

Syntax

func (obj *AS3Sender) SigningCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SigningCertSubject Property (AS3Sender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *AS3Sender) SigningCertSubject() (string, error)
func (obj *AS3Sender) SetSigningCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

Data Type

string

SigningCertEncoded Property (AS3Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *AS3Sender) SigningCertEncoded() ([]byte, error)
func (obj *AS3Sender) SetSigningCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

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

Data Type

[]byte

SSLAcceptServerCertEffectiveDate Property (AS3Sender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLAcceptServerCertExpirationDate Property (AS3Sender Component)

The date on which the certificate expires.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSLAcceptServerCertExtendedKeyUsage Property (AS3Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprint Property (AS3Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprintSHA1 Property (AS3Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprintSHA256 Property (AS3Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLAcceptServerCertIssuer Property (AS3Sender Component)

The issuer of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKey Property (AS3Sender Component)

The private key of the certificate (if available).

Syntax

func (obj *AS3Sender) SSLAcceptServerCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKeyAvailable Property (AS3Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSLAcceptServerCertPrivateKeyContainer Property (AS3Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *AS3Sender) SSLAcceptServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKey Property (AS3Sender Component)

The public key of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKeyAlgorithm Property (AS3Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKeyLength Property (AS3Sender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *AS3Sender) SSLAcceptServerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSLAcceptServerCertSerialNumber Property (AS3Sender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLAcceptServerCertSignatureAlgorithm Property (AS3Sender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLAcceptServerCertStore Property (AS3Sender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertStore() ([]byte, error)
func (obj *AS3Sender) SetSSLAcceptServerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSLAcceptServerCertStorePassword Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) SSLAcceptServerCertStorePassword() (string, error)
func (obj *AS3Sender) SetSSLAcceptServerCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SSLAcceptServerCertStoreType Property (AS3Sender Component)

The type of certificate store for this certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertStoreType() (int32, error)
func (obj *AS3Sender) SetSSLAcceptServerCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

SSLAcceptServerCertSubjectAltNames Property (AS3Sender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintMD5 Property (AS3Sender Component)

The MD5 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintSHA1 Property (AS3Sender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintSHA256 Property (AS3Sender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertUsage Property (AS3Sender Component)

The text description of UsageFlags .

Syntax

func (obj *AS3Sender) SSLAcceptServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSLAcceptServerCertUsageFlags Property (AS3Sender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSLAcceptServerCertVersion Property (AS3Sender Component)

The certificate's version number.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSLAcceptServerCertSubject Property (AS3Sender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *AS3Sender) SSLAcceptServerCertSubject() (string, error)
func (obj *AS3Sender) SetSSLAcceptServerCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

Data Type

string

SSLAcceptServerCertEncoded Property (AS3Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *AS3Sender) SSLAcceptServerCertEncoded() ([]byte, error)
func (obj *AS3Sender) SetSSLAcceptServerCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

Data Type

[]byte

SSLCertEffectiveDate Property (AS3Sender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *AS3Sender) SSLCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLCertExpirationDate Property (AS3Sender Component)

The date on which the certificate expires.

Syntax

func (obj *AS3Sender) SSLCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSLCertExtendedKeyUsage Property (AS3Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *AS3Sender) SSLCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSLCertFingerprint Property (AS3Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLCertFingerprintSHA1 Property (AS3Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLCertFingerprintSHA256 Property (AS3Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLCertIssuer Property (AS3Sender Component)

The issuer of the certificate.

Syntax

func (obj *AS3Sender) SSLCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSLCertPrivateKey Property (AS3Sender Component)

The private key of the certificate (if available).

Syntax

func (obj *AS3Sender) SSLCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSLCertPrivateKeyAvailable Property (AS3Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *AS3Sender) SSLCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSLCertPrivateKeyContainer Property (AS3Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *AS3Sender) SSLCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSLCertPublicKey Property (AS3Sender Component)

The public key of the certificate.

Syntax

func (obj *AS3Sender) SSLCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSLCertPublicKeyAlgorithm Property (AS3Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *AS3Sender) SSLCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLCertPublicKeyLength Property (AS3Sender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *AS3Sender) SSLCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSLCertSerialNumber Property (AS3Sender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *AS3Sender) SSLCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLCertSignatureAlgorithm Property (AS3Sender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *AS3Sender) SSLCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLCertStore Property (AS3Sender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *AS3Sender) SSLCertStore() ([]byte, error)
func (obj *AS3Sender) SetSSLCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSLCertStorePassword Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) SSLCertStorePassword() (string, error)
func (obj *AS3Sender) SetSSLCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SSLCertStoreType Property (AS3Sender Component)

The type of certificate store for this certificate.

Syntax

func (obj *AS3Sender) SSLCertStoreType() (int32, error)
func (obj *AS3Sender) SetSSLCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

SSLCertSubjectAltNames Property (AS3Sender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *AS3Sender) SSLCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSLCertThumbprintMD5 Property (AS3Sender Component)

The MD5 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertThumbprintSHA1 Property (AS3Sender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertThumbprintSHA256 Property (AS3Sender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertUsage Property (AS3Sender Component)

The text description of UsageFlags .

Syntax

func (obj *AS3Sender) SSLCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSLCertUsageFlags Property (AS3Sender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *AS3Sender) SSLCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSLCertVersion Property (AS3Sender Component)

The certificate's version number.

Syntax

func (obj *AS3Sender) SSLCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSLCertSubject Property (AS3Sender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *AS3Sender) SSLCertSubject() (string, error)
func (obj *AS3Sender) SetSSLCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

Data Type

string

SSLCertEncoded Property (AS3Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *AS3Sender) SSLCertEncoded() ([]byte, error)
func (obj *AS3Sender) SetSSLCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

Data Type

[]byte

SSLProvider Property (AS3Sender Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

func (obj *AS3Sender) SSLProvider() (int32, error)
func (obj *AS3Sender) SetSSLProvider(value int32) error

Possible Values

0   // Automatic
1   // Platform
2   // Internal

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

Possible values are as follows:

Additional Notes

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

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

int32

SSLServerCertEffectiveDate Property (AS3Sender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *AS3Sender) SSLServerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLServerCertExpirationDate Property (AS3Sender Component)

The date on which the certificate expires.

Syntax

func (obj *AS3Sender) SSLServerCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSLServerCertExtendedKeyUsage Property (AS3Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *AS3Sender) SSLServerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSLServerCertFingerprint Property (AS3Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLServerCertFingerprintSHA1 Property (AS3Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLServerCertFingerprintSHA256 Property (AS3Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLServerCertIssuer Property (AS3Sender Component)

The issuer of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSLServerCertPrivateKey Property (AS3Sender Component)

The private key of the certificate (if available).

Syntax

func (obj *AS3Sender) SSLServerCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSLServerCertPrivateKeyAvailable Property (AS3Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *AS3Sender) SSLServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSLServerCertPrivateKeyContainer Property (AS3Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *AS3Sender) SSLServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSLServerCertPublicKey Property (AS3Sender Component)

The public key of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSLServerCertPublicKeyAlgorithm Property (AS3Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *AS3Sender) SSLServerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLServerCertPublicKeyLength Property (AS3Sender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *AS3Sender) SSLServerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSLServerCertSerialNumber Property (AS3Sender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *AS3Sender) SSLServerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLServerCertSignatureAlgorithm Property (AS3Sender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *AS3Sender) SSLServerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLServerCertStore Property (AS3Sender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *AS3Sender) SSLServerCertStore() ([]byte, error)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

[]byte

SSLServerCertStorePassword Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) SSLServerCertStorePassword() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertStoreType Property (AS3Sender Component)

The type of certificate store for this certificate.

Syntax

func (obj *AS3Sender) SSLServerCertStoreType() (int32, error)

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

int32

SSLServerCertSubjectAltNames Property (AS3Sender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSLServerCertThumbprintMD5 Property (AS3Sender Component)

The MD5 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertThumbprintSHA1 Property (AS3Sender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertThumbprintSHA256 Property (AS3Sender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertUsage Property (AS3Sender Component)

The text description of UsageFlags .

Syntax

func (obj *AS3Sender) SSLServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSLServerCertUsageFlags Property (AS3Sender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *AS3Sender) SSLServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSLServerCertVersion Property (AS3Sender Component)

The certificate's version number.

Syntax

func (obj *AS3Sender) SSLServerCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSLServerCertSubject Property (AS3Sender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *AS3Sender) SSLServerCertSubject() (string, error)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

string

SSLServerCertEncoded Property (AS3Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *AS3Sender) SSLServerCertEncoded() ([]byte, error)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

This property is read-only.

Data Type

[]byte

SSLStartMode Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) SSLStartMode() (int32, error)
func (obj *AS3Sender) SetSSLStartMode(value int32) error

Possible Values

0   // Automatic
1   // Implicit
2   // Explicit
3   // None

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

int32

Subject Property (AS3Sender Component)

The subject of the message.

Syntax

func (obj *AS3Sender) Subject() (string, error)
func (obj *AS3Sender) SetSubject(value string) error

Default Value

""

Remarks

The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer.

Data Type

string

Timeout Property (AS3Sender Component)

The timeout for the class.

Syntax

func (obj *AS3Sender) Timeout() (int32, error)
func (obj *AS3Sender) SetTimeout(value int32) error

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

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

If Timeout expires, and the operation is not yet complete, the component fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

int32

User Property (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) User() (string, error)
func (obj *AS3Sender) SetUser(value string) error

Default Value

""

Remarks

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

Data Type

string

Abort Method (AS3Sender Component)

The method aborts the current upload or download.

Syntax

func (obj *AS3Sender) Abort() error

Remarks

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

ChangeRemotePath Method (AS3Sender Component)

This method changes the current path on the FTP server.

Syntax

func (obj *AS3Sender) ChangeRemotePath(RemotePath string) error

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the component 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");

Config Method (AS3Sender Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *AS3Sender) Config(ConfigurationString string) (string, error)

Remarks

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

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

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

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

DeleteFile Method (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) DeleteFile(FileName string) error

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.

GetFileSize Method (AS3Sender Component)

Gets the size of a file on the FTP server.

Syntax

func (obj *AS3Sender) GetFileSize(FileName string) error

Remarks

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

GetFileTime Method (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) GetFileTime(FileName string) error

Remarks

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

ListDirectory Method (AS3Sender Component)

List the current directory on an FTP server.

Syntax

func (obj *AS3Sender) ListDirectory(FilesToList string) error

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.

ListDirectoryLong Method (AS3Sender Component)

List the current directory on an FTP server.

Syntax

func (obj *AS3Sender) ListDirectoryLong(FilesToList string) error

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.

Logoff Method (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) Logoff() error

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.

Logon Method (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) Logon() error

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

QueryRemotePath Method (AS3Sender Component)

This queries the server for the current path.

Syntax

func (obj *AS3Sender) QueryRemotePath() (string, error)

Remarks

This method queries the server for the current path. When called, the component will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

ReadReceipt Method (AS3Sender Component)

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

Syntax

func (obj *AS3Sender) ReadReceipt(FileName string) error

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

Reset Method (AS3Sender Component)

Resets the state of the control.

Syntax

func (obj *AS3Sender) Reset() error

Remarks

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

Send Method (AS3Sender Component)

Prepares and sends the AS3 message.

Syntax

func (obj *AS3Sender) Send(FileName string) error

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 component to determine an appropriate name.

SendFTPCommand Method (AS3Sender Component)

Sends the exact command directly to the server.

Syntax

func (obj *AS3Sender) SendFTPCommand(command string) error

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.

VerifyReceipt Method (AS3Sender Component)

Verifies an MDN receipt.

Syntax

func (obj *AS3Sender) VerifyReceipt() error

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.

ConnectionStatus Event (AS3Sender Component)

Fired to indicate changes in the connection state.

Syntax

// AS3SenderConnectionStatusEventArgs carries the AS3Sender ConnectionStatus event's parameters.
type AS3SenderConnectionStatusEventArgs struct {...}

func (args *AS3SenderConnectionStatusEventArgs) ConnectionEvent() string
func (args *AS3SenderConnectionStatusEventArgs) StatusCode() int32
func (args *AS3SenderConnectionStatusEventArgs) Description() string

// AS3SenderConnectionStatusEvent defines the signature of the AS3Sender ConnectionStatus event's handler function.
type AS3SenderConnectionStatusEvent func(sender *AS3Sender, args *AS3SenderConnectionStatusEventArgs)

func (obj *AS3Sender) GetOnConnectionStatusHandler() AS3SenderConnectionStatusEvent
func (obj *AS3Sender) SetOnConnectionStatusHandler(handlerFunc AS3SenderConnectionStatusEvent)

Remarks

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

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.

DirList Event (AS3Sender Component)

This event is fired when a directory entry is received.

Syntax

// AS3SenderDirListEventArgs carries the AS3Sender DirList event's parameters.
type AS3SenderDirListEventArgs struct {...}

func (args *AS3SenderDirListEventArgs) DirEntry() string
func (args *AS3SenderDirListEventArgs) FileName() string
func (args *AS3SenderDirListEventArgs) IsDir() bool
func (args *AS3SenderDirListEventArgs) FileSize() int64
func (args *AS3SenderDirListEventArgs) FileTime() string

// AS3SenderDirListEvent defines the signature of the AS3Sender DirList event's handler function.
type AS3SenderDirListEvent func(sender *AS3Sender, args *AS3SenderDirListEventArgs)

func (obj *AS3Sender) GetOnDirListHandler() AS3SenderDirListEvent
func (obj *AS3Sender) SetOnDirListHandler(handlerFunc AS3SenderDirListEvent)

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

EndTransfer Event (AS3Sender Component)

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

Syntax

// AS3SenderEndTransferEventArgs carries the AS3Sender EndTransfer event's parameters.
type AS3SenderEndTransferEventArgs struct {...}

func (args *AS3SenderEndTransferEventArgs) Direction() int32

// AS3SenderEndTransferEvent defines the signature of the AS3Sender EndTransfer event's handler function.
type AS3SenderEndTransferEvent func(sender *AS3Sender, args *AS3SenderEndTransferEventArgs)

func (obj *AS3Sender) GetOnEndTransferHandler() AS3SenderEndTransferEvent
func (obj *AS3Sender) SetOnEndTransferHandler(handlerFunc AS3SenderEndTransferEvent)

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.

Error Event (AS3Sender Component)

Fired when information is available about errors during data delivery.

Syntax

// AS3SenderErrorEventArgs carries the AS3Sender Error event's parameters.
type AS3SenderErrorEventArgs struct {...}

func (args *AS3SenderErrorEventArgs) ErrorCode() int32
func (args *AS3SenderErrorEventArgs) Description() string

// AS3SenderErrorEvent defines the signature of the AS3Sender Error event's handler function.
type AS3SenderErrorEvent func(sender *AS3Sender, args *AS3SenderErrorEventArgs)

func (obj *AS3Sender) GetOnErrorHandler() AS3SenderErrorEvent
func (obj *AS3Sender) SetOnErrorHandler(handlerFunc AS3SenderErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component fails with an error.

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

Log Event (AS3Sender Component)

Fired with log information while processing a message.

Syntax

// AS3SenderLogEventArgs carries the AS3Sender Log event's parameters.
type AS3SenderLogEventArgs struct {...}

func (args *AS3SenderLogEventArgs) LogType() string
func (args *AS3SenderLogEventArgs) LogMessage() []byte

// AS3SenderLogEvent defines the signature of the AS3Sender Log event's handler function.
type AS3SenderLogEvent func(sender *AS3Sender, args *AS3SenderLogEventArgs)

func (obj *AS3Sender) GetOnLogHandler() AS3SenderLogEvent
func (obj *AS3Sender) SetOnLogHandler(handlerFunc AS3SenderLogEvent)

Remarks

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

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

The LogMessage event parameter holds the raw log data.

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

PITrail Event (AS3Sender Component)

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

Syntax

// AS3SenderPITrailEventArgs carries the AS3Sender PITrail event's parameters.
type AS3SenderPITrailEventArgs struct {...}

func (args *AS3SenderPITrailEventArgs) Direction() int32
func (args *AS3SenderPITrailEventArgs) Message() string

// AS3SenderPITrailEvent defines the signature of the AS3Sender PITrail event's handler function.
type AS3SenderPITrailEvent func(sender *AS3Sender, args *AS3SenderPITrailEventArgs)

func (obj *AS3Sender) GetOnPITrailHandler() AS3SenderPITrailEvent
func (obj *AS3Sender) SetOnPITrailHandler(handlerFunc AS3SenderPITrailEvent)

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:

SSLServerAuthentication Event (AS3Sender Component)

Fired after the server presents its certificate to the client.

Syntax

// AS3SenderSSLServerAuthenticationEventArgs carries the AS3Sender SSLServerAuthentication event's parameters.
type AS3SenderSSLServerAuthenticationEventArgs struct {...}

func (args *AS3SenderSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *AS3SenderSSLServerAuthenticationEventArgs) CertSubject() string
func (args *AS3SenderSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *AS3SenderSSLServerAuthenticationEventArgs) Status() string
func (args *AS3SenderSSLServerAuthenticationEventArgs) Accept() bool
func (args *AS3SenderSSLServerAuthenticationEventArgs) SetAccept(value bool)

// AS3SenderSSLServerAuthenticationEvent defines the signature of the AS3Sender SSLServerAuthentication event's handler function.
type AS3SenderSSLServerAuthenticationEvent func(sender *AS3Sender, args *AS3SenderSSLServerAuthenticationEventArgs)

func (obj *AS3Sender) GetOnSSLServerAuthenticationHandler() AS3SenderSSLServerAuthenticationEvent
func (obj *AS3Sender) SetOnSSLServerAuthenticationHandler(handlerFunc AS3SenderSSLServerAuthenticationEvent)

Remarks

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

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

SSLStatus Event (AS3Sender Component)

Fired when secure connection progress messages are available.

Syntax

// AS3SenderSSLStatusEventArgs carries the AS3Sender SSLStatus event's parameters.
type AS3SenderSSLStatusEventArgs struct {...}

func (args *AS3SenderSSLStatusEventArgs) Message() string

// AS3SenderSSLStatusEvent defines the signature of the AS3Sender SSLStatus event's handler function.
type AS3SenderSSLStatusEvent func(sender *AS3Sender, args *AS3SenderSSLStatusEventArgs)

func (obj *AS3Sender) GetOnSSLStatusHandler() AS3SenderSSLStatusEvent
func (obj *AS3Sender) SetOnSSLStatusHandler(handlerFunc AS3SenderSSLStatusEvent)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AS3Sender Component)

This event fires when a file starts downloading or uploading.

Syntax

// AS3SenderStartTransferEventArgs carries the AS3Sender StartTransfer event's parameters.
type AS3SenderStartTransferEventArgs struct {...}

func (args *AS3SenderStartTransferEventArgs) Direction() int32

// AS3SenderStartTransferEvent defines the signature of the AS3Sender StartTransfer event's handler function.
type AS3SenderStartTransferEvent func(sender *AS3Sender, args *AS3SenderStartTransferEventArgs)

func (obj *AS3Sender) GetOnStartTransferHandler() AS3SenderStartTransferEvent
func (obj *AS3Sender) SetOnStartTransferHandler(handlerFunc AS3SenderStartTransferEvent)

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.

Transfer Event (AS3Sender Component)

This event is fired during the file download or upload.

Syntax

// AS3SenderTransferEventArgs carries the AS3Sender Transfer event's parameters.
type AS3SenderTransferEventArgs struct {...}

func (args *AS3SenderTransferEventArgs) Direction() int32
func (args *AS3SenderTransferEventArgs) BytesTransferred() int64
func (args *AS3SenderTransferEventArgs) PercentDone() int32
func (args *AS3SenderTransferEventArgs) Text() []byte

// AS3SenderTransferEvent defines the signature of the AS3Sender Transfer event's handler function.
type AS3SenderTransferEvent func(sender *AS3Sender, args *AS3SenderTransferEventArgs)

func (obj *AS3Sender) GetOnTransferHandler() AS3SenderTransferEvent
func (obj *AS3Sender) SetOnTransferHandler(handlerFunc AS3SenderTransferEvent)

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.

Config Settings (AS3Sender Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

AS3Sender Config Settings

FTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (AS3Sender Component)

AS3Sender Errors

FTP Errors

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

TCPClient Errors

TCP/IP Errors

SMIME Errors