SOAPSigner Class
Properties Methods Events Config Settings Errors
The SOAPSigner class signs SOAP messages.
Syntax
SOAPSigner
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.
AutoValidateSignatures | Specifies whether class should validate any present signatures when the document is opened. |
BlockedCertificates | The certificates that must be rejected as trust anchors. |
Certificates | A collection of certificates included in the electronic signature. |
CheckTrustedLists | Specifies whether the class should attempt to validate chain trust via a known Trusted List. |
CRLs | A collection of certificate revocation lists embedded into the signature by the signer. |
EmbedCertificateMethod | Controls the certificate disposition within the signature. |
Encoding | Specifies XML encoding. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
InputBytes | Use this property to pass the input to class in byte array form. |
InputFile | Specifies the SOAP message to be signed. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
NewSignature | Provides access to new signature properties. |
OCSPs | A collection of OCSP responses embedded into the signature. |
OfflineMode | Switches the class to 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. |
Proxy | The proxy server settings. |
References | A list of references to the data to be signed. |
RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
SecurityHeaderIndex | Specifies the SecurityHeader index. |
Signatures | Provides details of all signatures found in the SOAP message. |
SigningCertificate | The certificate to be used for signing. |
SigningChain | The signing certificate chain. |
SocketSettings | Manages network connection settings. |
Timestamps | Contains a collection of timestamps for the processed document. |
TimestampServer | The address of the timestamping server. |
TLSClientChain | The TLS client certificate chain. |
TLSServerChain | The TLS server's certificate chain. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
ValidationMoment | The time point at which signature validity is to be established. |
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. |
AddKnownNamespace | Adds known prefix and correspondent namespace URI. |
AddReference | Creates a new XML reference to the specified XML element. |
Close | Closes an opened SOAP message. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
ExtractAsyncData | Extracts user data from the DC signing service response. |
GetInnerXML | Get the inner XML content of the selected XML element. |
GetOuterXML | Get the outer XML content of the selected XML element. |
GetTextContent | Get the text content of the selected XML element. |
Open | Opens a document for signing or updating. |
Reset | Resets the class settings. |
Revalidate | Revalidates a signature in accordance with current settings. |
SelectInfo | Select signature information for a specific entity. |
SetInnerXML | Set the inner XML content of the selected XML element. |
SetTextContent | Set the text content of the selected XML element. |
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 an 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.
ChainElementDownload | Fires when there is a need to download a chain element from an online source. |
ChainElementNeeded | Fires when an element required to validate the chain was not located. |
ChainElementStore | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. |
ChainValidated | Reports the completion of a certificate chain validation. |
ChainValidationProgress | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
Error | Information about errors during signing. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
FormatElement | Reports the XML element that is currently being processed. |
FormatText | Reports XML text that is currently being processed. |
MessageLoaded | This event is fired when the message has been loaded into memory. |
Notification | This event notifies the application about an underlying control flow event. |
ReferenceValidated | Marks the end of a reference validation. |
ResolveReference | Asks the application to resolve a reference. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Marks the completion of the signature validation routine. |
TimestampFound | Signifies the start of a timestamp validation routine. |
TimestampRequest | Fires when the class is ready to request a timestamp from an external TSA. |
TimestampValidated | Reports the completion of the timestamp validation routine. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AddAllDataObjectsTimestamp | Whether to add all data objects timestamp during signing. |
BinarySecurityTokenID | Specifies the ID for BinarySecurityToken element. |
BinarySecurityTokenType | Specifies the token type for BinarySecurityToken element. |
ClaimedRolesXML | The XML content of the claimed roles. |
ClaimedRoleText | The text of the claimed role. |
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. |
ExclusiveCanonicalizationPrefix | Specifies the exclusive canonicalization prefix. |
HMACKey | The key value for HMAC. |
HMACOutputLength | Sets the length of the HMAC output. |
HMACSigningUsed | Whether to use HMAC signing. |
IgnoreTimestampFailure | Whether to ignore time-stamping failure during signing. |
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. |
NormalizeNewLine | Controls whether newline combinations should be automatically normalized. |
PolicyDescription | signature policy description. |
PolicyExplicitText | The explicit text of the user notice. |
PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
PrependCustomXML | The custom XML content that prepended before signature. |
ProductionPlace | Identifies the place of the signature production. |
PSSUsed | Whether to use RSASSA-PSS algorithm. |
QualifyingPropertiesID | Specifies the ID for QualifyingProperties element. |
QualifyingPropertiesObjectID | Specifies the ID for object with QualifyingProperties element. |
QualifyingPropertiesReferenceCount | The number of the QualifyingPropertiesReference elements. |
QualifyingPropertiesReferenceID[Index] | Specifies the QualifyingPropertiesReference's ID. |
QualifyingPropertiesReferenceURI[Index] | Specifies the QualifyingPropertiesReference's URI. |
RefsTimestampType | Specifies references timestamp type to include to the signature. |
SecurityHeaderIndex | Specifies the SecurityHeader index. |
SecurityHeaderMustUnderstand | Specifies the MustUnderstand for SecurityHeader element. |
SecurityTokenReferenceID | Specifies the ID for SecurityTokenReference element. |
SecurityTokenReferenceTokenType | Specifies the token type 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. |
SigningCertificatesChain | The indicator of which certificates should be/are included as the signing chain. |
SigningCertificatesHashAlgorithm | Specifies the hash algorithm used for SigningCertificates. |
SigPolicyDescription | signature policy description. |
SigPolicyExplicitText | The explicit text of the user notice. |
SigPolicyHash | The EPES policy hash. |
SigPolicyHashAlgorithm | The hash algorithm that was used to generate the EPES policy hash. |
SigPolicyID | The EPES policy ID. |
SigPolicyNoticeNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
SigPolicyURI | The EPES policy URI. |
StripWhitespace | Controls whether excessive whitespace characters should be stripped off when loading the document. |
TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
TimestampValidationDataDetails | Specifies timestamp validation data details to include to the signature. |
UseHMACSigning | Whether to use HMAC signing. |
UsePSS | Whether to use RSASSA-PSS algorithm. |
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. |
WSSEPrefix | Specifies the WSSE prefix. |
WSUPrefix | Specifies the WSU prefix. |
WSUTimestampCreated | Specifies the message creation time. |
WSUTimestampCreatedFormat | Specifies the date time format for message creation time. |
WSUTimestampCreatedTimeZoneOffset | Specifies the time zone offset for message creation time. |
WSUTimestampExpires | Specifies the message expiration time. |
WSUTimestampExpiresFormat | Specifies the date time format for message expiration time. |
WSUTimestampExpiresTimeZoneOffset | Specifies the time zone offset for message expiration time. |
WSUTimestampID | Specifies the ID for wsu:Timestamp element. |
XAdESPrefix | Specifies the XAdES prefix. |
XAdESv141Prefix | Specifies the XAdES v1.4.1 prefix. |
XMLFormatting | Specifies the signature XML formatting. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
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. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
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. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
PKICachePath | Specifies the file system path where cached PKI data is stored. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
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. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
AutoValidateSignatures Property (SOAPSigner Class)
Specifies whether class should validate any present signatures when the document is opened.
Syntax
ANSI (Cross Platform) int GetAutoValidateSignatures();
int SetAutoValidateSignatures(int bAutoValidateSignatures); Unicode (Windows) BOOL GetAutoValidateSignatures();
INT SetAutoValidateSignatures(BOOL bAutoValidateSignatures);
int secureblackbox_soapsigner_getautovalidatesignatures(void* lpObj);
int secureblackbox_soapsigner_setautovalidatesignatures(void* lpObj, int bAutoValidateSignatures);
bool GetAutoValidateSignatures();
int SetAutoValidateSignatures(bool bAutoValidateSignatures);
Default Value
FALSE
Remarks
This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the Revalidate method.
Data Type
Boolean
BlockedCertificates Property (SOAPSigner Class)
The certificates that must be rejected as trust anchors.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_soapsigner_getblockedcertcount(void* lpObj);
int secureblackbox_soapsigner_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_soapsigner_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_soapsigner_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_soapsigner_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); QByteArray GetBlockedCertBytes(int iBlockedCertIndex); qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
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.
Data Type
Certificates Property (SOAPSigner Class)
A collection of certificates included in the electronic signature.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetCertificates();
int secureblackbox_soapsigner_getcertcount(void* lpObj);
int secureblackbox_soapsigner_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
int secureblackbox_soapsigner_getcertca(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
int secureblackbox_soapsigner_getcertcerttype(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertcrldistributionpoints(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertcurve(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertfingerprint(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertfriendlyname(void* lpObj, int certindex);
int64 secureblackbox_soapsigner_getcerthandle(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcerthashalgorithm(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertissuer(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertissuerrdn(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertkeyalgorithm(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertkeybits(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertkeyfingerprint(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertkeyusage(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertkeyvalid(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertocsplocations(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertocspnocheck(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertorigin(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertpolicyids(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertprivatekeybytes(void* lpObj, int certindex, char** lpCertPrivateKeyBytes, int* lenCertPrivateKeyBytes);
int secureblackbox_soapsigner_getcertprivatekeyexists(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertprivatekeyextractable(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
int secureblackbox_soapsigner_getcertqualified(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertqualifiedstatements(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertqualifiers(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertselfsigned(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
char* secureblackbox_soapsigner_getcertsigalgorithm(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertsource(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertsubject(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertsubjectalternativename(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
char* secureblackbox_soapsigner_getcertsubjectrdn(void* lpObj, int certindex);
int secureblackbox_soapsigner_getcertvalid(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertvalidfrom(void* lpObj, int certindex);
char* secureblackbox_soapsigner_getcertvalidto(void* lpObj, int certindex);
int GetCertCount(); QByteArray GetCertBytes(int iCertIndex); bool GetCertCA(int iCertIndex); QByteArray GetCertCAKeyID(int iCertIndex); int GetCertCertType(int iCertIndex); QString GetCertCRLDistributionPoints(int iCertIndex); QString GetCertCurve(int iCertIndex); QString GetCertFingerprint(int iCertIndex); QString GetCertFriendlyName(int iCertIndex); qint64 GetCertHandle(int iCertIndex); QString GetCertHashAlgorithm(int iCertIndex); QString GetCertIssuer(int iCertIndex); QString GetCertIssuerRDN(int iCertIndex); QString GetCertKeyAlgorithm(int iCertIndex); int GetCertKeyBits(int iCertIndex); QString GetCertKeyFingerprint(int iCertIndex); int GetCertKeyUsage(int iCertIndex); bool GetCertKeyValid(int iCertIndex); QString GetCertOCSPLocations(int iCertIndex); bool GetCertOCSPNoCheck(int iCertIndex); int GetCertOrigin(int iCertIndex); QString GetCertPolicyIDs(int iCertIndex); QByteArray GetCertPrivateKeyBytes(int iCertIndex); bool GetCertPrivateKeyExists(int iCertIndex); bool GetCertPrivateKeyExtractable(int iCertIndex); QByteArray GetCertPublicKeyBytes(int iCertIndex); bool GetCertQualified(int iCertIndex); int GetCertQualifiedStatements(int iCertIndex); QString GetCertQualifiers(int iCertIndex); bool GetCertSelfSigned(int iCertIndex); QByteArray GetCertSerialNumber(int iCertIndex); QString GetCertSigAlgorithm(int iCertIndex); int GetCertSource(int iCertIndex); QString GetCertSubject(int iCertIndex); QString GetCertSubjectAlternativeName(int iCertIndex); QByteArray GetCertSubjectKeyID(int iCertIndex); QString GetCertSubjectRDN(int iCertIndex); bool GetCertValid(int iCertIndex); QString GetCertValidFrom(int iCertIndex); QString GetCertValidTo(int iCertIndex);
Remarks
This property includes a collection of certificates of the currently selected info.
This property is read-only and not available at design time.
Data Type
CheckTrustedLists Property (SOAPSigner Class)
Specifies whether the class should attempt to validate chain trust via a known Trusted List.
Syntax
ANSI (Cross Platform) int GetCheckTrustedLists();
int SetCheckTrustedLists(int bCheckTrustedLists); Unicode (Windows) BOOL GetCheckTrustedLists();
INT SetCheckTrustedLists(BOOL bCheckTrustedLists);
int secureblackbox_soapsigner_getchecktrustedlists(void* lpObj);
int secureblackbox_soapsigner_setchecktrustedlists(void* lpObj, int bCheckTrustedLists);
bool GetCheckTrustedLists();
int SetCheckTrustedLists(bool bCheckTrustedLists);
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).
Data Type
Boolean
CRLs Property (SOAPSigner Class)
A collection of certificate revocation lists embedded into the signature by the signer.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetCRLs();
int secureblackbox_soapsigner_getcrlcount(void* lpObj);
int secureblackbox_soapsigner_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);
int secureblackbox_soapsigner_getcrlcakeyid(void* lpObj, int crlindex, char** lpCRLCAKeyID, int* lenCRLCAKeyID);
int secureblackbox_soapsigner_getcrlentrycount(void* lpObj, int crlindex);
int64 secureblackbox_soapsigner_getcrlhandle(void* lpObj, int crlindex);
char* secureblackbox_soapsigner_getcrlissuer(void* lpObj, int crlindex);
char* secureblackbox_soapsigner_getcrlissuerrdn(void* lpObj, int crlindex);
char* secureblackbox_soapsigner_getcrllocation(void* lpObj, int crlindex);
char* secureblackbox_soapsigner_getcrlnextupdate(void* lpObj, int crlindex);
char* secureblackbox_soapsigner_getcrlsigalgorithm(void* lpObj, int crlindex);
int secureblackbox_soapsigner_getcrlsource(void* lpObj, int crlindex);
int secureblackbox_soapsigner_getcrltbs(void* lpObj, int crlindex, char** lpCRLTBS, int* lenCRLTBS);
char* secureblackbox_soapsigner_getcrlthisupdate(void* lpObj, int crlindex);
int GetCRLCount(); QByteArray GetCRLBytes(int iCRLIndex); QByteArray GetCRLCAKeyID(int iCRLIndex); int GetCRLEntryCount(int iCRLIndex); qint64 GetCRLHandle(int iCRLIndex); QString GetCRLIssuer(int iCRLIndex); QString GetCRLIssuerRDN(int iCRLIndex); QString GetCRLLocation(int iCRLIndex); QString GetCRLNextUpdate(int iCRLIndex); QString GetCRLSigAlgorithm(int iCRLIndex); int GetCRLSource(int iCRLIndex); QByteArray GetCRLTBS(int iCRLIndex); QString GetCRLThisUpdate(int iCRLIndex);
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.
Data Type
EmbedCertificateMethod Property (SOAPSigner Class)
Controls the certificate disposition within the signature.
Syntax
ANSI (Cross Platform) int GetEmbedCertificateMethod();
int SetEmbedCertificateMethod(int iEmbedCertificateMethod); Unicode (Windows) INT GetEmbedCertificateMethod();
INT SetEmbedCertificateMethod(INT iEmbedCertificateMethod);
Possible Values
CWEC_IN_SIGNATURE(0),
CWEC_IN_BINARY_SECURITY_TOKEN(1),
CWEC_IN_SIGNED_BINARY_SECURITY_TOKEN(2),
CWEC_IN_BINARY_SECURITY_TOKEN_AND_SIGNATURE(3),
CWEC_NONE(4)
int secureblackbox_soapsigner_getembedcertificatemethod(void* lpObj);
int secureblackbox_soapsigner_setembedcertificatemethod(void* lpObj, int iEmbedCertificateMethod);
int GetEmbedCertificateMethod();
int SetEmbedCertificateMethod(int iEmbedCertificateMethod);
Default Value
1
Remarks
This property controls the method of embedding the signing certificate(s) into the signature if WS-Security signature type is used.
Supported values:
cwecInSignature | 0 | Embed certificate(s) into the signature |
cwecInBinarySecurityToken | 1 | Embed certificate(s) into the BinarySecurityToken element |
cwecInSignedBinarySecurityToken | 2 | Embed certificate(s) into the BinarySecurityToken element and sign them |
cwecInBinarySecurityTokenAndSignature | 3 | Embed certificate(s) into the BinarySecurityToken element and the signature |
cwecNone | 4 | Don't embed certificate(s) into the BinarySecurityToken element or the signature |
Data Type
Integer
Encoding Property (SOAPSigner Class)
Specifies XML encoding.
Syntax
ANSI (Cross Platform) char* GetEncoding();
int SetEncoding(const char* lpszEncoding); Unicode (Windows) LPWSTR GetEncoding();
INT SetEncoding(LPCWSTR lpszEncoding);
char* secureblackbox_soapsigner_getencoding(void* lpObj);
int secureblackbox_soapsigner_setencoding(void* lpObj, const char* lpszEncoding);
QString GetEncoding();
int SetEncoding(QString qsEncoding);
Default Value
""
Remarks
Use this property to specify the encoding to apply to the XML documents.
Data Type
String
ExternalCrypto Property (SOAPSigner Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_soapsigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_soapsigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_soapsigner_getexternalcryptodata(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_soapsigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_soapsigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_soapsigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_soapsigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_soapsigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_soapsigner_getexternalcryptomode(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_soapsigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_soapsigner_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Data Type
FIPSMode Property (SOAPSigner Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_soapsigner_getfipsmode(void* lpObj);
int secureblackbox_soapsigner_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
IgnoreChainValidationErrors Property (SOAPSigner Class)
Makes the class tolerant to chain validation errors.
Syntax
ANSI (Cross Platform) int GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(int bIgnoreChainValidationErrors); Unicode (Windows) BOOL GetIgnoreChainValidationErrors();
INT SetIgnoreChainValidationErrors(BOOL bIgnoreChainValidationErrors);
int secureblackbox_soapsigner_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_soapsigner_setignorechainvalidationerrors(void* lpObj, int bIgnoreChainValidationErrors);
bool GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(bool bIgnoreChainValidationErrors);
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.
Data Type
Boolean
InputBytes Property (SOAPSigner Class)
Use this property to pass the input to class in byte array form.
Syntax
ANSI (Cross Platform) int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes); Unicode (Windows) INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);
int secureblackbox_soapsigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_soapsigner_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);
QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
Data Type
Byte Array
InputFile Property (SOAPSigner Class)
Specifies the SOAP message to be signed.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_soapsigner_getinputfile(void* lpObj);
int secureblackbox_soapsigner_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
Provide a full path to the SOAP message to be signed.
Data Type
String
KnownCertificates Property (SOAPSigner Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_soapsigner_getknowncertcount(void* lpObj);
int secureblackbox_soapsigner_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_soapsigner_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_soapsigner_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_soapsigner_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
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.
Data Type
KnownCRLs Property (SOAPSigner Class)
Additional CRLs for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_soapsigner_getknowncrlcount(void* lpObj);
int secureblackbox_soapsigner_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_soapsigner_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_soapsigner_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_soapsigner_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); QByteArray GetKnownCRLBytes(int iKnownCRLIndex); qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
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.
Data Type
KnownOCSPs Property (SOAPSigner Class)
Additional OCSP responses for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
int secureblackbox_soapsigner_getknownocspcount(void* lpObj);
int secureblackbox_soapsigner_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_soapsigner_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_soapsigner_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_soapsigner_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex); qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
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.
Data Type
NewSignature Property (SOAPSigner Class)
Provides access to new signature properties.
Syntax
SecureBlackboxSOAPSignature* GetNewSignature();
int secureblackbox_soapsigner_getnewsigcanonicalizationmethod(void* lpObj);
int secureblackbox_soapsigner_setnewsigcanonicalizationmethod(void* lpObj, int iNewSigCanonicalizationMethod);
int secureblackbox_soapsigner_getnewsigchainvalidationdetails(void* lpObj);
int secureblackbox_soapsigner_getnewsigchainvalidationresult(void* lpObj);
char* secureblackbox_soapsigner_getnewsigclaimedsigningtime(void* lpObj);
int secureblackbox_soapsigner_setnewsigclaimedsigningtime(void* lpObj, const char* lpszNewSigClaimedSigningTime);
int secureblackbox_soapsigner_getnewsigcompatibilityerrors(void* lpObj);
int secureblackbox_soapsigner_getnewsigcontainslongterminfo(void* lpObj);
char* secureblackbox_soapsigner_getnewsigentitylabel(void* lpObj);
int64 secureblackbox_soapsigner_getnewsighandle(void* lpObj);
int secureblackbox_soapsigner_setnewsighandle(void* lpObj, int64 lNewSigHandle);
char* secureblackbox_soapsigner_getnewsighashalgorithm(void* lpObj);
int secureblackbox_soapsigner_setnewsighashalgorithm(void* lpObj, const char* lpszNewSigHashAlgorithm);
char* secureblackbox_soapsigner_getnewsigissuerrdn(void* lpObj);
char* secureblackbox_soapsigner_getnewsiglastarchivaltime(void* lpObj);
int secureblackbox_soapsigner_getnewsiglevel(void* lpObj);
int secureblackbox_soapsigner_setnewsiglevel(void* lpObj, int iNewSigLevel);
char* secureblackbox_soapsigner_getnewsigparententity(void* lpObj);
int secureblackbox_soapsigner_setnewsigparententity(void* lpObj, const char* lpszNewSigParentEntity);
char* secureblackbox_soapsigner_getnewsigpolicyhash(void* lpObj);
int secureblackbox_soapsigner_setnewsigpolicyhash(void* lpObj, const char* lpszNewSigPolicyHash);
char* secureblackbox_soapsigner_getnewsigpolicyhashalgorithm(void* lpObj);
int secureblackbox_soapsigner_setnewsigpolicyhashalgorithm(void* lpObj, const char* lpszNewSigPolicyHashAlgorithm);
char* secureblackbox_soapsigner_getnewsigpolicyid(void* lpObj);
int secureblackbox_soapsigner_setnewsigpolicyid(void* lpObj, const char* lpszNewSigPolicyID);
char* secureblackbox_soapsigner_getnewsigpolicyuri(void* lpObj);
int secureblackbox_soapsigner_setnewsigpolicyuri(void* lpObj, const char* lpszNewSigPolicyURI);
int secureblackbox_soapsigner_getnewsigserialnumber(void* lpObj, char** lpNewSigSerialNumber, int* lenNewSigSerialNumber);
int secureblackbox_soapsigner_getnewsigsignaturebytes(void* lpObj, char** lpNewSigSignatureBytes, int* lenNewSigSignatureBytes);
int secureblackbox_soapsigner_getnewsigsignaturetype(void* lpObj);
int secureblackbox_soapsigner_setnewsigsignaturetype(void* lpObj, int iNewSigSignatureType);
int secureblackbox_soapsigner_getnewsigsignaturevalidationresult(void* lpObj);
int secureblackbox_soapsigner_getnewsigsubjectkeyid(void* lpObj, char** lpNewSigSubjectKeyID, int* lenNewSigSubjectKeyID);
char* secureblackbox_soapsigner_getnewsigsubjectrdn(void* lpObj);
int secureblackbox_soapsigner_getnewsigtimestamped(void* lpObj);
char* secureblackbox_soapsigner_getnewsigvalidatedsigningtime(void* lpObj);
char* secureblackbox_soapsigner_getnewsigvalidationlog(void* lpObj);
int secureblackbox_soapsigner_getnewsigxadesversion(void* lpObj);
int secureblackbox_soapsigner_setnewsigxadesversion(void* lpObj, int iNewSigXAdESVersion);
char* secureblackbox_soapsigner_getnewsigxmlelement(void* lpObj);
int secureblackbox_soapsigner_setnewsigxmlelement(void* lpObj, const char* lpszNewSigXMLElement);
int GetNewSigCanonicalizationMethod();
int SetNewSigCanonicalizationMethod(int iNewSigCanonicalizationMethod); int GetNewSigChainValidationDetails(); int GetNewSigChainValidationResult(); QString GetNewSigClaimedSigningTime();
int SetNewSigClaimedSigningTime(QString qsNewSigClaimedSigningTime); int GetNewSigCompatibilityErrors(); bool GetNewSigContainsLongTermInfo(); QString GetNewSigEntityLabel(); qint64 GetNewSigHandle();
int SetNewSigHandle(qint64 lNewSigHandle); QString GetNewSigHashAlgorithm();
int SetNewSigHashAlgorithm(QString qsNewSigHashAlgorithm); QString GetNewSigIssuerRDN(); QString GetNewSigLastArchivalTime(); int GetNewSigLevel();
int SetNewSigLevel(int iNewSigLevel); QString GetNewSigParentEntity();
int SetNewSigParentEntity(QString qsNewSigParentEntity); QString GetNewSigPolicyHash();
int SetNewSigPolicyHash(QString qsNewSigPolicyHash); QString GetNewSigPolicyHashAlgorithm();
int SetNewSigPolicyHashAlgorithm(QString qsNewSigPolicyHashAlgorithm); QString GetNewSigPolicyID();
int SetNewSigPolicyID(QString qsNewSigPolicyID); QString GetNewSigPolicyURI();
int SetNewSigPolicyURI(QString qsNewSigPolicyURI); QByteArray GetNewSigSerialNumber(); QByteArray GetNewSigSignatureBytes(); int GetNewSigSignatureType();
int SetNewSigSignatureType(int iNewSigSignatureType); int GetNewSigSignatureValidationResult(); QByteArray GetNewSigSubjectKeyID(); QString GetNewSigSubjectRDN(); bool GetNewSigTimestamped(); QString GetNewSigValidatedSigningTime(); QString GetNewSigValidationLog(); int GetNewSigXAdESVersion();
int SetNewSigXAdESVersion(int iNewSigXAdESVersion); QString GetNewSigXMLElement();
int SetNewSigXMLElement(QString qsNewSigXMLElement);
Remarks
Use this property to tune-up signature properties.
This property is read-only and not available at design time.
Data Type
OCSPs Property (SOAPSigner Class)
A collection of OCSP responses embedded into the signature.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetOCSPs();
int secureblackbox_soapsigner_getocspcount(void* lpObj);
int secureblackbox_soapsigner_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);
int secureblackbox_soapsigner_getocspentrycount(void* lpObj, int ocspindex);
int64 secureblackbox_soapsigner_getocsphandle(void* lpObj, int ocspindex);
char* secureblackbox_soapsigner_getocspissuer(void* lpObj, int ocspindex);
char* secureblackbox_soapsigner_getocspissuerrdn(void* lpObj, int ocspindex);
char* secureblackbox_soapsigner_getocsplocation(void* lpObj, int ocspindex);
char* secureblackbox_soapsigner_getocspproducedat(void* lpObj, int ocspindex);
char* secureblackbox_soapsigner_getocspsigalgorithm(void* lpObj, int ocspindex);
int secureblackbox_soapsigner_getocspsource(void* lpObj, int ocspindex);
int GetOCSPCount(); QByteArray GetOCSPBytes(int iOCSPIndex); int GetOCSPEntryCount(int iOCSPIndex); qint64 GetOCSPHandle(int iOCSPIndex); QString GetOCSPIssuer(int iOCSPIndex); QString GetOCSPIssuerRDN(int iOCSPIndex); QString GetOCSPLocation(int iOCSPIndex); QString GetOCSPProducedAt(int iOCSPIndex); QString GetOCSPSigAlgorithm(int iOCSPIndex); int GetOCSPSource(int iOCSPIndex);
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.
Data Type
OfflineMode Property (SOAPSigner Class)
Switches the class to offline mode.
Syntax
ANSI (Cross Platform) int GetOfflineMode();
int SetOfflineMode(int bOfflineMode); Unicode (Windows) BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);
int secureblackbox_soapsigner_getofflinemode(void* lpObj);
int secureblackbox_soapsigner_setofflinemode(void* lpObj, int bOfflineMode);
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
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.
Data Type
Boolean
OutputBytes Property (SOAPSigner Class)
Use this property to read the output the class object has produced.
Syntax
ANSI (Cross Platform) int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes); Unicode (Windows) INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);
int secureblackbox_soapsigner_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);
QByteArray 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.
Data Type
Byte Array
OutputFile Property (SOAPSigner Class)
A file where the signed SOAP message will be saved.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_soapsigner_getoutputfile(void* lpObj);
int secureblackbox_soapsigner_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
Provide a full path to the file where the signed SOAP message should be saved.
Data Type
String
Profile Property (SOAPSigner Class)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
ANSI (Cross Platform) char* GetProfile();
int SetProfile(const char* lpszProfile); Unicode (Windows) LPWSTR GetProfile();
INT SetProfile(LPCWSTR lpszProfile);
char* secureblackbox_soapsigner_getprofile(void* lpObj);
int secureblackbox_soapsigner_setprofile(void* lpObj, const char* lpszProfile);
QString GetProfile();
int SetProfile(QString qsProfile);
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.
Data Type
String
Proxy Property (SOAPSigner Class)
The proxy server settings.
Syntax
SecureBlackboxProxySettings* GetProxy();
char* secureblackbox_soapsigner_getproxyaddress(void* lpObj);
int secureblackbox_soapsigner_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_soapsigner_getproxyauthentication(void* lpObj);
int secureblackbox_soapsigner_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_soapsigner_getproxypassword(void* lpObj);
int secureblackbox_soapsigner_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_soapsigner_getproxyport(void* lpObj);
int secureblackbox_soapsigner_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_soapsigner_getproxyproxytype(void* lpObj);
int secureblackbox_soapsigner_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_soapsigner_getproxyrequestheaders(void* lpObj);
int secureblackbox_soapsigner_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_soapsigner_getproxyresponsebody(void* lpObj);
int secureblackbox_soapsigner_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_soapsigner_getproxyresponseheaders(void* lpObj);
int secureblackbox_soapsigner_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_soapsigner_getproxyuseipv6(void* lpObj);
int secureblackbox_soapsigner_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_soapsigner_getproxyusername(void* lpObj);
int secureblackbox_soapsigner_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Data Type
References Property (SOAPSigner Class)
A list of references to the data to be signed.
Syntax
SecureBlackboxList<SecureBlackboxXMLReference>* GetReferences();
int secureblackbox_soapsigner_getreferencecount(void* lpObj);
int secureblackbox_soapsigner_setreferencecount(void* lpObj, int iReferenceCount);
int secureblackbox_soapsigner_getreferenceautogenerateelementid(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceautogenerateelementid(void* lpObj, int referenceindex, int bReferenceAutoGenerateElementId);
int secureblackbox_soapsigner_getreferencecanonicalizationmethod(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencecanonicalizationmethod(void* lpObj, int referenceindex, int iReferenceCanonicalizationMethod);
char* secureblackbox_soapsigner_getreferencecustomelementid(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencecustomelementid(void* lpObj, int referenceindex, const char* lpszReferenceCustomElementId);
char* secureblackbox_soapsigner_getreferencedataobjectdescription(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencedataobjectdescription(void* lpObj, int referenceindex, const char* lpszReferenceDataObjectDescription);
char* secureblackbox_soapsigner_getreferencedataobjectencoding(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencedataobjectencoding(void* lpObj, int referenceindex, const char* lpszReferenceDataObjectEncoding);
char* secureblackbox_soapsigner_getreferencedataobjectidentifier(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencedataobjectidentifier(void* lpObj, int referenceindex, const char* lpszReferenceDataObjectIdentifier);
char* secureblackbox_soapsigner_getreferencedataobjectmimetype(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencedataobjectmimetype(void* lpObj, int referenceindex, const char* lpszReferenceDataObjectMimeType);
int secureblackbox_soapsigner_getreferencedigestvalue(void* lpObj, int referenceindex, char** lpReferenceDigestValue, int* lenReferenceDigestValue);
int secureblackbox_soapsigner_setreferencedigestvalue(void* lpObj, int referenceindex, const char* lpReferenceDigestValue, int lenReferenceDigestValue);
int64 secureblackbox_soapsigner_getreferencehandle(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencehandle(void* lpObj, int referenceindex, int64 lReferenceHandle);
int secureblackbox_soapsigner_getreferencehasdataobjectformat(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencehasdataobjectformat(void* lpObj, int referenceindex, int bReferenceHasDataObjectFormat);
char* secureblackbox_soapsigner_getreferencehashalgorithm(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencehashalgorithm(void* lpObj, int referenceindex, const char* lpszReferenceHashAlgorithm);
int secureblackbox_soapsigner_getreferencehasuri(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencehasuri(void* lpObj, int referenceindex, int bReferenceHasURI);
char* secureblackbox_soapsigner_getreferenceid(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceid(void* lpObj, int referenceindex, const char* lpszReferenceID);
char* secureblackbox_soapsigner_getreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceinclusivenamespacesprefixlist(void* lpObj, int referenceindex, const char* lpszReferenceInclusiveNamespacesPrefixList);
char* secureblackbox_soapsigner_getreferencereferencetype(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencereferencetype(void* lpObj, int referenceindex, const char* lpszReferenceReferenceType);
int secureblackbox_soapsigner_getreferencetargetdata(void* lpObj, int referenceindex, char** lpReferenceTargetData, int* lenReferenceTargetData);
int secureblackbox_soapsigner_setreferencetargetdata(void* lpObj, int referenceindex, const char* lpReferenceTargetData, int lenReferenceTargetData);
int secureblackbox_soapsigner_getreferencetargettype(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencetargettype(void* lpObj, int referenceindex, int iReferenceTargetType);
char* secureblackbox_soapsigner_getreferencetargetxmlelement(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencetargetxmlelement(void* lpObj, int referenceindex, const char* lpszReferenceTargetXMLElement);
char* secureblackbox_soapsigner_getreferenceuri(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceuri(void* lpObj, int referenceindex, const char* lpszReferenceURI);
int secureblackbox_soapsigner_getreferenceusebase64transform(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceusebase64transform(void* lpObj, int referenceindex, int bReferenceUseBase64Transform);
int secureblackbox_soapsigner_getreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceuseenvelopedsignaturetransform(void* lpObj, int referenceindex, int bReferenceUseEnvelopedSignatureTransform);
int secureblackbox_soapsigner_getreferenceusexpathfilter2transform(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceusexpathfilter2transform(void* lpObj, int referenceindex, int bReferenceUseXPathFilter2Transform);
int secureblackbox_soapsigner_getreferenceusexpathtransform(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferenceusexpathtransform(void* lpObj, int referenceindex, int bReferenceUseXPathTransform);
int secureblackbox_soapsigner_getreferencevalidationresult(void* lpObj, int referenceindex);
char* secureblackbox_soapsigner_getreferencexpathexpression(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencexpathexpression(void* lpObj, int referenceindex, const char* lpszReferenceXPathExpression);
char* secureblackbox_soapsigner_getreferencexpathfilter2expressions(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencexpathfilter2expressions(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2Expressions);
char* secureblackbox_soapsigner_getreferencexpathfilter2filters(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencexpathfilter2filters(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2Filters);
char* secureblackbox_soapsigner_getreferencexpathfilter2prefixlist(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencexpathfilter2prefixlist(void* lpObj, int referenceindex, const char* lpszReferenceXPathFilter2PrefixList);
char* secureblackbox_soapsigner_getreferencexpathprefixlist(void* lpObj, int referenceindex);
int secureblackbox_soapsigner_setreferencexpathprefixlist(void* lpObj, int referenceindex, const char* lpszReferenceXPathPrefixList);
int GetReferenceCount();
int SetReferenceCount(int iReferenceCount); bool GetReferenceAutoGenerateElementId(int iReferenceIndex);
int SetReferenceAutoGenerateElementId(int iReferenceIndex, bool bReferenceAutoGenerateElementId); int GetReferenceCanonicalizationMethod(int iReferenceIndex);
int SetReferenceCanonicalizationMethod(int iReferenceIndex, int iReferenceCanonicalizationMethod); QString GetReferenceCustomElementId(int iReferenceIndex);
int SetReferenceCustomElementId(int iReferenceIndex, QString qsReferenceCustomElementId); QString GetReferenceDataObjectDescription(int iReferenceIndex);
int SetReferenceDataObjectDescription(int iReferenceIndex, QString qsReferenceDataObjectDescription); QString GetReferenceDataObjectEncoding(int iReferenceIndex);
int SetReferenceDataObjectEncoding(int iReferenceIndex, QString qsReferenceDataObjectEncoding); QString GetReferenceDataObjectIdentifier(int iReferenceIndex);
int SetReferenceDataObjectIdentifier(int iReferenceIndex, QString qsReferenceDataObjectIdentifier); QString GetReferenceDataObjectMimeType(int iReferenceIndex);
int SetReferenceDataObjectMimeType(int iReferenceIndex, QString qsReferenceDataObjectMimeType); QByteArray GetReferenceDigestValue(int iReferenceIndex);
int SetReferenceDigestValue(int iReferenceIndex, QByteArray qbaReferenceDigestValue); qint64 GetReferenceHandle(int iReferenceIndex);
int SetReferenceHandle(int iReferenceIndex, qint64 lReferenceHandle); bool GetReferenceHasDataObjectFormat(int iReferenceIndex);
int SetReferenceHasDataObjectFormat(int iReferenceIndex, bool bReferenceHasDataObjectFormat); QString GetReferenceHashAlgorithm(int iReferenceIndex);
int SetReferenceHashAlgorithm(int iReferenceIndex, QString qsReferenceHashAlgorithm); bool GetReferenceHasURI(int iReferenceIndex);
int SetReferenceHasURI(int iReferenceIndex, bool bReferenceHasURI); QString GetReferenceID(int iReferenceIndex);
int SetReferenceID(int iReferenceIndex, QString qsReferenceID); QString GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);
int SetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex, QString qsReferenceInclusiveNamespacesPrefixList); QString GetReferenceReferenceType(int iReferenceIndex);
int SetReferenceReferenceType(int iReferenceIndex, QString qsReferenceReferenceType); QByteArray GetReferenceTargetData(int iReferenceIndex);
int SetReferenceTargetData(int iReferenceIndex, QByteArray qbaReferenceTargetData); int GetReferenceTargetType(int iReferenceIndex);
int SetReferenceTargetType(int iReferenceIndex, int iReferenceTargetType); QString GetReferenceTargetXMLElement(int iReferenceIndex);
int SetReferenceTargetXMLElement(int iReferenceIndex, QString qsReferenceTargetXMLElement); QString GetReferenceURI(int iReferenceIndex);
int SetReferenceURI(int iReferenceIndex, QString qsReferenceURI); bool GetReferenceUseBase64Transform(int iReferenceIndex);
int SetReferenceUseBase64Transform(int iReferenceIndex, bool bReferenceUseBase64Transform); bool GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);
int SetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex, bool bReferenceUseEnvelopedSignatureTransform); bool GetReferenceUseXPathFilter2Transform(int iReferenceIndex);
int SetReferenceUseXPathFilter2Transform(int iReferenceIndex, bool bReferenceUseXPathFilter2Transform); bool GetReferenceUseXPathTransform(int iReferenceIndex);
int SetReferenceUseXPathTransform(int iReferenceIndex, bool bReferenceUseXPathTransform); bool GetReferenceValidationResult(int iReferenceIndex); QString GetReferenceXPathExpression(int iReferenceIndex);
int SetReferenceXPathExpression(int iReferenceIndex, QString qsReferenceXPathExpression); QString GetReferenceXPathFilter2Expressions(int iReferenceIndex);
int SetReferenceXPathFilter2Expressions(int iReferenceIndex, QString qsReferenceXPathFilter2Expressions); QString GetReferenceXPathFilter2Filters(int iReferenceIndex);
int SetReferenceXPathFilter2Filters(int iReferenceIndex, QString qsReferenceXPathFilter2Filters); QString GetReferenceXPathFilter2PrefixList(int iReferenceIndex);
int SetReferenceXPathFilter2PrefixList(int iReferenceIndex, QString qsReferenceXPathFilter2PrefixList); QString GetReferenceXPathPrefixList(int iReferenceIndex);
int SetReferenceXPathPrefixList(int iReferenceIndex, QString qsReferenceXPathPrefixList);
Remarks
Electronic signature is computed over a set of data pieces. Each piece of data to be signed is specified by a reference.
This property is read-only and not available at design time.
Data Type
RevocationCheck Property (SOAPSigner Class)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
ANSI (Cross Platform) int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck); Unicode (Windows) INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_soapsigner_getrevocationcheck(void* lpObj);
int secureblackbox_soapsigner_setrevocationcheck(void* lpObj, int iRevocationCheck);
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);
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.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
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.
Data Type
Integer
SecurityHeaderIndex Property (SOAPSigner Class)
Specifies the SecurityHeader index.
Syntax
ANSI (Cross Platform) int GetSecurityHeaderIndex();
int SetSecurityHeaderIndex(int iSecurityHeaderIndex); Unicode (Windows) INT GetSecurityHeaderIndex();
INT SetSecurityHeaderIndex(INT iSecurityHeaderIndex);
int secureblackbox_soapsigner_getsecurityheaderindex(void* lpObj);
int secureblackbox_soapsigner_setsecurityheaderindex(void* lpObj, int iSecurityHeaderIndex);
int GetSecurityHeaderIndex();
int SetSecurityHeaderIndex(int iSecurityHeaderIndex);
Default Value
-1
Remarks
Use this property to specify the index of SecurityHeader element where to put the signature. If the specified SecurityHeader element doesn't exist then a new SecurityHeader element will be created. The default value is "-1", in this case a new SecurityHeader element will be always created.
Data Type
Integer
Signatures Property (SOAPSigner Class)
Provides details of all signatures found in the SOAP message.
Syntax
SecureBlackboxList<SecureBlackboxSOAPSignature>* GetSignatures();
int secureblackbox_soapsigner_getsignaturecount(void* lpObj);
int secureblackbox_soapsigner_getsignaturecanonicalizationmethod(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturechainvalidationdetails(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturechainvalidationresult(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignatureclaimedsigningtime(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturecompatibilityerrors(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturecontainslongterminfo(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignatureentitylabel(void* lpObj, int signatureindex);
int64 secureblackbox_soapsigner_getsignaturehandle(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturehashalgorithm(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignatureissuerrdn(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturelastarchivaltime(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturelevel(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignatureparententity(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturepolicyhash(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturepolicyhashalgorithm(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturepolicyid(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturepolicyuri(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignatureserialnumber(void* lpObj, int signatureindex, char** lpSignatureSerialNumber, int* lenSignatureSerialNumber);
int secureblackbox_soapsigner_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);
int secureblackbox_soapsigner_getsignaturesignaturetype(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturesubjectkeyid(void* lpObj, int signatureindex, char** lpSignatureSubjectKeyID, int* lenSignatureSubjectKeyID);
char* secureblackbox_soapsigner_getsignaturesubjectrdn(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturetimestamped(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturevalidatedsigningtime(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturevalidationlog(void* lpObj, int signatureindex);
int secureblackbox_soapsigner_getsignaturexadesversion(void* lpObj, int signatureindex);
char* secureblackbox_soapsigner_getsignaturexmlelement(void* lpObj, int signatureindex);
int GetSignatureCount(); int GetSignatureCanonicalizationMethod(int iSignatureIndex); int GetSignatureChainValidationDetails(int iSignatureIndex); int GetSignatureChainValidationResult(int iSignatureIndex); QString GetSignatureClaimedSigningTime(int iSignatureIndex); int GetSignatureCompatibilityErrors(int iSignatureIndex); bool GetSignatureContainsLongTermInfo(int iSignatureIndex); QString GetSignatureEntityLabel(int iSignatureIndex); qint64 GetSignatureHandle(int iSignatureIndex); QString GetSignatureHashAlgorithm(int iSignatureIndex); QString GetSignatureIssuerRDN(int iSignatureIndex); QString GetSignatureLastArchivalTime(int iSignatureIndex); int GetSignatureLevel(int iSignatureIndex); QString GetSignatureParentEntity(int iSignatureIndex); QString GetSignaturePolicyHash(int iSignatureIndex); QString GetSignaturePolicyHashAlgorithm(int iSignatureIndex); QString GetSignaturePolicyID(int iSignatureIndex); QString GetSignaturePolicyURI(int iSignatureIndex); QByteArray GetSignatureSerialNumber(int iSignatureIndex); QByteArray GetSignatureSignatureBytes(int iSignatureIndex); int GetSignatureSignatureType(int iSignatureIndex); int GetSignatureSignatureValidationResult(int iSignatureIndex); QByteArray GetSignatureSubjectKeyID(int iSignatureIndex); QString GetSignatureSubjectRDN(int iSignatureIndex); bool GetSignatureTimestamped(int iSignatureIndex); QString GetSignatureValidatedSigningTime(int iSignatureIndex); QString GetSignatureValidationLog(int iSignatureIndex); int GetSignatureXAdESVersion(int iSignatureIndex); QString GetSignatureXMLElement(int iSignatureIndex);
Remarks
Use this property to get the details of all the signatures identified in the message.
This property is read-only and not available at design time.
Data Type
SigningCertificate Property (SOAPSigner Class)
The certificate to be used for signing.
Syntax
SecureBlackboxCertificate* GetSigningCertificate(); int SetSigningCertificate(SecureBlackboxCertificate* val);
int secureblackbox_soapsigner_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int64 secureblackbox_soapsigner_getsigningcerthandle(void* lpObj);
int secureblackbox_soapsigner_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);
QByteArray GetSigningCertBytes(); qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);
Remarks
Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.
This property is not available at design time.
Data Type
SigningChain Property (SOAPSigner Class)
The signing certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain(); int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_soapsigner_getsigningchaincount(void* lpObj);
int secureblackbox_soapsigner_setsigningchaincount(void* lpObj, int iSigningChainCount);
int secureblackbox_soapsigner_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);
int64 secureblackbox_soapsigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_soapsigner_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount); QByteArray GetSigningChainBytes(int iSigningChainIndex); qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);
Remarks
Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
Data Type
SocketSettings Property (SOAPSigner Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_soapsigner_getsocketdnsmode(void* lpObj);
int secureblackbox_soapsigner_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_soapsigner_getsocketdnsport(void* lpObj);
int secureblackbox_soapsigner_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_soapsigner_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_soapsigner_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_soapsigner_getsocketdnsservers(void* lpObj);
int secureblackbox_soapsigner_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_soapsigner_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_soapsigner_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_soapsigner_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_soapsigner_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_soapsigner_getsocketlocaladdress(void* lpObj);
int secureblackbox_soapsigner_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_soapsigner_getsocketlocalport(void* lpObj);
int secureblackbox_soapsigner_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_soapsigner_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_soapsigner_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_soapsigner_getsockettimeout(void* lpObj);
int secureblackbox_soapsigner_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_soapsigner_getsocketuseipv6(void* lpObj);
int secureblackbox_soapsigner_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers); int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
Timestamps Property (SOAPSigner Class)
Contains a collection of timestamps for the processed document.
Syntax
SecureBlackboxList<SecureBlackboxTimestampInfo>* GetTimestamps();
int secureblackbox_soapsigner_gettimestampcount(void* lpObj);
int64 secureblackbox_soapsigner_gettimestampaccuracy(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestampbytes(void* lpObj, int timestampindex, char** lpTimestampBytes, int* lenTimestampBytes);
int secureblackbox_soapsigner_gettimestampcertificateindex(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestampchainvalidationdetails(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestampchainvalidationresult(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestampcontainslongterminfo(void* lpObj, int timestampindex);
char* secureblackbox_soapsigner_gettimestampentitylabel(void* lpObj, int timestampindex);
char* secureblackbox_soapsigner_gettimestamphashalgorithm(void* lpObj, int timestampindex);
char* secureblackbox_soapsigner_gettimestampparententity(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestampserialnumber(void* lpObj, int timestampindex, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);
char* secureblackbox_soapsigner_gettimestamptime(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestamptimestamptype(void* lpObj, int timestampindex);
char* secureblackbox_soapsigner_gettimestamptsaname(void* lpObj, int timestampindex);
char* secureblackbox_soapsigner_gettimestampvalidationlog(void* lpObj, int timestampindex);
int secureblackbox_soapsigner_gettimestampvalidationresult(void* lpObj, int timestampindex);
int GetTimestampCount(); qint64 GetTimestampAccuracy(int iTimestampIndex); QByteArray GetTimestampBytes(int iTimestampIndex); int GetTimestampCertificateIndex(int iTimestampIndex); int GetTimestampChainValidationDetails(int iTimestampIndex); int GetTimestampChainValidationResult(int iTimestampIndex); bool GetTimestampContainsLongTermInfo(int iTimestampIndex); QString GetTimestampEntityLabel(int iTimestampIndex); QString GetTimestampHashAlgorithm(int iTimestampIndex); QString GetTimestampParentEntity(int iTimestampIndex); QByteArray GetTimestampSerialNumber(int iTimestampIndex); QString GetTimestampTime(int iTimestampIndex); int GetTimestampTimestampType(int iTimestampIndex); QString GetTimestampTSAName(int iTimestampIndex); QString GetTimestampValidationLog(int iTimestampIndex); int GetTimestampValidationResult(int iTimestampIndex);
Remarks
Use this property to access the timestamps included in the processed document.
This property is read-only and not available at design time.
Data Type
TimestampServer Property (SOAPSigner Class)
The address of the timestamping server.
Syntax
ANSI (Cross Platform) char* GetTimestampServer();
int SetTimestampServer(const char* lpszTimestampServer); Unicode (Windows) LPWSTR GetTimestampServer();
INT SetTimestampServer(LPCWSTR lpszTimestampServer);
char* secureblackbox_soapsigner_gettimestampserver(void* lpObj);
int secureblackbox_soapsigner_settimestampserver(void* lpObj, const char* lpszTimestampServer);
QString GetTimestampServer();
int SetTimestampServer(QString qsTimestampServer);
Default Value
""
Remarks
Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.
SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.
If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:
http://user:password@timestamp.server.com/TsaService
For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.
If this property is left empty, no timestamp will be added to the signature.
Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.
To employ the virtual service, assign an URI of the following format to this property:
virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true
Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:
component.Config("TimestampResponse=308208ab...");
Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.
The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.
The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.
The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.
The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.
All the parameters are optional.
Data Type
String
TLSClientChain Property (SOAPSigner Class)
The TLS client certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain(); int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_soapsigner_gettlsclientcertcount(void* lpObj);
int secureblackbox_soapsigner_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_soapsigner_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_soapsigner_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_soapsigner_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex); qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
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.
Data Type
TLSServerChain Property (SOAPSigner Class)
The TLS server's certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int secureblackbox_soapsigner_gettlsservercertcount(void* lpObj);
int secureblackbox_soapsigner_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_soapsigner_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_soapsigner_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_soapsigner_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_soapsigner_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_soapsigner_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_soapsigner_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_soapsigner_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_soapsigner_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount(); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); QString GetTLSServerCertFingerprint(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex); QString GetTLSServerCertIssuer(int iTLSServerCertIndex); QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex); QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex); int GetTLSServerCertKeyBits(int iTLSServerCertIndex); int GetTLSServerCertKeyUsage(int iTLSServerCertIndex); bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex); QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex); QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex); QString GetTLSServerCertSubject(int iTLSServerCertIndex); QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex); QString GetTLSServerCertValidFrom(int iTLSServerCertIndex); QString GetTLSServerCertValidTo(int iTLSServerCertIndex);
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.
Data Type
TLSSettings Property (SOAPSigner Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_soapsigner_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_soapsigner_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_soapsigner_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_soapsigner_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_soapsigner_gettlsciphersuites(void* lpObj);
int secureblackbox_soapsigner_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_soapsigner_gettlsclientauth(void* lpObj);
int secureblackbox_soapsigner_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_soapsigner_gettlseccurves(void* lpObj);
int secureblackbox_soapsigner_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_soapsigner_gettlsextensions(void* lpObj);
int secureblackbox_soapsigner_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_soapsigner_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_soapsigner_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_soapsigner_gettlspresharedidentity(void* lpObj);
int secureblackbox_soapsigner_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_soapsigner_gettlspresharedkey(void* lpObj);
int secureblackbox_soapsigner_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_soapsigner_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_soapsigner_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_soapsigner_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_soapsigner_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_soapsigner_gettlsrevocationcheck(void* lpObj);
int secureblackbox_soapsigner_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_soapsigner_gettlsssloptions(void* lpObj);
int secureblackbox_soapsigner_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_soapsigner_gettlstlsmode(void* lpObj);
int secureblackbox_soapsigner_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_soapsigner_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_soapsigner_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_soapsigner_gettlsusesessionresumption(void* lpObj);
int secureblackbox_soapsigner_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_soapsigner_gettlsversions(void* lpObj);
int secureblackbox_soapsigner_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Data Type
TrustedCertificates Property (SOAPSigner Class)
A list of trusted certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_soapsigner_gettrustedcertcount(void* lpObj);
int secureblackbox_soapsigner_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_soapsigner_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_soapsigner_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_soapsigner_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); QByteArray GetTrustedCertBytes(int iTrustedCertIndex); qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
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.
Data Type
ValidationMoment Property (SOAPSigner Class)
The time point at which signature validity is to be established.
Syntax
ANSI (Cross Platform) char* GetValidationMoment();
int SetValidationMoment(const char* lpszValidationMoment); Unicode (Windows) LPWSTR GetValidationMoment();
INT SetValidationMoment(LPCWSTR lpszValidationMoment);
char* secureblackbox_soapsigner_getvalidationmoment(void* lpObj);
int secureblackbox_soapsigner_setvalidationmoment(void* lpObj, const char* lpszValidationMoment);
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);
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.
Data Type
String
AddBodyReference Method (SOAPSigner Class)
Creates a new XML reference to the Body element of the SOAP message.
Syntax
ANSI (Cross Platform) int AddBodyReference(const char* lpszCustomId, int bAutoGenerateId); Unicode (Windows) INT AddBodyReference(LPCWSTR lpszCustomId, BOOL bAutoGenerateId);
int secureblackbox_soapsigner_addbodyreference(void* lpObj, const char* lpszCustomId, int bAutoGenerateId);
int AddBodyReference(const QString& qsCustomId, bool bAutoGenerateId);
Remarks
Use this method to add a reference to the Body element of the SOAP message.
The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.
Use CanonicalizationMethod and HashAlgorithm properties to specify the canonicalization method and hash algorithm to use.
The method returns the index of the new reference entry in the References collection.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
AddDataReference Method (SOAPSigner Class)
Creates a new XML reference to the specified data.
Syntax
ANSI (Cross Platform) int AddDataReference(const char* lpszDataURI, const char* lpData, int lenData); Unicode (Windows) INT AddDataReference(LPCWSTR lpszDataURI, LPCSTR lpData, INT lenData);
int secureblackbox_soapsigner_adddatareference(void* lpObj, const char* lpszDataURI, const char* lpData, int lenData);
int AddDataReference(const QString& qsDataURI, QByteArray qbaData);
Remarks
Use this method to add a reference to the custom data. Pass the reference's URI via DataURI parameter.
Use HashAlgorithm property to specify the hash algorithm to use.
The method returns the index of the new reference entry in the References collection.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
AddKnownNamespace Method (SOAPSigner Class)
Adds known prefix and correspondent namespace URI.
Syntax
ANSI (Cross Platform) int AddKnownNamespace(const char* lpszPrefix, const char* lpszURI); Unicode (Windows) INT AddKnownNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszURI);
int secureblackbox_soapsigner_addknownnamespace(void* lpObj, const char* lpszPrefix, const char* lpszURI);
int AddKnownNamespace(const QString& qsPrefix, const QString& qsURI);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddReference Method (SOAPSigner Class)
Creates a new XML reference to the specified XML element.
Syntax
ANSI (Cross Platform) int AddReference(const char* lpszTargetXmlElement, const char* lpszCustomId, int bAutoGenerateId); Unicode (Windows) INT AddReference(LPCWSTR lpszTargetXmlElement, LPCWSTR lpszCustomId, BOOL bAutoGenerateId);
int secureblackbox_soapsigner_addreference(void* lpObj, const char* lpszTargetXmlElement, const char* lpszCustomId, int bAutoGenerateId);
int AddReference(const QString& qsTargetXmlElement, const QString& qsCustomId, bool bAutoGenerateId);
Remarks
Use this method to add a reference to a particular XML element.
The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.
Use CanonicalizationMethod and HashAlgorithm properties to specify the canonicalization method and hash algorithm to use.
The method returns the index of the new reference entry in the References collection.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Close Method (SOAPSigner Class)
Closes an opened SOAP message.
Syntax
ANSI (Cross Platform) int Close(int bSaveChanges); Unicode (Windows) INT Close(BOOL bSaveChanges);
int secureblackbox_soapsigner_close(void* lpObj, int bSaveChanges);
int Close(bool bSaveChanges);
Remarks
Use this method to close a previously opened SOAP message. Set SaveChanges to true to apply any changes made.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (SOAPSigner Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_soapsigner_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (SOAPSigner Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_soapsigner_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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;....
Common ActionIDs:
Action | Parameters | Returned value | Description |
ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
ResetCertificateCache | none | none | Clears the cached certificates. |
ResetCRLCache | none | none | Clears the cached CRLs. |
ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ExtractAsyncData Method (SOAPSigner Class)
Extracts user data from the DC signing service response.
Syntax
ANSI (Cross Platform) char* ExtractAsyncData(const char* lpszAsyncReply); Unicode (Windows) LPWSTR ExtractAsyncData(LPCWSTR lpszAsyncReply);
char* secureblackbox_soapsigner_extractasyncdata(void* lpObj, const char* lpszAsyncReply);
QString ExtractAsyncData(const QString& qsAsyncReply);
Remarks
Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.
The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetInnerXML Method (SOAPSigner Class)
Get the inner XML content of the selected XML element.
Syntax
ANSI (Cross Platform) char* GetInnerXML(const char* lpszXPath); Unicode (Windows) LPWSTR GetInnerXML(LPCWSTR lpszXPath);
char* secureblackbox_soapsigner_getinnerxml(void* lpObj, const char* lpszXPath);
QString GetInnerXML(const QString& qsXPath);
Remarks
Call this method to get the inner XML content of the selected XML element.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetOuterXML Method (SOAPSigner Class)
Get the outer XML content of the selected XML element.
Syntax
ANSI (Cross Platform) char* GetOuterXML(const char* lpszXPath); Unicode (Windows) LPWSTR GetOuterXML(LPCWSTR lpszXPath);
char* secureblackbox_soapsigner_getouterxml(void* lpObj, const char* lpszXPath);
QString GetOuterXML(const QString& qsXPath);
Remarks
Call this method to get the outer XML content of the selected XML element.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetTextContent Method (SOAPSigner Class)
Get the text content of the selected XML element.
Syntax
ANSI (Cross Platform) char* GetTextContent(const char* lpszXPath); Unicode (Windows) LPWSTR GetTextContent(LPCWSTR lpszXPath);
char* secureblackbox_soapsigner_gettextcontent(void* lpObj, const char* lpszXPath);
QString GetTextContent(const QString& qsXPath);
Remarks
Call this method to get the text content of the selected XML element.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Open Method (SOAPSigner Class)
Opens a document for signing or updating.
Syntax
ANSI (Cross Platform) int Open(); Unicode (Windows) INT Open();
int secureblackbox_soapsigner_open(void* lpObj);
int Open();
Remarks
Use this method to open a document for signing or updating. When finished, call Close to complete or discard the operation.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (SOAPSigner Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_soapsigner_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Revalidate Method (SOAPSigner Class)
Revalidates a signature in accordance with current settings.
Syntax
ANSI (Cross Platform) int Revalidate(const char* lpszSigLabel); Unicode (Windows) INT Revalidate(LPCWSTR lpszSigLabel);
int secureblackbox_soapsigner_revalidate(void* lpObj, const char* lpszSigLabel);
int Revalidate(const QString& qsSigLabel);
Remarks
Use this method to re-validate a signature in the opened SOAP message.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SelectInfo Method (SOAPSigner Class)
Select signature information for a specific entity.
Syntax
ANSI (Cross Platform) int SelectInfo(const char* lpszEntityLabel, int iInfoType, int bClearSelection); Unicode (Windows) INT SelectInfo(LPCWSTR lpszEntityLabel, INT iInfoType, BOOL bClearSelection);
int secureblackbox_soapsigner_selectinfo(void* lpObj, const char* lpszEntityLabel, int iInfoType, int bClearSelection);
int SelectInfo(const QString& qsEntityLabel, int iInfoType, bool bClearSelection);
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:
sitEntity | 1 | Select the current entity |
sitParentEntity | 2 | Select the parent entity of the current entity |
sitTimestamps | 4 | Select all timestamps covering the current entity |
sitSignatures | 8 | Select all signatures covering the current entity |
sitSigningChain | 16 | Select the signing chain of the current entity |
sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
sitAttributes | 65536 | Select this entity's CMS attributes |
sitReferences | 131072 | Select this entity's XML references |
sitSignedParts | 262144 | Select this entity's signed parts |
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetInnerXML Method (SOAPSigner Class)
Set the inner XML content of the selected XML element.
Syntax
ANSI (Cross Platform) int SetInnerXML(const char* lpszXPath, const char* lpszValue); Unicode (Windows) INT SetInnerXML(LPCWSTR lpszXPath, LPCWSTR lpszValue);
int secureblackbox_soapsigner_setinnerxml(void* lpObj, const char* lpszXPath, const char* lpszValue);
int SetInnerXML(const QString& qsXPath, const QString& qsValue);
Remarks
Call this method to set the inner XML content of the selected XML element.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetTextContent Method (SOAPSigner Class)
Set the text content of the selected XML element.
Syntax
ANSI (Cross Platform) int SetTextContent(const char* lpszXPath, const char* lpszValue); Unicode (Windows) INT SetTextContent(LPCWSTR lpszXPath, LPCWSTR lpszValue);
int secureblackbox_soapsigner_settextcontent(void* lpObj, const char* lpszXPath, const char* lpszValue);
int SetTextContent(const QString& qsXPath, const QString& qsValue);
Remarks
Call this method to set the text content of the selected XML element.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Sign Method (SOAPSigner Class)
Signs the SOAP message.
Syntax
ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign();
int secureblackbox_soapsigner_sign(void* lpObj);
int Sign();
Remarks
Call this method to generate a signed SOAP message.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SignAsyncBegin Method (SOAPSigner Class)
Initiates the asynchronous signing operation.
Syntax
ANSI (Cross Platform) char* SignAsyncBegin(); Unicode (Windows) LPWSTR SignAsyncBegin();
char* secureblackbox_soapsigner_signasyncbegin(void* lpObj);
QString SignAsyncBegin();
Remarks
When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.
Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.
Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.
Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.
AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.
In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SignAsyncEnd Method (SOAPSigner Class)
Completes the asynchronous signing operation.
Syntax
ANSI (Cross Platform) int SignAsyncEnd(const char* lpszAsyncReply); Unicode (Windows) INT SignAsyncEnd(LPCWSTR lpszAsyncReply);
int secureblackbox_soapsigner_signasyncend(void* lpObj, const char* lpszAsyncReply);
int SignAsyncEnd(const QString& qsAsyncReply);
Remarks
When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.
Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).
Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.
Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.
AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.
In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SignExternal Method (SOAPSigner Class)
Signs the document using an external signing facility.
Syntax
ANSI (Cross Platform) int SignExternal(); Unicode (Windows) INT SignExternal();
int secureblackbox_soapsigner_signexternal(void* lpObj);
int SignExternal();
Remarks
Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.
When all preparations are done and hash is computed, the class fires ExternalSign event which allows to pass the hash value for signing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Timestamp Method (SOAPSigner Class)
Use this method to add an timestamp.
Syntax
ANSI (Cross Platform) int Timestamp(const char* lpszSigLabel, int iTimestampType); Unicode (Windows) INT Timestamp(LPCWSTR lpszSigLabel, INT iTimestampType);
int secureblackbox_soapsigner_timestamp(void* lpObj, const char* lpszSigLabel, int iTimestampType);
int Timestamp(const QString& qsSigLabel, int iTimestampType);
Remarks
Call this method to timestamp the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. This method could be called separately or in SignatureValidated event handler after successful signature validation. Use the TimestampType parameter to specify the type of timestamp to create
Supported timestamp types:
tstSignature | 12 | Signature timestamp |
tstRefsOnly | 13 | RefsOnly timestamp |
tstSigAndRefs | 14 | SigAndRefs timestamp |
tstArchive | 7 | Archive timestamp |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Upgrade Method (SOAPSigner Class)
Upgrades existing XAdES signature to a new form.
Syntax
ANSI (Cross Platform) int Upgrade(const char* lpszSigLabel, int iUpgradeKind); Unicode (Windows) INT Upgrade(LPCWSTR lpszSigLabel, INT iUpgradeKind);
int secureblackbox_soapsigner_upgrade(void* lpObj, const char* lpszSigLabel, int iUpgradeKind);
int Upgrade(const QString& qsSigLabel, int iUpgradeKind);
Remarks
XAdES standard defines a number of different 'forms' of signatures which can be used for different purposes. Use this method to upgrade XAdES signature to a new form or level specified by UpgradeKind. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, C, X, X-L, A).
The supported levels and forms are:
aslUnknown | 0 | Unknown signature level |
aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
aslBaselineB | 2 | Baseline B (B-B, basic) |
aslBaselineT | 3 | Baseline T (B-T, timestamped) |
aslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |
aslBES | 6 | BES (Basic Electronic Signature) |
aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
aslT | 8 | T (Timestamped) |
aslC | 9 | C (T with revocation references) |
aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
aslA | 16 | A (archived) |
aslExtendedBES | 17 | Extended BES |
aslExtendedEPES | 18 | Extended EPES |
aslExtendedT | 19 | Extended T |
aslExtendedC | 20 | Extended C |
aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
aslExtendedA | 28 | Extended A |
The supported additional upgrade kinds are:
xukAddValidationDataRefs | 256 | Add signature validation references |
xukAddValidationDataValues | 512 | Add signature validation values |
xukAddTimestampValidationData | 1024 | Add timestamp validation data |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ChainElementDownload Event (SOAPSigner Class)
Fires when there is a need to download a chain element from an online source.
Syntax
ANSI (Cross Platform) virtual int FireChainElementDownload(SOAPSignerChainElementDownloadEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN;
const char *Location;
int Action; int reserved; } SOAPSignerChainElementDownloadEventParams;
Unicode (Windows) virtual INT FireChainElementDownload(SOAPSignerChainElementDownloadEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
LPCWSTR Location;
INT Action; INT reserved; } SOAPSignerChainElementDownloadEventParams;
#define EID_SOAPSIGNER_CHAINELEMENTDOWNLOAD 1 virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);
class SOAPSignerChainElementDownloadEventParams { public: int Kind(); const QString &CertRDN(); const QString &CACertRDN(); const QString &Location(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainElementDownload(SOAPSignerChainElementDownloadEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireChainElementDownload(SOAPSignerChainElementDownloadEventParams *e) {...}
Remarks
Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.
veaAuto | 0 | Handle the action automatically (the default behaviour) |
veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
veaAcceptNow | 3 | Accept the validated certificate immediately |
veaAbortNow | 4 | Abort the validation, reject the certificate |
cekUnknown | 0 | Unknown or unsupported element type |
cekCertificate | 1 | An X.509 certificate |
cekCRL | 2 | A CRL |
cekOCSP | 3 | An OCSP response |
ChainElementNeeded Event (SOAPSigner Class)
Fires when an element required to validate the chain was not located.
Syntax
ANSI (Cross Platform) virtual int FireChainElementNeeded(SOAPSignerChainElementNeededEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN; int reserved; } SOAPSignerChainElementNeededEventParams;
Unicode (Windows) virtual INT FireChainElementNeeded(SOAPSignerChainElementNeededEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN; INT reserved; } SOAPSignerChainElementNeededEventParams;
#define EID_SOAPSIGNER_CHAINELEMENTNEEDED 2 virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);
class SOAPSignerChainElementNeededEventParams { public: int Kind(); const QString &CertRDN(); const QString &CACertRDN(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainElementNeeded(SOAPSignerChainElementNeededEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireChainElementNeeded(SOAPSignerChainElementNeededEventParams *e) {...}
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.
cekUnknown | 0 | Unknown or unsupported element type |
cekCertificate | 1 | An X.509 certificate |
cekCRL | 2 | A CRL |
cekOCSP | 3 | An OCSP response |
ChainElementStore Event (SOAPSigner Class)
This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
Syntax
ANSI (Cross Platform) virtual int FireChainElementStore(SOAPSignerChainElementStoreEventParams *e);
typedef struct {
int Kind;
const char *Body; int lenBody;
char *URI; int reserved; } SOAPSignerChainElementStoreEventParams;
Unicode (Windows) virtual INT FireChainElementStore(SOAPSignerChainElementStoreEventParams *e);
typedef struct {
INT Kind;
LPCSTR Body; INT lenBody;
LPWSTR URI; INT reserved; } SOAPSignerChainElementStoreEventParams;
#define EID_SOAPSIGNER_CHAINELEMENTSTORE 3 virtual INT SECUREBLACKBOX_CALL FireChainElementStore(INT &iKind, LPSTR &lpBody, INT &lenBody, LPSTR &lpszURI);
class SOAPSignerChainElementStoreEventParams { public: int Kind(); const QByteArray &Body(); const QString &URI(); void SetURI(const QString &qsURI); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainElementStore(SOAPSignerChainElementStoreEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireChainElementStore(SOAPSignerChainElementStoreEventParams *e) {...}
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.
cekUnknown | 0 | Unknown or unsupported element type |
cekCertificate | 1 | An X.509 certificate |
cekCRL | 2 | A CRL |
cekOCSP | 3 | An OCSP response |
ChainValidated Event (SOAPSigner Class)
Reports the completion of a certificate chain validation.
Syntax
ANSI (Cross Platform) virtual int FireChainValidated(SOAPSignerChainValidatedEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *SubjectRDN;
int ValidationResult;
int ValidationDetails;
int Cancel; int reserved; } SOAPSignerChainValidatedEventParams;
Unicode (Windows) virtual INT FireChainValidated(SOAPSignerChainValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR SubjectRDN;
INT ValidationResult;
INT ValidationDetails;
BOOL Cancel; INT reserved; } SOAPSignerChainValidatedEventParams;
#define EID_SOAPSIGNER_CHAINVALIDATED 4 virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails, BOOL &bCancel);
class SOAPSignerChainValidatedEventParams { public: int Index(); const QString &EntityLabel(); const QString &SubjectRDN(); int ValidationResult(); int ValidationDetails(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainValidated(SOAPSignerChainValidatedEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireChainValidated(SOAPSignerChainValidatedEventParams *e) {...}
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.
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationProgress Event (SOAPSigner Class)
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
ANSI (Cross Platform) virtual int FireChainValidationProgress(SOAPSignerChainValidationProgressEventParams *e);
typedef struct {
const char *EventKind;
const char *CertRDN;
const char *CACertRDN;
int Action; int reserved; } SOAPSignerChainValidationProgressEventParams;
Unicode (Windows) virtual INT FireChainValidationProgress(SOAPSignerChainValidationProgressEventParams *e);
typedef struct {
LPCWSTR EventKind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
INT Action; INT reserved; } SOAPSignerChainValidationProgressEventParams;
#define EID_SOAPSIGNER_CHAINVALIDATIONPROGRESS 5 virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);
class SOAPSignerChainValidationProgressEventParams { public: const QString &EventKind(); const QString &CertRDN(); const QString &CACertRDN(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainValidationProgress(SOAPSignerChainValidationProgressEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireChainValidationProgress(SOAPSignerChainValidationProgressEventParams *e) {...}
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.
veaAuto | 0 | Handle the action automatically (the default behaviour) |
veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
veaAcceptNow | 3 | Accept the validated certificate immediately |
veaAbortNow | 4 | Abort the validation, reject the certificate |
Error Event (SOAPSigner Class)
Information about errors during signing.
Syntax
ANSI (Cross Platform) virtual int FireError(SOAPSignerErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SOAPSignerErrorEventParams;
Unicode (Windows) virtual INT FireError(SOAPSignerErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SOAPSignerErrorEventParams;
#define EID_SOAPSIGNER_ERROR 6 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SOAPSignerErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SOAPSignerErrorEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireError(SOAPSignerErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during signing.
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.
ExternalSign Event (SOAPSigner Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
ANSI (Cross Platform) virtual int FireExternalSign(SOAPSignerExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SOAPSignerExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SOAPSignerExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SOAPSignerExternalSignEventParams;
#define EID_SOAPSIGNER_EXTERNALSIGN 7 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class SOAPSignerExternalSignEventParams { public: const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(SOAPSignerExternalSignEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireExternalSign(SOAPSignerExternalSignEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
FormatElement Event (SOAPSigner Class)
Reports the XML element that is currently being processed.
Syntax
ANSI (Cross Platform) virtual int FireFormatElement(SOAPSignerFormatElementEventParams *e);
typedef struct {
char *StartTagWhitespace;
char *EndTagWhitespace;
int Level;
const char *Path;
int HasChildElements; int reserved; } SOAPSignerFormatElementEventParams;
Unicode (Windows) virtual INT FireFormatElement(SOAPSignerFormatElementEventParams *e);
typedef struct {
LPWSTR StartTagWhitespace;
LPWSTR EndTagWhitespace;
INT Level;
LPCWSTR Path;
BOOL HasChildElements; INT reserved; } SOAPSignerFormatElementEventParams;
#define EID_SOAPSIGNER_FORMATELEMENT 8 virtual INT SECUREBLACKBOX_CALL FireFormatElement(LPSTR &lpszStartTagWhitespace, LPSTR &lpszEndTagWhitespace, INT &iLevel, LPSTR &lpszPath, BOOL &bHasChildElements);
class SOAPSignerFormatElementEventParams { public: const QString &StartTagWhitespace(); void SetStartTagWhitespace(const QString &qsStartTagWhitespace); const QString &EndTagWhitespace(); void SetEndTagWhitespace(const QString &qsEndTagWhitespace); int Level(); const QString &Path(); bool HasChildElements(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FormatElement(SOAPSignerFormatElementEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireFormatElement(SOAPSignerFormatElementEventParams *e) {...}
Remarks
Path and Level specify the path to the XML element being processed and its nesting level, respectively.
HasChildElements specify if processed XML element has child elements.
Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.
FormatText Event (SOAPSigner Class)
Reports XML text that is currently being processed.
Syntax
ANSI (Cross Platform) virtual int FireFormatText(SOAPSignerFormatTextEventParams *e);
typedef struct {
char *Text;
int TextType;
int Level;
const char *Path; int reserved; } SOAPSignerFormatTextEventParams;
Unicode (Windows) virtual INT FireFormatText(SOAPSignerFormatTextEventParams *e);
typedef struct {
LPWSTR Text;
INT TextType;
INT Level;
LPCWSTR Path; INT reserved; } SOAPSignerFormatTextEventParams;
#define EID_SOAPSIGNER_FORMATTEXT 9 virtual INT SECUREBLACKBOX_CALL FireFormatText(LPSTR &lpszText, INT &iTextType, INT &iLevel, LPSTR &lpszPath);
class SOAPSignerFormatTextEventParams { public: const QString &Text(); void SetText(const QString &qsText); int TextType(); int Level(); const QString &Path(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FormatText(SOAPSignerFormatTextEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireFormatText(SOAPSignerFormatTextEventParams *e) {...}
Remarks
TextType parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; Path and Level specify the path to the XML element and its nesting level.
Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.
MessageLoaded Event (SOAPSigner Class)
This event is fired when the message has been loaded into memory.
Syntax
ANSI (Cross Platform) virtual int FireMessageLoaded(SOAPSignerMessageLoadedEventParams *e);
typedef struct {
int Cancel; int reserved; } SOAPSignerMessageLoadedEventParams;
Unicode (Windows) virtual INT FireMessageLoaded(SOAPSignerMessageLoadedEventParams *e);
typedef struct {
BOOL Cancel; INT reserved; } SOAPSignerMessageLoadedEventParams;
#define EID_SOAPSIGNER_MESSAGELOADED 10 virtual INT SECUREBLACKBOX_CALL FireMessageLoaded(BOOL &bCancel);
class SOAPSignerMessageLoadedEventParams { public: bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void MessageLoaded(SOAPSignerMessageLoadedEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireMessageLoaded(SOAPSignerMessageLoadedEventParams *e) {...}
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 (SOAPSigner Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(SOAPSignerNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SOAPSignerNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SOAPSignerNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SOAPSignerNotificationEventParams;
#define EID_SOAPSIGNER_NOTIFICATION 11 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class SOAPSignerNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(SOAPSignerNotificationEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireNotification(SOAPSignerNotificationEventParams *e) {...}
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:
BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
TimestampRequest | A timestamp is requested from the custom timestamping
authority. This event is only fired if TimestampServer was set to a
virtual:// URI. The EventParam parameter contains the
TSP request (or the plain hash, depending on the value provided to
TimestampServer), in base16, that needs to be sent to the TSA.
Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |
ReferenceValidated Event (SOAPSigner Class)
Marks the end of a reference validation.
Syntax
ANSI (Cross Platform) virtual int FireReferenceValidated(SOAPSignerReferenceValidatedEventParams *e);
typedef struct {
int ReferenceIndex;
const char *ID;
const char *URI;
const char *RefType;
int DigestValid; int reserved; } SOAPSignerReferenceValidatedEventParams;
Unicode (Windows) virtual INT FireReferenceValidated(SOAPSignerReferenceValidatedEventParams *e);
typedef struct {
INT ReferenceIndex;
LPCWSTR ID;
LPCWSTR URI;
LPCWSTR RefType;
BOOL DigestValid; INT reserved; } SOAPSignerReferenceValidatedEventParams;
#define EID_SOAPSIGNER_REFERENCEVALIDATED 12 virtual INT SECUREBLACKBOX_CALL FireReferenceValidated(INT &iReferenceIndex, LPSTR &lpszID, LPSTR &lpszURI, LPSTR &lpszRefType, BOOL &bDigestValid);
class SOAPSignerReferenceValidatedEventParams { public: int ReferenceIndex(); const QString &ID(); const QString &URI(); const QString &RefType(); bool DigestValid(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReferenceValidated(SOAPSignerReferenceValidatedEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireReferenceValidated(SOAPSignerReferenceValidatedEventParams *e) {...}
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 (SOAPSigner Class)
Asks the application to resolve a reference.
Syntax
ANSI (Cross Platform) virtual int FireResolveReference(SOAPSignerResolveReferenceEventParams *e);
typedef struct {
int ReferenceIndex;
const char *URI; int reserved; } SOAPSignerResolveReferenceEventParams;
Unicode (Windows) virtual INT FireResolveReference(SOAPSignerResolveReferenceEventParams *e);
typedef struct {
INT ReferenceIndex;
LPCWSTR URI; INT reserved; } SOAPSignerResolveReferenceEventParams;
#define EID_SOAPSIGNER_RESOLVEREFERENCE 13 virtual INT SECUREBLACKBOX_CALL FireResolveReference(INT &iReferenceIndex, LPSTR &lpszURI);
class SOAPSignerResolveReferenceEventParams { public: int ReferenceIndex(); const QString &URI(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResolveReference(SOAPSignerResolveReferenceEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireResolveReference(SOAPSignerResolveReferenceEventParams *e) {...}
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 (SOAPSigner Class)
Signifies the start of signature validation.
Syntax
ANSI (Cross Platform) virtual int FireSignatureFound(SOAPSignerSignatureFoundEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateSignature;
int ValidateChain; int reserved; } SOAPSignerSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(SOAPSignerSignatureFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateSignature;
BOOL ValidateChain; INT reserved; } SOAPSignerSignatureFoundEventParams;
#define EID_SOAPSIGNER_SIGNATUREFOUND 14 virtual INT SECUREBLACKBOX_CALL FireSignatureFound(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class SOAPSignerSignatureFoundEventParams { public: int Index(); const QString &EntityLabel(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); bool CertFound(); bool ValidateSignature(); void SetValidateSignature(bool bValidateSignature); bool ValidateChain(); void SetValidateChain(bool bValidateChain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureFound(SOAPSignerSignatureFoundEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireSignatureFound(SOAPSignerSignatureFoundEventParams *e) {...}
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 (SOAPSigner Class)
Marks the completion of the signature validation routine.
Syntax
ANSI (Cross Platform) virtual int FireSignatureValidated(SOAPSignerSignatureValidatedEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult;
int Cancel; int reserved; } SOAPSignerSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(SOAPSignerSignatureValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult;
BOOL Cancel; INT reserved; } SOAPSignerSignatureValidatedEventParams;
#define EID_SOAPSIGNER_SIGNATUREVALIDATED 15 virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult, BOOL &bCancel);
class SOAPSignerSignatureValidatedEventParams { public: int Index(); const QString &EntityLabel(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); int ValidationResult(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureValidated(SOAPSignerSignatureValidatedEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireSignatureValidated(SOAPSignerSignatureValidatedEventParams *e) {...}
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.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TimestampFound Event (SOAPSigner Class)
Signifies the start of a timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampFound(SOAPSignerTimestampFoundEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateTimestamp;
int ValidateChain; int reserved; } SOAPSignerTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(SOAPSignerTimestampFoundEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateTimestamp;
BOOL ValidateChain; INT reserved; } SOAPSignerTimestampFoundEventParams;
#define EID_SOAPSIGNER_TIMESTAMPFOUND 16 virtual INT SECUREBLACKBOX_CALL FireTimestampFound(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class SOAPSignerTimestampFoundEventParams { public: int Index(); const QString &EntityLabel(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); bool CertFound(); bool ValidateTimestamp(); void SetValidateTimestamp(bool bValidateTimestamp); bool ValidateChain(); void SetValidateChain(bool bValidateChain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TimestampFound(SOAPSignerTimestampFoundEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTimestampFound(SOAPSignerTimestampFoundEventParams *e) {...}
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.
TimestampRequest Event (SOAPSigner Class)
Fires when the class is ready to request a timestamp from an external TSA.
Syntax
ANSI (Cross Platform) virtual int FireTimestampRequest(SOAPSignerTimestampRequestEventParams *e);
typedef struct {
const char *TSA;
const char *TimestampRequest;
char *TimestampResponse;
int SuppressDefault; int reserved; } SOAPSignerTimestampRequestEventParams;
Unicode (Windows) virtual INT FireTimestampRequest(SOAPSignerTimestampRequestEventParams *e);
typedef struct {
LPCWSTR TSA;
LPCWSTR TimestampRequest;
LPWSTR TimestampResponse;
BOOL SuppressDefault; INT reserved; } SOAPSignerTimestampRequestEventParams;
#define EID_SOAPSIGNER_TIMESTAMPREQUEST 17 virtual INT SECUREBLACKBOX_CALL FireTimestampRequest(LPSTR &lpszTSA, LPSTR &lpszTimestampRequest, LPSTR &lpszTimestampResponse, BOOL &bSuppressDefault);
class SOAPSignerTimestampRequestEventParams { public: const QString &TSA(); const QString &TimestampRequest(); const QString &TimestampResponse(); void SetTimestampResponse(const QString &qsTimestampResponse); bool SuppressDefault(); void SetSuppressDefault(bool bSuppressDefault); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TimestampRequest(SOAPSignerTimestampRequestEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTimestampRequest(SOAPSignerTimestampRequestEventParams *e) {...}
Remarks
Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.
The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.
TimestampValidated Event (SOAPSigner Class)
Reports the completion of the timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampValidated(SOAPSignerTimestampValidatedEventParams *e);
typedef struct {
int Index;
const char *EntityLabel;
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *Time;
int ValidationResult;
int ChainValidationResult;
int ChainValidationDetails;
int Cancel; int reserved; } SOAPSignerTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(SOAPSignerTimestampValidatedEventParams *e);
typedef struct {
INT Index;
LPCWSTR EntityLabel;
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR Time;
INT ValidationResult;
INT ChainValidationResult;
INT ChainValidationDetails;
BOOL Cancel; INT reserved; } SOAPSignerTimestampValidatedEventParams;
#define EID_SOAPSIGNER_TIMESTAMPVALIDATED 18 virtual INT SECUREBLACKBOX_CALL FireTimestampValidated(INT &iIndex, LPSTR &lpszEntityLabel, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszTime, INT &iValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails, BOOL &bCancel);
class SOAPSignerTimestampValidatedEventParams { public: int Index(); const QString &EntityLabel(); const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); const QString &Time(); int ValidationResult(); int ChainValidationResult(); int ChainValidationDetails(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TimestampValidated(SOAPSignerTimestampValidatedEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTimestampValidated(SOAPSignerTimestampValidatedEventParams *e) {...}
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.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TLSCertNeeded Event (SOAPSigner Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(SOAPSignerTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } SOAPSignerTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(SOAPSignerTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } SOAPSignerTLSCertNeededEventParams;
#define EID_SOAPSIGNER_TLSCERTNEEDED 19 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class SOAPSignerTLSCertNeededEventParams { public: const QString &Host(); const QString &CANames(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertNeeded(SOAPSignerTLSCertNeededEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTLSCertNeeded(SOAPSignerTLSCertNeededEventParams *e) {...}
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 (SOAPSigner Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(SOAPSignerTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } SOAPSignerTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(SOAPSignerTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } SOAPSignerTLSCertValidateEventParams;
#define EID_SOAPSIGNER_TLSCERTVALIDATE 20 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class SOAPSignerTLSCertValidateEventParams { public: const QString &ServerHost(); const QString &ServerIP(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(SOAPSignerTLSCertValidateEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTLSCertValidate(SOAPSignerTLSCertValidateEventParams *e) {...}
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 (SOAPSigner Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(SOAPSignerTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } SOAPSignerTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(SOAPSignerTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } SOAPSignerTLSEstablishedEventParams;
#define EID_SOAPSIGNER_TLSESTABLISHED 21 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class SOAPSignerTLSEstablishedEventParams { public: const QString &Host(); const QString &Version(); const QString &Ciphersuite(); const QByteArray &ConnectionId(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(SOAPSignerTLSEstablishedEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTLSEstablished(SOAPSignerTLSEstablishedEventParams *e) {...}
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 (SOAPSigner Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(SOAPSignerTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } SOAPSignerTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(SOAPSignerTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } SOAPSignerTLSHandshakeEventParams;
#define EID_SOAPSIGNER_TLSHANDSHAKE 22 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class SOAPSignerTLSHandshakeEventParams { public: const QString &Host(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(SOAPSignerTLSHandshakeEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTLSHandshake(SOAPSignerTLSHandshakeEventParams *e) {...}
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 (SOAPSigner Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(SOAPSignerTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } SOAPSignerTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(SOAPSignerTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } SOAPSignerTLSShutdownEventParams;
#define EID_SOAPSIGNER_TLSSHUTDOWN 23 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class SOAPSignerTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(SOAPSignerTLSShutdownEventParams *e);
// Or, subclass SOAPSigner and override this emitter function. virtual int FireTLSShutdown(SOAPSignerTLSShutdownEventParams *e) {...}
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.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
char*
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
char* (read-only)
Default Value:
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
int (read-only)
Default Value: FALSE
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
char*
Default Value:
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
ValidFrom
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Syntax
SecureBlackboxCRL (declared in secureblackbox.h)
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
Bytes
char* (read-only)
Default Value:
Returns the raw CRL data in DER format.
CAKeyID
char*
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
char* (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
char* (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
char*
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
TBS
char* (read-only)
Default Value:
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
char*
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
CRL()
Creates an empty CRL object.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Syntax
SecureBlackboxExternalCrypto (declared in secureblackbox.h)
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
AsyncDocumentID
char*
Default Value: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
char*
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
char*
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
int
Default Value: FALSE
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
KeyID
char*
Default Value: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
char*
Default Value: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the KeyID topic.
Method
int
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
int
Default Value: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
char*
Default Value: ""
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Constructors
ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Syntax
SecureBlackboxOCSPResponse (declared in secureblackbox.h)
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
Bytes
char* (read-only)
Default Value:
A buffer containing the raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
char* (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
char* (read-only)
Default Value: ""
The location of the OCSP responder.
ProducedAt
char*
Default Value: ""
Specifies the time when the response was produced, in UTC.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this OCSP response.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Constructors
OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Syntax
SecureBlackboxProxySettings (declared in secureblackbox.h)
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
Address
char*
Default Value: ""
The IP address of the proxy server.
Authentication
int
Default Value: 0
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Password
char*
Default Value: ""
The password to authenticate to the proxy server.
Port
int
Default Value: 0
The port on the proxy server to connect to.
ProxyType
int
Default Value: 0
The type of the proxy server.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
RequestHeaders
char*
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
char*
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
char*
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
int
Default Value: FALSE
Specifies whether IPv6 should be used when connecting through the proxy.
Username
char*
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
ProxySettings()
Creates a new ProxySettings object.
SOAPSignature Type
The component is a container for an SOAP message signature.
Syntax
SecureBlackboxSOAPSignature (declared in secureblackbox.h)
Remarks
SOAP message may include any number of signatures. class stores on of them.
Fields
CanonicalizationMethod
int
Default Value: 0
The XML canonicalization method that was used for signing.
Supported canonicalization methods:
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
ClaimedSigningTime
char*
Default Value: ""
The signing time from the signer's computer.
Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.
CompatibilityErrors
int (read-only)
Default Value: 0
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
ContainsLongTermInfo
int (read-only)
Default Value: FALSE
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
EntityLabel
char* (read-only)
Default Value: ""
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: "Unknown"
The hash algorithm used for signing.
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
IssuerRDN
char* (read-only)
Default Value: ""
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
LastArchivalTime
char* (read-only)
Default Value: ""
Indicates the most recent archival time of an archived signature
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.
Level
int
Default Value: 2
Specifies which level or form of XAdES should be produced.
Use this property to specify the level or form of advanced electronic signature to be produced.
Use the Generic value to produce XML-DSIG signature.
The supported levels and forms are:
aslUnknown | 0 | Unknown signature level |
aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
aslBaselineB | 2 | Baseline B (B-B, basic) |
aslBaselineT | 3 | Baseline T (B-T, timestamped) |
aslBaselineLT | 4 | Baseline LT (B-LT, long-term) |
aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) |
aslBES | 6 | BES (Basic Electronic Signature) |
aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
aslT | 8 | T (Timestamped) |
aslC | 9 | C (T with revocation references) |
aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
aslA | 16 | A (archived) |
aslExtendedBES | 17 | Extended BES |
aslExtendedEPES | 18 | Extended EPES |
aslExtendedT | 19 | Extended T |
aslExtendedC | 20 | Extended C |
aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
aslExtendedA | 28 | Extended A |
* For XAdES form from XAdES v1.1.1 use either BES or EPES form values ** Extended forms are supported starting from XAdES v1.3.2
ParentEntity
char*
Default Value: ""
Use this property to get the parent signature label.
This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.
PolicyHash
char*
Default Value: ""
The signature policy hash value.
Use this property to get the signature policy hash from EPES signatures
PolicyHashAlgorithm
char*
Default Value: ""
The algorithm that was used to calculate the signature policy hash
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from PolicyHash.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
PolicyID
char*
Default Value: ""
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier from EPES signatures.
PolicyURI
char*
Default Value: ""
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
SerialNumber
char* (read-only)
Default Value:
The serial number of the signing certificate.
SignatureBytes
char* (read-only)
Default Value:
Returns the binary representation of the SOAP signature.
SignatureType
int
Default Value: 1
The SOAP signature type to use.
Use this property to specify the signature type to use when forming the signature.
Supported values:
sstUnknown | 0 | Unknown signature |
sstWSSSignature | 1 | Uses Web Services Security (WS-Security, WSS) signature. It is implemented according to the OASIS Web Services Security extension to SOAP |
sstSOAPSignature | 2 | Uses SOAP signature. It is implemented according to the SOAP Security Extensions: Digital Signature. |
SignatureValidationResult
int (read-only)
Default Value: 0
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
SubjectKeyID
char* (read-only)
Default Value:
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
SubjectRDN
char* (read-only)
Default Value: ""
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
Timestamped
int (read-only)
Default Value: FALSE
Use this property to establish whether the signature contains an embedded timestamp.
ValidatedSigningTime
char* (read-only)
Default Value: ""
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
ClaimedSigningTime returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
ValidationLog
char* (read-only)
Default Value: ""
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
XAdESVersion
int
Default Value: 3
Specifies XAdES version.
This property specifies the version of the XAdES specification the signature should comply with.
The supported vesions are:
xavUnknown | 0 | Unknown |
xav111 | 1 | XAdES v1.1.1 |
xav122 | 2 | XAdES v1.2.2 |
xav132 | 3 | XAdES v1.3.2 |
xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |
XMLElement
char*
Default Value: ""
Specifies the XML element where to save the signature or containing the signature.
This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.
Supported values are:
"" | an empty string indicates the Document element |
"#id" | indicates an XML element with specified Id |
XPath expression | indicates an XML element selected using XPath expression. Use AddKnownNamespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via AddKnownNamespace method. |
Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
Constructors
SOAPSignature()
Creates a new SOAP signature object.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
TimestampInfo Type
A container for timestamp information.
Syntax
SecureBlackboxTimestampInfo (declared in secureblackbox.h)
Remarks
The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.
Fields
Accuracy
int64 (read-only)
Default Value: 0
This field indicates the accuracy of the included time mark, in microseconds.
Bytes
char* (read-only)
Default Value:
Returns the raw timestamp data in DER format.
CertificateIndex
int (read-only)
Default Value: -1
Returns the index of the TSA certificate in the Certificates collection.
Use this property to look up the TSA certificate in the Certificates collection.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
ContainsLongTermInfo
int (read-only)
Default Value: FALSE
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
EntityLabel
char* (read-only)
Default Value: ""
Use this property to get the timestamp entity label.
This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
HashAlgorithm
char* (read-only)
Default Value: ""
Returns the timestamp's hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
ParentEntity
char* (read-only)
Default Value: ""
Use this property to get the label of the timestamp's parent entity.
This property references the EntityLabel of the object that the timestamp covers, typically a signature.
SerialNumber
char* (read-only)
Default Value:
Returns the timestamp's serial number.
Time
char* (read-only)
Default Value: ""
The time point incorporated into the timestamp.
TimestampType
int (read-only)
Default Value: 0
Returns the type of the timestamp.
Available options:
tstUnknown | 0 | |
tstLegacy | 1 | Supported by: Authenticode components |
tstTrusted | 2 | Supported by: Authenticode components |
tstGeneric | 3 | Supported by: CAdES components |
tstESC | 4 | Supported by: CAdES components |
tstContent | 5 | Supported by: CAdES components |
tstCertsAndCRLs | 6 | Supported by: CAdES components |
tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
tstIndividualDataObjects | 10 | Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components |
tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).
TSAName
char* (read-only)
Default Value: ""
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
ValidationLog
char* (read-only)
Default Value: ""
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
ValidationResult
int (read-only)
Default Value: 0
Contains the timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
Constructors
TimestampInfo()
Creates a new TimestampInfo object with default field values.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
char*
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ClientAuth
int
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
int
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
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.
SSLOptions
int
Default Value: 16
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. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
int
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
TLSSettings()
Creates a new TLSSettings object.
XMLReference Type
Represents an XML reference element.
Syntax
SecureBlackboxXMLReference (declared in secureblackbox.h)
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
AutoGenerateElementId
int
Default Value: FALSE
Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.
CanonicalizationMethod
int
Default Value: 0
Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
CustomElementId
char*
Default Value: ""
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.
DataObjectDescription
char*
Default Value: ""
This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element.
DataObjectEncoding
char*
Default Value: ""
This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element.
DataObjectIdentifier
char*
Default Value: ""
This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element.
DataObjectMimeType
char*
Default Value: ""
This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element.
DigestValue
char*
Default Value:
Use this property to get or set the value of the digest calculated over the referenced data.
This field is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HasDataObjectFormat
int
Default Value: FALSE
Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference.
Check this property to find out if the reference has an associated DataObjectFormat element.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the hash algorithm to be used.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
HasURI
int
Default Value: TRUE
Specifies whether the URI is set (even when it is empty).
ID
char*
Default Value: ""
A user-defined identifier (ID) attribute of this Reference element.
InclusiveNamespacesPrefixList
char*
Default Value: ""
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.
ReferenceType
char*
Default Value: ""
The Reference's type attribute as defined in XMLDSIG specification.
TargetData
char*
Default Value:
Contains the referenced external data when the digest value is not explicitly specified.
This field is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.
TargetType
int
Default Value: 0
The reference's target type to use.
Use this property to specify the reference's target type to use when forming the signature.
TargetXMLElement
char*
Default Value: ""
This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.
Supported values are:
"" | an empty string indicates the Document element. |
"#id" | indicates an XML element with specified Id. |
XPointer expression | indicates an XML element selected using XPointer expression. Use the AddKnownNamespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via AddKnownNamespace method. |
Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
URI
char*
Default Value: ""
Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.
UseBase64Transform
int
Default Value: FALSE
Specifies whether Base64 transform is included in transform chain.
UseEnvelopedSignatureTransform
int
Default Value: FALSE
Specifies whether enveloped signature transform is included in transform chain.
UseXPathFilter2Transform
int
Default Value: FALSE
Specifies whether XPath Filter 2.0 transform is included in transform chain.
UseXPathTransform
int
Default Value: FALSE
Specifies whether XPath transform is included in transform chain.
ValidationResult
int (read-only)
Default Value: FALSE
The outcome of the cryptographic reference validation.
XPathExpression
char*
Default Value: ""
Use this property to specify XPath expression for XPath transform of the reference.
XPathFilter2Expressions
char*
Default Value: ""
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.
XPathFilter2Filters
char*
Default Value: ""
Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.
Supported values:
"intersect" | Intersect filter computes the intersection of the selected subtrees with the filter node-set. |
"subtract" | Subtract filter computes the subtraction of the selected subtrees with the filter node-set. |
"union" | Union filter computes the union of the selected subtrees with the filter node-set. |
XPathFilter2PrefixList
char*
Default Value: ""
Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.
XPathPrefixList
char*
Default Value: ""
Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.
Constructors
XMLReference()
Creates a new XML reference element.
XMLReference(const char* lpszID)
Creates a new XML reference element from its ID .
XMLReference(const char* lpszID, const char* lpszURI)
Creates a new XML reference element from its ID and URI reference to the external data.
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SOAPSigner class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (SOAPSigner 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.SOAPSigner Config Settings
The supported values are: "X509v3", "X509PKIPathv1", "PKCS7", "Default" or fully qualified URLs for the first three values.
For default value, the component uses the "X509v3" type if one signing certificate is provided, and uses the "PKCS7" type otherwise.
For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.
Index value could be omitted for the first DataObjectFormat element.
Default value is "ec". In this case "ec:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
The empty elements in the custom XML content act as a placeholder for auto-generated elements.
For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>"
Supported values are:
certificate | Base64-encoded [X509v3] certificate is placed to the signature | |
issuerserial | X.509 issuer distinguished name/serial number pair are placed to the signature | |
subjectname | X.509 subject distinguished name is placed to the signature | |
ski | Base64 encoded plain (i.e. non-DER-encoded) value of a X509 V.3 SubjectKeyIdentifier extension is placed to the signature | |
crl | Base64-encoded certificate revocation list (CRL) is placed to the signature |
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
Supported values are:
SigAndRefs | SigAndRefs timestamp | |
RefsOnly | RefsOnly timestamp |
Default value is "ds". In this case "ds:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
cxcmNone | 0 | |
cxcmCanon | 1 | |
cxcmCanonComment | 2 | |
cxcmExclCanon | 3 | |
cxcmExclCanonComment | 4 | |
cxcmMinCanon | 5 | |
cxcmCanon_v1_1 | 6 | |
cxcmCanonComment_v1_1 | 7 |
Supported values are:
certificate | Base64-encoded [X509v3] certificates | |
crl | Base64-encoded certificate revocation lists (CRL) | |
ocsp | OCSP responses |
Supported values are:
certificate | References to X.509 certificates | |
crl | References to certificate revocation lists (CRL) | |
ocsp | References to OCSP responses |
Supported values:
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
Supported values are:
certificate | Base64-encoded [X509v3] certificates | |
crl | Base64-encoded certificate revocation lists (CRL) | |
ocsp | OCSP responses |
Default value is "wsse". In this case "wsse:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Default value is "wsu". In this case "wsu:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Supported values:
YYYY | Year (eg 1997) | |
YYYY-MM | Year and month (eg 1997-07) | |
YYYY-MM-DD | Complete date (eg 1997-07-16) | |
YYYY-MM-DDThh:mmTZD | Complete date plus hours and minutes (eg 1997-07-16T19:20+01:00) | |
YYYY-MM-DDThh:mm:ssTZD | Complete date plus hours, minutes and seconds (eg 1997-07-16T20:20:30Z) | |
YYYY-MM-DDThh:mm:ss.sTZD | Default. Complete date plus hours, minutes, seconds and a decimal fraction of a second (eg 1997-07-16T20:20:30.4Z) | |
YYYY-MM-DDThh:mm:ss.sssTZD | Complete date plus hours, minutes, seconds and a fraction of a second (eg 1997-07-16T20:20:30.451Z) |
Default value is "xades". In this case "xades:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Default value is "xadesv141". In this case "xadesv141:" prefix will be used.
Special values:
"#default" or "" | indicates that the prefix will be omitted. |
"#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Supported values:
"" or "none" | no formatting (by default). | |
"auto" | enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node" |
indent | specifies indentation level (default is 1) | |
indent-char | specifies indentation character: "space" or "tab" (default) | |
base64-max-length | specifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64) | |
starting-level | specifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node"). | |
indent-before-main | specifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no" |
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
certificate | Enables caching of certificates. |
crl | Enables caching of Certificate Revocation Lists (CRLs). |
ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (SOAPSigner Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SOAPSigner Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
33554433 | The input file does not exist (SB_ERROR_SOAP_INPUTFILE_NOT_EXISTS) |
33554434 | Invalid key type (SB_ERROR_SOAP_INVALID_KEY_TYPE) |
33554435 | No signature found to complete the asynchronous signing (SB_ERROR_SOAP_SIGNATURE_NOT_FOUND) |
33554436 | Unsupported signature type (SB_ERROR_SOAP_UNSUPPORTED_SIGNATURE_TYPE) |
33554437 | Unexpected HTTP status code (SB_ERROR_SOAP_UNEXPECTED_HTTP_STATUS_CODE) |
33554438 | SOAP service failed (SB_ERROR_SOAP_SERVICE_FAILED) |