AS3Sender Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorksEDI.As3sender

Remarks

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

A typical AS3 transaction is as follows:

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

(2) The receiver decompresses and decrypts the message and verifies the signature.

(3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message.

When sending an EDI message, the client should specify, at a minimum, AS3From and AS3To, EDIDataData, and EDIDataEDIType. You will also need to specify User, Password, and RemoteHost to Logon to the FTP server. After doing this you may send the data by calling Send.

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

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

The message may also be compressed by setting CompressionFormat.

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

Validating AS3 MDNs

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AS3From Property (AS3Sender Module)

The identity of the sending system.

Syntax

• Swift
• Objective-C

public var as3From: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=AS3From,setter=setAS3From:) NSString* AS3From;

- (NSString*)AS3From;
- (void)setAS3From :(NSString*)newAS3From;

Default Value

""

Remarks

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

Required.

AS3To Property (AS3Sender Module)

The identity of the receiving system.

Syntax

• Swift
• Objective-C

public var as3To: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=AS3To,setter=setAS3To:) NSString* AS3To;

- (NSString*)AS3To;
- (void)setAS3To :(NSString*)newAS3To;

Default Value

""

Remarks

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

Required.

AS3Version Property (AS3Sender Module)

The version of AS3 being used.

Syntax

• Swift
• Objective-C

public var as3Version: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=AS3Version,setter=setAS3Version:) NSString* AS3Version;

- (NSString*)AS3Version;
- (void)setAS3Version :(NSString*)newAS3Version;

Default Value

"1.0"

Remarks

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

Attachments Property (AS3Sender Module)

Collection of files attached to the current message.

Syntax

• Swift
• Objective-C

public var attachments: Array<EDIAttachment> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=attachmentCount,setter=setAttachmentCount:) int attachmentCount;

- (int)attachmentCount;
- (void)setAttachmentCount :(int)newAttachmentCount;

- (NSString*)attachmentContentType:(int)attachmentIndex;
- (void)setAttachmentContentType:(int)attachmentIndex :(NSString*)newAttachmentContentType;

- (NSString*)attachmentData:(int)attachmentIndex;
- (void)setAttachmentData:(int)attachmentIndex :(NSString*)newAttachmentData;

- (NSData*)attachmentDataB:(int)attachmentIndex;
- (void)setAttachmentDataB:(int)attachmentIndex :(NSData*)newAttachmentData;
- (NSString*)attachmentFilename:(int)attachmentIndex;
- (void)setAttachmentFilename:(int)attachmentIndex :(NSString*)newAttachmentFilename;

- (NSString*)attachmentHeaders:(int)attachmentIndex;
- (void)setAttachmentHeaders:(int)attachmentIndex :(NSString*)newAttachmentHeaders;

- (NSString*)attachmentName:(int)attachmentIndex;
- (void)setAttachmentName:(int)attachmentIndex :(NSString*)newAttachmentName;

 

Default Value

""

Remarks

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

CompressionFormat Property (AS3Sender Module)

The compression format (if any) to use.

Syntax

• Swift
• Objective-C

public var compressionFormat: As3senderCompressionFormats {
  get {...}
  set {...}
}

public enum As3senderCompressionFormats: Int32 {
  case cfNone = 0
  case cfZLIB = 1
}

@property (nonatomic,readwrite,assign,getter=compressionFormat,setter=setCompressionFormat:) int compressionFormat;

- (int)compressionFormat;
- (void)setCompressionFormat :(int)newCompressionFormat;

Default Value

0

Remarks

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

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

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

Connected Property (AS3Sender Module)

This shows whether the module is connected.

Syntax

• Swift
• Objective-C

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

Default Value

False

Remarks

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

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

EDIData Property (AS3Sender Module)

The EDI or other data to be sent.

Syntax

• Swift
• Objective-C

public var ediData: EDIData {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=EDIData,setter=setEDIData:) NSString* EDIData;

- (NSString*)EDIData;
- (void)setEDIData :(NSString*)newEDIData;

@property (nonatomic,readwrite,assign,getter=EDIDataB,setter=setEDIDataB:) NSData* EDIDataB;

- (NSData*)EDIDataB;
- (void)setEDIDataB :(NSData*)newEDIData;
@property (nonatomic,readwrite,assign,getter=EDIType,setter=setEDIType:) NSString* EDIType;

- (NSString*)EDIType;
- (void)setEDIType :(NSString*)newEDIType;

@property (nonatomic,readwrite,assign,getter=EDIFilename,setter=setEDIFilename:) NSString* EDIFilename;

- (NSString*)EDIFilename;
- (void)setEDIFilename :(NSString*)newEDIFilename;

@property (nonatomic,readwrite,assign,getter=EDIName,setter=setEDIName:) NSString* EDIName;

- (NSString*)EDIName;
- (void)setEDIName :(NSString*)newEDIName;

 

Default Value

""

Remarks

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

EncryptionAlgorithm Property (AS3Sender Module)

The algorithm used to encrypt the EDI data.

Syntax

• Swift
• Objective-C

public var encryptionAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) NSString* encryptionAlgorithm;

- (NSString*)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(NSString*)newEncryptionAlgorithm;

Default Value

"3DES"

Remarks

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

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

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

Possible values are:

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

Firewall Property (AS3Sender Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

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

FTPCommand Property (AS3Sender Module)

An FTP command to be sent directly to the FTP server.

Syntax

• Swift
• Objective-C

public var ftpCommand: String {  set {...}
}

@property (nonatomic,readwrite,assign,getter=FTPCommand,setter=setFTPCommand:) NSString* FTPCommand;

- (NSString*)FTPCommand;
- (void)setFTPCommand :(NSString*)newFTPCommand;

Default Value

""

Remarks

An FTP command to be sent directly to the FTP server.

This property is write-only.

FTPLastReply Property (AS3Sender Module)

The last reply from the FTP server.

Syntax

• Swift
• Objective-C

public var ftpLastReply: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=FTPLastReply) NSString* FTPLastReply;

- (NSString*)FTPLastReply;

Default Value

""

Remarks

The last reply from the FTP server.

This property is read-only.

LocalHost Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

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

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

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

LogDirectory Property (AS3Sender Module)

The path to a directory for logging.

Syntax

• Swift
• Objective-C

public var logDirectory: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=logDirectory,setter=setLogDirectory:) NSString* logDirectory;

- (NSString*)logDirectory;
- (void)setLogDirectory :(NSString*)newLogDirectory;

Default Value

""

Remarks

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

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

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

If logs cannot be written an exception will be thrown.

LogFile Property (AS3Sender Module)

The log file written.

Syntax

• Swift
• Objective-C

public var logFile: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=logFile) NSString* logFile;

- (NSString*)logFile;

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.

MDNOptions Property (AS3Sender Module)

Used to indicate the options requested for the MDN receipt.

Syntax

• Swift
• Objective-C

public var mdnOptions: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=MDNOptions,setter=setMDNOptions:) NSString* MDNOptions;

- (NSString*)MDNOptions;
- (void)setMDNOptions :(NSString*)newMDNOptions;

Default Value

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

Remarks

By default, the class will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard.

Set MDNOptions to an empty string to request an unsigned receipt.

This property will automatically be updated when SignatureAlgorithm is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value.

The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm.

MDNReceipt Property (AS3Sender Module)

The MDN receipt returned from the server.

Syntax

• Swift
• Objective-C

public var mdnReceipt: MDNReceipt {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=MDNReceiptContent,setter=setMDNReceiptContent:) NSString* MDNReceiptContent;

- (NSString*)MDNReceiptContent;
- (void)setMDNReceiptContent :(NSString*)newMDNReceiptContent;

@property (nonatomic,readwrite,assign,getter=MDNReceiptContentB,setter=setMDNReceiptContentB:) NSData* MDNReceiptContentB;

- (NSData*)MDNReceiptContentB;
- (void)setMDNReceiptContentB :(NSData*)newMDNReceiptContent;
@property (nonatomic,readonly,assign,getter=MDNReceiptHeaderCount) int MDNReceiptHeaderCount;

- (int)MDNReceiptHeaderCount;

@property (nonatomic,readonly,assign,getter=MDNReceiptHeaderField) NSString* MDNReceiptHeaderField;

- (NSString*)MDNReceiptHeaderField;

@property (nonatomic,readwrite,assign,getter=MDNReceiptHeaderIndex,setter=setMDNReceiptHeaderIndex:) int MDNReceiptHeaderIndex;

- (int)MDNReceiptHeaderIndex;
- (void)setMDNReceiptHeaderIndex :(int)newMDNReceiptHeaderIndex;

@property (nonatomic,readwrite,assign,getter=MDNReceiptHeaders,setter=setMDNReceiptHeaders:) NSString* MDNReceiptHeaders;

- (NSString*)MDNReceiptHeaders;
- (void)setMDNReceiptHeaders :(NSString*)newMDNReceiptHeaders;

@property (nonatomic,readonly,assign,getter=MDNReceiptHeaderValue) NSString* MDNReceiptHeaderValue;

- (NSString*)MDNReceiptHeaderValue;

@property (nonatomic,readonly,assign,getter=MDNReceiptMDN) NSString* MDNReceiptMDN;

- (NSString*)MDNReceiptMDN;

@property (nonatomic,readonly,assign,getter=MDNReceiptMessage) NSString* MDNReceiptMessage;

- (NSString*)MDNReceiptMessage;

@property (nonatomic,readonly,assign,getter=MDNReceiptMICValue) NSString* MDNReceiptMICValue;

- (NSString*)MDNReceiptMICValue;

@property (nonatomic,readonly,assign,getter=MDNReceiptSigningProtocol) NSString* MDNReceiptSigningProtocol;

- (NSString*)MDNReceiptSigningProtocol;

 

Default Value

""

Remarks

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

MDNTo Property (AS3Sender Module)

The system to which an MDN should be directed.

Syntax

• Swift
• Objective-C

public var mdnTo: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=MDNTo,setter=setMDNTo:) NSString* MDNTo;

- (NSString*)MDNTo;
- (void)setMDNTo :(NSString*)newMDNTo;

Default Value

""

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. You should specify a valid FTP URL for the request, e.g., "ftp://123.0.0.1".

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

MessageId Property (AS3Sender Module)

The Id of the message.

Syntax

• Swift
• Objective-C

public var messageId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageId,setter=setMessageId:) NSString* messageId;

- (NSString*)messageId;
- (void)setMessageId :(NSString*)newMessageId;

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.

OriginalContentMIC Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var originalContentMIC: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=originalContentMIC,setter=setOriginalContentMIC:) NSString* originalContentMIC;

- (NSString*)originalContentMIC;
- (void)setOriginalContentMIC :(NSString*)newOriginalContentMIC;

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

Passive Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var passive: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=passive,setter=setPassive:) BOOL passive;

- (BOOL)passive;
- (void)setPassive :(BOOL)newPassive;

Default Value

True

Remarks

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

Password Property (AS3Sender Module)

This is the password used to log in.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

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

ReceiptSignerCertEncoded Property (AS3Sender Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var receiptSignerCertEncoded: String {
  get {...}
  set {...}
}

public var receiptSignerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=receiptSignerCertEncoded,setter=setReceiptSignerCertEncoded:) NSString* receiptSignerCertEncoded;

- (NSString*)receiptSignerCertEncoded;
- (void)setReceiptSignerCertEncoded :(NSString*)newReceiptSignerCertEncoded;

@property (nonatomic,readwrite,assign,getter=receiptSignerCertEncodedB,setter=setReceiptSignerCertEncodedB:) NSData* receiptSignerCertEncodedB;

