AS4Client Class
Properties Methods Events Config Settings Errors
The AS4Client class connects to a server to send or receive files.
Class Name
IPWorksEDI_AS4Client
Procedural Interface
ipworksedi_as4client_open(); ipworksedi_as4client_close($res); ipworksedi_as4client_register_callback($res, $id, $function); ipworksedi_as4client_get_last_error($res); ipworksedi_as4client_get_last_error_code($res); ipworksedi_as4client_set($res, $id, $index, $value); ipworksedi_as4client_get($res, $id, $index); ipworksedi_as4client_do_config($res, $configurationstring); ipworksedi_as4client_do_doevents($res); ipworksedi_as4client_do_interrupt($res); ipworksedi_as4client_do_receivefiles($res); ipworksedi_as4client_do_reset($res); ipworksedi_as4client_do_sendfiles($res); ipworksedi_as4client_do_sendreceipt($res);
Remarks
The AS4Client component may be used to send or receive files from a server. The component will connect to a server and either send files (push), or request files to download (pull).
Sending Files
SendFiles sends the files specified by EDIData to URL.
Before calling this method set AgreementRef to the agreement identifier used by both parties. Set AS4From and AS4To. Set EDIData specifies the file(s) to be sent. To encrypt the data set RecipientCerts. To sign the data set SigningCert. The SignerCert property should be set to verify the signed receipt.
When this method is called the file(s) will be sent and any returned receipts will be verified.
To indicate a synchronous receipt is expected set ReceiptReplyMode to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):
- AgreementRef
- AS4From
- AS4To
- EDIData
- URL
- RecipientCerts (required to encrypt)
- SignerCert (required to verify signed receipts)
- SigningCert (required to sign files)
- ConversationId (optional)
- EncryptionAlgorithm (optional)
- LogDirectory (optional)
- MessageId (optional)
- MessageProperties (optional)
- Profile (optional)
- ReceiptReplyMode
- Service (optional)
- ServiceType (optional)
- SignatureAlgorithm (optional)
SendFiles Example (synchronous receipt):
client.Profile = As4clientProfiles.ebpfENTSOG;
//Specify the agreement and party information
client.AgreementRef = "http://agreements.company.com/sign_and_encrypt";
client.AS4From.Role = "Sender";
client.AS4From.Id = "org:b2b:example:company:A";
client.AS4To.Role = "Receiver";
client.AS4To.Id = "org:b2b:example:company:B";
//Configure the component to expect a synchronous receipt.
client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync;
//Company A's private certificate. Used to sign the outgoing message and files.
client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*");
//Company B's public certificate. Used to encrypt the outgoing file.
client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer"));
//Company B's public certificate. Used to verify the signed receipt.
client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer");
client.URL = "http://www.company.com:9090/msh";
EBData data = new EBData();
data.EDIType = "application/edi-x12";
data.Filename = "C:\\files\\myfile.x12";
data.Name = "myfile.x12";
client.EDIData.Add(data);
//Send file(s) and verify the receipt.
client.SendFiles();
The class also supports asynchronous receipts. In this configuration a file is sent from the class to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The AS4Server class may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either AS4Server or AS4Client may be used to verify the receipt.
Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set AsyncReceiptInfoDir before calling SendFiles. The class will automatically store the required information.
See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.
To indicate an asynchronous receipt is expected set ReceiptReplyMode to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):
- AgreementRef
- AS4From
- AS4To
- AsyncReceiptInfoDir
- EDIData
- URL
- RecipientCerts (required to encrypt)
- SignerCert (required to verify signed receipts)
- SigningCert (required to sign files)
- ConversationId (optional)
- EncryptionAlgorithm (optional)
- LogDirectory (optional)
- MessageId (optional)
- MessageProperties (optional)
- OriginalSOAPMessage (optional)
- OriginalSOAPMessageId (optional)
- Profile (optional)
- ReceiptReplyMode
- Service (optional)
- ServiceType (optional)
- SignatureAlgorithm (optional)
SendFiles Example (asynchronous receipt):
client.Profile = As4clientProfiles.ebpfENTSOG;
//Specify the agreement and party information
client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async";
client.AS4From.Role = "Sender";
client.AS4From.Id = "org:b2b:example:company:A";
client.AS4To.Role = "Receiver";
client.AS4To.Id = "org:b2b:example:company:B";
//Configure the component to expect a synchronous receipt.
client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync;
client.AsyncReceiptInfoDir = "C:\\async_info";
//Company A's private certificate. Used to sign the outgoing message and files.
client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*");
//Company B's public certificate. Used to encrypt the outgoing files.
client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer"));
//Company B's public certificate. Used to verify the signed receipt.
client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer");
client.URL = "http://www.company.com:9090/msh";
EBData data = new EBData();
data.EDIType = "application/edi-x12";
data.Filename = "C:\\files\\myfile.x12";
data.Name = "myfile.x12";
client.EDIData.Add(data);
//Send file(s).
client.SendFiles();
At this point the file(s) have been sent, but a receipt has not yet been received. AS4Server can be used
within a web site to listen for the receipt.
//**** Inside a web site ****
As4server server = new As4server;
server.ReadRequest();
if (!String.IsNullOrEmpty(server.IncomingReceipt.Content))
{
server.AsyncReceiptInfoDir = "C:\\async_info";
server.VerifyReceipt();
//The receipt is now verified
}
Receiving Files
ReceiveFiles establishes a connection to the server specified by URL and receives files.
The MPC specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If IncomingDirectory is set before calling this method the files will be written to the specified folder, otherwise inspect EDIData to obtain the received file data. The following properties are applicable when calling this method:
- SigningCert (required to sign the request)
- Certificate (required for decryption)
- SignerCert (required for signature verification)
- URL
- IncomingDirectory (optional)
- LogDirectory
- MPC
- TokenUser
- TokenPassword
- TokenPasswordType
- AS4From
- AS4To
- AgreementRef
- ConversationId
- Service
- ServiceAction
- ServiceType
- MessageId
- Receipt
To bundle the receipt with a subsequent ReceiveFiles call the Receipt property must hold the receipt. If the same instance of the class is being used this is already true since Receipt is populated automatically after receiving the file. To use another instance of the class for multiple calls to ReceiveFiles be sure to save the Receipt's ReceiptContent and ReceiptRefToMessageId values for later use.
ReceiveFiles Example:
client.Profile = As4clientProfiles.ebpfENTSOG;
//Company A's private certificate. Used for signing the request.
client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*");
//Company A's private certificate. Used for decrypting the file.
client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*");
//Company B's public certificate. Used for signature verification.
client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer");
client.URL = "http://www.company.com:9090/msh";
//Message Channel id
client.MPC = "mpc_a";
client.IncomingDirectory = "C:\\incoming_dir";
client.ReceiveFiles();
//Inspect client.AgreementRef and other properties for information about the received files
Console.WriteLine(client.AgreementRef);
Console.WriteLine(client.AS4From.Id);
Console.WriteLine(client.AS4To.Id);
Console.WriteLine(client.ConversationId);
//Save the receipt for later use
string receiptContent = client.Receipt.Content;
string receiptRefId = client.Receipt.RefToMessageId;
At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt
property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message
will be included with the request.
client.Receipt = new EBReceipt(receiptRefId, receiptContent);
client.ReceiveFiles(); //This will now include the bundled receipt
Sending Asynchronous Receipts
SendReceipt sends an asynchronous receipt to the URL.
This method is typically used in conjunction with AS4Server to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate Receipt and call this method.
//Send an asynchronous receipt
client.URL = ""http://www.company.com:9090/msh"";
client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content);
client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync;
client.SendReceipt();
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AgreementRef | The agreement reference. |
AS4FromId | The Id of the party. |
AS4FromIdType | The optional type of the Id. |
AS4FromRole | This property specifies the role of the party. |
AS4ToId | The Id of the party. |
AS4ToIdType | The optional type of the Id. |
AS4ToRole | This property specifies the role of the party. |
AsyncReceiptInfoDir | A directory to hold information used for asynchronous receipt verification. |
CertEncoded | This is the certificate (PEM/Base64 encoded). |
CertStore | This is the name of the certificate store for the client certificate. |
CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
CertStoreType | This is the type of certificate store for this certificate. |
CertSubject | This is the subject of the certificate used for client authentication. |
CompressionFormat | The compression format (if any) to use. |
ConversationId | The Conversation Id of the message. |
CookieCount | The number of records in the Cookie arrays. |
CookieDomain | This is the domain of a received cookie. |
CookieExpiration | This property contains an expiration time for the cookie (if provided by the server). |
CookieName | This property, contains the name of the cookie. |
CookiePath | This property contains a path name to limit the cookie to (if provided by the server). |
CookieSecure | This property contains the security flag of the received cookie. |
CookieValue | This property contains the value of the cookie. |
EDIDataCount | The number of records in the EDI arrays. |
EDIData | This property contains the EDI payload of the transmission. |
EDIEDIType | The Content-Type of the EDI message. |
EDIFilename | When sending, if Filename is specified, the file specified will be used for the EDI payload of the transmission. |
EDIName | Name is the final name to be associated with the contents of either the Data or FileName properties. |
EDIPropertyCount | The number of properties for this file. |
EDIPropertyIndex | Selects a property at the specified index. |
EDIPropertyName | The name of the property. |
EDIPropertyValue | The value of the property. |
EDISchemaLocation | The SchemaLocation , SchemaNamespace , and SchemaVersion optionally define the schema that applies to this particular file. |
EDISchemaNamespace | The namespace of the schema. |
EDISchemaVersion | The version of the schema. |
EncryptionAlgorithm | The algorithm used to encrypt the EDI data. |
ErrorCount | The number of records in the Error arrays. |
ErrorCategory | The category of error. |
ErrorCode | The error code. |
ErrorDescription | The description of the error. |
ErrorDetail | Additional details about the error. |
ErrorOrigin | The module within which the error occurred. |
ErrorRefMessageId | The MessageId to which the error applies. |
ErrorSeverity | The severity of the error. |
ErrorShortDescription | A short description of the error. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
IncomingDirectory | The directory to which incoming files are saved. |
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. |
MessageId | The unique Id of the message. |
MessagePropertyCount | The number of records in the MessageProperty arrays. |
MessagePropertyName | This property defines the name of the message property. |
MessagePropertyPropertyType | The optional type of the message property. |
MessagePropertyValue | The value of the message property. |
MPC | The MPC (Message Partition Channel) from which to receive files. |
OriginalSOAPMessage | The original SOAP message used to verify the receipt. |
OriginalSOAPMessageId | The original SOAP message Id used to verify the receipt. |
Profile | The AS4 profile. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
ReceiptContent | The content of the receipt. |
ReceiptRefToMessageId | The Message Id to which this receipt applies. |
ReceiptReplyMode | The expected receipt reply mode. |
RecipientCertCount | The number of records in the RecipientCert arrays. |
RecipientCertEncoded | This is the certificate (PEM/Base64 encoded). |
RefToMessageId | Specifies the RefToMessageId in the message. |
Service | The service which acts on the message. |
ServiceAction | The action within a service that acts on the message. |
ServiceType | The type of service. |
SignatureAlgorithm | Signature algorithm to be used in the message. |
SignerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SignerCertStore | This is the name of the certificate store for the client certificate. |
SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SignerCertStoreType | This is the type of certificate store for this certificate. |
SignerCertSubject | This is the subject of the certificate used for client authentication. |
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). |
Timeout | A timeout for the class. |
TokenPassword | The password used in UsernameToken authentication. |
TokenPasswordType | The password type used in UsernameToken authentication. |
TokenUser | The username used in UsernameToken authentication. |
URL | The URL to which the request is made. |
Method List
The following is the full list of the methods of the class 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. |
ReceiveFiles | Connects to a server to receive files. |
Reset | Resets the state of the control. |
SendFiles | Sends file(s) to the specified server and verify the receipt (if present). |
SendReceipt | Sends an asynchronous receipt. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
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. |
RecipientInfo | Fired for each recipient certificate of the encrypted message. |
SetCookie | This event is fired for every cookie set by the server. |
SignerCertInfo | This event is fired during verification of the signed message. |
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). |
TokenAuthentication | Fired when the server makes use of UsernameToken authentication. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AgreementRefPMode | AgreementRef PMode of message. |
AgreementRefType | The type of AgreementRef. |
AllowWarnings | Whether warnings are interpreted as fatal errors. |
AttachXMLFiles | Whether to send XML files as attachments or within the SOAP body. |
Authorization | The Authorization string to be sent to the server. |
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
CloseStreamAfterProcessing | Whether to close the input or output stream after processing. |
CompressXMLPayloads | Whether to compress XML data. |
ContentTransferEncoding | The content encoding of the payload data. |
DetectDuplicates | Whether to detect duplicate messages when receiving. |
EBPrefix | Specifies the prefix to use for messaging. |
EDIDataPartId[i] | Specified the part Id at the given index. |
EnableTokenReferenceTokenType | Whether to include the TokenType attribute in a SecurityTokenReference element. |
EncryptionSecurityTokenFormat | The format to use for the security token when encryption. |
FilenameProperty | Defines a part property to hold the filename. |
ForceSigningCert | Whether to force only the SigningCert to be used for signing. |
FromId[i] | The Id of the party specified by AS4From. |
FromIdCount | The number of Ids for the party specified by AS4From. |
FromIdType[i] | The Id type of the party specified by AS4From. |
IdRight | A custom Id for the right side of the MessageId. |
IncludeHeaders | Whether headers are included when posting to a file. |
KeyAgreementMethod | The agreement method used for KeyWrap encryption algorithms. |
KeyDerivationConcatKDFDigestMethod | The digest method used for the ConcatKDF key derivation method. |
KeyDerivationMethod | The key derivation method used for KeyWrap encryption algorithms. |
KeyEncryptionAlgorithm | The algorithm used to encrypt the key. |
LogLevel | The level of information to log. |
LogOptions | The information to be written to log files. |
MessageHeaders | Returns the headers of the message. |
MessageType | Indicates the type of message received. |
NormalizeIssuerSubject | Whether to normalize the certificate subject within the X509Data element. |
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. |
PullAction | The Action to use with selective message pulling. |
PullAgreementRef | The AgreementRef to use with selective message pulling. |
PullRefToMessageId | The RefToMessageId to use with selective message pulling. |
PullService | The Service to use with selective message pulling. |
PullServiceType | The ServiceType to use with selective message pulling. |
ReferenceHashAlgorithm | The hash algorithm used to has the data specified in the reference of a signature. |
RequireEncryption | Whether encryption is required when processing received messages. |
RequireSignature | Whether a signature is required when processing received messages. |
ResponseFile | A file from which to read the response. |
ResponseHeaders | The headers for the AS4 response message. |
SignerCACert | The CA certificates that issued the signer certificate. |
SigningSecurityTokenFormat | The format to use for the security token when signing. |
TempPath | Where temporary files are optionally written. |
ToId[i] | The Id of the party specified by AS4To. |
ToIdCount | The number of Ids for the party specified by AS4To. |
ToIdType[i] | The Id type of the party specified by AS4To. |
TransformReceipt | Whether to canonicalize the received receipt. |
UseNonce | Whether to use a nonce in UsernameToken authentication. |
User | A user name if authentication is to be used. |
UseTransformedXMLAttachment | Whether to send the canonicalized XML. |
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 class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class 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 class. |
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 class. |
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. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
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 class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
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. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AgreementRef Property (IPWorksEDI_AS4Client Class)
The agreement reference.
Object Oriented Interface
public function getAgreementRef(); public function setAgreementRef($value);
Procedural Interface
ipworksedi_as4client_get($res, 1 ); ipworksedi_as4client_set($res, 1, $value );
Default Value
''
Remarks
This property holds a value identifying the agreement between the two parties. The agreement is made outside the scope of the request and response and governs details about the interaction including reply mode, signing and encryption options, etc.
The value of this property should be set to a mutually agreed upon identifier. Both parties will use this value know what the expected requirements are for a particular request or response.
The format of this value is typically a URI, such as "http://mycompany.com/agreement_01" but can be any unique string that both parties are configured to accept. Another common format is the concatenation of the AS4From and AS4To values.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef"
Data Type
String
AS4FromId Property (IPWorksEDI_AS4Client Class)
The Id of the party.
Object Oriented Interface
public function getAS4FromId(); public function setAS4FromId($value);
Procedural Interface
ipworksedi_as4client_get($res, 2 ); ipworksedi_as4client_set($res, 2, $value );
Default Value
''
Remarks
The Id of the party. This value is required.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"
Data Type
String
AS4FromIdType Property (IPWorksEDI_AS4Client Class)
The optional type of the Id.
Object Oriented Interface
public function getAS4FromIdType(); public function setAS4FromIdType($value);
Procedural Interface
ipworksedi_as4client_get($res, 3 ); ipworksedi_as4client_set($res, 3, $value );
Default Value
''
Remarks
The optional type of the Id. If specified this value should be the domain to which the Id belongs.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"
Data Type
String
AS4FromRole Property (IPWorksEDI_AS4Client Class)
This property specifies the role of the party.
Object Oriented Interface
public function getAS4FromRole(); public function setAS4FromRole($value);
Procedural Interface
ipworksedi_as4client_get($res, 4 ); ipworksedi_as4client_set($res, 4, $value );
Default Value
''
Remarks
This property specifies the role of the party. This may be any value agreed upon by the trading partners.
In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator".
In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder".
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"
Data Type
String
AS4ToId Property (IPWorksEDI_AS4Client Class)
The Id of the party.
Object Oriented Interface
public function getAS4ToId(); public function setAS4ToId($value);
Procedural Interface
ipworksedi_as4client_get($res, 5 ); ipworksedi_as4client_set($res, 5, $value );
Default Value
''
Remarks
The Id of the party. This value is required.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"
Data Type
String
AS4ToIdType Property (IPWorksEDI_AS4Client Class)
The optional type of the Id.
Object Oriented Interface
public function getAS4ToIdType(); public function setAS4ToIdType($value);
Procedural Interface
ipworksedi_as4client_get($res, 6 ); ipworksedi_as4client_set($res, 6, $value );
Default Value
''
Remarks
The optional type of the Id. If specified this value should be the domain to which the Id belongs.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"
Data Type
String
AS4ToRole Property (IPWorksEDI_AS4Client Class)
This property specifies the role of the party.
Object Oriented Interface
public function getAS4ToRole(); public function setAS4ToRole($value);
Procedural Interface
ipworksedi_as4client_get($res, 7 ); ipworksedi_as4client_set($res, 7, $value );
Default Value
''
Remarks
This property specifies the role of the party. This may be any value agreed upon by the trading partners.
In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator".
In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder".
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"
Data Type
String
AsyncReceiptInfoDir Property (IPWorksEDI_AS4Client Class)
A directory to hold information used for asynchronous receipt verification.
Object Oriented Interface
public function getAsyncReceiptInfoDir(); public function setAsyncReceiptInfoDir($value);
Procedural Interface
ipworksedi_as4client_get($res, 8 ); ipworksedi_as4client_set($res, 8, $value );
Default Value
''
Remarks
This setting specifies a directory which holds information about the original message that was sent.
When sending files and requesting asynchronous receipts set this directory to a location where data can be stored. When the receipt is later received this property should be set so original message information can be read in order to verify the receipt.
As an alternative the original message information may be manually stored by saving the values of OriginalSOAPMessage and OriginalSOAPMessageId after sending a file. In this case OriginalSOAPMessage and OriginalSOAPMessageId should be populated before verifying the receipt.
See the VerifyReceipt method of AS4Server for more details about verifying asynchronous receipts.
Data Type
String
CertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getCertEncoded(); public function setCertEncoded($value);
Procedural Interface
ipworksedi_as4client_get($res, 10 ); ipworksedi_as4client_set($res, 10, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
CertStore Property (IPWorksEDI_AS4Client Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getCertStore(); public function setCertStore($value);
Procedural Interface
ipworksedi_as4client_get($res, 26 ); ipworksedi_as4client_set($res, 26, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject 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).
Data Type
Binary String
CertStorePassword Property (IPWorksEDI_AS4Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getCertStorePassword(); public function setCertStorePassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 27 ); ipworksedi_as4client_set($res, 27, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
CertStoreType Property (IPWorksEDI_AS4Client Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getCertStoreType(); public function setCertStoreType($value);
Procedural Interface
ipworksedi_as4client_get($res, 28 ); ipworksedi_as4client_set($res, 28, $value );
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 CertStore and set CertStorePassword 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. |
Data Type
Integer
CertSubject Property (IPWorksEDI_AS4Client Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getCertSubject(); public function setCertSubject($value);
Procedural Interface
ipworksedi_as4client_get($res, 29 ); ipworksedi_as4client_set($res, 29, $value );
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.
Data Type
String
CompressionFormat Property (IPWorksEDI_AS4Client Class)
The compression format (if any) to use.
Object Oriented Interface
public function getCompressionFormat(); public function setCompressionFormat($value);
Procedural Interface
ipworksedi_as4client_get($res, 37 ); ipworksedi_as4client_set($res, 37, $value );
Default Value
0
Remarks
This setting specifies the compression format to be applied to the parts specified by EDIData. When Profile is set to Standard the default value is 0 (ebcfNone). When Profile is set to ENTSOG or eDelivery the default value is 1 (ebcfGZIP).
Possible values are:
- 0 (ebcfNone - default for Standard)
- 1 (ebcfGZIP - default for ENTSOG and eDelivery)
Note: When Profile is set to Standard the first EDIData part will be included in the SOAP body if the EDIEDIType is "text/xml" or "application/xml". In that case since the data is included in the SOAP body it will not be compressed. When Profile is set to ENTSOG all EDIData parts are compressed.
Data Type
Integer
ConversationId Property (IPWorksEDI_AS4Client Class)
The Conversation Id of the message.
Object Oriented Interface
public function getConversationId(); public function setConversationId($value);
Procedural Interface
ipworksedi_as4client_get($res, 38 ); ipworksedi_as4client_set($res, 38, $value );
Default Value
''
Remarks
This property specifies an Id that may be used to identify a set of related messages. This is required and if a value is not specified one will automatically be created.
Note: When Profile is set to ebpfENTSOG this value will always be empty.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:ConversationId"
Data Type
String
CookieCount Property (IPWorksEDI_AS4Client Class)
The number of records in the Cookie arrays.
Object Oriented Interface
public function getCookieCount(); public function setCookieCount($value);
Procedural Interface
ipworksedi_as4client_get($res, 39 ); ipworksedi_as4client_set($res, 39, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at CookieCount - 1.This property is not available at design time.
Data Type
Integer
CookieDomain Property (IPWorksEDI_AS4Client Class)
This is the domain of a received cookie.
Object Oriented Interface
public function getCookieDomain($cookieindex);
Procedural Interface
ipworksedi_as4client_get($res, 40 , $cookieindex);
Default Value
''
Remarks
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.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
String
CookieExpiration Property (IPWorksEDI_AS4Client Class)
This property contains an expiration time for the cookie (if provided by the server).
Object Oriented Interface
public function getCookieExpiration($cookieindex);
Procedural Interface
ipworksedi_as4client_get($res, 41 , $cookieindex);
Default Value
''
Remarks
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.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
String
CookieName Property (IPWorksEDI_AS4Client Class)
This property, contains the name of the cookie.
Object Oriented Interface
public function getCookieName($cookieindex); public function setCookieName($cookieindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 42 , $cookieindex); ipworksedi_as4client_set($res, 42, $value , $cookieindex);
Default Value
''
Remarks
This property, contains the name of the cookie.
This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is not available at design time.
Data Type
String
CookiePath Property (IPWorksEDI_AS4Client Class)
This property contains a path name to limit the cookie to (if provided by the server).
Object Oriented Interface
public function getCookiePath($cookieindex);
Procedural Interface
ipworksedi_as4client_get($res, 43 , $cookieindex);
Default Value
''
Remarks
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.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
String
CookieSecure Property (IPWorksEDI_AS4Client Class)
This property contains the security flag of the received cookie.
Object Oriented Interface
public function getCookieSecure($cookieindex);
Procedural Interface
ipworksedi_as4client_get($res, 44 , $cookieindex);
Default Value
false
Remarks
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.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CookieValue Property (IPWorksEDI_AS4Client Class)
This property contains the value of the cookie.
Object Oriented Interface
public function getCookieValue($cookieindex); public function setCookieValue($cookieindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 45 , $cookieindex); ipworksedi_as4client_set($res, 45, $value , $cookieindex);
Default Value
''
Remarks
This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.
The SetCookie event provides the cookies set by the server.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is not available at design time.
Data Type
String
EDIDataCount Property (IPWorksEDI_AS4Client Class)
The number of records in the EDI arrays.
Object Oriented Interface
public function getEDIDataCount(); public function setEDIDataCount($value);
Procedural Interface
ipworksedi_as4client_get($res, 46 ); ipworksedi_as4client_set($res, 46, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
- EDIData
- EDIEDIType
- EDIFilename
- EDIName
- EDIPropertyCount
- EDIPropertyIndex
- EDIPropertyName
- EDIPropertyValue
- EDISchemaLocation
- EDISchemaNamespace
- EDISchemaVersion
This property is not available at design time.
Data Type
Integer
EDIData Property (IPWorksEDI_AS4Client Class)
This property contains the EDI payload of the transmission.
Object Oriented Interface
public function getEDIData($edidataindex); public function setEDIData($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 47 , $edidataindex); ipworksedi_as4client_set($res, 47, $value , $edidataindex);
Default Value
''
Remarks
This property contains the EDI payload of the transmission.
When sending files this may be specified to the data to be sent. This can be used as an alternative to setting EDIFilename.
When receiving files this will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error. If so, Data will contain the full decrypted text of the EDI message.
This property defines the EDI data to be sent. This may include multiple files.
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
Binary String
EDIEDIType Property (IPWorksEDI_AS4Client Class)
The Content-Type of the EDI message.
Object Oriented Interface
public function getEDIEDIType($edidataindex); public function setEDIEDIType($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 48 , $edidataindex); ipworksedi_as4client_set($res, 48, $value , $edidataindex);
Default Value
''
Remarks
The Content-Type of the EDI message. Sample values are "application/edi-x12", "application/edifact" or "application/xml".
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDIFilename Property (IPWorksEDI_AS4Client Class)
When sending, if Filename is specified, the file specified will be used for the EDI payload of the transmission.
Object Oriented Interface
public function getEDIFilename($edidataindex); public function setEDIFilename($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 49 , $edidataindex); ipworksedi_as4client_set($res, 49, $value , $edidataindex);
Default Value
''
Remarks
When sending, if EDIFilename is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.
When receiving, if IncomingDirectory is set, this will be populated with the name of the file which contains the processed message contents.
Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDIName Property (IPWorksEDI_AS4Client Class)
Name is the final name to be associated with the contents of either the Data or FileName properties.
Object Oriented Interface
public function getEDIName($edidataindex); public function setEDIName($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 50 , $edidataindex); ipworksedi_as4client_set($res, 50, $value , $edidataindex);
Default Value
'rfc1767.edi'
Remarks
EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.
When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.
When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDIPropertyCount Property (IPWorksEDI_AS4Client Class)
The number of properties for this file.
Object Oriented Interface
public function getEDIPropertyCount($edidataindex); public function setEDIPropertyCount($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 51 , $edidataindex); ipworksedi_as4client_set($res, 51, $value , $edidataindex);
Default Value
0
Remarks
The number of properties for this file.
Each file may contain zero or more properties associated with it. This property, in conjunction with EDIPropertyIndex, EDIPropertyName, and EDIPropertyValue can be used to specify properties when sending and read properties when receiving.
Sending
When sending files to add properties set EDIPropertyCount to specify the number of properties. Then set
EDIPropertyIndex to select the property. Set EDIPropertyName and EDIPropertyValue to define the values
for the property at EDIPropertyIndex. For instance:
data = new EBData();
data.EDIType = "image/jpeg";
data.Filename = "..\\1.jpg";
data.Name = "1.jpg";
data.PropertyCount = 2; //Define two properties
data.PropertyIndex = 0; //Select the first property
data.PropertyName = "name1";
data.PropertyValue = "value1";
data.PropertyIndex = 1; //Select the second property
data.PropertyName = "name2";
data.PropertyValue = "value2";
Receiving
When receiving files these properties may be queried to retrieve the values set by the sender. Inspect EDIPropertyCount to obtain the number of properties. Next set EDIPropertyIndex to select a property and query EDIPropertyName and EDIPropertyValue. For instance:
for (int i = 0; i < server.EDIData[0].PropertyCount;i++)
{
server.EDIData[0].PropertyIndex = i;
Console.WriteLine(server.EDIData[0].PropertyName + ": " + server.EDIData[0].PropertyValue);
}
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
Integer
EDIPropertyIndex Property (IPWorksEDI_AS4Client Class)
Selects a property at the specified index.
Object Oriented Interface
public function getEDIPropertyIndex($edidataindex); public function setEDIPropertyIndex($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 52 , $edidataindex); ipworksedi_as4client_set($res, 52, $value , $edidataindex);
Default Value
0
Remarks
Selects a property at the specified index.
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
Integer
EDIPropertyName Property (IPWorksEDI_AS4Client Class)
The name of the property.
Object Oriented Interface
public function getEDIPropertyName($edidataindex); public function setEDIPropertyName($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 53 , $edidataindex); ipworksedi_as4client_set($res, 53, $value , $edidataindex);
Default Value
''
Remarks
The name of the property.
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDIPropertyValue Property (IPWorksEDI_AS4Client Class)
The value of the property.
Object Oriented Interface
public function getEDIPropertyValue($edidataindex); public function setEDIPropertyValue($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 54 , $edidataindex); ipworksedi_as4client_set($res, 54, $value , $edidataindex);
Default Value
''
Remarks
The value of the property.
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDISchemaLocation Property (IPWorksEDI_AS4Client Class)
The SchemaLocation , SchemaNamespace , and SchemaVersion optionally define the schema that applies to this particular file.
Object Oriented Interface
public function getEDISchemaLocation($edidataindex); public function setEDISchemaLocation($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 55 , $edidataindex); ipworksedi_as4client_set($res, 55, $value , $edidataindex);
Default Value
''
Remarks
The EDISchemaLocation, EDISchemaNamespace, and EDISchemaVersion optionally define the schema that applies to this particular file. This may be used by the receiving party to properly interpret the file data.
Schema information is not required, but if schema information is included EDISchemaLocation is required and must be set to the URI of the schema.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@location"
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDISchemaNamespace Property (IPWorksEDI_AS4Client Class)
The namespace of the schema.
Object Oriented Interface
public function getEDISchemaNamespace($edidataindex); public function setEDISchemaNamespace($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 56 , $edidataindex); ipworksedi_as4client_set($res, 56, $value , $edidataindex);
Default Value
''
Remarks
The namespace of the schema. This property is optional. Refer to EDISchemaLocation for details.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace"
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EDISchemaVersion Property (IPWorksEDI_AS4Client Class)
The version of the schema.
Object Oriented Interface
public function getEDISchemaVersion($edidataindex); public function setEDISchemaVersion($edidataindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 57 , $edidataindex); ipworksedi_as4client_set($res, 57, $value , $edidataindex);
Default Value
''
Remarks
The version of the schema. This property is optional. Refer to EDISchemaLocation for details.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace"
The $edidataindex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.
This property is not available at design time.
Data Type
String
EncryptionAlgorithm Property (IPWorksEDI_AS4Client Class)
The algorithm used to encrypt the EDI data.
Object Oriented Interface
public function getEncryptionAlgorithm(); public function setEncryptionAlgorithm($value);
Procedural Interface
ipworksedi_as4client_get($res, 58 ); ipworksedi_as4client_set($res, 58, $value );
Default Value
'AES128GCM'
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
- DES
- AESCBC128
- AESCBC192
- AESCBC256
- AES128GCM (default)
- AES192GCM
- AES256GCM
Data Type
String
ErrorCount Property (IPWorksEDI_AS4Client Class)
The number of records in the Error arrays.
Object Oriented Interface
public function getErrorCount(); public function setErrorCount($value);
Procedural Interface
ipworksedi_as4client_get($res, 59 ); ipworksedi_as4client_set($res, 59, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
- ErrorCategory
- ErrorCode
- ErrorDescription
- ErrorDetail
- ErrorOrigin
- ErrorRefMessageId
- ErrorSeverity
- ErrorShortDescription
This property is not available at design time.
Data Type
Integer
ErrorCategory Property (IPWorksEDI_AS4Client Class)
The category of error.
Object Oriented Interface
public function getErrorCategory($errorindex); public function setErrorCategory($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 60 , $errorindex); ipworksedi_as4client_set($res, 60, $value , $errorindex);
Default Value
''
Remarks
The category of error. Typical values include "Content", "Packaging", "UnPackaging", "Communication", and "InternalProcess". This value is optional.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
ErrorCode Property (IPWorksEDI_AS4Client Class)
The error code.
Object Oriented Interface
public function getErrorCode($errorindex); public function setErrorCode($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 61 , $errorindex); ipworksedi_as4client_set($res, 61, $value , $errorindex);
Default Value
''
Remarks
The error code. This value is required. The standard format is "EBMS:0001", where "0001" is the numeric code portion.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
ErrorDescription Property (IPWorksEDI_AS4Client Class)
The description of the error.
Object Oriented Interface
public function getErrorDescription($errorindex); public function setErrorDescription($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 62 , $errorindex); ipworksedi_as4client_set($res, 62, $value , $errorindex);
Default Value
''
Remarks
The description of the error. This value is optional.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
ErrorDetail Property (IPWorksEDI_AS4Client Class)
Additional details about the error.
Object Oriented Interface
public function getErrorDetail($errorindex); public function setErrorDetail($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 63 , $errorindex); ipworksedi_as4client_set($res, 63, $value , $errorindex);
Default Value
''
Remarks
Additional details about the error. This may include other helpful information such as a stack trace. This value is optional.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
ErrorOrigin Property (IPWorksEDI_AS4Client Class)
The module within which the error occurred.
Object Oriented Interface
public function getErrorOrigin($errorindex); public function setErrorOrigin($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 64 , $errorindex); ipworksedi_as4client_set($res, 64, $value , $errorindex);
Default Value
''
Remarks
The module within which the error occurred. Typical values include "ebMS", "reliability", and "security". This value is optional.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
ErrorRefMessageId Property (IPWorksEDI_AS4Client Class)
The MessageId to which the error applies.
Object Oriented Interface
public function getErrorRefMessageId($errorindex); public function setErrorRefMessageId($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 65 , $errorindex); ipworksedi_as4client_set($res, 65, $value , $errorindex);
Default Value
''
Remarks
The MessageId to which the error applies. This is optional but should be supplied if possible.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
ErrorSeverity Property (IPWorksEDI_AS4Client Class)
The severity of the error.
Object Oriented Interface
public function getErrorSeverity($errorindex); public function setErrorSeverity($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 66 , $errorindex); ipworksedi_as4client_set($res, 66, $value , $errorindex);
Default Value
0
Remarks
The severity of the error. Possible values are:
- 0 (ebstWarning - default)
- 1 (ebstFailure)
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
Integer
ErrorShortDescription Property (IPWorksEDI_AS4Client Class)
A short description of the error.
Object Oriented Interface
public function getErrorShortDescription($errorindex); public function setErrorShortDescription($errorindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 67 , $errorindex); ipworksedi_as4client_set($res, 67, $value , $errorindex);
Default Value
''
Remarks
A short description of the error. This may be helpful for logging or readability. This value is optional.
The $errorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.
This property is not available at design time.
Data Type
String
FirewallAutoDetect Property (IPWorksEDI_AS4Client Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
ipworksedi_as4client_get($res, 68 ); ipworksedi_as4client_set($res, 68, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (IPWorksEDI_AS4Client Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
ipworksedi_as4client_get($res, 69 ); ipworksedi_as4client_set($res, 69, $value );
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (IPWorksEDI_AS4Client Class)
This property contains the name or IP address of firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
ipworksedi_as4client_get($res, 70 ); ipworksedi_as4client_set($res, 70, $value );
Default Value
''
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (IPWorksEDI_AS4Client Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 71 ); ipworksedi_as4client_set($res, 71, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (IPWorksEDI_AS4Client Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
ipworksedi_as4client_get($res, 72 ); ipworksedi_as4client_set($res, 72, $value );
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (IPWorksEDI_AS4Client Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
ipworksedi_as4client_get($res, 73 ); ipworksedi_as4client_set($res, 73, $value );
Default Value
''
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
IncomingDirectory Property (IPWorksEDI_AS4Client Class)
The directory to which incoming files are saved.
Object Oriented Interface
public function getIncomingDirectory(); public function setIncomingDirectory($value);
Procedural Interface
ipworksedi_as4client_get($res, 74 ); ipworksedi_as4client_set($res, 74, $value );
Default Value
''
Remarks
If IncomingDirectory is set, the received files will be stored in the specified directory. If a filename is specified in the EDI message, the component will write to the specified filename, otherwise, a filename will be automatically generated based on a timestamp of the incoming transmission. In either case, if the filename exists on disk, the data will be written to the same name with a "-duplicate?" appended to the filename, where "?" is the number of duplicates.
This property is optional, if not set file data will be stored in EDIData.
Data Type
String
LocalHost Property (IPWorksEDI_AS4Client Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworksedi_as4client_get($res, 75 ); ipworksedi_as4client_set($res, 75, $value );
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.
Data Type
String
LogDirectory Property (IPWorksEDI_AS4Client Class)
The path to a directory for logging.
Object Oriented Interface
public function getLogDirectory(); public function setLogDirectory($value);
Procedural Interface
ipworksedi_as4client_get($res, 76 ); ipworksedi_as4client_set($res, 76, $value );
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 files for each transmission, with separate extensions for each type of data:
Status (.log) | Contains information about the steps taken during processing. |
Request (.out) | Contains the raw request/response that is sent by the class. |
Response (.in) | Contains the raw request/response that is received by the class. |
Incoming ebXML (.ieb) | Contains the incoming ebXML message. |
Outgoing ebXML (.oeb) | Contains the outgoing ebXML message. |
One or more of these log files 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:
%AS4From% | The AS4From value in the message. Note that invalid filename characters will be replaced with the _ character. |
%MessageId% | The MessageId of the transmission, after it is generated. |
%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.
Data Type
String
LogFile Property (IPWorksEDI_AS4Client Class)
The log file written.
Object Oriented Interface
public function getLogFile();
Procedural Interface
ipworksedi_as4client_get($res, 77 );
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 about the steps taken during processing. |
Request (.out) | Contains the raw request/response that is sent by the class. |
Response (.in) | Contains the raw request/response that is received by the class. |
Incoming ebXML (.ieb) | Contains the incoming ebXML message. |
Outgoing ebXML (.oeb) | Contains the outgoing ebXML message. |
One or more of these log files 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:
%AS4From% | The AS4From value in the message. Note that invalid filename characters will be replaced with the _ character. |
%MessageId% | The MessageId of the transmission, after it is generated. |
%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.
This property is read-only.
Data Type
String
MessageId Property (IPWorksEDI_AS4Client Class)
The unique Id of the message.
Object Oriented Interface
public function getMessageId(); public function setMessageId($value);
Procedural Interface
ipworksedi_as4client_get($res, 78 ); ipworksedi_as4client_set($res, 78, $value );
Default Value
''
Remarks
This property defines the unique Id of the message. When sending files the class will automatically generate a value in the format "GUID@nsoftware". When receiving files the Id will be populated with the value read from the message.
In most cases there is no need to set this value, however if a file needs to be retransmitted using the same message Id for reliability this may be set. In AS4Client this may be set before calling SendFiles. In AS4Server this may be set after calling ReadRequest and before calling SendResponse.
This property is not available at design time.
Data Type
String
MessagePropertyCount Property (IPWorksEDI_AS4Client Class)
The number of records in the MessageProperty arrays.
Object Oriented Interface
public function getMessagePropertyCount(); public function setMessagePropertyCount($value);
Procedural Interface
ipworksedi_as4client_get($res, 79 ); ipworksedi_as4client_set($res, 79, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessagePropertyCount - 1.This property is not available at design time.
Data Type
Integer
MessagePropertyName Property (IPWorksEDI_AS4Client Class)
This property defines the name of the message property.
Object Oriented Interface
public function getMessagePropertyName($messagepropertyindex); public function setMessagePropertyName($messagepropertyindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 80 , $messagepropertyindex); ipworksedi_as4client_set($res, 80, $value , $messagepropertyindex);
Default Value
''
Remarks
This property defines the name of the message property. This is required.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/@Name"
The $messagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePropertyCount property.
This property is not available at design time.
Data Type
String
MessagePropertyPropertyType Property (IPWorksEDI_AS4Client Class)
The optional type of the message property.
Object Oriented Interface
public function getMessagePropertyPropertyType($messagepropertyindex); public function setMessagePropertyPropertyType($messagepropertyindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 81 , $messagepropertyindex); ipworksedi_as4client_set($res, 81, $value , $messagepropertyindex);
Default Value
''
Remarks
The optional type of the message property.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/@Type"
The $messagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePropertyCount property.
This property is not available at design time.
Data Type
String
MessagePropertyValue Property (IPWorksEDI_AS4Client Class)
The value of the message property.
Object Oriented Interface
public function getMessagePropertyValue($messagepropertyindex); public function setMessagePropertyValue($messagepropertyindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 82 , $messagepropertyindex); ipworksedi_as4client_set($res, 82, $value , $messagepropertyindex);
Default Value
''
Remarks
The value of the message property.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/"
The $messagepropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePropertyCount property.
This property is not available at design time.
Data Type
String
MPC Property (IPWorksEDI_AS4Client Class)
The MPC (Message Partition Channel) from which to receive files.
Object Oriented Interface
public function getMPC(); public function setMPC($value);
Procedural Interface
ipworksedi_as4client_get($res, 83 ); ipworksedi_as4client_set($res, 83, $value );
Default Value
''
Remarks
This property specifies the MPC (Message Partition Channel) from which to receive files. This must be set before calling ReceiveFiles. The value specified here must be known to the other party.
When left unspecified this indicates the default MPC.
This value corresponds to the ebMS element "eb:Messaging/eb:SignalMessage/eb:PullRequest/@mpc"
Data Type
String
OriginalSOAPMessage Property (IPWorksEDI_AS4Client Class)
The original SOAP message used to verify the receipt.
Object Oriented Interface
public function getOriginalSOAPMessage(); public function setOriginalSOAPMessage($value);
Procedural Interface
ipworksedi_as4client_get($res, 84 ); ipworksedi_as4client_set($res, 84, $value );
Default Value
''
Remarks
OriginalSOAPMessage and OriginalSOAPMessageId may be used as an alternative to AsyncReceiptInfoDir when verifying receipts.
If AsyncReceiptInfoDir is not set when the original message is sent, these values will be populated after the send and the values should be saved.
Before verifying the receipt set these properties to their original values.
This property is not available at design time.
Data Type
String
OriginalSOAPMessageId Property (IPWorksEDI_AS4Client Class)
The original SOAP message Id used to verify the receipt.
Object Oriented Interface
public function getOriginalSOAPMessageId(); public function setOriginalSOAPMessageId($value);
Procedural Interface
ipworksedi_as4client_get($res, 85 ); ipworksedi_as4client_set($res, 85, $value );
Default Value
''
Remarks
OriginalSOAPMessage and OriginalSOAPMessageId may be used as an alternative to AsyncReceiptInfoDir when verifying receipts.
If AsyncReceiptInfoDir is not set when the original message is sent, these values will be populated after the send and the values should be saved.
Before verifying the receipt set these properties to their original values.
This property is not available at design time.
Data Type
String
Profile Property (IPWorksEDI_AS4Client Class)
The AS4 profile.
Object Oriented Interface
public function getProfile(); public function setProfile($value);
Procedural Interface
ipworksedi_as4client_get($res, 86 ); ipworksedi_as4client_set($res, 86, $value );
Default Value
0
Remarks
This property specifies the AS4 profile to use. Different profiles may have different requirements and default options. Setting this property to the correct value ensures that the right options are selected in order to conform to the profile. Possible values are:
0 (ebpfStandard - default) | The AS4 Profile of ebMS 3.0 Version 1.0 OASIS Standard |
1 (ebpfENTSOG) | The ENTSOG AS4 Profile |
2 (ebpfEDelivery) | The eDelivery AS4 Profile |
2 (ebpfBDEW) | The BDEW AS4 Profile |
When Profile is set to ebpfENTSOG the following settings are automatically applied:
Property | Value |
CompressionFormat | ebcfGZIP |
EncryptionAlgorithm | "AES128GCM" |
ConversationId | Remains empty |
SignatureAlgorithm | "SHA256" |
OAEPRSAHashAlgorithm | "SHA256" |
OAEPMGF1HashAlgorithm | "SHA256" |
When Profile is set to ebpfEDelivery the following settings are automatically applied:
Property | Value |
CompressionFormat | ebcfGZIP |
EncryptionAlgorithm | "AES128GCM" |
RequireEncryption | True |
RequireSignature | True |
SignatureAlgorithm | "SHA256" |
OAEPRSAHashAlgorithm | "SHA256" |
OAEPMGF1HashAlgorithm | "SHA256" |
EncryptionSecurityTokenFormat | 1 (Binary) |
SigningSecurityTokenFormat | 1 (Binary) |
Property | Value |
CompressionFormat | ebcfGZIP |
EncryptionAlgorithm | "AES128GCM" |
RequireEncryption | True |
RequireSignature | True |
SignatureAlgorithm | "ECDSASHA256" |
EncryptionSecurityTokenFormat | 0 (X509) |
SigningSecurityTokenFormat | 3 (X509PKIPathv1) |
ForceSigningCert | True |
KeyEncryptionAlgorithm | KW-AES128 |
KeyAgreementMethod | ECDH-ES |
KeyDerivationMethod | ConcatKDF |
KeyDerivationConcatKDFDigestMethod | SHA256 |
Data Type
Integer
ProxyAuthScheme Property (IPWorksEDI_AS4Client Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Object Oriented Interface
public function getProxyAuthScheme(); public function setProxyAuthScheme($value);
Procedural Interface
ipworksedi_as4client_get($res, 87 ); ipworksedi_as4client_set($res, 87, $value );
Default Value
0
Remarks
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 ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (IPWorksEDI_AS4Client Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Object Oriented Interface
public function getProxyAutoDetect(); public function setProxyAutoDetect($value);
Procedural Interface
ipworksedi_as4client_get($res, 88 ); ipworksedi_as4client_set($res, 88, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (IPWorksEDI_AS4Client Class)
This property contains a password if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyPassword(); public function setProxyPassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 89 ); ipworksedi_as4client_set($res, 89, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (IPWorksEDI_AS4Client Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Object Oriented Interface
public function getProxyPort(); public function setProxyPort($value);
Procedural Interface
ipworksedi_as4client_get($res, 90 ); ipworksedi_as4client_set($res, 90, $value );
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (IPWorksEDI_AS4Client Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Object Oriented Interface
public function getProxyServer(); public function setProxyServer($value);
Procedural Interface
ipworksedi_as4client_get($res, 91 ); ipworksedi_as4client_set($res, 91, $value );
Default Value
''
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (IPWorksEDI_AS4Client Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Object Oriented Interface
public function getProxySSL(); public function setProxySSL($value);
Procedural Interface
ipworksedi_as4client_get($res, 92 ); ipworksedi_as4client_set($res, 92, $value );
Default Value
0
Remarks
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. |
Data Type
Integer
ProxyUser Property (IPWorksEDI_AS4Client Class)
This property contains a username if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyUser(); public function setProxyUser($value);
Procedural Interface
ipworksedi_as4client_get($res, 93 ); ipworksedi_as4client_set($res, 93, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ReceiptContent Property (IPWorksEDI_AS4Client Class)
The content of the receipt.
Object Oriented Interface
public function getReceiptContent(); public function setReceiptContent($value);
Procedural Interface
ipworksedi_as4client_get($res, 94 ); ipworksedi_as4client_set($res, 94, $value );
Default Value
''
Remarks
The content of the receipt. This is the raw XML of the receipt.
The class will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.
Data Type
String
ReceiptRefToMessageId Property (IPWorksEDI_AS4Client Class)
The Message Id to which this receipt applies.
Object Oriented Interface
public function getReceiptRefToMessageId(); public function setReceiptRefToMessageId($value);
Procedural Interface
ipworksedi_as4client_get($res, 95 ); ipworksedi_as4client_set($res, 95, $value );
Default Value
''
Remarks
The Message Id to which this receipt applies. This is the original Message Id from the initial transmission of the file. This allows the receipt to be correlated with the original transmission.
The class will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.
Data Type
String
ReceiptReplyMode Property (IPWorksEDI_AS4Client Class)
The expected receipt reply mode.
Object Oriented Interface
public function getReceiptReplyMode(); public function setReceiptReplyMode($value);
Procedural Interface
ipworksedi_as4client_get($res, 96 ); ipworksedi_as4client_set($res, 96, $value );
Default Value
0
Remarks
This setting tells the class how to expect or deliver a receipt. Possible values are:
0 (rrmSync - default) | The receipt is expected in the response to the request. This is only valid when sending files from a client to a server (push). This is a synchronous receipt (the receipt is returned in the same HTTP connection). |
1 (rrmAsync) | The receipt is returned at a later time. The receipt may be returned by itself in a separate connection, or may be bundled with a subsequent request. This is the only available mode when receiving files from a server (pull). |
2 (rrmNone) | No receipt is expected. |
It is important to always set this property to the correct value in both AS4Client and AS4Server, whether sending or receiving, so the class can build a valid message. This should be set to the previously agreed upon value between the parties in the agreement identified by AgreementRef
Data Type
Integer
RecipientCertCount Property (IPWorksEDI_AS4Client Class)
The number of records in the RecipientCert arrays.
Object Oriented Interface
public function getRecipientCertCount(); public function setRecipientCertCount($value);
Procedural Interface
ipworksedi_as4client_get($res, 97 ); ipworksedi_as4client_set($res, 97, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at RecipientCertCount - 1.This property is not available at design time.
Data Type
Integer
RecipientCertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getRecipientCertEncoded($recipientcertindex); public function setRecipientCertEncoded($recipientcertindex, $value);
Procedural Interface
ipworksedi_as4client_get($res, 99 , $recipientcertindex); ipworksedi_as4client_set($res, 99, $value , $recipientcertindex);
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.
The $recipientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is not available at design time.
Data Type
Binary String
RefToMessageId Property (IPWorksEDI_AS4Client Class)
Specifies the RefToMessageId in the message.
Object Oriented Interface
public function getRefToMessageId(); public function setRefToMessageId($value);
Procedural Interface
ipworksedi_as4client_get($res, 126 ); ipworksedi_as4client_set($res, 126, $value );
Default Value
''
Remarks
This property specifies the RefToMessageId value in the message being sent.
This property is only applicable when Profile is set to ebpfEDelivery. The eDelivery profile supports the Two-Way/Push-and-Push MEP (Message Exchange Pattern), where sending a file can be in reference to a previously received file. In this case RefToMessageId specifies the Id of the previously received message to which this send is in reference.
When sending with AS4Client this should only be set when using the eDelivery profile and need to explicitly specify the RefToMessageId value as per the Two-Way/Push-And-Push MEP.
When receiving with AS4Server this may be read after receiving a message.
Data Type
String
Service Property (IPWorksEDI_AS4Client Class)
The service which acts on the message.
Object Oriented Interface
public function getService(); public function setService($value);
Procedural Interface
ipworksedi_as4client_get($res, 127 ); ipworksedi_as4client_set($res, 127, $value );
Default Value
'http://docs.oasis-open.org/ebxml-msg/as4/200902/service'
Remarks
This property specifies the service which acts on the message. This should only be changed from the default value if there is a specific reason to do so.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service"
Data Type
String
ServiceAction Property (IPWorksEDI_AS4Client Class)
The action within a service that acts on the message.
Object Oriented Interface
public function getServiceAction(); public function setServiceAction($value);
Procedural Interface
ipworksedi_as4client_get($res, 128 ); ipworksedi_as4client_set($res, 128, $value );
Default Value
'http://docs.oasis-open.org/ebxml-msg/as4/200902/action'
Remarks
This property defines the action within a service that acts upon a message. This should only be changed from the default value if there is a specific reason to do so.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Action".
Data Type
String
ServiceType Property (IPWorksEDI_AS4Client Class)
The type of service.
Object Oriented Interface
public function getServiceType(); public function setServiceType($value);
Procedural Interface
ipworksedi_as4client_get($res, 129 ); ipworksedi_as4client_set($res, 129, $value );
Default Value
''
Remarks
This optionally specifies the type of the service. The semantics of this value should be agreed upon by both parties ahead of time. It may be used to tell the other party how to interpret the Service value.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service@type"
Data Type
String
SignatureAlgorithm Property (IPWorksEDI_AS4Client Class)
Signature algorithm to be used in the message.
Object Oriented Interface
public function getSignatureAlgorithm(); public function setSignatureAlgorithm($value);
Procedural Interface
ipworksedi_as4client_get($res, 130 ); ipworksedi_as4client_set($res, 130, $value );
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)
- ECDSA-SHA1
- ECDSA-SHA224
- ECDSA-SHA256
- ECDSA-SHA384
- ECDSA-SHA512
The default value is "SHA-256".
Data Type
String
SignerCertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSignerCertEncoded(); public function setSignerCertEncoded($value);
Procedural Interface
ipworksedi_as4client_get($res, 132 ); ipworksedi_as4client_set($res, 132, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SignerCertStore Property (IPWorksEDI_AS4Client Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSignerCertStore(); public function setSignerCertStore($value);
Procedural Interface
ipworksedi_as4client_get($res, 148 ); ipworksedi_as4client_set($res, 148, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject 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).
Data Type
Binary String
SignerCertStorePassword Property (IPWorksEDI_AS4Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSignerCertStorePassword(); public function setSignerCertStorePassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 149 ); ipworksedi_as4client_set($res, 149, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SignerCertStoreType Property (IPWorksEDI_AS4Client Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSignerCertStoreType(); public function setSignerCertStoreType($value);
Procedural Interface
ipworksedi_as4client_get($res, 150 ); ipworksedi_as4client_set($res, 150, $value );
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 SignerCertStore and set SignerCertStorePassword 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. |
Data Type
Integer
SignerCertSubject Property (IPWorksEDI_AS4Client Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSignerCertSubject(); public function setSignerCertSubject($value);
Procedural Interface
ipworksedi_as4client_get($res, 151 ); ipworksedi_as4client_set($res, 151, $value );
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.
Data Type
String
SigningCertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSigningCertEncoded(); public function setSigningCertEncoded($value);
Procedural Interface
ipworksedi_as4client_get($res, 160 ); ipworksedi_as4client_set($res, 160, $value );
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.
This property is not available at design time.
Data Type
Binary String
SigningCertStore Property (IPWorksEDI_AS4Client Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSigningCertStore(); public function setSigningCertStore($value);
Procedural Interface
ipworksedi_as4client_get($res, 176 ); ipworksedi_as4client_set($res, 176, $value );
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).
Data Type
Binary String
SigningCertStorePassword Property (IPWorksEDI_AS4Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSigningCertStorePassword(); public function setSigningCertStorePassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 177 ); ipworksedi_as4client_set($res, 177, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SigningCertStoreType Property (IPWorksEDI_AS4Client Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSigningCertStoreType(); public function setSigningCertStoreType($value);
Procedural Interface
ipworksedi_as4client_get($res, 178 ); ipworksedi_as4client_set($res, 178, $value );
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. |
Data Type
Integer
SigningCertSubject Property (IPWorksEDI_AS4Client Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSigningCertSubject(); public function setSigningCertSubject($value);
Procedural Interface
ipworksedi_as4client_get($res, 179 ); ipworksedi_as4client_set($res, 179, $value );
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.
Data Type
String
SSLAcceptServerCertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
ipworksedi_as4client_get($res, 188 ); ipworksedi_as4client_set($res, 188, $value );
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.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
ipworksedi_as4client_get($res, 216 ); ipworksedi_as4client_set($res, 216, $value );
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.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (IPWorksEDI_AS4Client Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
ipworksedi_as4client_get($res, 232 ); ipworksedi_as4client_set($res, 232, $value );
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).
Data Type
Binary String
SSLCertStorePassword Property (IPWorksEDI_AS4Client Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 233 ); ipworksedi_as4client_set($res, 233, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (IPWorksEDI_AS4Client Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
ipworksedi_as4client_get($res, 234 ); ipworksedi_as4client_set($res, 234, $value );
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. |
Data Type
Integer
SSLCertSubject Property (IPWorksEDI_AS4Client Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
ipworksedi_as4client_get($res, 235 ); ipworksedi_as4client_set($res, 235, $value );
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.
Data Type
String
SSLProvider Property (IPWorksEDI_AS4Client Class)
This specifies the SSL/TLS implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
ipworksedi_as4client_get($res, 243 ); ipworksedi_as4client_set($res, 243, $value );
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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEncoded Property (IPWorksEDI_AS4Client Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
ipworksedi_as4client_get($res, 245 );
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 and not available at design time.
Data Type
Binary String
Timeout Property (IPWorksEDI_AS4Client Class)
A timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworksedi_as4client_get($res, 272 ); ipworksedi_as4client_set($res, 272, $value );
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 fails with an error.
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.
Data Type
Integer
TokenPassword Property (IPWorksEDI_AS4Client Class)
The password used in UsernameToken authentication.
Object Oriented Interface
public function getTokenPassword(); public function setTokenPassword($value);
Procedural Interface
ipworksedi_as4client_get($res, 273 ); ipworksedi_as4client_set($res, 273, $value );
Default Value
''
Remarks
This property specifies the password used in UsernameToken authentication.
UsernameToken Authentication Notes
If TokenUser and TokenPassword are specified the class will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.
TokenPassword should normally be set to the plaintext password that both the client and server know. The class will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.
client.TokenUser = "User";
client.TokenPassword = "MyPassword";
client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest;
client.ReceiveFiles();
A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.
If TokenPasswordType is set to tptText the class will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.
Data Type
String
TokenPasswordType Property (IPWorksEDI_AS4Client Class)
The password type used in UsernameToken authentication.
Object Oriented Interface
public function getTokenPasswordType(); public function setTokenPasswordType($value);
Procedural Interface
ipworksedi_as4client_get($res, 274 ); ipworksedi_as4client_set($res, 274, $value );
Default Value
0
Remarks
The type of password to send in the request. Possible values are:
0 (tptDigest - default) | TokenPassword holds the plaintext password and the class hashes it. |
1 (tptText) | TokenPassword is transmitted exactly as provided. |
UsernameToken Authentication Notes
If TokenUser and TokenPassword are specified the class will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.
TokenPassword should normally be set to the plaintext password that both the client and server know. The class will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.
client.TokenUser = "User";
client.TokenPassword = "MyPassword";
client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest;
client.ReceiveFiles();
A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.
If TokenPasswordType is set to tptText the class will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.
Data Type
Integer
TokenUser Property (IPWorksEDI_AS4Client Class)
The username used in UsernameToken authentication.
Object Oriented Interface
public function getTokenUser(); public function setTokenUser($value);
Procedural Interface
ipworksedi_as4client_get($res, 275 ); ipworksedi_as4client_set($res, 275, $value );
Default Value
''
Remarks
This property specifies the username to be sent for UsernameToken authentication.
UsernameToken Authentication Notes
If TokenUser and TokenPassword are specified the class will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.
TokenPassword should normally be set to the plaintext password that both the client and server know. The class will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.
client.TokenUser = "User";
client.TokenPassword = "MyPassword";
client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest;
client.ReceiveFiles();
A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.
If TokenPasswordType is set to tptText the class will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.
Data Type
String
URL Property (IPWorksEDI_AS4Client Class)
The URL to which the request is made.
Object Oriented Interface
public function getURL(); public function setURL($value);
Procedural Interface
ipworksedi_as4client_get($res, 276 ); ipworksedi_as4client_set($res, 276, $value );
Default Value
''
Remarks
This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https".
Data Type
String
Config Method (IPWorksEDI_AS4Client Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksedi_as4client_do_config($res, $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 (IPWorksEDI_AS4Client Class)
Processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworksedi_as4client_do_doevents($res);
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 (IPWorksEDI_AS4Client Class)
Interrupt the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworksedi_as4client_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ReceiveFiles Method (IPWorksEDI_AS4Client Class)
Connects to a server to receive files.
Object Oriented Interface
public function doReceiveFiles();
Procedural Interface
ipworksedi_as4client_do_receivefiles($res);
Remarks
ReceiveFiles establishes a connection to the server specified by URL and receives files.
The MPC specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If IncomingDirectory is set before calling this method the files will be written to the specified folder, otherwise inspect EDIData to obtain the received file data. The following properties are applicable when calling this method:
- SigningCert (required to sign the request)
- Certificate (required for decryption)
- SignerCert (required for signature verification)
- URL
- IncomingDirectory (optional)
- LogDirectory
- MPC
- TokenUser
- TokenPassword
- TokenPasswordType
- AS4From
- AS4To
- AgreementRef
- ConversationId
- Service
- ServiceAction
- ServiceType
- MessageId
- Receipt
To bundle the receipt with a subsequent ReceiveFiles call the Receipt property must hold the receipt. If the same instance of the class is being used this is already true since Receipt is populated automatically after receiving the file. To use another instance of the class for multiple calls to ReceiveFiles be sure to save the Receipt's ReceiptContent and ReceiptRefToMessageId values for later use.
ReceiveFiles Example:
client.Profile = As4clientProfiles.ebpfENTSOG;
//Company A's private certificate. Used for signing the request.
client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*");
//Company A's private certificate. Used for decrypting the file.
client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*");
//Company B's public certificate. Used for signature verification.
client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer");
client.URL = "http://www.company.com:9090/msh";
//Message Channel id
client.MPC = "mpc_a";
client.IncomingDirectory = "C:\\incoming_dir";
client.ReceiveFiles();
//Inspect client.AgreementRef and other properties for information about the received files
Console.WriteLine(client.AgreementRef);
Console.WriteLine(client.AS4From.Id);
Console.WriteLine(client.AS4To.Id);
Console.WriteLine(client.ConversationId);
//Save the receipt for later use
string receiptContent = client.Receipt.Content;
string receiptRefId = client.Receipt.RefToMessageId;
At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt
property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message
will be included with the request.
client.Receipt = new EBReceipt(receiptRefId, receiptContent);
client.ReceiveFiles(); //This will now include the bundled receipt
Reset Method (IPWorksEDI_AS4Client Class)
Resets the state of the control.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksedi_as4client_do_reset($res);
Remarks
Reset resets the state of the class. All properties will be set to their default values.
SendFiles Method (IPWorksEDI_AS4Client Class)
Sends file(s) to the specified server and verify the receipt (if present).
Object Oriented Interface
public function doSendFiles();
Procedural Interface
ipworksedi_as4client_do_sendfiles($res);
Remarks
SendFiles sends the files specified by EDIData to URL.
Before calling this method set AgreementRef to the agreement identifier used by both parties. Set AS4From and AS4To. Set EDIData specifies the file(s) to be sent. To encrypt the data set RecipientCerts. To sign the data set SigningCert. The SignerCert property should be set to verify the signed receipt.
When this method is called the file(s) will be sent and any returned receipts will be verified.
To indicate a synchronous receipt is expected set ReceiptReplyMode to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):
- AgreementRef
- AS4From
- AS4To
- EDIData
- URL
- RecipientCerts (required to encrypt)
- SignerCert (required to verify signed receipts)
- SigningCert (required to sign files)
- ConversationId (optional)
- EncryptionAlgorithm (optional)
- LogDirectory (optional)
- MessageId (optional)
- MessageProperties (optional)
- Profile (optional)
- ReceiptReplyMode
- Service (optional)
- ServiceType (optional)
- SignatureAlgorithm (optional)
SendFiles Example (synchronous receipt):
client.Profile = As4clientProfiles.ebpfENTSOG;
//Specify the agreement and party information
client.AgreementRef = "http://agreements.company.com/sign_and_encrypt";
client.AS4From.Role = "Sender";
client.AS4From.Id = "org:b2b:example:company:A";
client.AS4To.Role = "Receiver";
client.AS4To.Id = "org:b2b:example:company:B";
//Configure the component to expect a synchronous receipt.
client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync;
//Company A's private certificate. Used to sign the outgoing message and files.
client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*");
//Company B's public certificate. Used to encrypt the outgoing file.
client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer"));
//Company B's public certificate. Used to verify the signed receipt.
client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer");
client.URL = "http://www.company.com:9090/msh";
EBData data = new EBData();
data.EDIType = "application/edi-x12";
data.Filename = "C:\\files\\myfile.x12";
data.Name = "myfile.x12";
client.EDIData.Add(data);
//Send file(s) and verify the receipt.
client.SendFiles();
The class also supports asynchronous receipts. In this configuration a file is sent from the class to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The AS4Server class may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either AS4Server or AS4Client may be used to verify the receipt.
Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set AsyncReceiptInfoDir before calling SendFiles. The class will automatically store the required information.
See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.
To indicate an asynchronous receipt is expected set ReceiptReplyMode to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):
- AgreementRef
- AS4From
- AS4To
- AsyncReceiptInfoDir
- EDIData
- URL
- RecipientCerts (required to encrypt)
- SignerCert (required to verify signed receipts)
- SigningCert (required to sign files)
- ConversationId (optional)
- EncryptionAlgorithm (optional)
- LogDirectory (optional)
- MessageId (optional)
- MessageProperties (optional)
- OriginalSOAPMessage (optional)
- OriginalSOAPMessageId (optional)
- Profile (optional)
- ReceiptReplyMode
- Service (optional)
- ServiceType (optional)
- SignatureAlgorithm (optional)
SendFiles Example (asynchronous receipt):
client.Profile = As4clientProfiles.ebpfENTSOG;
//Specify the agreement and party information
client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async";
client.AS4From.Role = "Sender";
client.AS4From.Id = "org:b2b:example:company:A";
client.AS4To.Role = "Receiver";
client.AS4To.Id = "org:b2b:example:company:B";
//Configure the component to expect a synchronous receipt.
client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync;
client.AsyncReceiptInfoDir = "C:\\async_info";
//Company A's private certificate. Used to sign the outgoing message and files.
client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*");
//Company B's public certificate. Used to encrypt the outgoing files.
client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer"));
//Company B's public certificate. Used to verify the signed receipt.
client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer");
client.URL = "http://www.company.com:9090/msh";
EBData data = new EBData();
data.EDIType = "application/edi-x12";
data.Filename = "C:\\files\\myfile.x12";
data.Name = "myfile.x12";
client.EDIData.Add(data);
//Send file(s).
client.SendFiles();
At this point the file(s) have been sent, but a receipt has not yet been received. AS4Server can be used
within a web site to listen for the receipt.
//**** Inside a web site ****
As4server server = new As4server;
server.ReadRequest();
if (!String.IsNullOrEmpty(server.IncomingReceipt.Content))
{
server.AsyncReceiptInfoDir = "C:\\async_info";
server.VerifyReceipt();
//The receipt is now verified
}
SendReceipt Method (IPWorksEDI_AS4Client Class)
Sends an asynchronous receipt.
Object Oriented Interface
public function doSendReceipt();
Procedural Interface
ipworksedi_as4client_do_sendreceipt($res);
Remarks
SendReceipt sends an asynchronous receipt to the URL.
This method is typically used in conjunction with AS4Server to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate Receipt and call this method.
//Send an asynchronous receipt
client.URL = ""http://www.company.com:9090/msh"";
client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content);
client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync;
client.SendReceipt();
Connected Event (IPWorksEDI_AS4Client Class)
This event is fired immediately after a connection completes (or fails).
Object Oriented Interface
public function fireConnected($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 1, array($this, 'fireConnected'));
Parameter List
'statuscode'
'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 (IPWorksEDI_AS4Client Class)
This event is fired when a connection is closed.
Object Oriented Interface
public function fireDisconnected($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 2, array($this, 'fireDisconnected'));
Parameter List
'statuscode'
'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 (IPWorksEDI_AS4Client Class)
This event is fired when a document finishes transferring.
Object Oriented Interface
public function fireEndTransfer($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 3, array($this, 'fireEndTransfer'));
Parameter List
'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 (IPWorksEDI_AS4Client Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 4, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (IPWorksEDI_AS4Client Class)
This event is fired every time a header line comes in.
Object Oriented Interface
public function fireHeader($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 5, array($this, 'fireHeader'));
Parameter List
'field'
'value'
Remarks
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 (IPWorksEDI_AS4Client Class)
Fired with log information while processing a message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 6, array($this, 'fireLog'));
Parameter List
'logtype'
'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:
"INFO" | Information about the status of the process. |
"ERROR" | An error was encountered. |
"DEBUG" | Debug information. |
RecipientInfo Event (IPWorksEDI_AS4Client Class)
Fired for each recipient certificate of the encrypted message.
Object Oriented Interface
public function fireRecipientInfo($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 7, array($this, 'fireRecipientInfo'));
Parameter List
'issuer'
'serialnumber'
'subjectkeyidentifier'
'encryptionalgorithm'
Remarks
When ParseRequest is called and the file is encrypted, this event will fire for each recipient certificate for which the file was encrypted.
Issuer is the subject of the issuer certificate.
SerialNumber is the serial number of the encryption certificate.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
EncryptionAlgorithm is the encryption algorithm used to encrypt the message. Possible values are as follows:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
SetCookie Event (IPWorksEDI_AS4Client Class)
This event is fired for every cookie set by the server.
Object Oriented Interface
public function fireSetCookie($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 8, array($this, 'fireSetCookie'));
Parameter List
'name'
'value'
'expires'
'domain'
'path'
'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.
SignerCertInfo Event (IPWorksEDI_AS4Client Class)
This event is fired during verification of the signed message.
Object Oriented Interface
public function fireSignerCertInfo($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 9, array($this, 'fireSignerCertInfo'));
Parameter List
'issuer'
'serialnumber'
'subjectkeyidentifier'
'certencoded'
Remarks
During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:
Issuer specifies the subject of the issuer of the certificate used to sign the message.
SerialNumber is the serial number of the certificate used to sign the message.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.
Note: When this value is present, the class will automatically use this value to perform signature verification.
The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.
SSLServerAuthentication Event (IPWorksEDI_AS4Client Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 10, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (IPWorksEDI_AS4Client Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 11, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (IPWorksEDI_AS4Client Class)
This event is fired when a document starts transferring (after the headers).
Object Oriented Interface
public function fireStartTransfer($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 12, array($this, 'fireStartTransfer'));
Parameter List
'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.
TokenAuthentication Event (IPWorksEDI_AS4Client Class)
Fired when the server makes use of UsernameToken authentication.
Object Oriented Interface
public function fireTokenAuthentication($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 13, array($this, 'fireTokenAuthentication'));
Parameter List
'user'
'password'
'passwordtype'
'accept'
Remarks
This event fires when a server sends a response that includes UsernameToken authentication. This is typically only used by servers when sending a pull response.
User identifies the user.
Password should be set from within the event if PasswordType is 0 (digest). This parameter can be read when PasswordType is 1 (text).
PasswordType specifies the type of password. Possible values are:
- 0 (Digest)
- 1 (Text)
Accept may be set to manually accept the request.
When PasswordType is 0 (Digest) set the Password parameter to the plaintext password. Do not set Accept The class will hash the provided password value and compare it to the value in the request. If it matched the class will accept the request. If it does not match the class will populate Errors with an error indicating authentication has failed.
When PasswordType is 1 (Text) the Password parameter will hold the exact value received in the request. Inspect Password and determine whether to accept the request. To accept the request set Accept to True.
After this event fires if authentication failed Errors will contain an appropriate error. Send the errors back to the server by calling SendResponse.
Transfer Event (IPWorksEDI_AS4Client Class)
This event is fired while a document transfers (delivers document).
Object Oriented Interface
public function fireTransfer($param);
Procedural Interface
ipworksedi_as4client_register_callback($res, 14, array($this, 'fireTransfer'));
Parameter List
'direction'
'bytestransferred'
'percentdone'
'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.
Config Settings (AS4Client Class)
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.AS4Client Config Settings
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef/@pmode"
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef/@type"
This setting is only applicable when the first file specified in EDIData is of type "text/xml" or "application/xml". In addition this is only applicable when Profile is set to Standard.
If set to True (default), the file will be sent as an attachment. This allows the filename to be preserved and the file is sent as a separate MIME part. If set to False and the criteria above are met then the file will be sent within the SOAP body. In this case the filename cannot be preserved normally.
The default value is True.
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.
Note: When Profile is set to Standard the first EDIData part will be included in the SOAP body if the EDIEDIType is "text/xml" or "application/xml". In that case since the data is included in the SOAP body it will not be compressed. When Profile is set to ENTSOG all EDIData parts are compressed.
Base64 (2) | Base64 encoding of binary data. |
Binary (4) | Binary data without any encoding. |
The default value depends on the Profile. For the Standard profile the default value is False. When Profile is set to ENTSOG this value is set to True.
<eb3:PartInfo href="cid:_de48eece-d1d8-4823-8a63-d3a8d14dc1a8@nsoftware">In some cases it may be desired or necessary to specify a user-defined value. For instance:
<eb3:PartInfo href="cid:mypart@myhost">After adding the part to EDIData the Id may be specified by setting:
AS4Component.Config("EDIDataPartId[0]=mypart@myhost");This setting is also populated with the parsed Ids after receiving a message.
0 (X509 - default) | X509 data including the certificate's issuer name and issuer serial number is included in the X509Data element. |
1 (Binary) | A binary security token holds the base64 encoded contents of the public certificate and is referenced from within the Reference element. |
2 (Subject Key Identifier) | The X509 subject key identifier is included in the KeyIdentifier element. |
3 (X509PKIPathv1) | A binary security token holds the base64 encoded ordered list of X509 public certificates and is referenced from within the Reference element. |
The default value is 0 (X509) and should not be changed unless there is a specific reason to do so.
Note: The default value when Profile is set to eDelivery is 1 (Binary).
This is helpful in the case where Profile is set to ebpfStandard and the first file being sent is of type "text/xml" or "application/xml". In that case the file content is included in the SOAP body and there is no standard mechanism for preserving the filename.
When set the class will automatically populate the property when sending files and will read the filename from this property when receiving files.
By default this is not specified.
Note: The filenames will always be preserved within the MIME header attributes whenever possible regardless of whether this setting is specified.
If set to True (default) the class will only attempt to use the certificate specified by SigningCert. If SigningCert is not specified signing will not be attempted.
component.Config("FromIdCount=2");
component.Config("FromId[0]=id1");
component.Config("FromIdType[0]=mytype");
component.Config("FromId[1]=id2");
When receiving a message with multiple Ids, query these settings to read the values.
By default this value is unspecified and only a single Id is used as specified in the AS4FromId property of AS4From.
Value | Algorithm | Notes |
DH | http://www.w3.org/2009/xmlenc11#dh | Not currently implemented. |
DH-ES | http://www.w3.org/2009/xmlenc11#dh-es | Not currently implemented. |
ECDH-ES | http://www.w3.org/2009/xmlenc11#ECDH-ES | Default when Profile is ebpfBDEW. |
- SHA512
- SHA384
- SHA256 (Default)
- SHA224
- SHA1
Value | Algorithm |
ConcatKDF (Default) | http://www.w3.org/2009/xmlenc11#ConcatKDF |
PBKDF2 | http://www.w3.org/2009/xmlenc11#pbkdf2 |
Value | Algorithm | Notes |
RSA-OAEP-XMLENC11 | http://www.w3.org/2009/xmlenc11#rsa-oaep | This is used in the default configuration. Additionally if RSA-OAEP is specified this will be automatically used instead if OAEPMGF1HashAlgorithm is set to any value except SHA1 or OAEPRSAHashAlgorithm is set to SHA384 or SHA512. |
RSA-v1.5 | http://www.w3.org/2001/04/xmlenc#rsa-1_5 | There are no conditions for the use of this algorithm. If specified it will be used regardless of other settings. |
RSA-OAEP | http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p | This is used by default when OAEPMGF1HashAlgorithm is set to SHA1 and OAEPRSAHashAlgorithm is set to SHA1 or SHA256. This is only applicable under these conditions, it cannot override when RSA-OAEP-XMLENC11 is used based on the OAEPMGF1HashAlgorithm and OAEPRSAHashAlgorithm values. |
KW-AES128 | http://www.w3.org/2001/04/xmlenc#kw-aes128 | This is used by default if Profile is set to ebpfBDEW. |
KW-AES192 | http://www.w3.org/2001/04/xmlenc#kw-aes192 | |
KW-AES256 | http://www.w3.org/2001/04/xmlenc#kw-aes256 |
0 (Error) | Only errors are logged. |
1 (Info - default) | Informational and errors are logged. |
2 (Debug) | All information is logged including debug info. |
Log | Contains information about the steps taken during processing. Also see LogLevel. |
Incoming | Contains the raw request/response that is received by the class. |
Outgoing | Contains the raw request/response that is sent by the class. |
IncomingMessage | Contains the incoming ebXML message. |
OutgoingMessage | Contains the outgoing ebXML message. |
All (default) | All of the above |
1 | Pull Request (Receive Files) |
2 | User Message (Send Files) |
4 | Receipt |
8 | Error Message |
int requestType = Int32.Parse(AS4Server.Config("MessageType"));
if((requestType & 1) != 0)
//The request contains a pull request
The default value is True to maximize interoperability with other AS4 software.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
Note: If Profile is set to ENTSOG the MGF1HashAlgorithm will be set to "SHA256" by default.
- "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.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
If this setting is specified, the class will verify the chain of the signer certificate against the CA
list set in this setting. To specify one or more CA certificate prior to signature verification set
this to the base64 encoded public certificate of each CA certificate. Each additional certificate can be
added by prepending the data with a + character. If the value begins with a + the class
will add the following value to an internal store of CA certificates. For instance:
//Add the first CA certificate
as4.Config("SignerCACert=MIICFDCCAX2g...");
//Add another CA certificate (Note the leading '+')
as4.Config("SignerCACert=+MIICHDCCAYW...");
If the chain validation fails during signature verification the class fails with an error. If this setting is not specified no chain validation is performed.
0 (X509 - default) | X509 data including the certificate's issuer name and issuer serial number is included in the X509Data element. |
1 (Binary) | A binary security token holds the base64 encoded contents of the public certificate and is referenced from within the Reference element. |
2 (Subject Key Identifier) | The X509 subject key identifier is included in the KeyIdentifier element. |
3 (X509PKIPathv1) | A binary security token holds the base64 encoded ordered list of X509 public certificates and is referenced from within the Reference element. |
The default value is 0 (X509) and should not be changed unless there is a specific reason to do so.
Note: The default value when Profile is set to eDelivery is 1 (Binary).
component.Config("ToIdCount=2");
component.Config("ToId[0]=id1");
component.Config("ToIdType[0]=mytype");
component.Config("ToId[1]=id2");
When receiving a message with multiple Ids, query these settings to read the values.
By default this value is unspecified and only a single Id is used as specified in the AS4ToId property of AS4To.
When set to True (default) the class will perform canonicalize the receipt when it is received. This may be helpful if the value of ReceiptContent is to be used in a later process where a valid XML document is required. When set to true (false by default), the component will transform the receipt content made available in the component using Exclusive XML Canonicalization.
If False the class will not alter the received receipt. The value of ReceiptContent will not itself be a well formed XML document.
See TokenUser and TokenPassword for more details.
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 fails with an error 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 fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error 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 false.
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 CRLF ("\r\n") .
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. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
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.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----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 fails with an error.
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.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (AS4Client Class)
AS4Client Errors
601 Unsupported signature algorithm. | |
705 No response to deliver. | |
774 Error writing to stream. | |
1201 Invalid ebXML. | |
1204 Invalid part href value. | |
1205 Unknown original message when creating receipt. | |
1206 Could not build user message. | |
1207 MPC value is missing. | |
1210 A required property is not set, check the message for details. | |
1211 Invalid or missing URL. | |
1212 Unable to send request. | |
1213 The other party returned an error. Check the Errors property for details. | |
1214 Error processing receipt. | |
1215 Error saving data to AsyncReceiptInfoDir. | |
1216 Error reading data from AsyncReceiptInfoDir. | |
1217 MPC in the response does not match the MPC in the request. | |
1218 Duplicate message detected. | |
1219 Invalid profile value. | |
1220 Unsupported compression type | |
1221 Input file not found. | |
1222 Error compressing file. | |
1223 Invalid LogLevel value. | |
1224 Error setting EDI content when building message. | |
1225 Could not find a required message part. | |
1226 Invalid SOAP message. | |
1227 Invalid signature. | |
1228 Unknown XML reference. | |
1229 Digest verification failed. | |
1230 Could not find the required key. | |
1231 No CipherReference of CipherValue found. | |
1232 Only cid references are supported. | |
1233 Error signing message. | |
1234 Cannot find subject identifier. | |
1235 Error creating encryption key. | |
1236 Error decrypting part. | |
1237 Error calculating digest. | |
1238 The specified certificate cannot be used to decrypt this message. | |
1239 A signature is required, but is not present. | |
1240 Encryption is required, but the message is not encrypted. |
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |