OfficeSigner Component

Properties Methods Events Config Settings Errors

The OfficeSigner component signs Office documents.

Syntax

nsoftware.SecureBlackbox.Officesigner

Remarks

OfficeSigner provides digital signing capabilities of Office documents, and provides support for extended facilities, such as timestamps and advanced (XAdES) signatures.

Property List

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


AutoValidateSignatures	Specifies whether component 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.
CRLs	A collection of certificate revocation lists embedded into the signature by the signer.
DocumentFormat	Defines the format of the Office document.
DocumentType	Defines the type of the Office document.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
IgnoreChainValidationErrors	Makes the component tolerant to chain validation errors.
InputBytes	Use this property to pass the input to component in the byte array form.
InputFile	The file to be signed.
InputStream	Stream containing the Office document.
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 component to the offline mode.
OutputBytes	Use this property to read the output the component object has produced.
OutputFile	Defines where to save the signed document.
OutputStream	The stream where the signed document would be saved.
Profile	Specifies a pre-defined profile to apply when creating the signature.
Proxy	The proxy server settings.
RevocationCheck	Specifies the kind(s) of revocation check to perform.
Signatures	Provides details of all signatures found in the Office document.
SignedParts	All signed parts or entries found in the Office signatures.
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 component with short descriptions. Click on the links for further details.


AddTimestampValidationData	Use this method to add timestamp validation data to the signature.
AddValidationDataRefs	Use this method to add signature validation references to the signature.
AddValidationDataValues	Use this method to add signature validation values to the signature.
Close	Closes an opened document.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
ExtractAsyncData	Extracts user data from the DC signing service response.
Open	Opens a document for signing or updating.
Revalidate	Revalidates a signature in accordance with current settings.
Sign	Calculates the signature value.
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 component 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.
DocumentLoaded	This event is fired when the document has been loaded into memory.
Error	Information about errors during signing.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
Notification	This event notifies the application about an underlying control flow event.
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 component 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 component with short descriptions. Click on the links for further details.


ClaimedRoleText	The text of the claimed role.
ClaimedRoleXML	The XML content of the claimed roles.
CommitmentTypeIndicationAllSignedDataObjects[Index]	Specifies the CommitmentTypeIndication's AllSignedDataObjects.
CommitmentTypeIndicationCount	The number of the CommitmentTypeIndication elements.
CommitmentTypeIndicationIdentifier[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.
CommitmentTypeIndicationIdentifierDescription[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.
CommitmentTypeIndicationIdentifierDocumentationReferences[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.
CommitmentTypeIndicationIdentifierQualifier[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.
CommitmentTypeIndicationObjectReference[Index]	Specifies the CommitmentTypeIndication's ObjectReference.
CommitmentTypeIndicationQualifiersXML[Index]	The XML content of the CommitmentTypeIndication's Qualifiers.
DislikeOpenEndedOCSPs	Tells the component to discourage OCSP responses without an explicit NextUpdate parameter.
ExpireTime	Signature expiration time in UTC.
ForceCompleteChainValidation	Whether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrusted	Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GracePeriod	Specifies a grace period to apply during revocation information checks.
IgnoreChainLoops	Whether chain loops should be ignored.
IgnoreOCSPNoCheckExtension	Whether OCSP NoCheck extension should be ignored.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
IgnoreTimestampFailure	Whether to ignore time-stamping failure during signing.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
IncludeKnownRevocationInfoToSignature	Whether to include custom revocation info to the signature.
ProductionPlace	Identifies the place of the signature production.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
RefsTimestampType	Specifies references timestamp type to include to the signature.
SignatureInfoAddress1	Specifies the location at which the signature was created.
SignatureInfoAddress2	Specifies the location at which the signature was created.
SignatureInfoComments	Comments to the signature info text.
SignatureInfoDelegateSuggestedSigner	Specifies the name of a person.
SignatureInfoDelegateSuggestedSigner2	Specifies the title of a person.
SignatureInfoDelegateSuggestedSignerEmail	Specifies the e-mail address of a person.
SignatureInfoImage	Specifies an image for the digital signature.
SignatureInfoIncluded	Whether to include the signature info.
SignatureInfoInvalidLnImage	Specifies the image of an invalid signature.
SignatureInfoSignatureType	Specifies the type of the digital signature.
SignatureInfoText	The text to be displayed as the signature info.
SignatureInfoValidLnImage	Specifies the image of a valid signature.
SignatureLineAdditionalSignatureInfo[Index]	Contains additional signature information.
SignatureLineAllowComments[Index]	Indicates if comments are allowed.
SignatureLineCount	The number of signature lines.
SignatureLineId[Index]	Contains signature unique ID.
SignatureLineImageData[Index]	Contains signature image.
SignatureLineIndex	Specifies the index of the signature line to sign.
SignatureLineShowSignDate[Index]	Indicates if signing date should be shown.
SignatureLineSignatureIndex[Index]	The index of the signature that signs signature line.
SignatureLineSignatureProviderId[Index]	Contains signature provider ID.
SignatureLineSignatureProviderUrl[Index]	Contains signature provider URL.
SignatureLineSigned[Index]	Indicates if signature line is signed.
SignatureLineSigningInstructions[Index]	Contains signing instructions.
SignatureLineSuggestedSigner2[Index]	Suggested signer line two.
SignatureLineSuggestedSigner[Index]	Suggested signer line one.
SignatureLineSuggestedSignerEmail[Index]	Suggested signer email address.
SignTime	Specifies the signing time in UTC.
SigPolicyDescription	signature policy description.
SigPolicyExplicitText	The explicit text of the user notice.
SigPolicyHash	The hash value of the signature policy.
SigPolicyHashAlgorithm	Specifies the hash algorithm used to compute the signature policy hash.
SigPolicyID	Identifies the signature policy.
SigPolicyNoticeNumbers	Contains user notice numbers.
SigPolicyNoticeOrganization	The organization part of the NoticeReference qualifier.
SigPolicyURI	Signature policy URI.
TempPath	Location where the temporary files are stored.
TimestampCanonicalizationMethod	Specifies canonicalization method used in timestamp.
TimestampValidationDataDetails	Specifies timestamp validation data details to include to the signature.
TLSChainValidationDetails	Contains the advanced details of the TLS server certificate validation.
TLSChainValidationResult	Contains the result of the TLS server certificate validation.
TLSClientAuthRequested	Indicates whether the TLS server requests client authentication.
TLSValidationLog	Contains the log of the TLS server certificate validation.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
TspHashAlgorithm	Sets a specific hash algorithm for use with the timestamping service.
UseMicrosoftCTL	Enables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
UseValidationCache	Enables or disable the use of the product-wide certificate chain validation cache.
ValidationDataRefsDetails	Specifies validation data references details to include to the signature.
ValidationDataValuesDetails	Specifies validation data values details to include to the signature.
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 component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
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.
UseOwnDNSResolver	Specifies whether the client components should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AutoValidateSignatures Property (OfficeSigner Component)

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

public bool AutoValidateSignatures { get; set; }

Public Property AutoValidateSignatures As Boolean

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.

BlockedCertificates Property (OfficeSigner Component)

The certificates that must be rejected as trust anchors.

Syntax

C#
VB.NET

public CertificateList BlockedCertificates { get; }

Public Property BlockedCertificates As CertificateList

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.

Certificates Property (OfficeSigner Component)

A collection of certificates included in the electronic signature.

Syntax

C#
VB.NET

public CertificateList Certificates { get; }

Public ReadOnly Property Certificates As CertificateList

Remarks

Use this property to access all certificates included into the signature(s) by its creator.

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

CRLs Property (OfficeSigner Component)

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

Syntax

C#
VB.NET

public CRLList CRLs { get; }

Public ReadOnly Property CRLs As CRLList

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.

DocumentFormat Property (OfficeSigner Component)

Defines the format of the Office document.

Syntax

C#
VB.NET

public OfficesignerDocumentFormats DocumentFormat { get; }

enum OfficesignerDocumentFormats {
  odfUnknown,
  odfBinary,
  odfOpenXML,
  odfOpenXPS,
  odfOpenDocument
}

Public ReadOnly Property DocumentFormat As OfficesignerDocumentFormats

Enum OfficesignerDocumentFormats
  odfUnknown
  odfBinary
  odfOpenXML
  odfOpenXPS
  odfOpenDocument
End Enum

Default Value

Remarks

This property contains the Office document format.


odfUnknown	`0`	Unknown document format
odfBinary	`1`	Binary Office document
odfOpenXML	`2`	OpenXML Office document
odfOpenXPS	`3`	OpenXPS document
odfOpenDocument	`4`	OpenOffice document

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

DocumentType Property (OfficeSigner Component)

Defines the type of the Office document.

Syntax

C#
VB.NET

public string DocumentType { get; }

Public ReadOnly Property DocumentType As String

Default Value

Remarks

This property contains the Office document type.

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

ExternalCrypto Property (OfficeSigner Component)

Provides access to external signing and DC parameters.

Syntax

C#
VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

FIPSMode Property (OfficeSigner Component)

Reserved.

Syntax

C#
VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (OfficeSigner Component)

Makes the component tolerant to chain validation errors.

Syntax

C#
VB.NET

public bool IgnoreChainValidationErrors { get; set; }

Public Property IgnoreChainValidationErrors As Boolean

Default Value

False

Remarks

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

InputBytes Property (OfficeSigner Component)

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

Syntax

C#
VB.NET

public byte[] InputBytes { get; set; }

Public Property InputBytes As Byte()

Remarks

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

This property is not available at design time.

InputFile Property (OfficeSigner Component)

The file to be signed.

Syntax

C#
VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

Remarks

Provide the path to the Office document to be signed.

InputStream Property (OfficeSigner Component)

Stream containing the Office document.

Syntax

C#
VB.NET

public System.IO.Stream InputStream { get; set; }

Public Property InputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to feed the document to the component via a stream.

This property is not available at design time.

KnownCertificates Property (OfficeSigner Component)

Additional certificates for chain validation.

Syntax

C#
VB.NET

public CertificateList KnownCertificates { get; }

Public Property KnownCertificates As CertificateList

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 component manually.

The purpose of certificates to be added to this collection is roughly equivalent to that of 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.

KnownCRLs Property (OfficeSigner Component)

Additional CRLs for chain validation.

Syntax

C#
VB.NET

public CRLList KnownCRLs { get; }

Public Property KnownCRLs As CRLList

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.

KnownOCSPs Property (OfficeSigner Component)

Additional OCSP responses for chain validation.

Syntax

C#
VB.NET

public OCSPResponseList KnownOCSPs { get; }

Public Property KnownOCSPs As OCSPResponseList

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.

NewSignature Property (OfficeSigner Component)

Provides access to new signature properties.

Syntax

C#
VB.NET

public OfficeSignature NewSignature { get; }

Public ReadOnly Property NewSignature As OfficeSignature

Remarks

Use this property to tune-up signature properties.

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

OCSPs Property (OfficeSigner Component)

A collection of OCSP responses embedded into the signature.

Syntax

C#
VB.NET

public OCSPResponseList OCSPs { get; }

Public ReadOnly Property OCSPs As OCSPResponseList

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.

OfflineMode Property (OfficeSigner Component)

Switches the component to the offline mode.

Syntax

C#
VB.NET

public bool OfflineMode { get; set; }

Public Property OfflineMode As Boolean

Default Value

False

Remarks

When working in offline mode, the component 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 validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

OutputBytes Property (OfficeSigner Component)

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

Syntax

C#
VB.NET

public byte[] OutputBytes { get; }

Public ReadOnly Property OutputBytes As Byte()

Remarks

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

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

OutputFile Property (OfficeSigner Component)

Defines where to save the signed document.

Syntax

C#
VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

Remarks

Specifies the path where the signed Office document should be saved.

OutputStream Property (OfficeSigner Component)

The stream where the signed document would be saved.

Syntax

C#
VB.NET

public System.IO.Stream OutputStream { get; set; }

Public Property OutputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to save the signed document to the stream.

This property is not available at design time.

Profile Property (OfficeSigner Component)

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

Syntax

C#
VB.NET

public string Profile { get; set; }

Public Property Profile As String

Default Value

Remarks

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

Proxy Property (OfficeSigner Component)

The proxy server settings.

Syntax

C#
VB.NET

public ProxySettings Proxy { get; }

Public ReadOnly Property Proxy As ProxySettings

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

RevocationCheck Property (OfficeSigner Component)

Specifies the kind(s) of revocation check to perform.

Syntax

C#
VB.NET

public OfficesignerRevocationChecks RevocationCheck { get; set; }

enum OfficesignerRevocationChecks {
  crcNone,
  crcAuto,
  crcAllCRL,
  crcAllOCSP,
  crcAllCRLAndOCSP,
  crcAnyCRL,
  crcAnyOCSP,
  crcAnyCRLOrOCSP,
  crcAnyOCSPOrCRL
}

Public Property RevocationCheck As OfficesignerRevocationChecks

Enum OfficesignerRevocationChecks
  crcNone
  crcAuto
  crcAllCRL
  crcAllOCSP
  crcAllCRLAndOCSP
  crcAnyCRL
  crcAnyOCSP
  crcAnyCRLOrOCSP
  crcAnyOCSPOrCRL
End Enum

Default Value

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 (CRL) 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`)	Check all provided CRL endpoints for all chain certificates.
crcAllOCSP (`3`)	Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP (`4`)	Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL (`5`)	At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP (`6`)	At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP (`7`)	At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL (`8`)	At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Signatures Property (OfficeSigner Component)

Provides details of all signatures found in the Office document.

Syntax

C#
VB.NET

public OfficeSignatureList Signatures { get; }

Public ReadOnly Property Signatures As OfficeSignatureList

Remarks

Use this property to get the details of all the signatures identified in the document.

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

SignedParts Property (OfficeSigner Component)

All signed parts or entries found in the Office signatures.

Syntax

C#
VB.NET

public OfficeSignedPartList SignedParts { get; }

Public ReadOnly Property SignedParts As OfficeSignedPartList

Remarks

This property contains a list of all signed parts or entries extracted from the Office signatures.

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

SigningCertificate Property (OfficeSigner Component)

The certificate to be used for signing.

Syntax

C#
VB.NET

public Certificate SigningCertificate { get; set; }

Public Property SigningCertificate As Certificate

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.

SigningChain Property (OfficeSigner Component)

The signing certificate chain.

Syntax

C#
VB.NET

public CertificateList SigningChain { get; }

Public Property SigningChain As CertificateList

Remarks

Use this property to provide the chain for the signing certificate. Use SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

SocketSettings Property (OfficeSigner Component)

Manages network connection settings.

Syntax

C#
VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Timestamps Property (OfficeSigner Component)

Contains a collection of timestamps for the processed document.

Syntax

C#
VB.NET

public TimestampInfoList Timestamps { get; }

Public ReadOnly Property Timestamps As TimestampInfoList

Remarks

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

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

TimestampServer Property (OfficeSigner Component)

The address of the timestamping server.

Syntax

C#
VB.NET

public string TimestampServer { get; set; }

Public Property TimestampServer As String

Default Value

Remarks

Use this property to set the address of the TSA (Time Stamping Authority) server which should be used for timestamping the signature.

TLSClientChain Property (OfficeSigner Component)

The TLS client certificate chain.

Syntax

C#
VB.NET

public CertificateList TLSClientChain { get; }

Public Property TLSClientChain As CertificateList

Remarks

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

This property is not available at design time.

TLSServerChain Property (OfficeSigner Component)

The TLS server's certificate chain.

Syntax

C#
VB.NET

public CertificateList TLSServerChain { get; }

Public ReadOnly Property TLSServerChain As CertificateList

Remarks

Use this property to access the certificate chain sent by the TLS server.

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

TLSSettings Property (OfficeSigner Component)

Manages TLS layer settings.

Syntax

C#
VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

TrustedCertificates Property (OfficeSigner Component)

A list of trusted certificates for chain validation.

Syntax

C#
VB.NET

public CertificateList TrustedCertificates { get; }

Public Property TrustedCertificates As CertificateList

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 than that of 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.

ValidationMoment Property (OfficeSigner Component)

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

Syntax

C#
VB.NET

public string ValidationMoment { get; set; }

Public Property ValidationMoment As String

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 signature creation time, or 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.

AddTimestampValidationData Method (OfficeSigner Component)

Use this method to add timestamp validation data to the signature.

Syntax

C#
VB.NET

public void AddTimestampValidationData(int sigIndex);

Public Sub AddTimestampValidationData(ByVal SigIndex As Integer)

Remarks

Call this method to add certificates and revocation information used to validate timestamp's signer certificates at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

AddValidationDataRefs Method (OfficeSigner Component)

Use this method to add signature validation references to the signature.

Syntax

C#
VB.NET

public void AddValidationDataRefs(int sigIndex);

Public Sub AddValidationDataRefs(ByVal SigIndex As Integer)

Remarks

Call this method to add references to certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

AddValidationDataValues Method (OfficeSigner Component)

Use this method to add signature validation values to the signature.

Syntax

C#
VB.NET

public void AddValidationDataValues(int sigIndex);

Public Sub AddValidationDataValues(ByVal SigIndex As Integer)

Remarks

Call this method to add certificates and revocation information used to validate a signature at a particular time. This method could be called separately or in SignatureValidated event handler after successful signature validation.

Close Method (OfficeSigner Component)

Closes an opened document.

Syntax

C#
VB.NET

public void Close(bool saveChanges);

Public Sub Close(ByVal SaveChanges As Boolean)

Remarks

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

Config Method (OfficeSigner Component)

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

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

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

DoAction Method (OfficeSigner Component)

Performs an additional action.

Syntax

C#
VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

ExtractAsyncData Method (OfficeSigner Component)

Extracts user data from the DC signing service response.

Syntax

C#
VB.NET

public string ExtractAsyncData(string asyncReply);

Public Function ExtractAsyncData(ByVal AsyncReply As String) As String

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 completion async stage.

Open Method (OfficeSigner Component)

Opens a document for signing or updating.

Syntax

C#
VB.NET

public void Open();

Public Sub Open()

Remarks

Use this method to open a document for signing or updating. When finished, call Close to complete or discard the operation.

Revalidate Method (OfficeSigner Component)

Revalidates a signature in accordance with current settings.

Syntax

C#
VB.NET

public void Revalidate(int sigIndex);

Public Sub Revalidate(ByVal SigIndex As Integer)

Remarks

Use this method to re-validate a signature in the opened Office document.

Sign Method (OfficeSigner Component)

Calculates the signature value.

Syntax

C#
VB.NET

public void Sign();

Public Sub Sign()

Remarks

Call this method to generate a signature over the document.

SignAsyncBegin Method (OfficeSigner Component)

Initiates the asynchronous signing operation.

Syntax

C#
VB.NET

public string SignAsyncBegin();

Public Function SignAsyncBegin() As String

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. DC protocol is based on 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 control), which processes it and produces a matching signatures state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignAsyncEnd Method (OfficeSigner Component)

Completes the asynchronous signing operation.

Syntax

C#
VB.NET

public void SignAsyncEnd(string asyncReply);

Public Sub SignAsyncEnd(ByVal AsyncReply As String)

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

SignExternal Method (OfficeSigner Component)

Signs the document using an external signing facility.

Syntax

C#
VB.NET

public void SignExternal();

Public Sub 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 component fires ExternalSign event which allows to pass the hash value for signing.

Timestamp Method (OfficeSigner Component)

Use this method to add an timestamp.

Syntax

C#
VB.NET

public void Timestamp(int sigIndex, int timestampType);

Public Sub Timestamp(ByVal SigIndex As Integer, ByVal TimestampType As Integer)

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

Upgrade Method (OfficeSigner Component)

Upgrades existing XAdES signature to a new form.

Syntax

C#
VB.NET

public void Upgrade(int sigIndex, int toForm);

Public Sub Upgrade(ByVal SigIndex As Integer, ByVal ToForm As Integer)

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 specified by ToForm. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, C, X, X-L, A).

Supported forms:


xafNone	`0`
xafBasic	`1`	XAdES form, supported by XAdES v1.1.1
xafBES	`2`	XAdES-BES form, supported starting from XAdES v1.2.2
xafEPES	`3`	XAdES-EPES form, supported starting from XAdES v1.2.2
xafT	`4`	XAdES-T form
xafC	`5`	XAdES-C form
xafX	`6`	XAdES-X form
xafXL	`7`	XAdES-X-L form
xafA	`8`	XAdES-A form
xafExtendedBES	`9`	XAdES-E-BES form
xafExtendedEPES	`10`	XAdES-E-EPES form
xafExtendedT	`11`	XAdES-E-T form
xafExtendedC	`12`	XAdES-E-C form
xafExtendedX	`13`	XAdES-E-X form
xafExtendedXLong	`14`	XAdES-E-X-Long form (type 1)
xafExtendedXL	`15`	XAdES-E-X-L form (type 2)
xafExtendedA	`16`	XAdES-E-A form

ChainElementDownload Event (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnChainElementDownloadHandler OnChainElementDownload;

public delegate void OnChainElementDownloadHandler(object sender, OfficesignerChainElementDownloadEventArgs e);

public class OfficesignerChainElementDownloadEventArgs : EventArgs {
  public int Kind { get; }
  public string CertRDN { get; }
  public string CACertRDN { get; }
  public string Location { get; }
  public int Action { get; set; }
}

Public Event OnChainElementDownload As OnChainElementDownloadHandler

Public Delegate Sub OnChainElementDownloadHandler(sender As Object, e As OfficesignerChainElementDownloadEventArgs)

Public Class OfficesignerChainElementDownloadEventArgs Inherits EventArgs
  Public ReadOnly Property Kind As Integer
  Public ReadOnly Property CertRDN As String
  Public ReadOnly Property CACertRDN As String
  Public ReadOnly Property Location As String
  Public Property Action As Integer
End Class

Remarks

Subscribe to this event to be notified about validation element retrievals. Use 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

ChainElementNeeded Event (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnChainElementNeededHandler OnChainElementNeeded;

public delegate void OnChainElementNeededHandler(object sender, OfficesignerChainElementNeededEventArgs e);

public class OfficesignerChainElementNeededEventArgs : EventArgs {
  public int Kind { get; }
  public string CertRDN { get; }
  public string CACertRDN { get; }
}

Public Event OnChainElementNeeded As OnChainElementNeededHandler

Public Delegate Sub OnChainElementNeededHandler(sender As Object, e As OfficesignerChainElementNeededEventArgs)

Public Class OfficesignerChainElementNeededEventArgs Inherits EventArgs
  Public ReadOnly Property Kind As Integer
  Public ReadOnly Property CertRDN As String
  Public ReadOnly Property CACertRDN As String
End Class

Remarks

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

ChainElementStore Event (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnChainElementStoreHandler OnChainElementStore;

public delegate void OnChainElementStoreHandler(object sender, OfficesignerChainElementStoreEventArgs e);

public class OfficesignerChainElementStoreEventArgs : EventArgs {
  public int Kind { get; }
  public byte[] Body { get; }
  public string URI { get; set; }
}

Public Event OnChainElementStore As OnChainElementStoreHandler

Public Delegate Sub OnChainElementStoreHandler(sender As Object, e As OfficesignerChainElementStoreEventArgs)

Public Class OfficesignerChainElementStoreEventArgs Inherits EventArgs
  Public ReadOnly Property Kind As Integer
  Public ReadOnly Property Body As Byte()
  Public Property URI As String
End Class

Remarks

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

ChainValidated Event (OfficeSigner Component)

Reports the completion of a certificate chain validation.

Syntax

C#
VB.NET

public event OnChainValidatedHandler OnChainValidated;

public delegate void OnChainValidatedHandler(object sender, OfficesignerChainValidatedEventArgs e);

public class OfficesignerChainValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string SubjectRDN { get; }
  public int ValidationResult { get; }
  public int ValidationDetails { get; }
}

Public Event OnChainValidated As OnChainValidatedHandler

Public Delegate Sub OnChainValidatedHandler(sender As Object, e As OfficesignerChainValidatedEventArgs)

Public Class OfficesignerChainValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property SubjectRDN As String
  Public ReadOnly Property ValidationResult As Integer
  Public ReadOnly Property ValidationDetails As Integer
End Class

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)

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


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 (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnChainValidationProgressHandler OnChainValidationProgress;

public delegate void OnChainValidationProgressHandler(object sender, OfficesignerChainValidationProgressEventArgs e);

public class OfficesignerChainValidationProgressEventArgs : EventArgs {
  public string EventKind { get; }
  public string CertRDN { get; }
  public string CACertRDN { get; }
  public int Action { get; set; }
}

Public Event OnChainValidationProgress As OnChainValidationProgressHandler

Public Delegate Sub OnChainValidationProgressHandler(sender As Object, e As OfficesignerChainValidationProgressEventArgs)

Public Class OfficesignerChainValidationProgressEventArgs Inherits EventArgs
  Public ReadOnly Property EventKind As String
  Public ReadOnly Property CertRDN As String
  Public ReadOnly Property CACertRDN As String
  Public Property Action As Integer
End Class

Remarks

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

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind. Use 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

DocumentLoaded Event (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnDocumentLoadedHandler OnDocumentLoaded;

public delegate void OnDocumentLoadedHandler(object sender, OfficesignerDocumentLoadedEventArgs e);

public class OfficesignerDocumentLoadedEventArgs : EventArgs {
  public bool Cancel { get; set; }
}

Public Event OnDocumentLoaded As OnDocumentLoadedHandler

Public Delegate Sub OnDocumentLoadedHandler(sender As Object, e As OfficesignerDocumentLoadedEventArgs)

Public Class OfficesignerDocumentLoadedEventArgs Inherits EventArgs
  Public Property Cancel As Boolean
End Class

Remarks

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

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

Error Event (OfficeSigner Component)

Information about errors during signing.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, OfficesignerErrorEventArgs e);

public class OfficesignerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As OfficesignerErrorEventArgs)

Public Class OfficesignerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event is fired in case of exceptional conditions during the office document processing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (OfficeSigner Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

C#
VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, OfficesignerExternalSignEventArgs e);

public class OfficesignerExternalSignEventArgs : EventArgs {
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As OfficesignerExternalSignEventArgs)

Public Class OfficesignerExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

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 component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .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(); };

Notification Event (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, OfficesignerNotificationEventArgs e);

public class OfficesignerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As OfficesignerNotificationEventArgs)

Public Class OfficesignerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

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


DocumentLoaded	Reports the completion of Office document processing by the component. Use the event handler to access document-related information. The EventParam value passed with this EventID is empty.
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.

SignatureFound Event (OfficeSigner Component)

Signifies the start of signature validation.

Syntax

C#
VB.NET

public event OnSignatureFoundHandler OnSignatureFound;

public delegate void OnSignatureFoundHandler(object sender, OfficesignerSignatureFoundEventArgs e);

public class OfficesignerSignatureFoundEventArgs : EventArgs {
  public int Index { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public bool CertFound { get; }
  public bool ValidateSignature { get; set; }
  public bool ValidateChain { get; set; }
}

Public Event OnSignatureFound As OnSignatureFoundHandler

Public Delegate Sub OnSignatureFoundHandler(sender As Object, e As OfficesignerSignatureFoundEventArgs)

Public Class OfficesignerSignatureFoundEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property CertFound As Boolean
  Public Property ValidateSignature As Boolean
  Public Property ValidateChain As Boolean
End Class

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 is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

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

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

SignatureValidated Event (OfficeSigner Component)

Marks the completion of the signature validation routine.

Syntax

C#
VB.NET

public event OnSignatureValidatedHandler OnSignatureValidated;

public delegate void OnSignatureValidatedHandler(object sender, OfficesignerSignatureValidatedEventArgs e);

public class OfficesignerSignatureValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public int ValidationResult { get; }
}

Public Event OnSignatureValidated As OnSignatureValidatedHandler

Public Delegate Sub OnSignatureValidatedHandler(sender As Object, e As OfficesignerSignatureValidatedEventArgs)

Public Class OfficesignerSignatureValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property ValidationResult As Integer
End Class

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

TimestampFound Event (OfficeSigner Component)

Signifies the start of a timestamp validation routine.

Syntax

C#
VB.NET

public event OnTimestampFoundHandler OnTimestampFound;

public delegate void OnTimestampFoundHandler(object sender, OfficesignerTimestampFoundEventArgs e);

public class OfficesignerTimestampFoundEventArgs : EventArgs {
  public int Index { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public bool CertFound { get; }
  public bool ValidateTimestamp { get; set; }
  public bool ValidateChain { get; set; }
}

Public Event OnTimestampFound As OnTimestampFoundHandler

Public Delegate Sub OnTimestampFoundHandler(sender As Object, e As OfficesignerTimestampFoundEventArgs)

Public Class OfficesignerTimestampFoundEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property CertFound As Boolean
  Public Property ValidateTimestamp As Boolean
  Public Property ValidateChain As Boolean
End Class

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.

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 SignatureValidationResult and ChainValidationResult properties respectively.

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

TimestampRequest Event (OfficeSigner Component)

Fires when the component is ready to request a timestamp from an external TSA.

Syntax

C#
VB.NET

public event OnTimestampRequestHandler OnTimestampRequest;

public delegate void OnTimestampRequestHandler(object sender, OfficesignerTimestampRequestEventArgs e);

public class OfficesignerTimestampRequestEventArgs : EventArgs {
  public string TSA { get; }
  public string TimestampRequest { get; }
  public string TimestampResponse { get; set; }
  public bool SuppressDefault { get; set; }
}

Public Event OnTimestampRequest As OnTimestampRequestHandler

Public Delegate Sub OnTimestampRequestHandler(sender As Object, e As OfficesignerTimestampRequestEventArgs)

Public Class OfficesignerTimestampRequestEventArgs Inherits EventArgs
  Public ReadOnly Property TSA As String
  Public ReadOnly Property TimestampRequest As String
  Public Property TimestampResponse As String
  Public Property SuppressDefault As Boolean
End Class

Remarks

Subscribe to this event to be 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 TimestampServer property. Set 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 (OfficeSigner Component)

Reports the completion of the timestamp validation routine.

Syntax

C#
VB.NET

public event OnTimestampValidatedHandler OnTimestampValidated;

public delegate void OnTimestampValidatedHandler(object sender, OfficesignerTimestampValidatedEventArgs e);

public class OfficesignerTimestampValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public string Time { get; }
  public int ValidationResult { get; }
  public int ChainValidationResult { get; }
  public int ChainValidationDetails { get; }
}

Public Event OnTimestampValidated As OnTimestampValidatedHandler

Public Delegate Sub OnTimestampValidatedHandler(sender As Object, e As OfficesignerTimestampValidatedEventArgs)

Public Class OfficesignerTimestampValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property Time As String
  Public ReadOnly Property ValidationResult As Integer
  Public ReadOnly Property ChainValidationResult As Integer
  Public ReadOnly Property ChainValidationDetails As Integer
End Class

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

TLSCertNeeded Event (OfficeSigner Component)

Fires when a remote TLS party requests a client certificate.

Syntax

C#
VB.NET

public event OnTLSCertNeededHandler OnTLSCertNeeded;

public delegate void OnTLSCertNeededHandler(object sender, OfficesignerTLSCertNeededEventArgs e);

public class OfficesignerTLSCertNeededEventArgs : EventArgs {
  public string Host { get; }
  public string CANames { get; }
}

Public Event OnTLSCertNeeded As OnTLSCertNeededHandler

Public Delegate Sub OnTLSCertNeededHandler(sender As Object, e As OfficesignerTLSCertNeededEventArgs)

Public Class OfficesignerTLSCertNeededEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public ReadOnly Property CANames As String
End Class

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 (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 (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, OfficesignerTLSCertValidateEventArgs e);

public class OfficesignerTLSCertValidateEventArgs : EventArgs {
  public string ServerHost { get; }
  public string ServerIP { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As OfficesignerTLSCertValidateEventArgs)

Public Class OfficesignerTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ServerHost As String
  Public ReadOnly Property ServerIP As String
  Public Property Accept As Boolean
End Class

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components 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 component, and can be adjusted if needed.

TLSEstablished Event (OfficeSigner Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

C#
VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, OfficesignerTLSEstablishedEventArgs e);

public class OfficesignerTLSEstablishedEventArgs : EventArgs {
  public string Host { get; }
  public string Version { get; }
  public string Ciphersuite { get; }
  public byte[] ConnectionId { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As OfficesignerTLSEstablishedEventArgs)

Public Class OfficesignerTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public ReadOnly Property Version As String
  Public ReadOnly Property Ciphersuite As String
  Public ReadOnly Property ConnectionId As Byte()
  Public Property Abort As Boolean
End Class

Remarks

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

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

TLSHandshake Event (OfficeSigner Component)

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

Syntax

C#
VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

public delegate void OnTLSHandshakeHandler(object sender, OfficesignerTLSHandshakeEventArgs e);

public class OfficesignerTLSHandshakeEventArgs : EventArgs {
  public string Host { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSHandshake As OnTLSHandshakeHandler

Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As OfficesignerTLSHandshakeEventArgs)

Public Class OfficesignerTLSHandshakeEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public Property Abort As Boolean
End Class

Remarks

The component 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 with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.

TLSShutdown Event (OfficeSigner Component)

Reports the graceful closure of a TLS connection.

Syntax

C#
VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

public delegate void OnTLSShutdownHandler(object sender, OfficesignerTLSShutdownEventArgs e);

public class OfficesignerTLSShutdownEventArgs : EventArgs {
  public string Host { get; }
}

Public Event OnTLSShutdown As OnTLSShutdownHandler

Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As OfficesignerTLSShutdownEventArgs)

Public Class OfficesignerTLSShutdownEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
End Class

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

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Bytes
Byte()

Returns raw certificate data in DER format.

CA
Boolean

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

CAKeyID
Byte()

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

CRLDistributionPoints
String

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Curve
String

Specifies the elliptic curve of the EC public key.


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
Byte()

Contains the fingerprint (a hash imprint) of this certificate.

FriendlyName
String

Contains an associated alias (friendly name) of the certificate.

HashAlgorithm
String

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)


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
String

The common name of the certificate issuer (CA), typically a company name.

IssuerRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

KeyAlgorithm
String

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`

KeyBits
Integer

Returns the length of the public key.

KeyFingerprint
Byte()

Returns a fingerprint of the public key contained in the certificate.

KeyUsage
Integer

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

KeyValid
Boolean

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
String

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

OCSPNoCheck
Boolean

Accessor to the value of the certificates ocsp-no-check extension.

Origin
Integer

Returns the origin of this certificate.

PolicyIDs
String

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.

PrivateKeyBytes
Byte()

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

PrivateKeyExists
Boolean

Indicates whether the certificate has an associated private key.

PrivateKeyExtractable
Boolean

Indicates whether the private key is extractable

PublicKeyBytes
Byte()

Contains the certificate's public key in DER format.

QualifiedStatements
QualifiedStatementsTypes

Returns the qualified status of the certificate.

SelfSigned
Boolean

Indicates whether the certificate is self-signed (root) or signed by an external CA.

SerialNumber
Byte()

Returns the certificate's serial number.

SigAlgorithm
String

Indicates the algorithm that was used by the CA to sign this certificate.

Subject
String

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

SubjectAlternativeName
String

Returns or sets the value of the Subject Alternative Name extension of the certificate.

SubjectKeyID
Byte()

Contains a unique identifier (fingerprint) of the certificate's private key.

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 with a SHA1 hash of the bit string of the subject public key.

SubjectRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

ValidFrom
String

The time point at which the certificate becomes valid, in UTC.

ValidTo
String

The time point at which the certificate expires, in UTC.

Constructors

C#
VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

C#
VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

C#
VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

C#
VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

C#
VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

CRL Type

Represents a Certificate Revocation List.

Remarks

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

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

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

Fields


Bytes Byte()	Returns raw CRL data in DER format.
CAKeyID Byte()	A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount Integer	Returns the number of certificate status entries in the CRL.
Issuer String	The common name of the CRL issuer (CA), typically a company name.
IssuerRDN String	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location String	The URL that the CRL was downloaded from.
NextUpdate String	The planned time and date of the next version of this CRL to be published.
SigAlgorithm String	The public key algorithm that was used by the CA to sign this CRL.
TBS Byte()	The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate String	The date and time at which this version of the CRL was published.

Constructors

C#
VB.NET

public CRL(byte[] bytes, int startIndex, int count);

Public CRL(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.

C#
VB.NET

public CRL(string location);

Public CRL(ByVal Location As String)

Creates a CRL object by downloading it from a remote location.

C#
VB.NET

public CRL(System.IO.Stream stream);

Public CRL(ByVal Stream As System.IO.Stream)

Creates a CRL object from data contained in a stream.

C#
VB.NET

public CRL();

Public CRL()

Creates an empty CRL object.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

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
String

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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
String

Custom parameters to be passed to the signing service (uninterpreted).

Data
String

Additional data to be included in the async state and mirrored back by the requestor

ExternalHashCalculation
Boolean

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

HashAlgorithm
String

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
String

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 extra protection layer for the protocol and diminishes the risk of 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
String

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
AsyncSignMethods

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Mode
ExternalCryptoModes

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 OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

PublicKeyAlgorithm
String

Provide 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

C#
VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

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

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

Fields


Bytes Byte()	Buffer containing raw OCSP response data.
EntryCount Integer	The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Issuer String	Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN String	Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location String	Location of the OCSP responder.
ProducedAt String	Specifies the time when the response was produced, in UTC.

Constructors

C#
VB.NET

public OCSPResponse(byte[] bytes, int startIndex, int count);

Public OCSPResponse(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.

C#
VB.NET

public OCSPResponse(string location);

Public OCSPResponse(ByVal Location As String)

Downloads an OCSP response from a remote location.

C#
VB.NET

public OCSPResponse(System.IO.Stream stream);

Public OCSPResponse(ByVal Stream As System.IO.Stream)

Initializes the response with the data from a stream.

C#
VB.NET

public OCSPResponse();

Public OCSPResponse()

Creates an empty OCSP response object.

OfficeSignature Type

The component is a container for an Office document signature.

Remarks

Office document may include any number of document signatures. component stores on of them.

Fields

CertificateIndex
Integer

Returns the index of the signing certificate in the Certificates collection

Use this property to look up the signing certificate in the Certificates collection.

ChainValidationDetails
Integer

The details of a certificate chain validation outcome. They may often suggest what 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
ChainValidities

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
String

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.

CorePropertiesSigned
Boolean

Returns True if this signature covers the core properties of the document.

DocumentSigned
Boolean

Returns True if the signature covers the document itself.

ExpireTime
String

Specifies the signature expiration time in UTC.

HashAlgorithm
String

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
String

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
String

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.

PolicyHash
String

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

PolicyHashAlgorithm
String

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
String

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
String

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
Byte()

The serial number of the timestamp.

SignatureBytes
Byte()

Returns the binary representation of the Office signature.

SignatureInfoComments
String

Contains the comments for the SignatureInfoText.

SignatureInfoText
String

Contains the text of the signature info.

SignatureOriginSigned
Boolean

Returns True if the signature origin is signed.

SignatureType
OfficeSignatureTypes

Specifies the type of this signature.


ostDefault	`0`
ostBinaryCryptoAPI	`1`
ostBinaryXML	`2`
ostOpenXML	`3`
ostOpenXPS	`4`
ostOpenDocument	`5`

SignatureValidationResult
SignatureValidities

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

SubjectKeyID
Byte()

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
String

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
Boolean

Use this property to establish whether the signature contains an embedded timestamp.

ValidatedSigningTime
String

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
String

Contains the complete log of the certificate validation routine.

Use this property to access the chain validation log produced by the component. 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.

XAdES
Boolean

Specifies whether the document contains an advanced signature (XAdES).

Use this property to check whether the document is signed with XAdES or XML-DSIG only.

XAdESForm
XAdESForms

Specifies which form of XAdES should be produced.

Use this property to specify the form (level) of advanced electronic signature to be produced.


xafNone	`0`
xafBasic	`1`	XAdES form, supported by XAdES v1.1.1
xafBES	`2`	XAdES-BES form, supported starting from XAdES v1.2.2
xafEPES	`3`	XAdES-EPES form, supported starting from XAdES v1.2.2
xafT	`4`	XAdES-T form
xafC	`5`	XAdES-C form
xafX	`6`	XAdES-X form
xafXL	`7`	XAdES-X-L form
xafA	`8`	XAdES-A form
xafExtendedBES	`9`	XAdES-E-BES form
xafExtendedEPES	`10`	XAdES-E-EPES form
xafExtendedT	`11`	XAdES-E-T form
xafExtendedC	`12`	XAdES-E-C form
xafExtendedX	`13`	XAdES-E-X form
xafExtendedXLong	`14`	XAdES-E-X-Long form (type 1)
xafExtendedXL	`15`	XAdES-E-X-L form (type 2)
xafExtendedA	`16`	XAdES-E-A form

* XAdES-E-* forms are supported starting from XAdES v1.3.2

XAdESVersion
XAdESVersions

Specifies XAdES version.

This property specifies the version of the XAdES specification the signature should comply with. For the form of XAdES, use XAdESForm.


xavUnknown	`0`
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)

Constructors

C#
VB.NET

public OfficeSignature();

Public OfficeSignature()

Creates a new Office signature object.

OfficeSignedPart Type

The component is responsible for storing a signed part of an Office document.

Remarks

An Office document may contain any number of signed parts; component contains a single one of them.

Fields

ContentType
String

Specifies the content type of this signed part.

HashAlgorithm
String

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`

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`

IsRelationshipPart
Boolean

Specifies whether this signed part is a relationship part.

Path
String

The path to this signed part in the document package.

SignatureIndex
Integer

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

ValidationResult
SignatureValidities

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

Constructors

C#
VB.NET

public OfficeSignedPart();

Public OfficeSignedPart()

Creates a new Office signed part object.

ProxySettings Type

A container for proxy server settings.

Remarks

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

Fields

Address
String

The IP address of the proxy server.

Authentication
ProxyAuthTypes

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Password
String

The password to authenticate to the proxy server.

Port
Integer

The port on the proxy server to connect to.

ProxyType
ProxyTypes

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

RequestHeaders
String

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
String

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

ResponseHeaders
String

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

UseIPv6
Boolean

Specifies whether IPv6 should be used when connecting through the proxy.

UseProxy
Boolean

Enables or disables proxy-driven connection.

Username
String

Specifies the username credential for proxy authentication.

Constructors

C#
VB.NET

public ProxySettings();

Public ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

DNSMode
DNSResolveModes

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
Integer

Specifies the port number to be used for sending queries to the DNS server.

DNSQueryTimeout
Integer

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

DNSServers
String

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

DNSTotalTimeout
Integer

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

IncomingSpeedLimit
Integer

The maximum number of bytes to read from the socket, per second.

LocalAddress
String

The local network interface to bind the socket to.

LocalPort
Integer

The local port number to bind the socket to.

OutgoingSpeedLimit
Integer

The maximum number of bytes to write to the socket, per second.

Timeout
Integer

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
Boolean

Enables or disables IP protocol version 6.

Constructors

C#
VB.NET

public SocketSettings();

Public SocketSettings()

Creates a new SocketSettings object.

TimestampInfo Type

A container for timestamp information.

Remarks

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

Fields

Accuracy
Long

This field indicates the accuracy of the included time mark, in microseconds.

Bytes
Byte()

Returns raw timestamp data in DER format.

CertificateIndex
Integer

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
Integer

The details of a certificate chain validation outcome. They may often suggest what 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
ChainValidities

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.

HashAlgorithm
String

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`

SerialNumber
Byte()

Returns the timestamp's serial number.

SignatureIndex
Integer

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

Time
String

The time point incorporated into the timestamp.

TimestampType
Integer

Returns the type of the timestamp.

Available options:


tstUnknown	`0`
tstLegacy	`1`	Supported by: AuthenticodeVerifier
tstTrusted	`2`	Supported by: AuthenticodeVerifier
tstGeneric	`3`	Supported by: CAdESVerifier
tstESC	`4`	Supported by: CAdESVerifier
tstContent	`5`	Supported by: CAdESVerifier
tstCertsAndCRLs	`6`	Supported by: CAdESVerifier
tstArchive	`7`	Archive timestamp. Supported by: CAdESVerifier, OfficeVerifier, SOAPVerifier, XAdESVerifier
tstArchive2	`8`	Archive v2 timestamp. Supported by: CAdESVerifier
tstArchive3	`9`	Archive v3 timestamp. Supported by: CAdESVerifier
tstIndividualDataObjects	`10`	Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier
tstAllDataObjects	`11`	Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier
tstSignature	`12`	Signature timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier
tstRefsOnly	`13`	RefsOnly timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier
tstSigAndRefs	`14`	SigAndRefs timestamp. Supported by: OfficeVerifier, SOAPVerifier, XAdESVerifier

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

TSAName
String

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

ValidationLog
String

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

ValidationResult
SignatureValidities

Contains 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

Constructors

C#
VB.NET

public TimestampInfo();

Public TimestampInfo()

Creates a new TimestampInfo object with default field values.

TLSSettings Type

A container for TLS connection settings.

Remarks

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

Fields

AutoValidateCertificates
Boolean

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

BaseConfiguration
SecureTransportPredefinedConfigurations

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

Ciphersuites
String

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 that allow to blanketly enable or disable all ciphersuites 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

ECCurves
String

Defines the elliptic curves to enable.

Extensions
String

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
Boolean

Whether to force TLS session resumption when the destination address changes.

PreSharedIdentity
String

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedKey
String

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

PreSharedKeyCiphersuite
String

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

RenegotiationAttackPreventionMode
RenegotiationAttackPreventionModes

Selects 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
RevocationCheckKinds

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`)	Check all provided CRL endpoints for all chain certificates.
crcAllOCSP (`3`)	Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP (`4`)	Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL (`5`)	At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP (`6`)	At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP (`7`)	At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL (`8`)	At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

SSLOptions
Integer

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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (not send) 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 handshake message as large batches rather than individually

TLSMode
SSLModes

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, allow plain data.

UseExtendedMasterSecret
Boolean

Enables Extended Master Secret Extension, as defined in RFC 7627.

UseSessionResumption
Boolean

Enables or disables TLS session resumption capability.

Versions
Integer

Th 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

C#
VB.NET

public TLSSettings();

Public TLSSettings()

Creates a new TLSSettings object.

Config Settings (OfficeSigner Component)

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

OfficeSigner Config Settings

ClaimedRoleText: The text of the claimed role.

Use this property to specify the text of the first claimed role.

ClaimedRoleXML: The XML content of the claimed roles.

Use this property to specify the XML content of the claimed roles element.

CommitmentTypeIndicationAllSignedDataObjects[Index]: Specifies the CommitmentTypeIndication's AllSignedDataObjects.

This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationCount: The number of the CommitmentTypeIndication elements.

Returns the number of the xades:CommitmentTypeIndication elements available.

CommitmentTypeIndicationIdentifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.

This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierDescription[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.

This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierDocumentationReferences[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.

This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierQualifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.

This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationObjectReference[Index]: Specifies the CommitmentTypeIndication's ObjectReference.

This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationQualifiersXML[Index]: The XML content of the CommitmentTypeIndication's Qualifiers.

This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.

DislikeOpenEndedOCSPs: Tells the component to discourage OCSP responses without an explicit NextUpdate parameter.

When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the component is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

ExpireTime: Signature expiration time in UTC.

Specifies the signature expiration time in UTC. Used for Binary Crypto API signature.

ForceCompleteChainValidation: Whether to check the CA certificates when the signing certificate is invalid.

Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.

ForceCompleteChainValidationForTrusted: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

GracePeriod: Specifies a grace period to apply during revocation information checks.

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

IgnoreChainLoops: Whether chain loops should be ignored.

Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

IgnoreOCSPNoCheckExtension: Whether OCSP NoCheck extension should be ignored.

Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.

IgnoreTimestampFailure: Whether to ignore time-stamping failure during signing.

If this property is set to True, any failure during time-stamping process will be ignored.

ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings.

IncludeKnownRevocationInfoToSignature: Whether to include custom revocation info to the signature.

This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

ProductionPlace: Identifies the place of the signature production.

Use this property to specify the signature production place.

Sample value: "CITY=Test City, ST=Test State, POSTALCODE=Test Code, C=Test Country"

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

Set this property to True to force the component to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

RefsTimestampType: Specifies references timestamp type to include to the signature.

Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.

Supported values are:


SigAndRefs		SigAndRefs timestamp
RefsOnly		RefsOnly timestamp

SignatureInfoAddress1: Specifies the location at which the signature was created.

Use this property to specify the location at which the signature was created.

SignatureInfoAddress2: Specifies the location at which the signature was created.

Use this property to specify the location at which the signature was created.

SignatureInfoComments: Comments to the signature info text.

Comments to the signature info text.

SignatureInfoDelegateSuggestedSigner: Specifies the name of a person.

Use this property to specify the name of a person to whom the signature has been delegated.

SignatureInfoDelegateSuggestedSigner2: Specifies the title of a person.

Use this property to specify the title of a person to whom the signature has been delegated.

SignatureInfoDelegateSuggestedSignerEmail: Specifies the e-mail address of a person.

Use this property to specify the e-mail address of a person to whom the signature has been delegated.

SignatureInfoImage: Specifies an image for the digital signature.

Use his property to set an image for the digital signature.

SignatureInfoIncluded: Whether to include the signature info.

Specifies whether to include the signature info.

Sample code that demonstrates adding signature information for OpenXML documents: signer.EnableXAdES = true; signer.XAdESForm = xafEPES; signer.Config("SignatureInfoIncluded=true"); signer.Config("SignatureInfoText=Text"); signer.Config("SignatureInfoComments=Comment"); signer.Config("ClaimedRoleText=Role"); signer.Config("CommitmentTypeIndicationCount=1"); signer.Config("CommitmentTypeIndicationAllSignedDataObjects=true"); signer.Config("CommitmentTypeIndicationIdentifier=http://uri.etsi.org/01903/v1.2.2#ProofOfApproval"); signer.Config("CommitmentTypeIndicationIdentifierDescription=Approved this document"); signer.Config("ProductionPlace=CITY=Test City, ST=Test State, POSTALCODE=Test Code, C=Test Country"); signer.Config("SignatureInfoAddress1=Address1"); signer.Config("SignatureInfoAddress2=Address2");

SignatureInfoInvalidLnImage: Specifies the image of an invalid signature.

Use this property to set the image of an invalid signature, if the digital signature must be printed.

SignatureInfoSignatureType: Specifies the type of the digital signature.

Use this property to specify the type of the digital signature.

When the type is 2, both SignatureInfoValidLnImage and SignatureInfoInvalidLnImage images should be specified.

SignatureInfoText: The text to be displayed as the signature info.

The text to be displayed as the signature info.

SignatureInfoValidLnImage: Specifies the image of a valid signature.

Use this property to set the image of a valid signature, if the digital signature must be printed.

SignatureLineAdditionalSignatureInfo[Index]: Contains additional signature information.

This property contains additional signature information.

SignatureLineAllowComments[Index]: Indicates if comments are allowed.

This property contains the True value if comments are allowed.

SignatureLineCount: The number of signature lines.

Returns the number of the signature lines available for Office Open XML (OOXML) documents.

SignatureLineId[Index]: Contains signature unique ID.

This property contains signature unique ID.

SignatureLineImageData[Index]: Contains signature image.

This property contains signature image.

SignatureLineIndex: Specifies the index of the signature line to sign.

Use this property to specify the signature line that should be signed. If the default value of -1 is assigned to this property, no signature line will be signed.

SignatureLineShowSignDate[Index]: Indicates if signing date should be shown.

This property contains the True value if the signature line should include the signing date.

SignatureLineSignatureIndex[Index]: The index of the signature that signs signature line.

This property contains the index of the signature that signs this signature line.

SignatureLineSignatureProviderId[Index]: Contains signature provider ID.

This property contains a unique ID identifying which signature provider created the signature line.

SignatureLineSignatureProviderUrl[Index]: Contains signature provider URL.

This property contains a signature provider download URL.

SignatureLineSigned[Index]: Indicates if signature line is signed.

This property contains the True value if signature line is signed.

SignatureLineSigningInstructions[Index]: Contains signing instructions.

This property contains the instructions, shown to the user at signing time.

SignatureLineSuggestedSigner2[Index]: Suggested signer line two.

This property contains the second line of information of who should sign the signature line.

SignatureLineSuggestedSigner[Index]: Suggested signer line one.

This property contains the first line of information of who should sign the signature line.

SignatureLineSuggestedSignerEmail[Index]: Suggested signer email address.

This property contains the email address of who should sign the signature line.

SignTime: Specifies the signing time in UTC.

Specifies the signing time in UTC. Used for Binary Crypto API signature.

SigPolicyDescription: signature policy description.

This property specifies the Description of the signature policy.

SigPolicyExplicitText: The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.

SigPolicyHash: The hash value of the signature policy.

This property contains the hash value of the signature policy.

SigPolicyHashAlgorithm: Specifies the hash algorithm used to compute the signature policy hash.

Use this property to specify the algorithm used to compute the signature policy hash.

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`

SigPolicyID: Identifies the signature policy.

This property contains an identifier that uniquely identifies a specific version of the signature policy.

SigPolicyNoticeNumbers: Contains user notice numbers.

This property provides an access to the list of notice numbers, by which the explicit signature policy notice texts could be retrieved.

SigPolicyNoticeOrganization: The organization part of the NoticeReference qualifier.

Use this property to specify the "organization" part of the NoticeReference signature policy qualifier for XAdES-EPES form.

SigPolicyURI: Signature policy URI.

This property specifies the URI of the signature policy.

TempPath: Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TimestampCanonicalizationMethod: Specifies canonicalization method used in timestamp.

Use this property to specify the canonicalization method used in timestamp.


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

TimestampValidationDataDetails: Specifies timestamp validation data details to include to the signature.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.

Supported values are:


certificate		Base64-encoded [X509v3] certificates
crl		Base64-encoded certificate revocation lists (CRL)
ocsp		OCSP responses

TLSChainValidationDetails: Contains the advanced details of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to access the TLS certificate validation details.

TLSChainValidationResult: Contains the result of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to obtain the TLS certificate validation result.

TLSClientAuthRequested: Indicates whether the TLS server requests client authentication.

Check this property in TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via TLSClientChain property. Note that the component may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

TLSValidationLog: Contains the log of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to retrieve the validation log of the TLS server.

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

CA, revocation source, TLS key usage requirements are not mandated
Violation of OCSP issuer requirements are ignored
AuthorityKeyID extension in CRL and certificate issuing CAs are ignored (helps with incorrectly renewed certificates)
Basic constraints and name constraints of CA certificates are ignored
Some weaker algorithms are tolerated

TspHashAlgorithm: Sets a specific hash algorithm for use with the timestamping service.

In default configuration component uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

UseValidationCache: Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from the fresh start.

ValidationDataRefsDetails: Specifies validation data references details to include to the signature.

Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.

Supported values are:


certificate		References to X.509 certificates
crl		References to certificate revocation lists (CRL)
ocsp		References to OCSP responses

ValidationDataValuesDetails: Specifies validation data values details to include to the signature.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.

Supported values are:


certificate		Base64-encoded [X509v3] certificates
crl		Base64-encoded certificate revocation lists (CRL)
ocsp		OCSP responses

Base Config Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

Cookies: Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

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

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

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

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

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.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


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)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (OfficeSigner Component)

OfficeSigner Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
24117249   Input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS)
24117250   Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT)
24117251   Document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE)
24117252   Document is not signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED)
24117253   Document is encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED)
24117254   Document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE)
24117255   Document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED)
24117256   Unknown encryption algorithm (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION)
24117257   Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD)
24117258   Signature not found (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND)


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Component is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
	1048579 Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
	1048580 Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
	1048581 Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
	1048581 Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
	24117249 Input file does not exist (`SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS`)
	24117250 Unsupported document format (`SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT`)
	24117251 Document cannot be signed (`SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE`)
	24117252 Document is not signed (`SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED`)
	24117253 Document is encrypted (`SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED`)
	24117254 Document cannot be encrypted (`SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE`)
	24117255 Document is not encrypted (`SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED`)
	24117256 Unknown encryption algorithm (`SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION`)
	24117257 Invalid password (`SB_ERROR_OFFICE_INVALID_PASSWORD`)
	24117258 Signature not found (`SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND`)