Struct ipworksedi::AS4Server

Properties   Methods   Events   Config Settings   Errors  

The AS4Server struct implements an AS4 / ebHandler.

Syntax

ipworksedi::AS4Server

Remarks

The AS4Server struct implements server-side processing of AS4 messages. It may be used to receive files form a client (push), respond to a client's request for files (pull), and also handles generating and verifying receipts.

The struct is designed to be easily integrated into a HTTP server, such as ASP.NET, but may also be used outside of a web server. The examples below assume the struct is used within an environment where there is an HTTP context.

To begin, when a request is received first call read_request. This reads the AS4 request from the content of the request (and optionally the request_headers_string) property. Alternatively the request data may be passed directly to the struct by specifying calling set_request_stream. After calling read_request the following properties may be checked:

• agreement_ref
• as4_from
• as4_to
• conversation_id
• edi_data
• errors
• incoming_receipt
• message_id
• message_properties
• mpc
• service
• service_action
• service_type

The first step after calling read_request is to determine if the client is sending files (push) or requesting files (pull). To determine this check the value of agreement_ref and mpc. For instance: if (server.AgreementRef == "" && server.MPC != "") { //The client is requesting files from the specified MPC //No other relevant properties are populated } else //AgreementRef is not empty, and MPC is empty { //The client is sending files. AgreementRef is populated with the agreement reference. //AS4From, AS4To, ConversationId, etc are populated }

Determining if the request contains an asynchronous receipt from a previous transmission may also be done at this time by checking the incoming_receipt property's incoming_receipt_content property. If it is populated a receipt is present. To verify the receipt set async_receipt_info_dir to the directory where information about the message was originally stored and call verify_receipt. If the receipt is signed signer_cert must also be set. See the section below and also send_files for more details.

Once information about the request is determined the struct may then be configured to respond appropriately depending on the operation.

Receiving Files and Sending a Receipt

When receiving files first check the agreement_ref, as4_from, and as4_to properties to determine who is sending the files and with what previously agreed upon configuration. Once this is known, if the request is signed and encrypted set certificate to the decryption certificate and signer_cert to the public certificate used for signature verification. incoming_directory may optionally be set to automatically store the incoming files. //Process incoming files and send a signed receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmSync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendResponse(); //Sends the receipt Receiving Files and Sending an Asynchronous Receipt

Receipts may be sent in the response (synchronous) or at a later time (asynchronous). If the agreement specifies that the receipt be sent asynchronously the following steps may be taken to send the receipt.

After calling read_request the receipt_reply_mode may be set to indicate the receipt will be returned asynchronously. After calling parse_request call send_ack_response to send back a HTTP 200 OK to the client. The receipt may then be returned later.

To send an asynchronous receipt AS4Client may be used. This can be sent to the partner's web site, or bundled with a later response (depending on the agreement made between the parties). In the example below AS4Client is used to send the receipt to the other party's web site.

//Process incoming files and send an asynchronous receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendAckResponse(); //Sends an ack, but not the receipt At this point receipt is populated with the receipt to be sent. Store the Receipt's receipt_content and receipt_ref_to_message_id values for use when sending the receipt later. Sending a receipt can be done with AS4Client.

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

Sending Files

To process a request to send files first check the mpc property. This holds the Message Partition Channel (MPC) from which the client would like to receive files. Next, set agreement_ref, as4_from, as4_to. Check incoming_receipt to determine if the request has a bundled receipt. If it does verify_receipt can be called to verify the receipt.

Note: If the client requests files from the default MPC then mpc may be empty. See MessageType for details.

If the client makes use of UsernameToken authentication the on_token_authentication event will fire when processing the request.

To send files back to the client simply set edi_data to the files you wish to send. When send_response is called the files will be sent back to the client.

//Process a request to send files (pull) //Holds information from the original send so that receipts can be verified later server.AsyncReceiptInfoDir = Path.Combine(Request.PhysicalApplicationPath, "..\\temp\\ReceiptInfoDir") server.Profile = As4serverProfiles.ebpfENTSOG; server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request has a bundled receipt verify it first if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); } //If the request is a pull request (MPC is set) if (server.AgreementRef == "" && server.MPC != "") { server.AgreementRef = "http://agreements.company.com/pull_files"; server.AS4From.Id = "org:holodeckb2b:example:company:B"; server.AS4From.Role = "Sender"; server.AS4To.Id = "org:holodeckb2b:example:company:A"; server.AS4To.Role = "Receiver"; server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the message and files. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to encrypt files. server.RecipientCerts.Add(new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer"))); EBData data = new EBData(); data.EDIType = "text/xml"; data.Data = "<test>Hello AS4 World!</test>"; server.EDIData.Add(data); server.SendResponse(); }

Processing Receipts

Any incoming request may potentially include a receipt. The request may be a receipt by itself, or it may be bundled with another type of request (send/receive). When initially sending files async_receipt_info_dir may be set to store data about the original message on disk for use when verifying the receipt. If this is not desired manually store the original_soap_message and original_soap_message_id instead.

To detect if an incoming request contains a receipt simply check the incoming_receipt property's receipt_content property. If it is populated the request includes a receipt. Set async_receipt_info_dir to the same location as when the file was originally sent. Or alternatively set original_soap_message and original_soap_message_id properties to the original values.

If the receipt is signed set signer_cert to the public certificate which will be used to verify the signature. Lastly call verify_receipt. This will perform any signature verification and verify the receipt content as well, matching it to the original message values.

server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request contains a receipt verify it if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); }

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEDI. Due to this, the AS4Server struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of AS4Server when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

agreement_ref property (AS4Server Struct)

The agreement reference.

Syntax

