SOAPVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The SOAPVerifier class verifies signed SOAP messages.

Syntax

secureblackbox.SOAPVerifier

Remarks

Use this control to verify signatures over signed SOAP messages.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AllSignaturesValid Property (SOAPVerifier Class)

The cumulative validity of all signatures.

Syntax

public boolean isAllSignaturesValid();

Default Value

False

Remarks

Use this property to check if all the signatures found in the message or document are valid.

This property is read-only and not available at design time.

AutoValidateSignatures Property (SOAPVerifier Class)

Specifies whether class should validate any present signatures when the document is opened.

Syntax

public boolean isAutoValidateSignatures();


public void setAutoValidateSignatures(boolean autoValidateSignatures);

Default Value

True

Remarks

This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.

BlockedCertificates Property (SOAPVerifier Class)

The certificates that must be rejected as trust anchors.

Syntax

public CertificateList getBlockedCertificates();


public void setBlockedCertificates(CertificateList blockedCertificates);

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Certificates Property (SOAPVerifier Class)

A collection of certificates included in the electronic signature.

Syntax

public CertificateList getCertificates();

Remarks

This property includes a collection of certificates of the currently selected info.

This collection is indexed from 0 to size -1.

This property is read-only and not available at design time.

Please refer to the Certificate type for a complete list of fields.

CheckTrustedLists Property (SOAPVerifier Class)

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

Syntax

public boolean isCheckTrustedLists();


public void setCheckTrustedLists(boolean checkTrustedLists);

Default Value

False

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

CRLs Property (SOAPVerifier Class)

A collection of certificate revocation lists embedded into the signature by the signer.

Syntax

public CRLList getCRLs();

Remarks

Use this property to access the CRLs embedded into the signature by the signer.

This property is read-only and not available at design time.

Please refer to the CRL type for a complete list of fields.

Encoding Property (SOAPVerifier Class)

Specifies XML encoding.

Syntax

public String getEncoding();


public void setEncoding(String encoding);

Default Value

""

Remarks

Use this property to specify the encoding to apply to the XML documents.

FIPSMode Property (SOAPVerifier Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (SOAPVerifier Class)

Makes the class tolerant to chain validation errors.

Syntax

public boolean isIgnoreChainValidationErrors();


public void setIgnoreChainValidationErrors(boolean ignoreChainValidationErrors);

Default Value

False

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

InputBytes Property (SOAPVerifier Class)

Use this property to pass the input to class in byte array form.

Syntax

public byte[] getInputBytes();


public void setInputBytes(byte[] inputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

InputFile Property (SOAPVerifier Class)

A path to the signed SOAP message.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

Provide a path to the SOAP message to be verified.

InputStream Property (SOAPVerifier Class)

Stream containing the signed SOAP message.

Syntax

public java.io.InputStream getInputStream();


public void setInputStream(java.io.InputStream inputStream);

Default Value

null

Remarks

Use this property to pass the SOAP message to the class in a stream.

This property is not available at design time.

KnownCertificates Property (SOAPVerifier Class)

Additional certificates for chain validation.

Syntax

public CertificateList getKnownCertificates();


public void setKnownCertificates(CertificateList knownCertificates);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

KnownCRLs Property (SOAPVerifier Class)

Additional CRLs for chain validation.

Syntax

public CRLList getKnownCRLs();


public void setKnownCRLs(CRLList knownCRLs);

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

Please refer to the CRL type for a complete list of fields.

KnownOCSPs Property (SOAPVerifier Class)

Additional OCSP responses for chain validation.

Syntax

public OCSPResponseList getKnownOCSPs();


public void setKnownOCSPs(OCSPResponseList knownOCSPs);

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

Please refer to the OCSPResponse type for a complete list of fields.

OCSPs Property (SOAPVerifier Class)

A collection of OCSP responses embedded into the signature.

Syntax

public OCSPResponseList getOCSPs();

Remarks

Use this property to access the OCSP responses embedded into the signature by its creator.

This property is read-only and not available at design time.

Please refer to the OCSPResponse type for a complete list of fields.

OfflineMode Property (SOAPVerifier Class)

Switches the class to offline mode.

Syntax

public boolean isOfflineMode();


public void setOfflineMode(boolean offlineMode);

Default Value

False

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

OutputBytes Property (SOAPVerifier Class)

Use this property to read the output the class object has produced.

Syntax

public byte[] getOutputBytes();

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

OutputFile Property (SOAPVerifier Class)

A file where the extracted SOAP message is to be saved.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

Default Value

""

Remarks

Provide a path to the file where the updated SOAP message should be saved.

OutputStream Property (SOAPVerifier Class)

The stream where the modified SOAP message should be saved.

Syntax

public java.io.OutputStream getOutputStream();


public void setOutputStream(java.io.OutputStream outputStream);

Default Value

null

Remarks

Use this property to specify the stream to write the modified signed SOAP message to.

This property is not available at design time.

Profile Property (SOAPVerifier Class)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

public String getProfile();


public void setProfile(String profile);

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Proxy Property (SOAPVerifier Class)

The proxy server settings.

Syntax

public ProxySettings getProxy();

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Please refer to the ProxySettings type for a complete list of fields.

References Property (SOAPVerifier Class)

References covered by the signature.

Syntax

public XMLReferenceList getReferences();

Remarks

Use this property to get the references to the data covered by the signature.

This property is read-only and not available at design time.

Please refer to the XMLReference type for a complete list of fields.

RevocationCheck Property (SOAPVerifier Class)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

public int getRevocationCheck();


public void setRevocationCheck(int revocationCheck);


Enumerated values:
  public final static int crcNone = 0;
  public final static int crcAuto = 1;
  public final static int crcAllCRL = 2;
  public final static int crcAllOCSP = 3;
  public final static int crcAllCRLAndOCSP = 4;
  public final static int crcAnyCRL = 5;
  public final static int crcAnyOCSP = 6;
  public final static int crcAnyCRLOrOCSP = 7;
  public final static int crcAnyOCSPOrCRL = 8;

Default Value

1

Remarks

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Signatures Property (SOAPVerifier Class)

All signatures found in the SOAP message.

Syntax

public SOAPSignatureList getSignatures();

Remarks

This property contains a list of all signatures made over the SOAP message.

This property is read-only and not available at design time.

Please refer to the SOAPSignature type for a complete list of fields.

SocketSettings Property (SOAPVerifier Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

Timestamps Property (SOAPVerifier Class)

Contains a collection of timestamps for the processed document.

Syntax

public TimestampInfoList getTimestamps();

Remarks

Use this property to access the timestamps included in the processed document.

This property is read-only and not available at design time.

Please refer to the TimestampInfo type for a complete list of fields.

TLSClientChain Property (SOAPVerifier Class)

The TLS client certificate chain.

Syntax

public CertificateList getTLSClientChain();


public void setTLSClientChain(CertificateList TLSClientChain);

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

TLSServerChain Property (SOAPVerifier Class)

The TLS server's certificate chain.

Syntax

public CertificateList getTLSServerChain();

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

This property is read-only and not available at design time.

Please refer to the Certificate type for a complete list of fields.

TLSSettings Property (SOAPVerifier Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

TrustedCertificates Property (SOAPVerifier Class)

A list of trusted certificates for chain validation.

Syntax

public CertificateList getTrustedCertificates();


public void setTrustedCertificates(CertificateList trustedCertificates);

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ValidationMoment Property (SOAPVerifier Class)

The time point at which signature validity is to be established.

Syntax

public String getValidationMoment();


public void setValidationMoment(String validationMoment);

Default Value

""

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

AddKnownNamespace Method (SOAPVerifier Class)

Adds known prefix and correspondent namespace URI.

Syntax

public void addKnownNamespace(String prefix, String URI);

Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

Close Method (SOAPVerifier Class)

Closes an opened SOAP message.

Syntax

public void close(boolean saveChanges);

Remarks

Use this method to close a previously opened SOAP message. Set SaveChanges to true to apply any changes made.

Config Method (SOAPVerifier Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

DoAction Method (SOAPVerifier Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetInnerXML Method (SOAPVerifier Class)

Get the inner XML content of the selected XML element.

Syntax

public String getInnerXML(String XPath);

Remarks

Call this method to get the inner XML content of the selected XML element.

GetOuterXML Method (SOAPVerifier Class)

Get the outer XML content of the selected XML element.

Syntax

public String getOuterXML(String XPath);

Remarks

Call this method to get the outer XML content of the selected XML element.

GetSignedData Method (SOAPVerifier Class)

Returns the part of the XML document that is covered by the signature.

Syntax

public void getSignedData(String sigLabel, int refIndex);

Remarks

Use this method to retrieve the part of the XML document or data that is covered by the SigLabel signature and referenced by RefIndex reference.

GetTextContent Method (SOAPVerifier Class)

Get the text content of the selected XML element.

Syntax

public String getTextContent(String XPath);

Remarks

Call this method to get the text content of the selected XML element.

Open Method (SOAPVerifier Class)

Opens a document for verifying or removing signatures.

Syntax

public void open();

Remarks

Use this method to open a document for verifying or removing signatures. When finished, call Close to complete or discard the operation.

Reset Method (SOAPVerifier Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

Revalidate Method (SOAPVerifier Class)

Revalidates a signature in accordance with current settings.

Syntax

public void revalidate(String sigLabel);

Remarks

Use this method to re-validate a signature in the opened SOAP message.

SelectInfo Method (SOAPVerifier Class)

Select signature information for a specific entity.

Syntax

public void selectInfo(String entityLabel, int infoType, boolean clearSelection);

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

SetInnerXML Method (SOAPVerifier Class)

Set the inner XML content of the selected XML element.

Syntax

public void setInnerXML(String XPath, String value);

Remarks

Call this method to set the inner XML content of the selected XML element.

SetTextContent Method (SOAPVerifier Class)

Set the text content of the selected XML element.

Syntax

public void setTextContent(String XPath, String value);

Remarks

Call this method to set the text content of the selected XML element.

Unsign Method (SOAPVerifier Class)

Deletes a signature from the document.

Syntax

public void unsign(String sigLabel);

Remarks

Use this method to delete an existing signature from the document. Use SigLabel parameter to specify the signature to be removed.

Verify Method (SOAPVerifier Class)

Verifies a digitally signed SOAP message.

Syntax

public void verify();

Remarks

Call this method to verify a signed SOAP message. Provide the message via InputFile or InputStream property.

ChainElementDownload Event (SOAPVerifier Class)

Fires when there is a need to download a chain element from an online source.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void chainElementDownload(SOAPVerifierChainElementDownloadEvent e) {}
  ...
}

public class SOAPVerifierChainElementDownloadEvent {
  public int kind;
  public String certRDN;
  public String CACertRDN;
  public String location;
  public int action; //read-write
}

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

ChainElementNeeded Event (SOAPVerifier Class)

Fires when an element required to validate the chain was not located.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void chainElementNeeded(SOAPVerifierChainElementNeededEvent e) {}
  ...
}

public class SOAPVerifierChainElementNeededEvent {
  public int kind;
  public String certRDN;
  public String CACertRDN;
}

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.

ChainElementStore Event (SOAPVerifier Class)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void chainElementStore(SOAPVerifierChainElementStoreEvent e) {}
  ...
}

public class SOAPVerifierChainElementStoreEvent {
  public int kind;
  public byte[] body;
  public String URI; //read-write
}

Remarks

This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.

ChainValidated Event (SOAPVerifier Class)

Reports the completion of a certificate chain validation.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void chainValidated(SOAPVerifierChainValidatedEvent e) {}
  ...
}

public class SOAPVerifierChainValidatedEvent {
  public int index;
  public String entityLabel;
  public String subjectRDN;
  public int validationResult;
  public int validationDetails;
  public boolean cancel; //read-write
}

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

Any other value reports a failure, and ValidationDetails provides more details on its reasons.

ChainValidationProgress Event (SOAPVerifier Class)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void chainValidationProgress(SOAPVerifierChainValidationProgressEvent e) {}
  ...
}

public class SOAPVerifierChainValidationProgressEvent {
  public String eventKind;
  public String certRDN;
  public String CACertRDN;
  public int action; //read-write
}

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.

Error Event (SOAPVerifier Class)

Information about errors during signature verification.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void error(SOAPVerifierErrorEvent e) {}
  ...
}

public class SOAPVerifierErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The event is fired in case of exceptional conditions during verification.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to SOAP.

MessageLoaded Event (SOAPVerifier Class)

This event is fired when the message has been loaded into memory.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void messageLoaded(SOAPVerifierMessageLoadedEvent e) {}
  ...
}

public class SOAPVerifierMessageLoadedEvent {
  public boolean cancel; //read-write
}

Remarks

The handler for this event is a good place to check message properties, which may be useful when preparing the signature.

Set Cancel to true to terminate message processing on this stage.

Notification Event (SOAPVerifier Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void notification(SOAPVerifierNotificationEvent e) {}
  ...
}

public class SOAPVerifierNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

ReferenceValidated Event (SOAPVerifier Class)

Marks the end of a reference validation.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void referenceValidated(SOAPVerifierReferenceValidatedEvent e) {}
  ...
}

public class SOAPVerifierReferenceValidatedEvent {
  public int referenceIndex;
  public String ID;
  public String URI;
  public String refType;
  public boolean digestValid;
}

Remarks

The class fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.

ResolveReference Event (SOAPVerifier Class)

Asks the application to resolve a reference.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void resolveReference(SOAPVerifierResolveReferenceEvent e) {}
  ...
}

public class SOAPVerifierResolveReferenceEvent {
  public int referenceIndex;
  public String URI;
}

Remarks

This event is fired when the control could not automatically resolve a reference and requires custom treatment.

URI contains a reference to the data.

ReferenceIndex specifies the index of the reference to process.

Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.

SignatureFound Event (SOAPVerifier Class)

Signifies the start of signature validation.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void signatureFound(SOAPVerifierSignatureFoundEvent e) {}
  ...
}

public class SOAPVerifierSignatureFoundEvent {
  public int index;
  public String entityLabel;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public boolean certFound;
  public boolean validateSignature; //read-write
  public boolean validateChain; //read-write
}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (SOAPVerifier Class)

Marks the completion of the signature validation routine.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void signatureValidated(SOAPVerifierSignatureValidatedEvent e) {}
  ...
}

public class SOAPVerifierSignatureValidatedEvent {
  public int index;
  public String entityLabel;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public int validationResult;
  public boolean cancel; //read-write
}

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

TimestampFound Event (SOAPVerifier Class)

Signifies the start of a timestamp validation routine.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void timestampFound(SOAPVerifierTimestampFoundEvent e) {}
  ...
}

public class SOAPVerifierTimestampFoundEvent {
  public int index;
  public String entityLabel;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public boolean certFound;
  public boolean validateTimestamp; //read-write
  public boolean validateChain; //read-write
}

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the ValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (SOAPVerifier Class)

Reports the completion of the timestamp validation routine.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void timestampValidated(SOAPVerifierTimestampValidatedEvent e) {}
  ...
}

public class SOAPVerifierTimestampValidatedEvent {
  public int index;
  public String entityLabel;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public String time;
  public int validationResult;
  public int chainValidationResult;
  public int chainValidationDetails;
  public boolean cancel; //read-write
}

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

TLSCertNeeded Event (SOAPVerifier Class)

Fires when a remote TLS party requests a client certificate.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void TLSCertNeeded(SOAPVerifierTLSCertNeededEvent e) {}
  ...
}

public class SOAPVerifierTLSCertNeededEvent {
  public String host;
  public String CANames;
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (SOAPVerifier Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void TLSCertValidate(SOAPVerifierTLSCertValidateEvent e) {}
  ...
}

public class SOAPVerifierTLSCertValidateEvent {
  public String serverHost;
  public String serverIP;
  public boolean accept; //read-write
}

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (SOAPVerifier Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void TLSEstablished(SOAPVerifierTLSEstablishedEvent e) {}
  ...
}

public class SOAPVerifierTLSEstablishedEvent {
  public String host;
  public String version;
  public String ciphersuite;
  public byte[] connectionId;
  public boolean abort; //read-write
}

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (SOAPVerifier Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void TLSHandshake(SOAPVerifierTLSHandshakeEvent e) {}
  ...
}

public class SOAPVerifierTLSHandshakeEvent {
  public String host;
  public boolean abort; //read-write
}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (SOAPVerifier Class)

Reports the graceful closure of a TLS connection.

Syntax

public class DefaultSOAPVerifierEventListener implements SOAPVerifierEventListener {
  ...
  public void TLSShutdown(SOAPVerifierTLSShutdownEvent e) {}
  ...
}

public class SOAPVerifierTLSShutdownEvent {
  public String host;
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

CRL Type

Represents a Certificate Revocation List.

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Constructors

public CRL( bytes,  startIndex,  count);

public CRL( location);

public CRL( stream);

public CRL();

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Constructors

public OCSPResponse( bytes,  startIndex,  count);

public OCSPResponse( location);

public OCSPResponse( stream);

public OCSPResponse();

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Constructors

public ProxySettings();

SOAPSignature Type

The class is a container for an SOAP message signature.

Remarks

SOAP message may include any number of signatures. class stores on of them.

Fields

Constructors

public SOAPSignature();

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

TimestampInfo Type

A container for timestamp information.

Remarks

The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.

Fields

Constructors

public TimestampInfo();

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public TLSSettings();

XMLReference Type

Represents an XML reference element.

Remarks

XMLReference specifies the digest algorithm and digest value, and, optionally: an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting.

Fields

Constructors

public XMLReference();

public XMLReference( ID);

public XMLReference( ID,  URI);

Config Settings (SOAPVerifier Class)

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

SOAPVerifier Config Settings

Base Config Settings

Trappable Errors (SOAPVerifier Class)

SOAPVerifier Errors