AS2Sender Module
Properties Methods Events Config Settings Errors
The AS2Sender module implements an AS2 / EDI-INT client.
Syntax
IPWorksEDI.As2sender
Remarks
The AS2Sender component may be used to send EDI or other messages over HTTP/S, using the AS2 protocol. It may also be used to verify synchronous or asynchronous server responses.
A typical AS2 transaction is as follows:
(1) The sender sends an EDI document to the receiver using HTTP or HTTPS. Typically the document will be signed and encrypted (particularly if SSL is not used). A signed receipt will also be requested.
(2) The receiver decrypts the message and verifies the signature.
(3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message.
When sending an EDI message, the client should specify, at a minimum, AS2From and AS2To, URL, and EDIData. The Post method should then be invoked.
To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data, set SigningCert. To encrypt, set RecipientCerts. If the recipient uses different certificates for signing and encryption it will also be necessary to set ReceiptSignerCert.
SSL will also be used if the scheme in URL is "https". If 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 MDNOptions property may be used to customize the request. By default, the class will request a signed MDN over an SHA1 hash.
The class supports both synchronous and asynchronous MDN receipt delivery. By default, the class requests synchronous MDN receipt delivery, and the MDN will be returned in the HTTP reply. To request asynchronous MDN delivery, set the MDNDeliveryOption to the URL where MDN's are to be delivered.
The HTTP reply will automatically be processed by the class. If an MDN was requested, Post will validate the MDN and (if signed) establish non-repudiation of receipt. Any errors or warnings will cause the class to throw an exception.
In either case, after the EDI transaction is processed successfully, the MDNReceipt will be populated with the appropriate values.
Validating Asynchronous MDNs
The class may also be used to process and verify asynchronous MDNs. To do this, you should invoke ReadAsyncReceipt. This will read the receipt from the current HTTP context (or from MDNReceipt, if set manually), and allow you to determine your trading partner's identity and the message ID. You should then set ReceiptSignerCert and OriginalContentMIC, and finally 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.
AS2From | The AS2 Identifier of the sending system. |
AS2To | The AS2 Identifier of the receiving system. |
AS2Version | The version of AS2 being used. |
AsyncMDNInfoDir | Path to a directory to store data used in verifying AsyncMDNs. |
Attachments | Collection of files attached to the current message. |
CEMDetails | A collection of Certificate Exchange Messaging (CEM) details. |
CompressionFormat | The compression format (if any) to use. |
Cookies | This property includes a collection of cookies. |
EDIData | The EDI or other data to be sent. |
EncryptionAlgorithm | The algorithm used to encrypt the EDI data. |
Etag | The Etag of the file being sent. |
Firewall | A set of properties related to firewall access. |
From | The email address of the HTTP agent (optional). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LogDirectory | The path to a directory for logging. |
LogFile | The log file written. |
MDNDeliveryOption | A URL indicating how the receipt is to be delivered. |
MDNOptions | Used to indicate the options requested for the MDN receipt. |
MDNReceipt | The MDN receipt returned from the server. |
MDNTo | Used to indicate that a message disposition notification is requested. |
MessageId | The Id of the message. |
OriginalContentMIC | The Message Integrity Check(s) (one-way hash) of the outgoing message. |
Proxy | A set of properties related to proxy access. |
ReceiptSignerCertEncoded | This is the certificate (PEM/Base64 encoded). |
ReceiptSignerCertStore | This is the name of the certificate store for the client certificate. |
ReceiptSignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ReceiptSignerCertStoreType | This is the type of certificate store for this certificate. |
ReceiptSignerCertSubject | This is the subject of the certificate used for client authentication. |
RecipientCertCount | The number of records in the RecipientCert arrays. |
RecipientCertEncoded | This is the certificate (PEM/Base64 encoded). |
RecipientCertStore | This is the name of the certificate store for the client certificate. |
RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
RecipientCertStoreType | This is the type of certificate store for this certificate. |
RecipientCertSubject | This is the subject of the certificate used for client authentication. |
RestartDirectory | The directory to log cached files when using AS2 restart functionality. |
RolloverSigningCertEncoded | This is the certificate (PEM/Base64 encoded). |
RolloverSigningCertStore | This is the name of the certificate store for the client certificate. |
RolloverSigningCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
RolloverSigningCertStoreType | This is the type of certificate store for this certificate. |
RolloverSigningCertSubject | This is the subject of the certificate used for client authentication. |
SignatureAlgorithm | Signature algorithm to be used in outgoing messages. |
SigningCertEncoded | This is the certificate (PEM/Base64 encoded). |
SigningCertStore | This is the name of the certificate store for the client certificate. |
SigningCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SigningCertStoreType | This is the type of certificate store for this certificate. |
SigningCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Subject | The subject of the message. |
Timeout | A timeout for the module. |
URL | The URL to which the request is made. |
UseOAEP | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). |
UsePSS | This property specifies whether or not RSA-PSS will be used during signing and verification. |
UserAgent | Information about the user agent. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
Post | Post data to the AS2 server, and check the receipt. |
ReadAsyncReceipt | Reads an asynchronous MDN receipt from the current HTTP session. |
Reset | Resets the state of the control. |
Restart | Restart sending of the file specified by the Etag property. |
SendCEMRequest | Sends a Certificate Exchange Messaging (CEM) request. |
SendCEMResponse | Sends a Certificate Exchange Messaging (CEM) response. |
SetRequestHeader | Allows the user to set or add arbitrary HTTP request headers. |
SetTPInfo | A convenient way to set AS2 communication parameters using XML strings. |
VerifyReceipt | Verifies an asynchronous MDN receipt. |
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.
Connected | This event is fired immediately after a connection completes (or fails). |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event is fired when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
Log | Fired with log information while processing a message. |
SetCookie | This event is fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
AllowMDNWarnings | Whether to fail on MDN warnings. |
Authorization | The Authorization string to be sent to the server. |
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
EncodeToTempDir | Whether to use temporary files when creating messages. |
IgnoreLoggingErrors | Whether to ignore errors that occur when writing to the log. |
IncludeHeaders | Whether headers are included when posting to a file. |
LogDebug | Whether to log debug data. |
LogFilename | The base name of the log file. |
LogOptions | The information to be written to log files. |
MDNDisposition | Returns the Disposition header of the MDN. |
MessageHeaders | Returns the headers of the message. |
NormalizeMIC | Whether to normalize line endings before calculating the MIC. |
OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used when encrypting a key. |
OAEPParams | The hex encoded OAEP parameters to be used when encrypting a key. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
Password | A password if authentication is to be used. |
PostToFile | Creates the message on disk. |
RequiredSignatureAlgorithms | Specifies a list of acceptable signature algorithms. |
User | A user name if authentication is to be used. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the module. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the module will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the module. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the module. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the module whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the module binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AS2From Property (AS2Sender Module)
The AS2 Identifier of the sending system.
Syntax
public var as2From: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=AS2From,setter=setAS2From:) NSString* AS2From; - (NSString*)AS2From; - (void)setAS2From :(NSString*)newAS2From;
Default Value
""
Remarks
May be company name, DUNS number, or anything agreed on by trading partners.
Required.
AS2To Property (AS2Sender Module)
The AS2 Identifier of the receiving system.
Syntax
public var as2To: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=AS2To,setter=setAS2To:) NSString* AS2To; - (NSString*)AS2To; - (void)setAS2To :(NSString*)newAS2To;
Default Value
""
Remarks
May be company name, DUNS number, or anything agreed on by trading partners.
Required.
AS2Version Property (AS2Sender Module)
The version of AS2 being used.
Syntax
public var as2Version: String { get {...} }
@property (nonatomic,readonly,assign,getter=AS2Version) NSString* AS2Version; - (NSString*)AS2Version;
Default Value
"1.2"
Remarks
The version of AS2 being used.
This property is read-only.
AsyncMDNInfoDir Property (AS2Sender Module)
Path to a directory to store data used in verifying AsyncMDNs.
Syntax
public var asyncMDNInfoDir: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=asyncMDNInfoDir,setter=setAsyncMDNInfoDir:) NSString* asyncMDNInfoDir; - (NSString*)asyncMDNInfoDir; - (void)setAsyncMDNInfoDir :(NSString*)newAsyncMDNInfoDir;
Default Value
""
Remarks
If Post is invoked after setting AsyncMDNInfoDir and an asynchronous MDN is requested, the class stores the data required to verify AsyncMDNs in a file in the specified directory. The name of the file is the MessageId of the outgoing message.
AsyncMDNInfoDir is also used while verifying asynchronous MDNs using VerifyReceipt. The properties required to process AsyncMDNs, namely OriginalContentMIC and MDNOptions, are automatically read from the file saved at the time of sending the original message.
Attachments Property (AS2Sender Module)
Collection of files attached to the current message.
Syntax
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
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
When a call to Send is made, the class will attach the files referenced by each EDIAttachment in this collection to the EDIData.
CEMDetails Property (AS2Sender Module)
A collection of Certificate Exchange Messaging (CEM) details.
Syntax
public var cemDetails: Array<CEMDetail> { get {...} }
@property (nonatomic,readwrite,assign,getter=CEMCount,setter=setCEMCount:) int CEMCount; - (int)CEMCount; - (void)setCEMCount :(int)newCEMCount; - (BOOL)CEMAccepted:(int)cEMIndex; - (void)setCEMAccepted:(int)cEMIndex :(BOOL)newCEMAccepted; - (NSString*)CEMCertId:(int)cEMIndex; - (void)setCEMCertId:(int)cEMIndex :(NSString*)newCEMCertId; - (NSString*)CEMCertIssuer:(int)cEMIndex; - (void)setCEMCertIssuer:(int)cEMIndex :(NSString*)newCEMCertIssuer; - (NSString*)CEMCertSerialNumber:(int)cEMIndex; - (void)setCEMCertSerialNumber:(int)cEMIndex :(NSString*)newCEMCertSerialNumber; - (NSString*)CEMCertStore:(int)cEMIndex; - (void)setCEMCertStore:(int)cEMIndex :(NSString*)newCEMCertStore; - (NSData*)CEMCertStoreB:(int)cEMIndex; - (void)setCEMCertStoreB:(int)cEMIndex :(NSData*)newCEMCertStore; - (NSString*)CEMCertStorePassword:(int)cEMIndex; - (void)setCEMCertStorePassword:(int)cEMIndex :(NSString*)newCEMCertStorePassword; - (int)CEMCertStoreType:(int)cEMIndex; - (void)setCEMCertStoreType:(int)cEMIndex :(int)newCEMCertStoreType; - (NSString*)CEMCertSubject:(int)cEMIndex; - (void)setCEMCertSubject:(int)cEMIndex :(NSString*)newCEMCertSubject; - (int)CEMCertUsage:(int)cEMIndex; - (void)setCEMCertUsage:(int)cEMIndex :(int)newCEMCertUsage; - (NSString*)CEMRejectionReason:(int)cEMIndex; - (void)setCEMRejectionReason:(int)cEMIndex :(NSString*)newCEMRejectionReason; - (NSString*)CEMRespondByDate:(int)cEMIndex; - (void)setCEMRespondByDate:(int)cEMIndex :(NSString*)newCEMRespondByDate; - (NSString*)CEMResponseURL:(int)cEMIndex; - (void)setCEMResponseURL:(int)cEMIndex :(NSString*)newCEMResponseURL;
Default Value
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
This collection holds Certificate Exchange Messaging (CEM) details. The details define the certificate, respond-by-date, and more.
When using AS2Sender see SendCEMResponse and SendCEMRequest for more information.
When using AS2Receiver see CEMRequest and CEMResponse for more information.
CompressionFormat Property (AS2Sender Module)
The compression format (if any) to use.
Syntax
public var compressionFormat: As2senderCompressionFormats { get {...} set {...} }
public enum As2senderCompressionFormats: 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.
Cookies Property (AS2Sender Module)
This property includes a collection of cookies.
Syntax
public var cookies: Array<HTTPCookie> { get {...} }
@property (nonatomic,readwrite,assign,getter=cookieCount,setter=setCookieCount:) int cookieCount; - (int)cookieCount; - (void)setCookieCount :(int)newCookieCount; - (NSString*)cookieDomain:(int)cookieIndex; - (NSString*)cookieExpiration:(int)cookieIndex; - (NSString*)cookieName:(int)cookieIndex; - (void)setCookieName:(int)cookieIndex :(NSString*)newCookieName; - (NSString*)cookiePath:(int)cookieIndex; - (BOOL)cookieSecure:(int)cookieIndex; - (NSString*)cookieValue:(int)cookieIndex; - (void)setCookieValue:(int)cookieIndex :(NSString*)newCookieValue;
Default Value
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.
To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.
MaxHTTPCookies can be used to control the maximum number of cookies saved.
EDIData Property (AS2Sender Module)
The EDI or other data to be sent.
Syntax
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
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
The EDI message to send.
EncryptionAlgorithm Property (AS2Sender Module)
The algorithm used to encrypt the EDI data.
Syntax
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
Etag Property (AS2Sender Module)
The Etag of the file being sent.
Syntax
public var etag: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=etag,setter=setEtag:) NSString* etag; - (NSString*)etag; - (void)setEtag :(NSString*)newEtag;
Default Value
""
Remarks
This specifies the Etag for the file. This value should be set to an empty string the first time a file is sent using the Restart command. The class will generate a unique Etag based on the processed contents of the file and set this property when sending begins.
If a file is interrupted, this value must be set when Restart is called to resume transfer of the already processed file.
Firewall Property (AS2Sender Module)
A set of properties related to firewall access.
Syntax
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
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
From Property (AS2Sender Module)
The email address of the HTTP agent (optional).
Syntax
public var from: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=from,setter=setFrom:) NSString* from; - (NSString*)from; - (void)setFrom :(NSString*)newFrom;
Default Value
""
Remarks
If the From property contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.
LocalHost Property (AS2Sender Module)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
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.
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 (AS2Sender Module)
The path to a directory for logging.
Syntax
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 complete text of the outgoing request and the incoming response.
The class will write multiple log file for each transmission, with separate extensions for each type of data:
Status (.log) | Contains information on applied security options and pass/fail status of transmission |
Request (.req) | Contains the outgoing request, after security options have been applied |
Payload (.dat) | Contains log of unsecured payload prior to transmission |
MDN Receipt (.mdn) | For synchronous requests or asynchronous receipts verified with VerifyReceipt, contains MDN receipt. |
Error (.err) | This is only written in an error is encountered, containing the error. |
One or more of these logs may be disabled by setting the LogOptions configuration setting.
LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the class will attempt to create the directory. The following macros are supported:
%MessageID% | The MessageID of the AS2 transmission, after it is generated. |
%AS2From% | The AS2-From field in the transmission |
%OriginalMessageID% | In MDN Receipts, the MessageID of the transmission that the receipt is for. You can use this to pair asynchronous MDN receipt logs with their transmissions |
%date:format% | %Format% is a platform-specific date/time formatting string. For example: |
The filenames will be chosen automatically by the 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.
If logs cannot be written an exception will be thrown.
LogFile Property (AS2Sender Module)
The log file written.
Syntax
public var logFile: String { get {...} }
@property (nonatomic,readonly,assign,getter=logFile) NSString* logFile; - (NSString*)logFile;
Default Value
""
Remarks
If LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files written, minus the extension.
The class will write multiple log files for each transmission, with separate extensions for each type of data:
Status (.log) | Contains information on applied security options and pass/fail status of transmission |
Request (.req) | Contains the outgoing request, after security options have been applied |
Payload (.dat) | Contains the unsecured payload data prior to transmission |
MDN Receipt (.mdn) | For synchronous requests or asynchronous receipts verified with VerifyReceipt. This contains the MDN receipt. |
Error (.err) | This is only written if an error is encountered and will contain the error. |
This property is read-only.
MDNDeliveryOption Property (AS2Sender Module)
A URL indicating how the receipt is to be delivered.
Syntax
public var mdnDeliveryOption: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=MDNDeliveryOption,setter=setMDNDeliveryOption:) NSString* MDNDeliveryOption; - (NSString*)MDNDeliveryOption; - (void)setMDNDeliveryOption :(NSString*)newMDNDeliveryOption;
Default Value
""
Remarks
The default mode of operation is for the receipt to be returned synchronously within the HTTP reply. By specifying a valid URL, the user may request asynchronous delivery instead. The URL indicates the destination for the reply, and may use any appropriate protocol, such as "http", "https", or "mailto".
If MDNDeliveryOption is set to an empty string, the receipt will be returned synchronously, and will be processed automatically by the class. Clients requesting asynchronous delivery should provide their own processing for reading receipts.
MDNOptions Property (AS2Sender Module)
Used to indicate the options requested for the MDN receipt.
Syntax
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 (AS2Sender Module)
The MDN receipt returned from the server.
Syntax
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
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
This property will contain an instance of MDNReceipt with the complete MDN receipt returned from the AS2 receiver. The receipt will be a signed or unsigned multipart/report in MIME format. For synchronous MDN requests, this property is populated automatically after the call to Post. If an asynchronous MDN is sent over HTTP, it may be read from the HTTP context by calling ReadAsyncReceipt, or it may be set manually.
When MDNReceipt is set to a valid MDN receipt, the originator of the receipt will be stored in AS2To, the intended recipient (presumably your system) will be stored in AS2From, and the original message ID will be stored in MessageId.
If you are processing a MDN receipt asynchronously, you can use the values to look up the original message and validate the receipt. Set the OriginalContentMIC, MDNOptions, and ReceiptSignerCert to the values originally computed when the message was sent (if you are requesting async MDNs you must save this information externally.). You can then validate the asynchronous receipt by invoking VerifyReceipt.
Alternatively, AsyncMDNInfoDir may be set in place of OriginalContentMIC, MessageId, and MDNOptions (provided it was set to the same value when the message was sent). If AsyncMDNInfoDir was specified when the message was sent, the class would have saved OriginalContentMIC and MDNOptions to a file identified by the MessageId for the transmission. These properties are read from the file matching the MessageId in the MDNReceipt automatically if AsyncMDNInfoDir is specified.
Note: MDNReceipt must be populated prior to calling VerifyReceipt.
MDNTo Property (AS2Sender Module)
Used to indicate that a message disposition notification is requested.
Syntax
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. The value may be an email address, URL, etc., and while its presence is used to determine whether or not an MDN is sent, the value itself will typically be ignored by the server.
By default, the class will request a PKCS#7 signature and synchronous delivery. You may set MDNDeliveryOption to request an asynchronous MDN, and you may set MDNOptions to request a different type of signature, or no signature at all.
MessageId Property (AS2Sender Module)
The Id of the message.
Syntax
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 (AS2Sender Module)
The Message Integrity Check(s) (one-way hash) of the outgoing message.
Syntax
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).
Proxy Property (AS2Sender Module)
A set of properties related to proxy access.
Syntax
public var proxy: Proxy { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme; - (int)proxyAuthScheme; - (void)setProxyAuthScheme :(int)newProxyAuthScheme; @property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect; - (BOOL)proxyAutoDetect; - (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect; @property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword; - (NSString*)proxyPassword; - (void)setProxyPassword :(NSString*)newProxyPassword; @property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort; - (int)proxyPort; - (void)setProxyPort :(int)newProxyPort; @property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer; - (NSString*)proxyServer; - (void)setProxyServer :(NSString*)newProxyServer; @property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL; - (int)proxySSL; - (void)setProxySSL :(int)newProxySSL; @property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser; - (NSString*)proxyUser; - (void)setProxyUser :(NSString*)newProxyUser;
Default Value
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
ReceiptSignerCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
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 (AS2Sender Module)
This is the name of the certificate store for the client certificate.
Syntax
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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., PKCS#12 certificate store).
ReceiptSignerCertStorePassword Property (AS2Sender 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
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 (AS2Sender Module)
This is the type of certificate store for this certificate.
Syntax
public var receiptSignerCertStoreType: As2senderReceiptSignerCertStoreTypes { get {...} set {...} }
public enum As2senderReceiptSignerCertStoreTypes: 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 cstPKCS11 = 23 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ReceiptSignerCertStore and set ReceiptSignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ReceiptSignerCertSubject Property (AS2Sender Module)
This is the subject of the certificate used for client authentication.
Syntax
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 properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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 (AS2Sender Module)
The number of records in the RecipientCert arrays.
Syntax
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
RecipientCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
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 (AS2Sender Module)
This is the name of the certificate store for the client certificate.
Syntax
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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., PKCS#12 certificate store).
RecipientCertStorePassword Property (AS2Sender 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
public var recipientCertStorePassword: String { get {...} set {...} }
- (NSString*)recipientCertStorePassword:(int)recipientCertIndex; - (void)setRecipientCertStorePassword:(int)recipientCertIndex :(NSString*)newRecipientCertStorePassword;
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.
RecipientCertStoreType Property (AS2Sender Module)
This is the type of certificate store for this certificate.
Syntax
public var recipientCertStoreType: As2senderRecipientCertStoreTypes { get {...} set {...} }
public enum As2senderRecipientCertStoreTypes: 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 cstPKCS11 = 23 case cstAuto = 99 }
- (int)recipientCertStoreType:(int)recipientCertIndex; - (void)setRecipientCertStoreType:(int)recipientCertIndex :(int)newRecipientCertStoreType;
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the RecipientCertStore and set RecipientCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
RecipientCertSubject Property (AS2Sender Module)
This is the subject of the certificate used for client authentication.
Syntax
public var recipientCertSubject: String { get {...} set {...} }
- (NSString*)recipientCertSubject:(int)recipientCertIndex; - (void)setRecipientCertSubject:(int)recipientCertIndex :(NSString*)newRecipientCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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 setRecipientCertSubject(recipientCertSubject: String) throws
RestartDirectory Property (AS2Sender Module)
The directory to log cached files when using AS2 restart functionality.
Syntax
public var restartDirectory: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=restartDirectory,setter=setRestartDirectory:) NSString* restartDirectory; - (NSString*)restartDirectory; - (void)setRestartDirectory :(NSString*)newRestartDirectory;
Default Value
""
Remarks
If this property is set, the class will cache all data to the RestartDirectory. Thus, when sending a file is interrupted, the class can restart the transmission of the file starting where it was interrupted.
To use this functionality, simply set the RestartDirectory and call Restart.
When using restart functionality, the data is completely processed to the RestartDirectory before sending begins.
NOTE: This directory will not automatically be cleaned up.
RolloverSigningCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var rolloverSigningCertEncoded: String { get {...} set {...} }
public var rolloverSigningCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=rolloverSigningCertEncoded,setter=setRolloverSigningCertEncoded:) NSString* rolloverSigningCertEncoded; - (NSString*)rolloverSigningCertEncoded; - (void)setRolloverSigningCertEncoded :(NSString*)newRolloverSigningCertEncoded; @property (nonatomic,readwrite,assign,getter=rolloverSigningCertEncodedB,setter=setRolloverSigningCertEncodedB:) NSData* rolloverSigningCertEncodedB; - (NSData*)rolloverSigningCertEncodedB; - (void)setRolloverSigningCertEncodedB :(NSData*)newRolloverSigningCertEncoded;
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RolloverSigningCertStore and RolloverSigningCertSubject properties also may be used to specify a certificate.
When RolloverSigningCertEncoded is set, a search is initiated in the current RolloverSigningCertStore for the private key of the certificate. If the key is found, RolloverSigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RolloverSigningCertSubject 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 setRolloverSigningCertEncodedB(rolloverSigningCertEncoded: Data) throws public func setRolloverSigningCertEncoded(rolloverSigningCertEncoded: String) throws
RolloverSigningCertStore Property (AS2Sender Module)
This is the name of the certificate store for the client certificate.
Syntax
public var rolloverSigningCertStore: String { get {...} set {...} }
public var rolloverSigningCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=rolloverSigningCertStore,setter=setRolloverSigningCertStore:) NSString* rolloverSigningCertStore; - (NSString*)rolloverSigningCertStore; - (void)setRolloverSigningCertStore :(NSString*)newRolloverSigningCertStore; @property (nonatomic,readwrite,assign,getter=rolloverSigningCertStoreB,setter=setRolloverSigningCertStoreB:) NSData* rolloverSigningCertStoreB; - (NSData*)rolloverSigningCertStoreB; - (void)setRolloverSigningCertStoreB :(NSData*)newRolloverSigningCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The RolloverSigningCertStoreType property denotes the type of the certificate store specified by RolloverSigningCertStore. If the store is password protected, specify the password in RolloverSigningCertStorePassword.
RolloverSigningCertStore is used in conjunction with the RolloverSigningCertSubject property to specify client certificates. If RolloverSigningCertStore has a value, and RolloverSigningCertSubject or RolloverSigningCertEncoded is set, a search for a certificate is initiated. Please see the RolloverSigningCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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., PKCS#12 certificate store).
RolloverSigningCertStorePassword Property (AS2Sender 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
public var rolloverSigningCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=rolloverSigningCertStorePassword,setter=setRolloverSigningCertStorePassword:) NSString* rolloverSigningCertStorePassword; - (NSString*)rolloverSigningCertStorePassword; - (void)setRolloverSigningCertStorePassword :(NSString*)newRolloverSigningCertStorePassword;
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.
RolloverSigningCertStoreType Property (AS2Sender Module)
This is the type of certificate store for this certificate.
Syntax
public var rolloverSigningCertStoreType: As2senderRolloverSigningCertStoreTypes { get {...} set {...} }
public enum As2senderRolloverSigningCertStoreTypes: 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 cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=rolloverSigningCertStoreType,setter=setRolloverSigningCertStoreType:) int rolloverSigningCertStoreType; - (int)rolloverSigningCertStoreType; - (void)setRolloverSigningCertStoreType :(int)newRolloverSigningCertStoreType;
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the RolloverSigningCertStore and set RolloverSigningCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
RolloverSigningCertSubject Property (AS2Sender Module)
This is the subject of the certificate used for client authentication.
Syntax
public var rolloverSigningCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=rolloverSigningCertSubject,setter=setRolloverSigningCertSubject:) NSString* rolloverSigningCertSubject; - (NSString*)rolloverSigningCertSubject; - (void)setRolloverSigningCertSubject :(NSString*)newRolloverSigningCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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 setRolloverSigningCertSubject(rolloverSigningCertSubject: String) throws
SignatureAlgorithm Property (AS2Sender Module)
Signature algorithm to be used in outgoing messages.
Syntax
public var signatureAlgorithm: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signatureAlgorithm,setter=setSignatureAlgorithm:) NSString* signatureAlgorithm; - (NSString*)signatureAlgorithm; - (void)setSignatureAlgorithm :(NSString*)newSignatureAlgorithm;
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.
SigningCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var signingCertEncoded: String { get {...} set {...} }
public var signingCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signingCertEncoded,setter=setSigningCertEncoded:) NSString* signingCertEncoded; - (NSString*)signingCertEncoded; - (void)setSigningCertEncoded :(NSString*)newSigningCertEncoded; @property (nonatomic,readwrite,assign,getter=signingCertEncodedB,setter=setSigningCertEncodedB:) NSData* signingCertEncodedB; - (NSData*)signingCertEncodedB; - (void)setSigningCertEncodedB :(NSData*)newSigningCertEncoded;
Default Value
""
Remarks
This is 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.
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 setSigningCertEncodedB(signingCertEncoded: Data) throws public func setSigningCertEncoded(signingCertEncoded: String) throws
SigningCertStore Property (AS2Sender Module)
This is the name of the certificate store for the client certificate.
Syntax
public var signingCertStore: String { get {...} set {...} }
public var signingCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signingCertStore,setter=setSigningCertStore:) NSString* signingCertStore; - (NSString*)signingCertStore; - (void)setSigningCertStore :(NSString*)newSigningCertStore; @property (nonatomic,readwrite,assign,getter=signingCertStoreB,setter=setSigningCertStoreB:) NSData* signingCertStoreB; - (NSData*)signingCertStoreB; - (void)setSigningCertStoreB :(NSData*)newSigningCertStore;
Default Value
"MY"
Remarks
This is 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
SigningCertStorePassword Property (AS2Sender 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
public var signingCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signingCertStorePassword,setter=setSigningCertStorePassword:) NSString* signingCertStorePassword; - (NSString*)signingCertStorePassword; - (void)setSigningCertStorePassword :(NSString*)newSigningCertStorePassword;
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.
SigningCertStoreType Property (AS2Sender Module)
This is the type of certificate store for this certificate.
Syntax
public var signingCertStoreType: As2senderSigningCertStoreTypes { get {...} set {...} }
public enum As2senderSigningCertStoreTypes: 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 cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=signingCertStoreType,setter=setSigningCertStoreType:) int signingCertStoreType; - (int)signingCertStoreType; - (void)setSigningCertStoreType :(int)newSigningCertStoreType;
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SigningCertStore and set SigningCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SigningCertSubject Property (AS2Sender Module)
This is the subject of the certificate used for client authentication.
Syntax
public var signingCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=signingCertSubject,setter=setSigningCertSubject:) NSString* signingCertSubject; - (NSString*)signingCertSubject; - (void)setSigningCertSubject :(NSString*)newSigningCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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 setSigningCertSubject(signingCertSubject: String) throws
SSLAcceptServerCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var sslAcceptServerCertEncoded: String { get {...} set {...} }
public var sslAcceptServerCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
Default Value
""
Remarks
This is 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.
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 setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws
SSLCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var sslCertEncoded: String { get {...} set {...} }
public var sslCertEncodedB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded; @property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
Default Value
""
Remarks
This is 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.
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 setSSLCertEncodedB(sslCertEncoded: Data) throws public func setSSLCertEncoded(sslCertEncoded: String) throws
SSLCertStore Property (AS2Sender Module)
This is the name of the certificate store for the client certificate.
Syntax
public var sslCertStore: String { get {...} set {...} }
public var sslCertStoreB: Data { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore :(NSString*)newSSLCertStore; @property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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., PKCS#12 certificate store).
SSLCertStorePassword Property (AS2Sender 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
public var sslCertStorePassword: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;
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.
SSLCertStoreType Property (AS2Sender Module)
This is the type of certificate store for this certificate.
Syntax
public var sslCertStoreType: As2senderSSLCertStoreTypes { get {...} set {...} }
public enum As2senderSSLCertStoreTypes: 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 cstPKCS11 = 23 case cstAuto = 99 }
@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType :(int)newSSLCertStoreType;
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SSLCertSubject Property (AS2Sender Module)
This is the subject of the certificate used for client authentication.
Syntax
public var sslCertSubject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject :(NSString*)newSSLCertSubject;
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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 setSSLCertSubject(sslCertSubject: String) throws
SSLProvider Property (AS2Sender Module)
This specifies the SSL/TLS implementation to use.
Syntax
public var sslProvider: As2senderSSLProviders { get {...} set {...} }
public enum As2senderSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider :(int)newSSLProvider;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.
SSLServerCertEncoded Property (AS2Sender Module)
This is the certificate (PEM/Base64 encoded).
Syntax
public var sslServerCertEncoded: String { get {...} }
public var sslServerCertEncodedB: Data { get {...} }
@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded; @property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
Default Value
""
Remarks
This is 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.
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 setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws
Subject Property (AS2Sender Module)
The subject of the message.
Syntax
public var subject: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=subject,setter=setSubject:) NSString* subject; - (NSString*)subject; - (void)setSubject :(NSString*)newSubject;
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.
Timeout Property (AS2Sender Module)
A timeout for the module.
Syntax
public var timeout: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout; - (int)timeout; - (void)setTimeout :(int)newTimeout;
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class .
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
URL Property (AS2Sender Module)
The URL to which the request is made.
Syntax
public var url: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL; - (NSString*)URL; - (void)setURL :(NSString*)newURL;
Default Value
""
Remarks
This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https".
UseOAEP Property (AS2Sender Module)
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).
Syntax
public var useOAEP: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=useOAEP,setter=setUseOAEP:) BOOL useOAEP; - (BOOL)useOAEP; - (void)setUseOAEP :(BOOL)newUseOAEP;
Default Value
False
Remarks
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the class will use PKCS1.
To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams
UsePSS Property (AS2Sender Module)
This property specifies whether or not RSA-PSS will be used during signing and verification.
Syntax
public var usePSS: Bool { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=usePSS,setter=setUsePSS:) BOOL usePSS; - (BOOL)usePSS; - (void)setUsePSS :(BOOL)newUsePSS;
Default Value
False
Remarks
This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.
UserAgent Property (AS2Sender Module)
Information about the user agent.
Syntax
public var userAgent: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=userAgent,setter=setUserAgent:) NSString* userAgent; - (NSString*)userAgent; - (void)setUserAgent :(NSString*)newUserAgent;
Default Value
"IPWorks EDI AS2Sender Component - www.nsoftware.com"
Remarks
You may override the default with the name and version of your software.
Config Method (AS2Sender Module)
Sets or retrieves a configuration setting.
Syntax
- (NSString*)config:(NSString*)configurationString;
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoEvents Method (AS2Sender Module)
Processes events from the internal message queue.
Syntax
public func doEvents() throws -> Void
- (void)doEvents;
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Interrupt Method (AS2Sender Module)
Interrupt the current method.
Syntax
public func interrupt() throws -> Void
- (void)interrupt;
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Post Method (AS2Sender Module)
Post data to the AS2 server, and check the receipt.
Syntax
public func post() throws -> Void
- (void)post;
Remarks
Post data to the server. The reply will also be checked, and if a synchronous MDN was requested (i.e., MDNTo is not empty), it will be validated. 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.
ReadAsyncReceipt Method (AS2Sender Module)
Reads an asynchronous MDN receipt from the current HTTP session.
Syntax
public func readAsyncReceipt() throws -> Void
- (void)readAsyncReceipt;
Remarks
ReadAsyncReceipt is used to read an asynchronous MDN receipt from the . The class will fetch the request stream from the HTTP session. MDNReceipt will be populated with a new instance of MDNReceipt.
Reset Method (AS2Sender Module)
Resets the state of the control.
Syntax
public func reset() throws -> Void
- (void)reset;
Remarks
Resets all HTTP headers as well as EDIData, etc. After invoking this method the class may be reused as if it were newly created.
Restart Method (AS2Sender Module)
Restart sending of the file specified by the Etag property.
Syntax
public func restart() throws -> Void
- (void)restart;
Remarks
This method should be called when using the AS2 restart functionality. When called, the class will process the file and cache the processed contents to the RestartDirectory. Before sending, the Etag property will be populated with a unique Etag which identifies the processed file.
If sending is interrupted or fails, this method should be called to restart sending of the previously processed file starting where the interruption occurred. In order to restart from the last transfer, the Etag must be populated with the value from the last connection.
NOTE: When using restart functionality, the data is completely processed to the RestartDirectory before sending begins.
SendCEMRequest Method (AS2Sender Module)
Sends a Certificate Exchange Messaging (CEM) request.
Syntax
- (void)sendCEMRequest:(NSString*)requestId;
Remarks
This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails.
Certificate Exchange Messaging (CEM) allows for new certificates to be sent to a recipient and be automatically updated. This removes the requirement to manually send new certificates to a partner via email or other means. When both sides support this functionality updating certificates can be accomplished in a short period of time.
To prepare a CEM request populate the CEMDetails collection with at least one certificate. For instance if the certificate of the application will be updated soon, the CEMDetails may be populated with the corresponding public certificate to be sent to your partner. CEMDetails should only contain public certificates.
Set CEMDetailsRespondByDate to the date by which you expect a response. The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".
Optionally set CEMDetailsCertId to a friendly identifier that the partner may use to help understand the purpose of the new certificate. For instance "New.Encryption.Cert.2014".
Set CEMDetailsResponseURL to the publicly accessible URL where the CEM response will be sent after the partner processes it.
The RequestId parameter uniquely identifies this CEM request and must be saved for use later when receiving the CEM response.
When calling this method the applicable CEMDetails properties are:
- CEMDetailsCertStoreType
- CEMDetailsCertStore
- CEMDetailsCertStorePassword
- CEMDetailsCertSubject
- CEMDetailsRespondByDate
- CEMDetailsResponseURL
- CEMDetailsCertUsage (optional)
- CEMDetailsCertId (optional)
SendCEMResponse Method (AS2Sender Module)
Sends a Certificate Exchange Messaging (CEM) response.
Syntax
- (void)sendCEMResponse:(NSString*)requestId;
Remarks
This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails.
A CEM request must have previously been received using AS2Receiver. To send the CEM response, populate CEMDetails with the certificate information and decide whether to accept or reject the request. The following properties may be set to specify the certificate:
- CEMDetailsCertStoreType
- CEMDetailsCertStore
- CEMDetailsCertSubject
- CEMDetailsCertIssuer
- CEMDetailsCertSerialNumber
After specifying the certificate information choose whether to accept or reject the request. To accept the request set CEMDetailsAccepted to True. To reject the request set CEMDetailsAccepted to False and specify a reason in CEMDetailsRejectionReason.
Call SendCEMResponse and pass the CEM request Id that was retrieved from the request.
SetRequestHeader Method (AS2Sender Module)
Allows the user to set or add arbitrary HTTP request headers.
Syntax
- (void)setRequestHeader:(NSString*)headerName :(NSString*)headerValue;
Remarks
HeaderName should contain the header name, and HeaderValue should contain its value. Use this to set headers such as To, Date, etc. Note that a default value for Date will automatically be determined and this method may be used to override the default.
SetRequestHeader may be used to set any header except for the following: AS2-To, AS2-From, AS2-Version, Subject, Message-Id, Disposition-Notification-To, Disposition-Notification-Options, Receipt-Delivery-Option, Host, Content-Length.
SetTPInfo Method (AS2Sender Module)
A convenient way to set AS2 communication parameters using XML strings.
Syntax
Remarks
SetTPInfo offers a convenient way to set AS2 communication parameters using XML strings. The format of the XML is the same as provided by the method GetTPInfo of AS2ProfileMgr.
The "self" information should always precede the partner information as shown below.
AS2Sender as2sender = new AS2Sender();
AS2Profilemgr mgr = new AS2Profilemgr();
mgr.DataDir = @"C:\as2data";
as2sender.SetTPInfo(mgr.GetTPInfo("self"));
as2sender.SetTPInfo(mgr.GetTPInfo("partnerOrg"));
as2sender.EDIFile = @"C:\as2Data.x12";
as2sender.Post();
VerifyReceipt Method (AS2Sender Module)
Verifies an asynchronous MDN receipt.
Syntax
public func verifyReceipt() throws -> Void
- (void)verifyReceipt;
Remarks
VerifyReceipt verifies the receipt in MDNReceipt against OriginalContentMIC, 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.
This method should be used to verify receipts received asynchronously; i.e., not in the HTTP reply to a POST. When posting, asynchronous MDN delivery may be requested by setting MDNDeliveryOption.
Connected Event (AS2Sender Module)
This event is fired immediately after a connection completes (or fails).
Syntax
- (void)onConnected:(int)statusCode :(NSString*)description;
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
Disconnected Event (AS2Sender Module)
This event is fired when a connection is closed.
Syntax
- (void)onDisconnected:(int)statusCode :(NSString*)description;
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
EndTransfer Event (AS2Sender Module)
This event is fired when a document finishes transferring.
Syntax
func onEndTransfer(direction: Int32)
- (void)onEndTransfer:(int)direction;
Remarks
The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (AS2Sender Module)
Fired when information is available about errors during data delivery.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class .
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.
Header Event (AS2Sender Module)
This event is fired every time a header line comes in.
Syntax
Remarks
The Field parameter contains the name of the HTTP header (same case as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains an empty string.
Note that only the top-level headers will be returned through this event, and that they are available through the ReplyHeaders property.
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (AS2Sender Module)
Fired with log information while processing a message.
Syntax
- (void)onLog:(NSString*)logType :(NSData*)logMessage;
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).
The LogMessage event parameter holds the raw log data.
The LogType event parameter indicates the type of log. Possible values are:
"LOG" | Information about the status of the process. |
"ERR" | An error was encountered. |
"DAT" | The EDI payload. |
"REQ" | The raw request |
"MDN" | The MDN response. |
"DEBUG" | Debug information. |
"DAT.INPUT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.ENCRYPT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.COMPRESS" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.SIGN" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DECRYPT" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DECOMPRESS" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.VERIFY" | Debug information when processing payload. Only applicable when LogDebug is True. |
"DAT.DEBUG" | Debug information when processing payload. Only applicable when LogDebug is True. |
SetCookie Event (AS2Sender Module)
This event is fired for every cookie set by the server.
Syntax
func onSetCookie(name: String, value: String, expires: String, domain: String, path: String, secure: Bool)
- (void)onSetCookie:(NSString*)name :(NSString*)value :(NSString*)expires :(NSString*)domain :(NSString*)path :(BOOL)secure;
Remarks
The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.
The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.
The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.
The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.
The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.
The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.
SSLServerAuthentication Event (AS2Sender Module)
Fired after the server presents its certificate to the client.
Syntax
func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").
SSLStatus Event (AS2Sender Module)
Fired when secure connection progress messages are available.
Syntax
func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AS2Sender Module)
This event is fired when a document starts transferring (after the headers).
Syntax
func onStartTransfer(direction: Int32)
- (void)onStartTransfer:(int)direction;
Remarks
The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (AS2Sender Module)
This event is fired while a document transfers (delivers document).
Syntax
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
CEMDetail Type
This type defines details about the CEM request.
Remarks
This type defines details about the CEM request. Not all fields are applicable for all operations.
Fields
accepted
Bool
Default Value: False
Whether the CEM request is accepted.
Before calling SendCEMResponse set this to True to accept the CEM request.
When processing a CEM response check this property to determine if the request was accepted.
certId
String
Default Value: ""
A user defined identifier for the certificate.
This property defines a user specified identifier for the certificate. This may be set to a value which helps the recipient identify the certificate. For instance "CompanyA.Encryption.Cert.2014".
This property may be set before calling SendCEMRequest or SendCEMResponse from AS2Sender.
This property may be queried when received a CEM request or response with AS2Receiver.
certIssuer
String
Default Value: ""
This property holds the issuer of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.
certSerialNumber
String
Default Value: ""
This property holds the serial number of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.
certStoreB
Data
Default Value: "MY"
The name of the certificate store for the certificate.
This property defines the store location for the type specified by .
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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., PKCS#12 certificate store).
certStore
String
Default Value: "MY"
The name of the certificate store for the certificate.
This property defines the store location for the type specified by .
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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., PKCS#12 certificate store).
certStorePassword
String
Default Value: ""
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
certStoreType
CertStoreTypes
Default Value: 0
The type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
certSubject
String
Default Value: ""
The subject of the certificate.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
certUsage
Int32
Default Value: 15
This property defines which usages are applicable to the certificate. This may be set to a binary 'OR' of one or more of the following values:
- 1 (TLS Client)
- 2 (TLS Server)
- 4 (Encryption)
- 8 (Signature)
rejectionReason
String
Default Value: ""
If is False this property specifies the reason a request was rejected.
When using AS2Sender this may be set to a string value which the recipient will see.
When using AS2Receiver query this property for details on why the request was rejected.
respondByDate
String
Default Value: ""
This property specifies the date by which the other party should respond. If the other party does not respond the new certificate may be used without any further notice. This property exists to assist the recipient in knowing when they should respond by. It does not guarantee a response by the specified date.
The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".
When using AS2Sender set this before calling SendCEMRequest.
When using AS2Receiver this property may be queried.
responseURL
String
Default Value: ""
This property defines the URL to which the response should be sent.
When using AS2Sender set this property before calling SendCEMRequest. This tells the recipient where to send the response.
When using AS2Receiver query this property to determine the URL where the response should be sent.
Constructors
public init()
EDIAttachment Type
This describes the file being attached.
Remarks
Information about the file's location that is being attached to the message is contained here.
Fields
contentType
String
Default Value: ""
The MIME content-type of this EDIAttachment.
dataB
Data
Default Value: ""
This property contains the attachment data.
In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment.
data
String
Default Value: ""
This property contains the attachment data.
In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment.
filename
String
Default Value: ""
The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the .
headers
String
Default Value: ""
The class fills out each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.
name
String
Default Value: ""
is the final name to be associated with the contents of either the or properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.
Constructors
public init()
public init(filename: )
public init(filename: , contentType: )
public init(filename: , contentType: , headers: )
EDIData Type
The EDI payload of the AS2 message.
Remarks
The EDI payload of the AS2 message.
Fields
dataB
Data
Default Value: ""
This property contains the EDI payload of the transmission.
In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.
data
String
Default Value: ""
This property contains the EDI payload of the transmission.
In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.
ediType
String
Default Value: ""
The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".
filename
String
Default Value: ""
In a sender, if is specified, the file specified will be used for the EDI payload of the transmission. will be populated with the name of the file.
In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.
Note: When is set, the data will be written to the stream and this property will not be populated.
name
String
Default Value: "rfc1767.edi"
is the final name to be associated with the contents of either the or properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.
When constructing EDI data to be sent, will be set to the same value as , but can be overridden after setting to indicate that another name should be used in the outbound request's Content-Disposition MIME header.
When receiving EDI data, will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.
Constructors
public init()
public init(data: , eDIType: )
public init(filename: , eDIType: )
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .
Fields
autoDetect
Bool
Default Value: False
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewallType
FirewallTypes
Default Value: 0
This property determines the type of firewall to connect through. The applicable values are as follows:
host
String
Default Value: ""
This property contains the name or IP address of firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class .
password
String
Default Value: ""
This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
port
Int32
Default Value: 0
This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.
Note: This property is set automatically when is set to a valid value. See the description of the property for details.
user
String
Default Value: ""
This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .
Constructors
public init()
HTTPCookie Type
An HTTP cookie can be either sent to or received from the server.
Remarks
An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.
Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.
Fields
domain
String (read-only)
Default Value: ""
This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.
expiration
String (read-only)
Default Value: ""
This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.
name
String
Default Value: ""
This property, contains the name of the cookie.
This property, along with , stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
path
String (read-only)
Default Value: ""
This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.
secure
Bool (read-only)
Default Value: False
This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.
value
String
Default Value: ""
This property contains the value of the cookie. A corresponding value is associated with the cookie specified by . This property holds that value.
The SetCookie event provides the cookies set by the server.
Constructors
public init()
public init(name: , value: )
MDNReceipt Type
The complete MDN Receipt returned by the receiver.
Remarks
The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature.
Fields
contentB
Data
Default Value: ""
This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.
content
String
Default Value: ""
This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.
headerCount
Int32 (read-only)
Default Value: 0
The number of headers in the MDN.
headerField
String (read-only)
Default Value: ""
headerIndex
Int32
Default Value: 0
headers
String
Default Value: ""
Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).
You can also use , , , and to easily iterate through each individual header.
headerValue
String (read-only)
Default Value: ""
mdn
String (read-only)
Default Value: ""
MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.
message
String (read-only)
Default Value: ""
The human-readable portion of the MDN receipt.
The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.
micValue
String (read-only)
Default Value: ""
The Message Integrity Check(s) (one-way hash) of the original EDI message.
An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.
The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".
signingProtocol
String (read-only)
Default Value: ""
This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.
Constructors
public init()
public init(headers: , content: )
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .
Fields
authScheme
ProxyAuthSchemes
Default Value: 0
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.
should be set to authNone (3) when no authentication is expected.
By default, is authBasic (0), and if the and properties are set, the component will attempt basic authentication.
If is set to authDigest (1), digest authentication will be attempted instead.
If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of and .
autoDetect
Bool
Default Value: False
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is .
password
String
Default Value: ""
This property contains a password if authentication is to be used for the proxy.
If is set to Basic Authentication, the and are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
port
Int32
Default Value: 80
This property contains the Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.
server
String
Default Value: ""
If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.
ssl
ProxySSLTypes
Default Value: 0
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
user
String
Default Value: ""
This property contains a username if authentication is to be used for the proxy.
If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.
If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.
Constructors
public init()
public init(server: , port: )
public init(server: , port: , user: , password: )
Config Settings (AS2Sender Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.AS2Sender Config Settings
This setting is provided so that the class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme; setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization setting in the form "Basic [encoded-user-password]".
0 (default) | Basic |
1 | Digest |
2 | Proprietary |
3 | None |
4 | NTLM |
5 | Negotiate |
6 | OAuth |
For security reasons, setting this value will clear the values of User and Password.
When sending, files with extensions ".input", ".sign", ".compress", and ".encrypt" may be created. When receiving, files with extensions ".input", ".verify", ".decompress", and ".decrypt" may be created.
Note that only the base name should be specified as the component will append the appropriate file extension.
Status | Contains information on applied security options and pass/fail status of transmission |
Request | Contains outgoing transmission, with applied security options |
Payload | Contains log of unsecured payload prior to transmission |
Response | For synchronous requests or asynchronous receipts verified with VerifyReceipt, contains MDN receipt, if sent. For asynchronous requests, contains server acknowledgement. |
Errors | A separate file with a .err extension is written when an error is encountered. |
All | All of the above |
In most cases the signature is verified by calculating a Message Integrity Check (MIC) over the exact data that is received. In some cases other software such as Mendelson AS2 may calculate signatures over a version of the data with normalized line endings. During processing attempts to verify a signature that was created in this manner may lead to one of the following errors:
- Unable to verify content integrity: Message digest mismatch in signature.
- The receipt signature could not be verified: Message digest mismatch in signature.
If one of the errors above is encountered and the received data is expected to be otherwise correct setting this setting to True may resolve the issue by normalizing line endings before verifying the signature.
Note: This should only be set to True if there is a specific reason to do so.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
Note: An empty string value indicates that the algorithm specified by OAEPRSAHashAlgorithm is used as the RSA hash algorithm as well.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.
If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class .
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (AS2Sender Module)
AS2Sender Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy performing current action. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URL scheme is invalid. | |
283 No MIME-boundary found. | |
501 Unable to parse the receipt. | |
502 The receipt is signed with an unsupported signature format (details follow). | |
511 Unsupported compression algorithm requested. | |
521 A Message Integrity Check was requested, but not provided in the MDN. | |
522 The Message Integrity Check returned in the MDN is incorrect. | |
523 Unable to parse Message Integrity Check. | |
524 Unrequested hashing algorithm used (check MDNOptions). | |
525 The Message ID returned in the MDN does not match. | |
531 The receipt was unsigned, and a signed receipt was expected. | |
532 The receipt signature could not be verified. | |
533 An MDN was expected in the HTTP reply, but was not returned. | |
600 Failure reported in MDN: Unsupported signing protocol. | |
601 Failure reported in MDN: Unsupported MIC algorithms. | |
602 Failure reported in MDN: Other (details follow). | |
611 Error reported in MDN: Decryption failed. | |
612 Error reported in MDN: Authentication failed. | |
613 Error reported in MDN: Could not verify content integrity. | |
614 Error reported in MDN: Unexpected processing error. | |
615 Error reported in MDN: Other (details follow). | |
621 Warning reported in MDN: Authentication failed, processing continued by receiver. | |
622 Warning reported in MDN: Other (details follow). | |
831 I/O Error (details follow). |
SMIME Errors
10191 Invalid index (RecipientIndex). | |
10192 Message decoding error (code). | |
10193 Unexpected message type. | |
10194 Unsupported hashing/signing algorithm. | |
10195 The message does not have any signers. | |
10196 The message signature could not be verified. | |
10197 Could not locate a suitable decryption certificate. | |
10198 The signer certificate could not be found. | |
10199 No signing certificate was supplied for signing the message. | |
10201 The specified certificate was not the one required. | |
10202 The specified certificate could not be found. | |
10221 Could not acquire CSP. | |
10222 Type validation error. | |
10223 Unsupported key size. | |
10224 Unrecognized Content-Type object identifier. | |
10225 Unrecognized public key format. | |
10226 No choices specified. | |
10228 Must specify output stream. | |
10280 Invalid part index. | |
10281 Unknown MIME type. | |
10283 No MIME-boundary found. | |
10280 Error decoding certificate. |