fn agreement_ref(&self ) -> Result<String, IPWorksEDIError> 
fn set_agreement_ref(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_agreement_ref_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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 as4_from and as4_to values.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef"

Data Type

String

as4_from_id property (AS4Server Struct)

The Id of the party.

Syntax

fn as4_from_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_as4_from_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_as4_from_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

as4_from_id_type property (AS4Server Struct)

The optional type of the Id.

Syntax

fn as4_from_id_type(&self ) -> Result<String, IPWorksEDIError> 
fn set_as4_from_id_type(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_as4_from_id_type_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

as4_from_role property (AS4Server Struct)

This property specifies the role of the party.

Syntax

fn as4_from_role(&self ) -> Result<String, IPWorksEDIError> 
fn set_as4_from_role(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_as4_from_role_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property specifies the role of the party. This may be any value agreed upon by the trading partners.

In as4_from 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 as4_to 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

as4_to_id property (AS4Server Struct)

The Id of the party.

Syntax

fn as4_to_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_as4_to_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_as4_to_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

as4_to_id_type property (AS4Server Struct)

The optional type of the Id.

Syntax

fn as4_to_id_type(&self ) -> Result<String, IPWorksEDIError> 
fn set_as4_to_id_type(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_as4_to_id_type_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

as4_to_role property (AS4Server Struct)

This property specifies the role of the party.

Syntax

fn as4_to_role(&self ) -> Result<String, IPWorksEDIError> 
fn set_as4_to_role(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_as4_to_role_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property specifies the role of the party. This may be any value agreed upon by the trading partners.

In as4_from 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 as4_to 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

async_receipt_info_dir property (AS4Server Struct)

A directory to hold information used for asynchronous receipt verification.

Syntax

fn async_receipt_info_dir(&self ) -> Result<String, IPWorksEDIError> 
fn set_async_receipt_info_dir(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_async_receipt_info_dir_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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 original_soap_message and original_soap_message_id after sending a file. In this case original_soap_message and original_soap_message_id should be populated before verifying the receipt.

See the verify_receipt method of AS4Server for more details about verifying asynchronous receipts.

Data Type

String

cert_effective_date property (AS4Server Struct)

The date on which this certificate becomes valid.

Syntax

fn cert_effective_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

cert_expiration_date property (AS4Server Struct)

The date on which the certificate expires.

Syntax

fn cert_expiration_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

cert_extended_key_usage property (AS4Server Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_fingerprint property (AS4Server Struct)

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

Syntax

fn cert_fingerprint(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

cert_fingerprint_sha1 property (AS4Server Struct)

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

Syntax

fn cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

cert_fingerprint_sha256 property (AS4Server Struct)

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

Syntax

fn cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

cert_issuer property (AS4Server Struct)

The issuer of the certificate.

Syntax

fn cert_issuer(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_private_key property (AS4Server Struct)

The private key of the certificate (if available).

Syntax

fn cert_private_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

cert_private_key_available property (AS4Server Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

cert_private_key_container property (AS4Server Struct)

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

Syntax

fn cert_private_key_container(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_public_key property (AS4Server Struct)

The public key of the certificate.

Syntax

fn cert_public_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_public_key_algorithm property (AS4Server Struct)

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

Syntax

fn cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_public_key_length property (AS4Server Struct)

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

Syntax

fn cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

cert_serial_number property (AS4Server Struct)

The serial number of the certificate encoded as a string.

Syntax

fn cert_serial_number(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_signature_algorithm property (AS4Server Struct)

The text description of the certificate's signature algorithm.

Syntax

fn cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_store property (AS4Server Struct)

The name of the certificate store for the client certificate.

Syntax

fn cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password-protected, specify the password in cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

cert_store_password property (AS4Server Struct)

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

Syntax

fn cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

cert_store_type property (AS4Server Struct)

The type of certificate store for this certificate.

Syntax

fn cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

cert_subject_alt_names property (AS4Server Struct)

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

Syntax

fn cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_thumbprint_md5 property (AS4Server Struct)

The MD5 hash of the certificate.

Syntax

fn cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_thumbprint_sha1 property (AS4Server Struct)

The SHA-1 hash of the certificate.

Syntax

fn cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_thumbprint_sha256 property (AS4Server Struct)

The SHA-256 hash of the certificate.

Syntax

fn cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_usage property (AS4Server Struct)

The text description of UsageFlags .

Syntax

fn cert_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

cert_usage_flags property (AS4Server Struct)

The flags that show intended use for the certificate.

Syntax

fn cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the cert_usage property for a text representation of cert_usage_flags.

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

This property is read-only.

Data Type

i32

cert_version property (AS4Server Struct)

The certificate's version number.

Syntax

fn cert_version(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_subject property (AS4Server Struct)

The subject of the certificate used for client authentication.

Syntax

fn cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

cert_encoded property (AS4Server Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec

conversation_id property (AS4Server Struct)

The Conversation Id of the message.

Syntax

fn conversation_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_conversation_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_conversation_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

edi_data_count property (AS4Server Struct)

The number of records in the EDI arrays.

Syntax

fn edi_data_count(&self ) -> Result<i32, IPWorksEDIError> 
fn set_edi_data_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• edi_data
• edi_file_name
• edi_name
• edi_property_count
• edi_property_index
• edi_property_name
• edi_property_value
• edi_schema_location
• edi_schema_namespace
• edi_schema_version
• edi_type

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

Data Type

i32

edi_data property (AS4Server Struct)

This property contains the EDI payload of the transmission.

Syntax

fn edi_data(&self , EDIDataIndex : i32) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_edi_data(&self, EDIDataIndex : i32, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_edi_data_ref(&self, EDIDataIndex : i32, value : &[u8]) ->  Option<IPWorksEDIError> 

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

When receiving files this will only be populated if incoming_directory and edi_output_stream have not been specified and parse_request 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.

Data Type

Vec

edi_type property (AS4Server Struct)

The Content-Type of the EDI message.

Syntax

fn edi_type(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_type(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_type_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

edi_file_name property (AS4Server Struct)

When sending, if FileName is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

fn edi_file_name(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_file_name(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_file_name_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

When sending, if edi_file_name is specified, the file specified will be used for the EDI payload of the transmission. edi_name will be populated with the name of the file.

When receiving, if incoming_directory is set, this will be populated with the name of the file which contains the processed message contents.

Note: When edi_output_stream 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.

Data Type

String

edi_name property (AS4Server Struct)

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

Syntax

fn edi_name(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_name(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_name_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

"rfc1767.edi"

Remarks

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

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

When receiving EDI data, edi_name 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.

Data Type

String

edi_property_count property (AS4Server Struct)

The number of properties for this file.

Syntax

fn edi_property_count(&self , EDIDataIndex : i32) -> Result<i32, IPWorksEDIError> 
fn set_edi_property_count(&self, EDIDataIndex : i32, value : i32) ->  Option<IPWorksEDIError> 

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 edi_property_index, edi_property_name, and edi_property_value can be used to specify properties when sending and read properties when receiving.

Sending

When sending files to add properties set edi_property_count to specify the number of properties. Then set edi_property_index to select the property. Set edi_property_name and edi_property_value to define the values for the property at edi_property_index. 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 edi_property_count to obtain the number of properties. Next set edi_property_index to select a property and query edi_property_name and edi_property_value. 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.

Data Type

i32

edi_property_index property (AS4Server Struct)

Selects a property at the specified index.

Syntax

fn edi_property_index(&self , EDIDataIndex : i32) -> Result<i32, IPWorksEDIError> 
fn set_edi_property_index(&self, EDIDataIndex : i32, value : i32) ->  Option<IPWorksEDIError> 

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.

Data Type

i32

edi_property_name property (AS4Server Struct)

The name of the property.

Syntax

fn edi_property_name(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_property_name(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_property_name_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

edi_property_value property (AS4Server Struct)

The value of the property.

Syntax

fn edi_property_value(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_property_value(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_property_value_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

edi_schema_location property (AS4Server Struct)

The SchemaLocation , SchemaNamespace , and SchemaVersion optionally define the schema that applies to this particular file.

Syntax

fn edi_schema_location(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_schema_location(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_schema_location_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The edi_schema_location, edi_schema_namespace, and edi_schema_version 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 edi_schema_location 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.

Data Type

String

edi_schema_namespace property (AS4Server Struct)

The namespace of the schema.

Syntax

fn edi_schema_namespace(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_schema_namespace(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_schema_namespace_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The namespace of the schema. This property is optional. Refer to edi_schema_location 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.

Data Type

String

edi_schema_version property (AS4Server Struct)

The version of the schema.

Syntax

fn edi_schema_version(&self , EDIDataIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_edi_schema_version(&self, EDIDataIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_edi_schema_version_ref(&self, EDIDataIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The version of the schema. This property is optional. Refer to edi_schema_location 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.

Data Type

String

encryption_algorithm property (AS4Server Struct)

The algorithm used to encrypt the EDI data.

Syntax

fn encryption_algorithm(&self ) -> Result<String, IPWorksEDIError> 
fn set_encryption_algorithm(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_encryption_algorithm_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

"AES128GCM"

Remarks

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

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

The struct 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

error_count property (AS4Server Struct)

The number of records in the Error arrays.

Syntax

fn error_count(&self ) -> Result<i32, IPWorksEDIError> 
fn set_error_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• error_category
• error_code
• error_description
• error_detail
• error_origin
• error_ref_message_id
• error_severity
• error_short_description

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

Data Type

i32

error_category property (AS4Server Struct)

The category of error.

Syntax

fn error_category(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_category(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_category_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

error_code property (AS4Server Struct)

The error code.

Syntax

fn error_code(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_code(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_code_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

error_description property (AS4Server Struct)

The description of the error.

Syntax

fn error_description(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_description(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_description_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

error_detail property (AS4Server Struct)

Additional details about the error.

Syntax

fn error_detail(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_detail(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_detail_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

error_origin property (AS4Server Struct)

The module within which the error occurred.

Syntax

fn error_origin(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_origin(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_origin_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

error_ref_message_id property (AS4Server Struct)

The MessageId to which the error applies.

Syntax

fn error_ref_message_id(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_ref_message_id(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_ref_message_id_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

error_severity property (AS4Server Struct)

The severity of the error.

Syntax

fn error_severity(&self , ErrorIndex : i32) -> Result<i32, IPWorksEDIError> 
fn set_error_severity(&self, ErrorIndex : i32, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // Warning
1   // Failure

Default Value

0

Remarks

The severity of the error. Possible values are:

• 0 (ebstWarning - default)
• 1 (ebstFailure)

This value is required.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

Data Type

i32

error_short_description property (AS4Server Struct)

A short description of the error.

Syntax

fn error_short_description(&self , ErrorIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_error_short_description(&self, ErrorIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_error_short_description_ref(&self, ErrorIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

incoming_directory property (AS4Server Struct)

The directory to which incoming files are saved.

Syntax

fn incoming_directory(&self ) -> Result<String, IPWorksEDIError> 
fn set_incoming_directory(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_incoming_directory_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

If incoming_directory 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 edi_data.

Data Type

String

incoming_receipt_content property (AS4Server Struct)

The content of the receipt.

Syntax

fn incoming_receipt_content(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The content of the receipt. This is the raw XML of the receipt.

The struct 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.

This property is read-only.

Data Type

String

incoming_receipt_ref_to_message_id property (AS4Server Struct)

The Message Id to which this receipt applies.

Syntax

fn incoming_receipt_ref_to_message_id(&self ) -> Result<String, IPWorksEDIError> 

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

This property is read-only.

Data Type

String

log_directory property (AS4Server Struct)

The path to a directory for logging.

Syntax

fn log_directory(&self ) -> Result<String, IPWorksEDIError> 
fn set_log_directory(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_log_directory_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

The struct will write multiple log files for each transmission, with separate extensions for each type of data:

One or more of these log files may be disabled by setting the LogOptions configuration setting. log_directory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the struct will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the struct. 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 log_file 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

log_file property (AS4Server Struct)

The log file written.

Syntax

fn log_file(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

If log_directory is specified a log file will be written in the specified directory and log_file will contain the full path and name of the files written, minus the extension.

The struct will write multiple log files for each transmission, with separate extensions for each type of data:

One or more of these log files may be disabled by setting the LogOptions configuration setting. log_directory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the struct will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the struct. 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 log_file 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

message_id property (AS4Server Struct)

The unique Id of the message.

Syntax

fn message_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_message_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property defines the unique Id of the message. When sending files the struct 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 send_files. In AS4Server this may be set after calling read_request and before calling send_response.

Data Type

String

message_property_count property (AS4Server Struct)

The number of records in the MessageProperty arrays.

Syntax

fn message_property_count(&self ) -> Result<i32, IPWorksEDIError> 
fn set_message_property_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_property_name
• message_property_property_type
• message_property_value

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

Data Type

i32

message_property_name property (AS4Server Struct)

This property defines the name of the message property.

Syntax

fn message_property_name(&self , MessagePropertyIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_message_property_name(&self, MessagePropertyIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_property_name_ref(&self, MessagePropertyIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

message_property_property_type property (AS4Server Struct)

The optional type of the message property.

Syntax

fn message_property_property_type(&self , MessagePropertyIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_message_property_property_type(&self, MessagePropertyIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_property_property_type_ref(&self, MessagePropertyIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

message_property_value property (AS4Server Struct)

The value of the message property.

Syntax

fn message_property_value(&self , MessagePropertyIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_message_property_value(&self, MessagePropertyIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_property_value_ref(&self, MessagePropertyIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

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.

Data Type

String

mpc property (AS4Server Struct)

The MPC (Message Partition Channel) from which files are requested.

Syntax

fn mpc(&self ) -> Result<String, IPWorksEDIError> 
fn set_mpc(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_mpc_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property specifies the MPC (Message Partition Channel) from which to receive files. This must be set before calling receive_files. 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"

This property defines the MPC (Message Partition Channel) from which the client requests files. This is populated after calling read_request and is used to determine from which channel to provide files to the client.

This value corresponds to the ebMS element "eb:Messaging/eb:SignalMessage/eb:PullRequest/@mpc"

Data Type

String

original_soap_message property (AS4Server Struct)

The original SOAP message used to verify the receipt.

Syntax

fn original_soap_message(&self ) -> Result<String, IPWorksEDIError> 
fn set_original_soap_message(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_original_soap_message_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

original_soap_message and original_soap_message_id may be used as an alternative to async_receipt_info_dir when verifying receipts.

If async_receipt_info_dir 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.

Data Type

String

original_soap_message_id property (AS4Server Struct)

The original SOAP message Id used to verify the receipt.

Syntax

fn original_soap_message_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_original_soap_message_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_original_soap_message_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

original_soap_message and original_soap_message_id may be used as an alternative to async_receipt_info_dir when verifying receipts.

If async_receipt_info_dir 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.

Data Type

String

profile property (AS4Server Struct)

The AS4 profile.

Syntax

fn profile(&self ) -> Result<i32, IPWorksEDIError> 
fn set_profile(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // Standard
1   // ENTSOG
2   // EDelivery
3   // BDEW
4   // ENTSOG_V4
5   // EDelivery_V2

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:

When profile is set to ebpfENTSOG the following settings are automatically applied:

When profile is set to ebpfENTSOG_V4, version 4 of the ENTSOG profile is used and the following settings are automatically applied:

When profile is set to ebpfEDelivery the following settings are automatically applied:

When profile is set to ebpfEDelivery_V2, version 2 of the eDelivery profile is used and the following settings are automatically applied:

When profile is set to ebpfBDEW the following settings are automatically applied:

Note: When ebpfBDEW is selected, both the SigningCert and Encryption Cert(recipientCert) MUST use ECDSA with the BrainpoolP256r1 curve.

Data Type

i32

receipt_content property (AS4Server Struct)

The content of the receipt.

Syntax

fn receipt_content(&self ) -> Result<String, IPWorksEDIError> 
fn set_receipt_content(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_receipt_content_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The content of the receipt. This is the raw XML of the receipt.

The struct 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

receipt_ref_to_message_id property (AS4Server Struct)

The Message Id to which this receipt applies.

Syntax

fn receipt_ref_to_message_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_receipt_ref_to_message_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_receipt_ref_to_message_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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 struct 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

receipt_reply_mode property (AS4Server Struct)

The expected receipt reply mode.

Syntax

fn receipt_reply_mode(&self ) -> Result<i32, IPWorksEDIError> 
fn set_receipt_reply_mode(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // Sync
1   // Async
2   // None

Default Value

0

Remarks

This setting tells the struct how to expect or deliver a receipt. Possible values are:

It is important to always set this property to the correct value in both AS4Client and AS4Server, whether sending or receiving, so the struct can build a valid message. This should be set to the previously agreed upon value between the parties in the agreement identified by agreement_ref

Data Type

i32

recipient_cert_count property (AS4Server Struct)

The number of records in the RecipientCert arrays.

Syntax

fn recipient_cert_count(&self ) -> Result<i32, IPWorksEDIError> 
fn set_recipient_cert_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• recipient_cert_effective_date
• recipient_cert_encoded
• recipient_cert_expiration_date
• recipient_cert_extended_key_usage
• recipient_cert_fingerprint
• recipient_cert_fingerprint_sha1
• recipient_cert_fingerprint_sha256
• recipient_cert_issuer
• recipient_cert_private_key
• recipient_cert_private_key_available
• recipient_cert_private_key_container
• recipient_cert_public_key
• recipient_cert_public_key_algorithm
• recipient_cert_public_key_length
• recipient_cert_serial_number
• recipient_cert_signature_algorithm
• recipient_cert_store
• recipient_cert_store_password
• recipient_cert_store_type
• recipient_cert_subject
• recipient_cert_subject_alt_names
• recipient_cert_thumbprint_md5
• recipient_cert_thumbprint_sha1
• recipient_cert_thumbprint_sha256
• recipient_cert_usage
• recipient_cert_usage_flags
• recipient_cert_version

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

Data Type

i32

recipient_cert_effective_date property (AS4Server Struct)

The date on which this certificate becomes valid.

Syntax

fn recipient_cert_effective_date(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

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

This property is read-only.

Data Type

String

recipient_cert_expiration_date property (AS4Server Struct)

The date on which the certificate expires.

Syntax

fn recipient_cert_expiration_date(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

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

This property is read-only.

Data Type

String

recipient_cert_extended_key_usage property (AS4Server Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn recipient_cert_extended_key_usage(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_fingerprint property (AS4Server Struct)

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

Syntax

fn recipient_cert_fingerprint(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

recipient_cert_fingerprint_sha1 property (AS4Server Struct)

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

Syntax

fn recipient_cert_fingerprint_sha1(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

recipient_cert_fingerprint_sha256 property (AS4Server Struct)

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

Syntax

fn recipient_cert_fingerprint_sha256(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

recipient_cert_issuer property (AS4Server Struct)

The issuer of the certificate.

Syntax

fn recipient_cert_issuer(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_private_key property (AS4Server Struct)

The private key of the certificate (if available).

Syntax

fn recipient_cert_private_key(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

recipient_cert_private_key_available property (AS4Server Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn recipient_cert_private_key_available(&self , RecipientCertIndex : i32) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

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

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

This property is read-only.

Data Type

bool

recipient_cert_private_key_container property (AS4Server Struct)

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

Syntax

fn recipient_cert_private_key_container(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_public_key property (AS4Server Struct)

The public key of the certificate.

Syntax

fn recipient_cert_public_key(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_public_key_algorithm property (AS4Server Struct)

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

Syntax

fn recipient_cert_public_key_algorithm(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_public_key_length property (AS4Server Struct)

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

Syntax

fn recipient_cert_public_key_length(&self , RecipientCertIndex : i32) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

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

This property is read-only.

Data Type

i32

recipient_cert_serial_number property (AS4Server Struct)

The serial number of the certificate encoded as a string.

Syntax

fn recipient_cert_serial_number(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_signature_algorithm property (AS4Server Struct)

The text description of the certificate's signature algorithm.

Syntax

fn recipient_cert_signature_algorithm(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_store property (AS4Server Struct)

The name of the certificate store for the client certificate.

Syntax

fn recipient_cert_store(&self , RecipientCertIndex : i32) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_recipient_cert_store(&self, RecipientCertIndex : i32, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_store_ref(&self, RecipientCertIndex : i32, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The recipient_cert_store_type property denotes the type of the certificate store specified by recipient_cert_store. If the store is password-protected, specify the password in recipient_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

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

Data Type

Vec

recipient_cert_store_password property (AS4Server Struct)

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

Syntax

fn recipient_cert_store_password(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_recipient_cert_store_password(&self, RecipientCertIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_store_password_ref(&self, RecipientCertIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

String

recipient_cert_store_type property (AS4Server Struct)

The type of certificate store for this certificate.

Syntax

fn recipient_cert_store_type(&self , RecipientCertIndex : i32) -> Result<i32, IPWorksEDIError> 
fn set_recipient_cert_store_type(&self, RecipientCertIndex : i32, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

Data Type

i32

recipient_cert_subject_alt_names property (AS4Server Struct)

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

Syntax

fn recipient_cert_subject_alt_names(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_thumbprint_md5 property (AS4Server Struct)

The MD5 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_md5(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_thumbprint_sha1 property (AS4Server Struct)

The SHA-1 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_sha1(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_thumbprint_sha256 property (AS4Server Struct)

The SHA-256 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_sha256(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_usage property (AS4Server Struct)

The text description of UsageFlags .

Syntax

fn recipient_cert_usage(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of recipient_cert_usage_flags.

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

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

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

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

This property is read-only.

Data Type

String

recipient_cert_usage_flags property (AS4Server Struct)

The flags that show intended use for the certificate.

Syntax

fn recipient_cert_usage_flags(&self , RecipientCertIndex : i32) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the recipient_cert_usage property for a text representation of recipient_cert_usage_flags.

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

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

This property is read-only.

Data Type

i32

recipient_cert_version property (AS4Server Struct)

The certificate's version number.

Syntax

fn recipient_cert_version(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_subject property (AS4Server Struct)

The subject of the certificate used for client authentication.

Syntax

fn recipient_cert_subject(&self , RecipientCertIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_recipient_cert_subject(&self, RecipientCertIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_subject_ref(&self, RecipientCertIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

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

Data Type

String

recipient_cert_encoded property (AS4Server Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn recipient_cert_encoded(&self , RecipientCertIndex : i32) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_recipient_cert_encoded(&self, RecipientCertIndex : i32, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_encoded_ref(&self, RecipientCertIndex : i32, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

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

Data Type

Vec

ref_to_message_id property (AS4Server Struct)

Specifies the RefToMessageId in the message.

Syntax

fn ref_to_message_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_ref_to_message_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ref_to_message_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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 ref_to_message_id 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

request property (AS4Server Struct)

The HTTP request to be processed.

Syntax

fn request(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_request(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_request_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The body of the request to be processed. The HTTP headers may be set separately in request_headers_string. If they are included, a double CRLF pair should be used to separate the headers from the body.

Data Type

Vec

request_header_count property (AS4Server Struct)

The number of records in the RequestHeader arrays.

Syntax

fn request_header_count(&self ) -> Result<i32, IPWorksEDIError> 
fn set_request_header_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• request_header_field
• request_header_value

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

Data Type

i32

request_header_field property (AS4Server Struct)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

fn request_header_field(&self , RequestHeaderIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_request_header_field(&self, RequestHeaderIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_request_header_field_ref(&self, RequestHeaderIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

Data Type

String

request_header_value property (AS4Server Struct)

This property contains the header contents.

Syntax

fn request_header_value(&self , RequestHeaderIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_request_header_value(&self, RequestHeaderIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_request_header_value_ref(&self, RequestHeaderIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property contains the Header contents.

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

Data Type

String

request_headers_string property (AS4Server Struct)

The HTTP headers in the AS4 request.

Syntax

fn request_headers_string(&self ) -> Result<String, IPWorksEDIError> 
fn set_request_headers_string(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_request_headers_string_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The entire list of headers, concatenated into a single string. These will include all HTTP headers. Specific headers may be accessed through request_headers.

Data Type

String

rollover_cert_effective_date property (AS4Server Struct)

The date on which this certificate becomes valid.

Syntax

fn rollover_cert_effective_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

rollover_cert_expiration_date property (AS4Server Struct)

The date on which the certificate expires.

Syntax

fn rollover_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

rollover_cert_extended_key_usage property (AS4Server Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn rollover_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_fingerprint property (AS4Server Struct)

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

Syntax

fn rollover_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_cert_fingerprint_sha1 property (AS4Server Struct)

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

Syntax

fn rollover_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_cert_fingerprint_sha256 property (AS4Server Struct)

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

Syntax

fn rollover_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_cert_issuer property (AS4Server Struct)

The issuer of the certificate.

Syntax

fn rollover_cert_issuer(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_private_key property (AS4Server Struct)

The private key of the certificate (if available).

Syntax

fn rollover_cert_private_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_cert_private_key_available property (AS4Server Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn rollover_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

rollover_cert_private_key_container property (AS4Server Struct)

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

Syntax

fn rollover_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_public_key property (AS4Server Struct)

The public key of the certificate.

Syntax

fn rollover_cert_public_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_public_key_algorithm property (AS4Server Struct)

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

Syntax

fn rollover_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_public_key_length property (AS4Server Struct)

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

Syntax

fn rollover_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

rollover_cert_serial_number property (AS4Server Struct)

The serial number of the certificate encoded as a string.

Syntax

fn rollover_cert_serial_number(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_signature_algorithm property (AS4Server Struct)

The text description of the certificate's signature algorithm.

Syntax

fn rollover_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_store property (AS4Server Struct)

The name of the certificate store for the client certificate.

Syntax

fn rollover_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_rollover_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_rollover_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The rollover_cert_store_type property denotes the type of the certificate store specified by rollover_cert_store. If the store is password-protected, specify the password in rollover_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

rollover_cert_store_password property (AS4Server Struct)

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

Syntax

fn rollover_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_rollover_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_rollover_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

rollover_cert_store_type property (AS4Server Struct)

The type of certificate store for this certificate.

Syntax

fn rollover_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_rollover_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

rollover_cert_subject_alt_names property (AS4Server Struct)

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

Syntax

fn rollover_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_thumbprint_md5 property (AS4Server Struct)

The MD5 hash of the certificate.

Syntax

fn rollover_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_thumbprint_sha1 property (AS4Server Struct)

The SHA-1 hash of the certificate.

Syntax

fn rollover_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_thumbprint_sha256 property (AS4Server Struct)

The SHA-256 hash of the certificate.

Syntax

fn rollover_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_usage property (AS4Server Struct)

The text description of UsageFlags .

Syntax

fn rollover_cert_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of rollover_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

rollover_cert_usage_flags property (AS4Server Struct)

The flags that show intended use for the certificate.

Syntax

fn rollover_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the rollover_cert_usage property for a text representation of rollover_cert_usage_flags.

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

This property is read-only.

Data Type

i32

rollover_cert_version property (AS4Server Struct)

The certificate's version number.

Syntax

fn rollover_cert_version(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_cert_subject property (AS4Server Struct)

The subject of the certificate used for client authentication.

Syntax

fn rollover_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_rollover_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_rollover_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

rollover_cert_encoded property (AS4Server Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn rollover_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_rollover_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_rollover_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec

rollover_signing_cert_effective_date property (AS4Server Struct)

The date on which this certificate becomes valid.

Syntax

fn rollover_signing_cert_effective_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

rollover_signing_cert_expiration_date property (AS4Server Struct)

The date on which the certificate expires.

Syntax

fn rollover_signing_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

rollover_signing_cert_extended_key_usage property (AS4Server Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn rollover_signing_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_fingerprint property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_signing_cert_fingerprint_sha1 property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_signing_cert_fingerprint_sha256 property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_signing_cert_issuer property (AS4Server Struct)

The issuer of the certificate.

Syntax

fn rollover_signing_cert_issuer(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_private_key property (AS4Server Struct)

The private key of the certificate (if available).

Syntax

fn rollover_signing_cert_private_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

rollover_signing_cert_private_key_available property (AS4Server Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn rollover_signing_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

rollover_signing_cert_private_key_container property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_public_key property (AS4Server Struct)

The public key of the certificate.

Syntax

fn rollover_signing_cert_public_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_public_key_algorithm property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_public_key_length property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

rollover_signing_cert_serial_number property (AS4Server Struct)

The serial number of the certificate encoded as a string.

Syntax

fn rollover_signing_cert_serial_number(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_signature_algorithm property (AS4Server Struct)

The text description of the certificate's signature algorithm.

Syntax

fn rollover_signing_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_store property (AS4Server Struct)

The name of the certificate store for the client certificate.

Syntax

fn rollover_signing_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_rollover_signing_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_rollover_signing_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The rollover_signing_cert_store_type property denotes the type of the certificate store specified by rollover_signing_cert_store. If the store is password-protected, specify the password in rollover_signing_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

rollover_signing_cert_store_password property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_rollover_signing_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_rollover_signing_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

rollover_signing_cert_store_type property (AS4Server Struct)

The type of certificate store for this certificate.

Syntax

fn rollover_signing_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_rollover_signing_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

rollover_signing_cert_subject_alt_names property (AS4Server Struct)

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

Syntax

fn rollover_signing_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_thumbprint_md5 property (AS4Server Struct)

The MD5 hash of the certificate.

Syntax

fn rollover_signing_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_thumbprint_sha1 property (AS4Server Struct)

The SHA-1 hash of the certificate.

Syntax

fn rollover_signing_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_thumbprint_sha256 property (AS4Server Struct)

The SHA-256 hash of the certificate.

Syntax

fn rollover_signing_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_usage property (AS4Server Struct)

The text description of UsageFlags .

Syntax

fn rollover_signing_cert_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of rollover_signing_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

rollover_signing_cert_usage_flags property (AS4Server Struct)

The flags that show intended use for the certificate.

Syntax

fn rollover_signing_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the rollover_signing_cert_usage property for a text representation of rollover_signing_cert_usage_flags.

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

This property is read-only.

Data Type

i32

rollover_signing_cert_version property (AS4Server Struct)

The certificate's version number.

Syntax

fn rollover_signing_cert_version(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

rollover_signing_cert_subject property (AS4Server Struct)

The subject of the certificate used for client authentication.

Syntax

fn rollover_signing_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_rollover_signing_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_rollover_signing_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

rollover_signing_cert_encoded property (AS4Server Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn rollover_signing_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_rollover_signing_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_rollover_signing_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec

service property (AS4Server Struct)

The service which acts on the message.

Syntax

fn service(&self ) -> Result<String, IPWorksEDIError> 
fn set_service(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_service_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

service_action property (AS4Server Struct)

The action within a service that acts on the message.

Syntax

fn service_action(&self ) -> Result<String, IPWorksEDIError> 
fn set_service_action(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_service_action_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

service_type property (AS4Server Struct)

The type of service.

Syntax

fn service_type(&self ) -> Result<String, IPWorksEDIError> 
fn set_service_type(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_service_type_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

signature_algorithm property (AS4Server Struct)

Signature algorithm to be used in the message.

Syntax

fn signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 
fn set_signature_algorithm(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signature_algorithm_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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
• EDDSA-ED25519
• EDDSA-ED448

The default value is "SHA-256".

Data Type

String

signer_cert_effective_date property (AS4Server Struct)

The date on which this certificate becomes valid.

Syntax

fn signer_cert_effective_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

signer_cert_expiration_date property (AS4Server Struct)

The date on which the certificate expires.

Syntax

fn signer_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

signer_cert_extended_key_usage property (AS4Server Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn signer_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_fingerprint property (AS4Server Struct)

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

Syntax

fn signer_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signer_cert_fingerprint_sha1 property (AS4Server Struct)

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

Syntax

fn signer_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signer_cert_fingerprint_sha256 property (AS4Server Struct)

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

Syntax

fn signer_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signer_cert_issuer property (AS4Server Struct)

The issuer of the certificate.

Syntax

fn signer_cert_issuer(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_private_key property (AS4Server Struct)

The private key of the certificate (if available).

Syntax

fn signer_cert_private_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signer_cert_private_key_available property (AS4Server Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn signer_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signer_cert_private_key_container property (AS4Server Struct)

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

Syntax

fn signer_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_public_key property (AS4Server Struct)

The public key of the certificate.

Syntax

fn signer_cert_public_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_public_key_algorithm property (AS4Server Struct)

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

Syntax

fn signer_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_public_key_length property (AS4Server Struct)

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

Syntax

fn signer_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

signer_cert_serial_number property (AS4Server Struct)

The serial number of the certificate encoded as a string.

Syntax

fn signer_cert_serial_number(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_signature_algorithm property (AS4Server Struct)

The text description of the certificate's signature algorithm.

Syntax

fn signer_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_store property (AS4Server Struct)

The name of the certificate store for the client certificate.

Syntax

fn signer_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signer_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signer_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The signer_cert_store_type property denotes the type of the certificate store specified by signer_cert_store. If the store is password-protected, specify the password in signer_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

signer_cert_store_password property (AS4Server Struct)

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

Syntax

fn signer_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_signer_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signer_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

signer_cert_store_type property (AS4Server Struct)

The type of certificate store for this certificate.

Syntax

fn signer_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_signer_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

signer_cert_subject_alt_names property (AS4Server Struct)

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

Syntax

fn signer_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_thumbprint_md5 property (AS4Server Struct)

The MD5 hash of the certificate.

Syntax

fn signer_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_thumbprint_sha1 property (AS4Server Struct)

The SHA-1 hash of the certificate.

Syntax

fn signer_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_thumbprint_sha256 property (AS4Server Struct)

The SHA-256 hash of the certificate.

Syntax

fn signer_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_usage property (AS4Server Struct)

The text description of UsageFlags .

Syntax

fn signer_cert_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of signer_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

signer_cert_usage_flags property (AS4Server Struct)

The flags that show intended use for the certificate.

Syntax

fn signer_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the signer_cert_usage property for a text representation of signer_cert_usage_flags.

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

This property is read-only.

Data Type

i32

signer_cert_version property (AS4Server Struct)

The certificate's version number.

Syntax

fn signer_cert_version(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_subject property (AS4Server Struct)

The subject of the certificate used for client authentication.

Syntax

fn signer_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_signer_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signer_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

signer_cert_encoded property (AS4Server Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn signer_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signer_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signer_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec

signing_cert_effective_date property (AS4Server Struct)

The date on which this certificate becomes valid.

Syntax

fn signing_cert_effective_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

signing_cert_expiration_date property (AS4Server Struct)

The date on which the certificate expires.

Syntax

fn signing_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

signing_cert_extended_key_usage property (AS4Server Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn signing_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_fingerprint property (AS4Server Struct)

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

Syntax

fn signing_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signing_cert_fingerprint_sha1 property (AS4Server Struct)

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

Syntax

fn signing_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signing_cert_fingerprint_sha256 property (AS4Server Struct)

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

Syntax

fn signing_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signing_cert_issuer property (AS4Server Struct)

The issuer of the certificate.

Syntax

fn signing_cert_issuer(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_private_key property (AS4Server Struct)

The private key of the certificate (if available).

Syntax

fn signing_cert_private_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signing_cert_private_key_available property (AS4Server Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn signing_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signing_cert_private_key_container property (AS4Server Struct)

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

Syntax

fn signing_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_public_key property (AS4Server Struct)

The public key of the certificate.

Syntax

fn signing_cert_public_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_public_key_algorithm property (AS4Server Struct)

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

Syntax

fn signing_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_public_key_length property (AS4Server Struct)

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

Syntax

fn signing_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

signing_cert_serial_number property (AS4Server Struct)

The serial number of the certificate encoded as a string.

Syntax

fn signing_cert_serial_number(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_signature_algorithm property (AS4Server Struct)

The text description of the certificate's signature algorithm.

Syntax

fn signing_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_store property (AS4Server Struct)

The name of the certificate store for the client certificate.

Syntax

fn signing_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signing_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signing_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The signing_cert_store_type property denotes the type of the certificate store specified by signing_cert_store. If the store is password-protected, specify the password in signing_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

signing_cert_store_password property (AS4Server Struct)

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

Syntax

fn signing_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_signing_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signing_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

signing_cert_store_type property (AS4Server Struct)

The type of certificate store for this certificate.

Syntax

fn signing_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_signing_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

signing_cert_subject_alt_names property (AS4Server Struct)

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

Syntax

fn signing_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_thumbprint_md5 property (AS4Server Struct)

The MD5 hash of the certificate.

Syntax

fn signing_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_thumbprint_sha1 property (AS4Server Struct)

The SHA-1 hash of the certificate.

Syntax

fn signing_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_thumbprint_sha256 property (AS4Server Struct)

The SHA-256 hash of the certificate.

Syntax

fn signing_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_usage property (AS4Server Struct)

The text description of UsageFlags .

Syntax

fn signing_cert_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of signing_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

signing_cert_usage_flags property (AS4Server Struct)

The flags that show intended use for the certificate.

Syntax

fn signing_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the signing_cert_usage property for a text representation of signing_cert_usage_flags.

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

This property is read-only.

Data Type

i32

signing_cert_version property (AS4Server Struct)

The certificate's version number.

Syntax

fn signing_cert_version(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_subject property (AS4Server Struct)

The subject of the certificate used for client authentication.

Syntax

fn signing_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_signing_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signing_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

signing_cert_encoded property (AS4Server Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn signing_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signing_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signing_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec

config method (AS4Server Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEDIError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

do_events method (AS4Server Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksEDIError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

interrupt method (AS4Server Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksEDIError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

parse_request method (AS4Server Struct)

Parses and processes the message.

Syntax

fn parse_request(&self) -> Result<(), IPWorksEDIError>

Remarks

This method processes the message in the request. If the message is encrypted, it will be decrypted. If the message is signed, the signature will be verified. This method should be called after calling read_request and specifying any necessary certificates for the operation to complete successfully.

Receiving Files and Sending a Receipt

When receiving files first check the agreement_ref, as4_from, and as4_to properties to determine who is sending the files and with what previously agreed upon configuration. Once this is known, if the request is signed and encrypted set certificate to the decryption certificate and signer_cert to the public certificate used for signature verification. incoming_directory may optionally be set to automatically store the incoming files. //Process incoming files and send a signed receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmSync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendResponse(); //Sends the receipt Receiving Files and Sending an Asynchronous Receipt

Receipts may be sent in the response (synchronous) or at a later time (asynchronous). If the agreement specifies that the receipt be sent asynchronously the following steps may be taken to send the receipt.

After calling read_request the receipt_reply_mode may be set to indicate the receipt will be returned asynchronously. After calling parse_request call send_ack_response to send back a HTTP 200 OK to the client. The receipt may then be returned later.

To send an asynchronous receipt AS4Client may be used. This can be sent to the partner's web site, or bundled with a later response (depending on the agreement made between the parties). In the example below AS4Client is used to send the receipt to the other party's web site.

//Process incoming files and send an asynchronous receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendAckResponse(); //Sends an ack, but not the receipt At this point receipt is populated with the receipt to be sent. Store the Receipt's receipt_content and receipt_ref_to_message_id values for use when sending the receipt later. Sending a receipt can be done with AS4Client.

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

Sending Files

To process a request to send files first check the mpc property. This holds the Message Partition Channel (MPC) from which the client would like to receive files. Next, set agreement_ref, as4_from, as4_to. Check incoming_receipt to determine if the request has a bundled receipt. If it does verify_receipt can be called to verify the receipt.

Note: If the client requests files from the default MPC then mpc may be empty. See MessageType for details.

If the client makes use of UsernameToken authentication the on_token_authentication event will fire when processing the request.

To send files back to the client simply set edi_data to the files you wish to send. When send_response is called the files will be sent back to the client.

//Process a request to send files (pull) //Holds information from the original send so that receipts can be verified later server.AsyncReceiptInfoDir = Path.Combine(Request.PhysicalApplicationPath, "..\\temp\\ReceiptInfoDir") server.Profile = As4serverProfiles.ebpfENTSOG; server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request has a bundled receipt verify it first if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); } //If the request is a pull request (MPC is set) if (server.AgreementRef == "" && server.MPC != "") { server.AgreementRef = "http://agreements.company.com/pull_files"; server.AS4From.Id = "org:holodeckb2b:example:company:B"; server.AS4From.Role = "Sender"; server.AS4To.Id = "org:holodeckb2b:example:company:A"; server.AS4To.Role = "Receiver"; server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the message and files. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to encrypt files. server.RecipientCerts.Add(new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer"))); EBData data = new EBData(); data.EDIType = "text/xml"; data.Data = "<test>Hello AS4 World!</test>"; server.EDIData.Add(data); server.SendResponse(); }

read_request method (AS4Server Struct)

Reads the AS4 request.

Syntax

fn read_request(&self) -> Result<(), IPWorksEDIError>

Remarks

To begin, when a request is received first call read_request. This reads the AS4 request from the content of the request (and optionally the request_headers_string) property. Alternatively the request data may be passed directly to the struct by specifying calling set_request_stream. After calling read_request the following properties may be checked:

• agreement_ref
• as4_from
• as4_to
• conversation_id
• edi_data
• errors
• incoming_receipt
• message_id
• message_properties
• mpc
• service
• service_action
• service_type

The first step after calling read_request is to determine if the client is sending files (push) or requesting files (pull). To determine this check the value of agreement_ref and mpc. For instance: if (server.AgreementRef == "" && server.MPC != "") { //The client is requesting files from the specified MPC //No other relevant properties are populated } else //AgreementRef is not empty, and MPC is empty { //The client is sending files. AgreementRef is populated with the agreement reference. //AS4From, AS4To, ConversationId, etc are populated }

Determining if the request contains an asynchronous receipt from a previous transmission may also be done at this time by checking the incoming_receipt property's incoming_receipt_content property. If it is populated a receipt is present. To verify the receipt set async_receipt_info_dir to the directory where information about the message was originally stored and call verify_receipt. If the receipt is signed signer_cert must also be set. See the section below and also send_files for more details.

Once information about the request is determined the struct may then be configured to respond appropriately depending on the operation.

reset method (AS4Server Struct)

Resets the state of the control.

Syntax

fn reset(&self) -> Result<(), IPWorksEDIError>

Remarks

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

send_ack_response method (AS4Server Struct)

Sends an acknowledgement of the request only.

Syntax

fn send_ack_response(&self) -> Result<(), IPWorksEDIError>

Remarks

This method is used to respond to a client who sends a file and the agreement dictates that the receipt be returned asynchronously. In this case no receipt should be returned to the client. This method will send an acknowledgment only (no receipt) to the client to indicate that the request was received and processed.

This method is only applicable when receipt_reply_mode is set to rrmAsync.

send_response method (AS4Server Struct)

This method sends the response over the current HTTP context.

Syntax

fn send_response(&self) -> Result<(), IPWorksEDIError>

Remarks

This method sends the response. This should be called after parse_request to deliver the response to the client.

Receiving Files and Sending a Receipt

When receiving files first check the agreement_ref, as4_from, and as4_to properties to determine who is sending the files and with what previously agreed upon configuration. Once this is known, if the request is signed and encrypted set certificate to the decryption certificate and signer_cert to the public certificate used for signature verification. incoming_directory may optionally be set to automatically store the incoming files. //Process incoming files and send a signed receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmSync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendResponse(); //Sends the receipt Receiving Files and Sending an Asynchronous Receipt

Receipts may be sent in the response (synchronous) or at a later time (asynchronous). If the agreement specifies that the receipt be sent asynchronously the following steps may be taken to send the receipt.

After calling read_request the receipt_reply_mode may be set to indicate the receipt will be returned asynchronously. After calling parse_request call send_ack_response to send back a HTTP 200 OK to the client. The receipt may then be returned later.

To send an asynchronous receipt AS4Client may be used. This can be sent to the partner's web site, or bundled with a later response (depending on the agreement made between the parties). In the example below AS4Client is used to send the receipt to the other party's web site.

//Process incoming files and send an asynchronous receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendAckResponse(); //Sends an ack, but not the receipt At this point receipt is populated with the receipt to be sent. Store the Receipt's receipt_content and receipt_ref_to_message_id values for use when sending the receipt later. Sending a receipt can be done with AS4Client.

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

Sending Files

To process a request to send files first check the mpc property. This holds the Message Partition Channel (MPC) from which the client would like to receive files. Next, set agreement_ref, as4_from, as4_to. Check incoming_receipt to determine if the request has a bundled receipt. If it does verify_receipt can be called to verify the receipt.

Note: If the client requests files from the default MPC then mpc may be empty. See MessageType for details.

If the client makes use of UsernameToken authentication the on_token_authentication event will fire when processing the request.

To send files back to the client simply set edi_data to the files you wish to send. When send_response is called the files will be sent back to the client.

//Process a request to send files (pull) //Holds information from the original send so that receipts can be verified later server.AsyncReceiptInfoDir = Path.Combine(Request.PhysicalApplicationPath, "..\\temp\\ReceiptInfoDir") server.Profile = As4serverProfiles.ebpfENTSOG; server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request has a bundled receipt verify it first if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); } //If the request is a pull request (MPC is set) if (server.AgreementRef == "" && server.MPC != "") { server.AgreementRef = "http://agreements.company.com/pull_files"; server.AS4From.Id = "org:holodeckb2b:example:company:B"; server.AS4From.Role = "Sender"; server.AS4To.Id = "org:holodeckb2b:example:company:A"; server.AS4To.Role = "Receiver"; server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the message and files. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to encrypt files. server.RecipientCerts.Add(new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer"))); EBData data = new EBData(); data.EDIType = "text/xml"; data.Data = "<test>Hello AS4 World!</test>"; server.EDIData.Add(data); server.SendResponse(); }

verify_receipt method (AS4Server Struct)

Verifies a received receipt.

Syntax

fn verify_receipt(&self) -> Result<(), IPWorksEDIError>

Remarks

This method is used to verify asynchronous receipts held in incoming_receipt.

Processing Receipts

Any incoming request may potentially include a receipt. The request may be a receipt by itself, or it may be bundled with another type of request (send/receive). When initially sending files async_receipt_info_dir may be set to store data about the original message on disk for use when verifying the receipt. If this is not desired manually store the original_soap_message and original_soap_message_id instead.

To detect if an incoming request contains a receipt simply check the incoming_receipt property's receipt_content property. If it is populated the request includes a receipt. Set async_receipt_info_dir to the same location as when the file was originally sent. Or alternatively set original_soap_message and original_soap_message_id properties to the original values.

If the receipt is signed set signer_cert to the public certificate which will be used to verify the signature. Lastly call verify_receipt. This will perform any signature verification and verify the receipt content as well, matching it to the original message values.

server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request contains a receipt verify it if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); }

on_error event (AS4Server Struct)

Fired when information is available about errors during data delivery.

Syntax

// AS4ServerErrorEventArgs carries the AS4Server Error event's parameters.
pub struct AS4ServerErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// AS4ServerErrorEvent defines the signature of the AS4Server Error event's handler function.
pub trait AS4ServerErrorEvent {
  fn on_error(&self, sender : AS4Server, e : &mut AS4ServerErrorEventArgs);
}

impl <'a> AS4Server<'a> {
  pub fn on_error(&self) -> &'a dyn AS4ServerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn AS4ServerErrorEvent);
  ...
}

Remarks

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

The error_code 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.

on_log event (AS4Server Struct)

Fired with log information while processing a message.

Syntax

// AS4ServerLogEventArgs carries the AS4Server Log event's parameters.
pub struct AS4ServerLogEventArgs {
  fn log_type(&self) -> &String
  fn log_message(&self) -> &String
}

// AS4ServerLogEvent defines the signature of the AS4Server Log event's handler function.
pub trait AS4ServerLogEvent {
  fn on_log(&self, sender : AS4Server, e : &mut AS4ServerLogEventArgs);
}

impl <'a> AS4Server<'a> {
  pub fn on_log(&self) -> &'a dyn AS4ServerLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn AS4ServerLogEvent);
  ...
}

Remarks

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

Log messages available through this event correspond to log files written to log_directory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of log_directory (i.e. when log_directory 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:

on_recipient_info event (AS4Server Struct)

Fired for each recipient certificate of the encrypted message.

Syntax

// AS4ServerRecipientInfoEventArgs carries the AS4Server RecipientInfo event's parameters.
pub struct AS4ServerRecipientInfoEventArgs {
  fn issuer(&self) -> &String
  fn serial_number(&self) -> &String
  fn subject_key_identifier(&self) -> &String
  fn encryption_algorithm(&self) -> &String
}

// AS4ServerRecipientInfoEvent defines the signature of the AS4Server RecipientInfo event's handler function.
pub trait AS4ServerRecipientInfoEvent {
  fn on_recipient_info(&self, sender : AS4Server, e : &mut AS4ServerRecipientInfoEventArgs);
}

impl <'a> AS4Server<'a> {
  pub fn on_recipient_info(&self) -> &'a dyn AS4ServerRecipientInfoEvent;
  pub fn set_on_recipient_info(&mut self, value : &'a dyn AS4ServerRecipientInfoEvent);
  ...
}

Remarks

When parse_request 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"

on_signer_cert_info event (AS4Server Struct)

This event is fired during verification of the signed message.

Syntax

// AS4ServerSignerCertInfoEventArgs carries the AS4Server SignerCertInfo event's parameters.
pub struct AS4ServerSignerCertInfoEventArgs {
  fn issuer(&self) -> &String
  fn serial_number(&self) -> &String
  fn subject_key_identifier(&self) -> &String
  fn cert_encoded(&self) -> &[u8]
}

// AS4ServerSignerCertInfoEvent defines the signature of the AS4Server SignerCertInfo event's handler function.
pub trait AS4ServerSignerCertInfoEvent {
  fn on_signer_cert_info(&self, sender : AS4Server, e : &mut AS4ServerSignerCertInfoEventArgs);
}

impl <'a> AS4Server<'a> {
  pub fn on_signer_cert_info(&self) -> &'a dyn AS4ServerSignerCertInfoEvent;
  pub fn set_on_signer_cert_info(&mut self, value : &'a dyn AS4ServerSignerCertInfoEvent);
  ...
}

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 signer_cert 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 struct will automatically use this value to perform signature verification.

The signer_cert 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.

on_token_authentication event (AS4Server Struct)

Fired when the client makes use of UsernameToken authentication.

Syntax

// AS4ServerTokenAuthenticationEventArgs carries the AS4Server TokenAuthentication event's parameters.
pub struct AS4ServerTokenAuthenticationEventArgs {
  fn user(&self) -> &String
  fn password(&self) -> &String
  fn set_password(&self, value : &str)
  fn set_password_ref(&self, value : &String)
  fn password_type(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// AS4ServerTokenAuthenticationEvent defines the signature of the AS4Server TokenAuthentication event's handler function.
pub trait AS4ServerTokenAuthenticationEvent {
  fn on_token_authentication(&self, sender : AS4Server, e : &mut AS4ServerTokenAuthenticationEventArgs);
}

impl <'a> AS4Server<'a> {
  pub fn on_token_authentication(&self) -> &'a dyn AS4ServerTokenAuthenticationEvent;
  pub fn set_on_token_authentication(&mut self, value : &'a dyn AS4ServerTokenAuthenticationEvent);
  ...
}

Remarks

This event fires when a client sends a request that includes UsernameToken authentication. This is typically only used by clients initiating a pull request.

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 struct will hash the provided password value and compare it to the value in the request. If it matched the struct will accept the request. If it does not match the struct 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 client by calling send_response.

Config Settings (AS4Server Struct)

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

AS4Server Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (AS4Server Struct)

AS4Server Errors

HTTP Errors

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

TCPClient Errors

TCP/IP Errors