- (NSData*)receiptSignerCertEncodedB;
- (void)setReceiptSignerCertEncodedB :(NSData*)newReceiptSignerCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setReceiptSignerCertEncodedB(receiptSignerCertEncoded: Data) throws
public func setReceiptSignerCertEncoded(receiptSignerCertEncoded: String) throws

ReceiptSignerCertStore Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var receiptSignerCertStore: String {
  get {...}
  set {...}
}

public var receiptSignerCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=receiptSignerCertStore,setter=setReceiptSignerCertStore:) NSString* receiptSignerCertStore;

- (NSString*)receiptSignerCertStore;
- (void)setReceiptSignerCertStore :(NSString*)newReceiptSignerCertStore;

@property (nonatomic,readwrite,assign,getter=receiptSignerCertStoreB,setter=setReceiptSignerCertStoreB:) NSData* receiptSignerCertStoreB;

- (NSData*)receiptSignerCertStoreB;
- (void)setReceiptSignerCertStoreB :(NSData*)newReceiptSignerCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

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

ReceiptSignerCertStorePassword Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var receiptSignerCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=receiptSignerCertStorePassword,setter=setReceiptSignerCertStorePassword:) NSString* receiptSignerCertStorePassword;

- (NSString*)receiptSignerCertStorePassword;
- (void)setReceiptSignerCertStorePassword :(NSString*)newReceiptSignerCertStorePassword;

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.

ReceiptSignerCertStoreType Property (AS3Sender Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var receiptSignerCertStoreType: As3senderReceiptSignerCertStoreTypes {
  get {...}
  set {...}
}

public enum As3senderReceiptSignerCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=receiptSignerCertStoreType,setter=setReceiptSignerCertStoreType:) int receiptSignerCertStoreType;

- (int)receiptSignerCertStoreType;
- (void)setReceiptSignerCertStoreType :(int)newReceiptSignerCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ReceiptSignerCertSubject Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var receiptSignerCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=receiptSignerCertSubject,setter=setReceiptSignerCertSubject:) NSString* receiptSignerCertSubject;

- (NSString*)receiptSignerCertSubject;
- (void)setReceiptSignerCertSubject :(NSString*)newReceiptSignerCertSubject;

Default Value

""

Remarks

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

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

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

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

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

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

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setReceiptSignerCertSubject(receiptSignerCertSubject: String) throws

RecipientCertCount Property (AS3Sender Module)

The number of records in the RecipientCert arrays.

Syntax

• Swift
• Objective-C

public var recipientCertCount: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recipientCertCount,setter=setRecipientCertCount:) int recipientCertCount;

- (int)recipientCertCount;
- (void)setRecipientCertCount :(int)newRecipientCertCount;

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject

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

RecipientCertEncoded Property (AS3Sender Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var recipientCertEncoded: String {
  get {...}
  set {...}
}

public var recipientCertEncodedB: Data {
  get {...}
  set {...}
}

- (NSString*)recipientCertEncoded:(int)recipientCertIndex;
- (void)setRecipientCertEncoded:(int)recipientCertIndex :(NSString*)newRecipientCertEncoded;

- (NSData*)recipientCertEncodedB:(int)recipientCertIndex;
- (void)setRecipientCertEncodedB:(int)recipientCertIndex :(NSData*)newRecipientCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setRecipientCertEncodedB(recipientCertEncoded: Data) throws
public func setRecipientCertEncoded(recipientCertEncoded: String) throws

RecipientCertStore Property (AS3Sender Module)

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

Syntax

• Swift
• Objective-C

public var recipientCertStore: String {
  get {...}
  set {...}
}

public var recipientCertStoreB: Data {
  get {...}
  set {...}
}

- (NSString*)recipientCertStore:(int)recipientCertIndex;
- (void)setRecipientCertStore:(int)recipientCertIndex :(NSString*)newRecipientCertStore;

- (NSData*)recipientCertStoreB:(int)recipientCertIndex;
- (void)setRecipientCertStoreB:(int)recipientCertIndex :(NSData*)newRecipientCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows: