SOAPSigner Class
Properties Methods Events Configuration Settings Errors
The SOAPSigner class signs SOAP messages.
Syntax
SecureBlackboxSOAPSigner
SecureBlackboxSOAPSignerSwift
Remarks
SOAPSigner creates electronic signatures for SOAP messages, and includes advanced security features such as support for timestamps and advanced electronic signatures (XAdES).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| - blockedCertCount | The number of records in the BlockedCert arrays. |
| - blockedCertBytes:(int)blockedCertIndex | Returns raw certificate data in DER format. |
| - blockedCertHandle:(int)blockedCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - canonicalizationMethod | Specifies XML canonicalization method to use. |
| - chainValidationDetails | The details of a certificate chain validation outcome. |
| - chainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
| - claimedSigningTime | The signing time from the signer's computer. |
| - embedCertificateMethod | Controls the certificate disposition within the signature. |
| - enableXAdES | Specifies if an advanced signature (XAdES) will be produced. |
| - encoding | Specifies XML encoding. |
| - externalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| - externalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| - externalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| - externalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| - externalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| - externalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| - externalCryptoMethod | Specifies the asynchronous signing method. |
| - externalCryptoMode | Specifies the external cryptography mode. |
| - externalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| - hashAlgorithm | Specifies the hash algorithm to be used. |
| - ignoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
| - inputBytes | Use this property to pass the input to class in the byte array form. |
| - inputFile | Specifies the SOAP message to be signed. |
| - knownCertCount | The number of records in the KnownCert arrays. |
| - knownCertBytes:(int)knownCertIndex | Returns raw certificate data in DER format. |
| - knownCertHandle:(int)knownCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - knownCRLCount | The number of records in the KnownCRL arrays. |
| - knownCRLBytes:(int)knownCRLIndex | Returns raw CRL data in DER format. |
| - knownCRLHandle:(int)knownCRLIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - knownOCSPCount | The number of records in the KnownOCSP arrays. |
| - knownOCSPBytes:(int)knownOCSPIndex | Buffer containing raw OCSP response data. |
| - knownOCSPHandle:(int)knownOCSPIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - offlineMode | Switches the class to the offline mode. |
| - outputBytes | Use this property to read the output the class object has produced. |
| - outputFile | A file where the signed SOAP message will be saved. |
| - profile | Specifies a pre-defined profile to apply when creating the signature. |
| - proxyAddress | The IP address of the proxy server. |
| - proxyAuthentication | The authentication type used by the proxy server. |
| - proxyPassword | The password to authenticate to the proxy server. |
| - proxyPort | The port on the proxy server to connect to. |
| - proxyProxyType | The type of the proxy server. |
| - proxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| - proxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| - proxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| - proxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| - proxyUseProxy | Enables or disables proxy-driven connection. |
| - proxyUsername | Specifies the username credential for proxy authentication. |
| - referenceCount | The number of records in the Reference arrays. |
| - referenceAutoGenerateElementId:(int)referenceIndex | Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. |
| - referenceCanonicalizationMethod:(int)referenceIndex | Use this property to specify the canonicalization method for the transform of the reference. |
| - referenceCustomElementId:(int)referenceIndex | Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. |
| - referenceDigestValue:(int)referenceIndex | Use this property to get or set the value of the digest calculated over the referenced data. |
| - referenceHandle:(int)referenceIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - referenceHashAlgorithm:(int)referenceIndex | Specifies the hash algorithm to be used. |
| - referenceHasURI:(int)referenceIndex | Specifies whether the URI is set (even when it is empty). |
| - referenceID:(int)referenceIndex | A user-defined identifier (ID) attribute of this Reference element. |
| - referenceInclusiveNamespacesPrefixList:(int)referenceIndex | Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. |
| - referenceReferenceType:(int)referenceIndex | The Reference's type attribute as defined in XMLDSIG specification. |
| - referenceTargetData:(int)referenceIndex | Contains the referenced external data when the digest value is not explicitly specified. |
| - referenceTargetXMLElement:(int)referenceIndex | This property specifies the referenced XML element. |
| - referenceURI:(int)referenceIndex | Use this property to get or set the URL which references the data. |
| - referenceUseBase64Transform:(int)referenceIndex | Specifies whether Base64 transform is included in transform chain. |
| - referenceUseEnvelopedSignatureTransform:(int)referenceIndex | Specifies whether enveloped signature transform is included in transform chain. |
| - referenceUseXPathFilter2Transform:(int)referenceIndex | Specifies whether XPath Filter 2. |
| - referenceUseXPathTransform:(int)referenceIndex | Specifies whether XPath transform is included in transform chain. |
| - referenceXPathExpression:(int)referenceIndex | Use this property to specify XPath expression for XPath transform of the reference. |
| - referenceXPathFilter2Expressions:(int)referenceIndex | Use this property to specify XPointer expression(s) for XPath Filter 2. |
| - referenceXPathFilter2Filters:(int)referenceIndex | Use this property to specify XPointer filter(s) for XPath Filter 2. |
| - referenceXPathFilter2PrefixList:(int)referenceIndex | Use this property to specify a prefix list for XPath Filter 2. |
| - referenceXPathPrefixList:(int)referenceIndex | Use this property to specify a prefix list for XPath transform of the reference. |
| - revocationCheck | Specifies the kind(s) of revocation check to perform. |
| - signatureIndex | The index of the signature to update. |
| - signatureType | The SOAP signature type to use. |
| - signingCertBytes | Returns raw certificate data in DER format. |
| - signingCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - signingChainCount | The number of records in the SigningChain arrays. |
| - signingChainBytes:(int)signingChainIndex | Returns raw certificate data in DER format. |
| - signingChainHandle:(int)signingChainIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - socketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
| - socketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
| - socketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
| - socketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| - socketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
| - socketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| - socketLocalAddress | The local network interface to bind the socket to. |
| - socketLocalPort | The local port number to bind the socket to. |
| - socketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| - socketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| - socketUseIPv6 | Enables or disables IP protocol version 6. |
| - timestampServer | The address of the timestamping server. |
| - TLSClientCertCount | The number of records in the TLSClientCert arrays. |
| - TLSClientCertBytes:(int)tLSClientCertIndex | Returns raw certificate data in DER format. |
| - TLSClientCertHandle:(int)tLSClientCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - TLSServerCertCount | The number of records in the TLSServerCert arrays. |
| - TLSServerCertBytes:(int)tLSServerCertIndex | Returns raw certificate data in DER format. |
| - TLSServerCertHandle:(int)tLSServerCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| - TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| - TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| - TLSECCurves | Defines the elliptic curves to enable. |
| - TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| - TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| - TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| - TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| - TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
| - TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| - TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| - TLSTLSMode | Specifies the TLS mode to use. |
| - TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
| - TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
| - TLSVersions | Th SSL/TLS versions to enable by default. |
| - trustedCertCount | The number of records in the TrustedCert arrays. |
| - trustedCertBytes:(int)trustedCertIndex | Returns raw certificate data in DER format. |
| - trustedCertHandle:(int)trustedCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - validationLog | Contains the complete log of the certificate validation routine. |
| - XAdESForm | Specifies which form of XAdES should be produced. |
| - XAdESVersion | Specifies XAdES version. |
| - namespaceCount | The number of records in the Namespace arrays. |
| - namespacePrefix:(int)namespaceIndex | A user-defined prefix value of a namespace. |
| - namespaceURI:(int)namespaceIndex | A user-defined URI value of a namespace. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| - addBodyReference | Creates a new XML reference to the Body element of the SOAP message. |
| - addDataReference | Creates a new XML reference to the specified data. |
| - addReference | Creates a new XML reference to the specified XML element. |
| - config | Sets or retrieves a configuration setting. |
| - extractAsyncData | Extracts user data from the DC signing service response. |
| - sign | Signs the SOAP message. |
| - signAsyncBegin | Initiates the asynchronous signing operation. |
| - signAsyncEnd | Completes the asynchronous signing operation. |
| - signExternal | Signs the document using an external signing facility. |
| - timestamp | Use this method to add timestamp. |
| - upgrade | Upgrades existing XAdES signature to a new form. |
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.
| - onError | Information about errors during signing. |
| - onExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| - onFormatElement | Reports the XML element that is currently being processed. |
| - onFormatText | Reports XML text that is currently being processed. |
| - onNotification | This event notifies the application about an underlying control flow event. |
| - onResolveReference | Asks the application to resolve a reference. |
| - onStoreCertificate | This event is fired when a certificate should be stored along with a signature. |
| - onStoreCRL | This event is fired when a CRL should be stored along with a signature. |
| - onStoreOCSPResponse | This event is fired when a OCSP Response should be stored along with a signature. |
| - onTLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| BinarySecurityTokenID | Specifies the ID for BinarySecurityToken element. |
| ClaimedRoleText | The text of the claimed role. |
| ClaimedRoleXML | The XML content of the claimed roles. |
| CommitmentTypeIndicationAllSignedDataObjects[Index] | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
| CommitmentTypeIndicationCount | The number of the CommitmentTypeIndication elements. |
| CommitmentTypeIndicationIdentifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
| CommitmentTypeIndicationIdentifierDescription[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
| CommitmentTypeIndicationIdentifierDocumentationReferences[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
| CommitmentTypeIndicationIdentifierQualifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
| CommitmentTypeIndicationObjectReference[Index] | Specifies the CommitmentTypeIndication's ObjectReference. |
| CommitmentTypeIndicationQualifiersXML[Index] | The XML content of the CommitmentTypeIndication's Qualifiers. |
| DataObjectFormatCount | The number of the DataObjectFormat elements. |
| DataObjectFormatDescription[Index] | Specifies the DataObjectFormat's Description. |
| DataObjectFormatEncoding[Index] | Specifies the DataObjectFormat's Encoding. |
| DataObjectFormatMimeType[Index] | Specifies the DataObjectFormat's MimeType. |
| DataObjectFormatObjectIdentifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Identifier. |
| DataObjectFormatObjectIdentifierDescription[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Description. |
| DataObjectFormatObjectIdentifierDocumentationReferences[Index] | Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences. |
| DataObjectFormatObjectIdentifierQualifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier. |
| DataObjectFormatObjectReference[Index] | Specifies the DataObjectFormat's ObjectReference. |
| ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HMACKey | The key value for HMAC. |
| HMACOutputLength | TBD. |
| IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreTimestampFailure | Whether to ignore time-stamping failure during signing. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IncludeKey | Specifies whether to include the signing key to the signature. |
| IncludeKeyValue | Specifies whether the key value must be included to the signature. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
| InclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList. |
| KeyInfoCustomXML | The custom XML content for KeyInfo element. |
| KeyInfoDetails | Specifies the signing key info details to include to the signature. |
| KeyInfoID | Specifies the ID for KeyInfo element. |
| KeyName | Contains information about the key used for signing. |
| PrependCustomXML | The custom XML content that prepended before signature. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| QualifyingPropertiesID | Specifies the ID for QualifyingProperties element. |
| RefsTimestampType | Specifies references timestamp type to include to the signature. |
| SecurityHeaderIndex | Specifies the SecurityHeader index. |
| SecurityTokenReferenceID | Specifies the ID for SecurityTokenReference element. |
| SignatureID | Specifies the ID for Signature element. |
| SignaturePrefix | Specifies the signature prefix. |
| SignatureValueID | Specifies the ID for SignatureValue element. |
| SignedInfoID | Specifies the ID for SignedInfo element. |
| SignedPropertiesID | Specifies the ID for SignedProperties element. |
| SignedPropertiesReferenceCanonicalizationMethod | Specifies the canonicalization method used in SignedProperties reference. |
| SignedPropertiesReferenceHashAlgorithm | Specifies the hash algorithm used in SignedProperties reference. |
| SignedPropertiesReferenceID | Specifies the ID for Reference element that points to SignedProperties element. |
| SignedPropertiesReferenceInclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference. |
| SignedPropertiesReferenceIndex | Specifies the index of SignedProperties reference. |
| SignedSignaturePropertiesID | Specifies the ID for SignedSignatureProperties element. |
| SigningCertificatesHashAlgorithm | Specifies the hash algorithm used for SigningCertificates. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The hash value of the signature policy. |
| SigPolicyHashAlgorithm | Specifies the hash algorithm used to compute the signature policy hash. |
| SigPolicyID | Identifies the signature policy. |
| SigPolicyNoticeNumbers | Contains user notice numbers. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | Signature policy URI. |
| TempPath | Location where the temporary files are stored. |
| TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
| TimestampValidationDataDetails | Specifies timestamp validation data details to include to the signature. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| UseHMACSigning | Whether to use HMAC signing. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UsePSS | Whether to use RSASSA-PSS algorithm. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| ValidationDataRefsDetails | Specifies validation data references details to include to the signature. |
| ValidationDataRefsHashAlgorithm | Specifies the hash algorithm used in validation data references. |
| ValidationDataValuesDetails | Specifies validation data values details to include to the signature. |
| WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
| XAdESPrefix | Specifies the XAdES prefix. |
| XAdESv141Prefix | Specifies the XAdES v1.4.1 prefix. |
| XMLFormatting | Specifies the signature XML formatting. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |