ASiCVerifier Component
Properties Methods Events Config Settings Errors
The ASiCVerifier component verifies signature containers.
Syntax
nsoftware.SecureBlackbox.Asicverifier
Remarks
ASiCVerifier provides the functionality of verifying signatures residing in Associated Signature Containers.
Both ASiC-S and ASiC-E profiles are supported.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AllSignaturesValid | The cumulative validity of all signatures. |
| AutoValidateSignatures | Specifies whether ASiCVerifier 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. |
| ExtractionMode | Specifies which entries should be extracted from the container upon verification. |
| Files | Lists all files contained in the container. |
| 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 | A path to the ASiC container to process. |
| InputStream | A stream containing ASiC data. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| 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 | The file where the processed data will be saved. |
| OutputPath | A local path to extract the files to. |
| OutputStream | The stream where the file is to be extracted. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform. |
| Signatures | Contains the list of signatures included in the ASiC container. |
| SocketSettings | Manages network connection settings. |
| Timestamps | Contains a collection of timestamps for the processed document. |
| 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.
| Close | Closes an opened container. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| ExtractFile | Extracts a file to one of the output media (bytes, stream, or disk file). |
| ExtractFiles | Extracts files covered by a signature to OutputPath . |
| Open | Opens an existing container for signing or updating. |
| Revalidate | Revalidates a signature in accordance with current settings. |
| Unsign | Deletes a signature from the container. |
| Verify | Verifies all signatures in the ASiC container. |
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. |
| ContainerLoaded | This event is fired when the container has been loaded into memory. |
| Error | Information about errors during ASiC signature verification. |
| FileExtractionStart | Signifies the start of a file extraction process. |
| 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. |
| 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.
| DislikeOpenEndedOCSPs | Tells the component to discourage OCSP responses without an explicit NextUpdate parameter. |
| ExtractToMemory | Tells the component to extract the current entry to memory. |
| 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. |
| IgnoreChainValidationErrors | Enable this property to ignore any chain validation issues. |
| IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| ProductionPlace | The production place XAdES attribute. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| TempPath | Path for storing temporary files. |
| 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. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseUTF8Filenames | Specifies whether to use UTF-8 filenames. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| 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. |
AllSignaturesValid Property (ASiCVerifier Component)
The cumulative validity of all signatures.
Syntax
Default Value
False
Remarks
Use this property to check if all the signatures found in the message or document are valid.
This property is read-only and not available at design time.
AutoValidateSignatures Property (ASiCVerifier Component)
Specifies whether ASiCVerifier should validate any present signatures when the document is opened.
Syntax
Default Value
True
Remarks
This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.
BlockedCertificates Property (ASiCVerifier Component)
The certificates that must be rejected as trust anchors.
Syntax
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 (ASiCVerifier Component)
A collection of certificates included in the electronic signature.
Syntax
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 (ASiCVerifier Component)
A collection of certificate revocation lists embedded into the signature by the signer.
Syntax
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.
ExtractionMode Property (ASiCVerifier Component)
Specifies which entries should be extracted from the container upon verification.
Syntax
public AsicverifierExtractionModes ExtractionMode { get; set; }
enum AsicverifierExtractionModes { aemNone, aemAll, aemSigned, aemSignedAndValid }
Public Property ExtractionMode As AsicverifierExtractionModes
Enum AsicverifierExtractionModes aemNone aemAll aemSigned aemSignedAndValid End Enum
Default Value
0
Remarks
Use this property to choose entries that should be extracted in the Verify method. Choose between extracting all files, signed-only, signed and with verified signature, and none at all (verify-only mode).
| aemNone | 0 |
| aemAll | 1 |
| aemSigned | 2 |
| aemSignedAndValid | 3 |
Files Property (ASiCVerifier Component)
Lists all files contained in the container.
Syntax
public ArchivedFileList Files { get; }
Public ReadOnly Property Files As ArchivedFileList
Remarks
Use this collection property to walk through the list of files contained in the archive.
This property is read-only and not available at design time.
FIPSMode Property (ASiCVerifier Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
IgnoreChainValidationErrors Property (ASiCVerifier Component)
Makes the component tolerant to chain validation errors.
Syntax
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 (ASiCVerifier Component)
Use this property to pass the input to component in the byte array form.
Syntax
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
InputFile Property (ASiCVerifier Component)
A path to the ASiC container to process.
Syntax
Default Value
""
Remarks
Use this property to provide a path to the signature container. Use InputStream to provide the container from memory rather than a disk file.
InputStream Property (ASiCVerifier Component)
A stream containing ASiC data.
Syntax
public System.IO.Stream InputStream { get; set; }
Public Property InputStream As System.IO.Stream
Default Value
null
Remarks
Use this property to feed ASiC data to the component from a stream object.
This property is not available at design time.
KnownCertificates Property (ASiCVerifier Component)
Additional certificates for chain validation.
Syntax
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 (ASiCVerifier Component)
Additional CRLs for chain validation.
Syntax
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 (ASiCVerifier Component)
Additional OCSP responses for chain validation.
Syntax
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.
OCSPs Property (ASiCVerifier Component)
A collection of OCSP responses embedded into the signature.
Syntax
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 (ASiCVerifier Component)
Switches the component to the offline mode.
Syntax
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 (ASiCVerifier Component)
Use this property to read the output the component object has produced.
Syntax
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 (ASiCVerifier Component)
The file where the processed data will be saved.
Syntax
Default Value
""
Remarks
Provides a path to the file where the component should save the updated container.
OutputPath Property (ASiCVerifier Component)
A local path to extract the files to.
Syntax
Default Value
""
Remarks
Assign this property with a path where the extracted files (selected according to ExtractionMode criteria) are to be saved.
OutputStream Property (ASiCVerifier Component)
The stream where the file is to be extracted.
Syntax
public System.IO.Stream OutputStream { get; set; }
Public Property OutputStream As System.IO.Stream
Default Value
null
Remarks
Use this property to specify the stream to take the data extracted from the container.
This property is not available at design time.
Profile Property (ASiCVerifier Component)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
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.
RevocationCheck Property (ASiCVerifier Component)
Specifies the kind(s) of revocation check to perform.
Syntax
public AsicverifierRevocationChecks RevocationCheck { get; set; }
enum AsicverifierRevocationChecks { crcNone, crcAuto, crcAllCRL, crcAllOCSP, crcAllCRLAndOCSP, crcAnyCRL, crcAnyOCSP, crcAnyCRLOrOCSP, crcAnyOCSPOrCRL }
Public Property RevocationCheck As AsicverifierRevocationChecks
Enum AsicverifierRevocationChecks crcNone crcAuto crcAllCRL crcAllOCSP crcAllCRLAndOCSP crcAnyCRL crcAnyOCSP crcAnyCRLOrOCSP crcAnyOCSPOrCRL End Enum
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (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 (ASiCVerifier Component)
Contains the list of signatures included in the ASiC container.
Syntax
public ASiCSignatureList Signatures { get; }
Public ReadOnly Property Signatures As ASiCSignatureList
Remarks
Use this property to access all signatures in the container.
This property is read-only and not available at design time.
SocketSettings Property (ASiCVerifier Component)
Manages network connection settings.
Syntax
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 (ASiCVerifier Component)
Contains a collection of timestamps for the processed document.
Syntax
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.
TLSClientChain Property (ASiCVerifier Component)
The TLS client certificate chain.
Syntax
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 (ASiCVerifier Component)
The TLS server's certificate chain.
Syntax
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 (ASiCVerifier Component)
Manages TLS layer settings.
Syntax
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 (ASiCVerifier Component)
A list of trusted certificates for chain validation.
Syntax
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 (ASiCVerifier Component)
The time point at which signature validity is to be established.
Syntax
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.
Close Method (ASiCVerifier Component)
Closes an opened container.
Syntax
Remarks
Use this method to close a previously opened container. Set SaveChanges to true to apply any changes made.
Config Method (ASiCVerifier Component)
Sets or retrieves a configuration setting.
Syntax
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 (ASiCVerifier Component)
Performs an additional action.
Syntax
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;....
ExtractFile Method (ASiCVerifier Component)
Extracts a file to one of the output media (bytes, stream, or disk file).
Syntax
Remarks
Use this method to extract a single archived
ExtractFiles Method (ASiCVerifier Component)
Extracts files covered by a signature to OutputPath .
Syntax
Remarks
Use this method to extract all files covered by the signature SigIndex to OutputPath. Set SigIndex to -1 to extract all the files included in the container.
Open Method (ASiCVerifier Component)
Opens an existing container for signing or updating.
Syntax
public void Open();
Public Sub Open()
Remarks
Use this method to open a container for signing or updating. When finished, call Close to complete or discard the operation.
Revalidate Method (ASiCVerifier Component)
Revalidates a signature in accordance with current settings.
Syntax
Remarks
Use this method to re-validate a signature in the opened ASiC document.
Unsign Method (ASiCVerifier Component)
Deletes a signature from the container.
Syntax
Remarks
Use this method to delete an existing signature from the container. Use SigIndex parameter to specify the signature to be removed.
Verify Method (ASiCVerifier Component)
Verifies all signatures in the ASiC container.
Syntax
public void Verify();
Public Sub Verify()
Remarks
Use this method to verify the signature and any associated signed files residing in the ASiC container.
When processing the container, the verifier walks through all the signatures contained in the message, one after another.
For each signature, the SignatureFound event is thrown. The benefits of this are that it:
- Lets you know some basic details about the signature and its creator
- Allows you to tell the component whether or not you want to validate it and/or its signing certificate's chain
- Gives you a chance to provide any missing certificates (CertFound indicates whether you need to do that)
The control's properties remain assigned with the last processed signature's details, and are still available after the Verify() call returns, providing a handy way to work with single-signature containers.
Once the main signature's processing completes, the control proceeds to its subordinate elements (countersignatures and/or timestamps). Each timestamp is reported via TimestampValidated event.
Having reported all the countersignatures and timestamps, the control proceeds to the next main signature and any timestamps associated with it - and so on.
ChainElementDownload Event (ASiCVerifier Component)
Fires when there is a need to download a chain element from an online source.
Syntax
public event OnChainElementDownloadHandler OnChainElementDownload; public delegate void OnChainElementDownloadHandler(object sender, AsicverifierChainElementDownloadEventArgs e); public class AsicverifierChainElementDownloadEventArgs : 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 AsicverifierChainElementDownloadEventArgs) Public Class AsicverifierChainElementDownloadEventArgs 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 (ASiCVerifier Component)
Fires when an element required to validate the chain was not located.
Syntax
public event OnChainElementNeededHandler OnChainElementNeeded; public delegate void OnChainElementNeededHandler(object sender, AsicverifierChainElementNeededEventArgs e); public class AsicverifierChainElementNeededEventArgs : 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 AsicverifierChainElementNeededEventArgs) Public Class AsicverifierChainElementNeededEventArgs 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 (ASiCVerifier Component)
This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
Syntax
public event OnChainElementStoreHandler OnChainElementStore; public delegate void OnChainElementStoreHandler(object sender, AsicverifierChainElementStoreEventArgs e); public class AsicverifierChainElementStoreEventArgs : 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 AsicverifierChainElementStoreEventArgs) Public Class AsicverifierChainElementStoreEventArgs 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 (ASiCVerifier Component)
Reports the completion of a certificate chain validation.
Syntax
public event OnChainValidatedHandler OnChainValidated; public delegate void OnChainValidatedHandler(object sender, AsicverifierChainValidatedEventArgs e); public class AsicverifierChainValidatedEventArgs : 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 AsicverifierChainValidatedEventArgs) Public Class AsicverifierChainValidatedEventArgs 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) |
| 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 (ASiCVerifier Component)
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
public event OnChainValidationProgressHandler OnChainValidationProgress; public delegate void OnChainValidationProgressHandler(object sender, AsicverifierChainValidationProgressEventArgs e); public class AsicverifierChainValidationProgressEventArgs : 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 AsicverifierChainValidationProgressEventArgs) Public Class AsicverifierChainValidationProgressEventArgs 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 |
ContainerLoaded Event (ASiCVerifier Component)
This event is fired when the container has been loaded into memory.
Syntax
public event OnContainerLoadedHandler OnContainerLoaded; public delegate void OnContainerLoadedHandler(object sender, AsicverifierContainerLoadedEventArgs e); public class AsicverifierContainerLoadedEventArgs : EventArgs { public bool Cancel { get; set; } }
Public Event OnContainerLoaded As OnContainerLoadedHandler Public Delegate Sub OnContainerLoadedHandler(sender As Object, e As AsicverifierContainerLoadedEventArgs) Public Class AsicverifierContainerLoadedEventArgs Inherits EventArgs Public Property Cancel As Boolean End Class
Remarks
The handler for this event is a good place to check for any existing signatures and validate them if required.
Set Cancel to true to terminate document processing on this stage.
Error Event (ASiCVerifier Component)
Information about errors during ASiC signature verification.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, AsicverifierErrorEventArgs e); public class AsicverifierErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As AsicverifierErrorEventArgs) Public Class AsicverifierErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The event is fired in case of exceptional conditions during ASiC signature verification.
ErrorCode contains an error code and Description contains a textual description of the error.
FileExtractionStart Event (ASiCVerifier Component)
Signifies the start of a file extraction process.
Syntax
public event OnFileExtractionStartHandler OnFileExtractionStart; public delegate void OnFileExtractionStartHandler(object sender, AsicverifierFileExtractionStartEventArgs e); public class AsicverifierFileExtractionStartEventArgs : EventArgs { public string FileName { get; } public long FileSize { get; } public string ModDate { get; } public bool Extract { get; set; } public string DestFile { get; set; } }
Public Event OnFileExtractionStart As OnFileExtractionStartHandler Public Delegate Sub OnFileExtractionStartHandler(sender As Object, e As AsicverifierFileExtractionStartEventArgs) Public Class AsicverifierFileExtractionStartEventArgs Inherits EventArgs Public ReadOnly Property FileName As String Public ReadOnly Property FileSize As Long Public ReadOnly Property ModDate As String Public Property Extract As Boolean Public Property DestFile As String End Class
Remarks
This event fires for every file located in the archive and matching the ExtractionMode setting before it is to be extracted.
DestFile indicates the path where the file will be saved to. You can alter the destination path here, by providing an alternative extraction path.
Set DestFile to an empty string and provide a stream object via the OutputStream property if you prefer to save the data to a stream instead of file.
If DestFile is set to an empty string and OutputStream is unassigned, the file will not be extracted.
Alternatively, you can request the extracted content to be saved into a byte array. To do this, leave DestFile and OutputStream empty, and keep the Extract parameter enabled.
Please take care when extracting large files into byte arrays, as those may consume large amounts of memory.
Note: if DestFile already exists, the component will overwrite it. To prevent overwriting of existing files, subscribe to this event, and change DestFile when needed.
Notification Event (ASiCVerifier Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, AsicverifierNotificationEventArgs e); public class AsicverifierNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As AsicverifierNotificationEventArgs) Public Class AsicverifierNotificationEventArgs 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.
SignatureFound Event (ASiCVerifier Component)
Signifies the start of signature validation.
Syntax
public event OnSignatureFoundHandler OnSignatureFound; public delegate void OnSignatureFoundHandler(object sender, AsicverifierSignatureFoundEventArgs e); public class AsicverifierSignatureFoundEventArgs : 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 AsicverifierSignatureFoundEventArgs) Public Class AsicverifierSignatureFoundEventArgs 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 (ASiCVerifier Component)
Marks the completion of the signature validation routine.
Syntax
public event OnSignatureValidatedHandler OnSignatureValidated; public delegate void OnSignatureValidatedHandler(object sender, AsicverifierSignatureValidatedEventArgs e); public class AsicverifierSignatureValidatedEventArgs : 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 AsicverifierSignatureValidatedEventArgs) Public Class AsicverifierSignatureValidatedEventArgs 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 (ASiCVerifier Component)
Signifies the start of a timestamp validation routine.
Syntax
public event OnTimestampFoundHandler OnTimestampFound; public delegate void OnTimestampFoundHandler(object sender, AsicverifierTimestampFoundEventArgs e); public class AsicverifierTimestampFoundEventArgs : 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 AsicverifierTimestampFoundEventArgs) Public Class AsicverifierTimestampFoundEventArgs 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.
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.
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.
TimestampValidated Event (ASiCVerifier Component)
Reports the completion of the timestamp validation routine.
Syntax
public event OnTimestampValidatedHandler OnTimestampValidated; public delegate void OnTimestampValidatedHandler(object sender, AsicverifierTimestampValidatedEventArgs e); public class AsicverifierTimestampValidatedEventArgs : 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 AsicverifierTimestampValidatedEventArgs) Public Class AsicverifierTimestampValidatedEventArgs 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 (ASiCVerifier Component)
Fires when a remote TLS party requests a client certificate.
Syntax
public event OnTLSCertNeededHandler OnTLSCertNeeded; public delegate void OnTLSCertNeededHandler(object sender, AsicverifierTLSCertNeededEventArgs e); public class AsicverifierTLSCertNeededEventArgs : EventArgs { public string Host { get; } public string CANames { get; } }
Public Event OnTLSCertNeeded As OnTLSCertNeededHandler Public Delegate Sub OnTLSCertNeededHandler(sender As Object, e As AsicverifierTLSCertNeededEventArgs) Public Class AsicverifierTLSCertNeededEventArgs 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 (ASiCVerifier Component)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, AsicverifierTLSCertValidateEventArgs e); public class AsicverifierTLSCertValidateEventArgs : 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 AsicverifierTLSCertValidateEventArgs) Public Class AsicverifierTLSCertValidateEventArgs 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 (ASiCVerifier Component)
Fires when a TLS handshake with Host successfully completes.
Syntax
public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, AsicverifierTLSEstablishedEventArgs e); public class AsicverifierTLSEstablishedEventArgs : 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 AsicverifierTLSEstablishedEventArgs) Public Class AsicverifierTLSEstablishedEventArgs 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 (ASiCVerifier Component)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, AsicverifierTLSHandshakeEventArgs e); public class AsicverifierTLSHandshakeEventArgs : EventArgs { public string Host { get; } public bool Abort { get; set; } }
Public Event OnTLSHandshake As OnTLSHandshakeHandler Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As AsicverifierTLSHandshakeEventArgs) Public Class AsicverifierTLSHandshakeEventArgs 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 (ASiCVerifier Component)
Reports the graceful closure of a TLS connection.
Syntax
public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, AsicverifierTLSShutdownEventArgs e); public class AsicverifierTLSShutdownEventArgs : EventArgs { public string Host { get; } }
Public Event OnTLSShutdown As OnTLSShutdownHandler Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As AsicverifierTLSShutdownEventArgs) Public Class AsicverifierTLSShutdownEventArgs 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.
ArchivedFile Type
Provides information about the compressed file.
Remarks
Use this type to access compressed file details.
Fields
|
Action Actions |
The action to apply to the file. Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:
|
||||||||||||
|
CompressedSize Long |
The size of the file after compression. |
||||||||||||
|
DataSource FileDataSources |
The type of the data source for this entry. Use this property to control the data source for this entry.
|
||||||||||||
|
Directory Boolean |
Tells if the entry is a directory or a regular file. |
||||||||||||
|
EncryptionAlgorithm String |
Returns the symmetric algorithm that was used to encrypt the file. |
||||||||||||
|
EncryptionKeyLength Integer |
Returns the length, in bits, of the encryption key. |
||||||||||||
|
EncryptionType EncryptionTypes |
The type of encryption applied to the file. Use this property to find out what kind of encryption was applied to the file.
|
||||||||||||
|
FileName String |
The original name of the compressed file or folder. |
||||||||||||
|
Folder String |
The containing folder of the entry. |
||||||||||||
|
LocalPath String |
The local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to. |
||||||||||||
|
MTime String |
The entry's last modification time. |
||||||||||||
|
NewFile Boolean |
Indicates whether the entry corresponds to a file to be added to the archive. |
||||||||||||
|
Path String |
The full internal path of the archived entry. |
||||||||||||
|
SignatureCount Integer |
The number of signatures covering the entry. |
||||||||||||
|
Signed Boolean |
Indicates whether the entry is signed. |
||||||||||||
|
Size Long |
The size of the file before compression. |
Constructors
public ArchivedFile();
Public ArchivedFile()
Creates a new ArchivedFile object.
ASiCSignature Type
Represents a signature in the ASiC container.
Remarks
This type contains information about a signature found in ASiC container. It holds various information about the signature, including its coverage and validation results.
An ASiC-S container can include one CAdES, and/or one XAdES, and/or one Timestamp. An ASiC-E container can include multiple CAdES signatures, XAdES signatures, and timestamp tokens.
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ClaimedSigningTime String |
Returns or sets signature's creation time. Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike ValidatedSigningTime does not originate from a trusted TSA and may be forfeited or wrong. The time is provided in UTC. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ContentType String |
The signature content type. Use this property to get or set the content type OID to be included with the signature. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FileName String |
The name of the ASiC signature file. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Set or returns the hash algorithm used to generate the signature. Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Level ASiCLevels |
Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels. The main differences between levels are in the scope of validation information included to the signature. BES signatures only include the most necessary information (the signing chain), whereas XL and A signatures include the complete set.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 ASiC signature. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureType ASiCSignatureTypes |
The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureValidationResult SignatureValidities |
The outcome of the cryptographic signature validation. The following signature validity values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SignedFiles String |
Contains a comma-separated list of files that are covered by the signature. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 the RDN of the owner of the signing certificate. RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 signing certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
Constructors
public ASiCSignature();
Public ASiCSignature()
Creates a new empty ASiC signature object.
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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
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.
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.
public Certificate(byte[] bytes, int startIndex, int count);
Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)
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.
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.
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.
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.
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.
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.
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.
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
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.
Creates a CRL object by downloading it from a remote location.
public CRL(System.IO.Stream stream);
Public CRL(ByVal Stream As System.IO.Stream)
Creates a CRL object from data contained in a stream.
Creates an empty CRL object.
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
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.
public OCSPResponse(string location);
Public OCSPResponse(ByVal Location As String)
Downloads an OCSP response from a remote location.
public OCSPResponse(System.IO.Stream stream);
Public OCSPResponse(ByVal Stream As System.IO.Stream)
Initializes the response with the data from a stream.
public OCSPResponse();
Public OCSPResponse()
Creates an empty OCSP response 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.
|
||||||||
|
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
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Returns the timestamp's hash algorithm
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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:
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.
|
Constructors
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.
|
|||||||||||||||||||||||||||||||||
|
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:
|
|||||||||||||||||||||||||||||||||
|
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:
|
|||||||||||||||||||||||||||||||||
|
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.
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. |
|||||||||||||||||||||||||||||||||
|
SSLOptions Integer |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
TLSMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
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.
|
Constructors
public TLSSettings();
Public TLSSettings()
Creates a new TLSSettings object.
Config Settings (ASiCVerifier 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.ASiCVerifier Config Settings
| 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). | |
| ExtractToMemory: Tells the component to extract the current entry to memory.Set this property to true to extract the entry being currently processed to memory and make it available in OutputBytes property. This property is reset before every subsequent entry is processed. Use FileExtractionStart event handler to re-enable it. | |
| ForceCompleteChainValidation: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (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. 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. | |
| IgnoreChainValidationErrors: Enable this property to ignore any chain validation issues.Set this property to True to make the component ignore any chain validation issues. This is not recommended unless you know what you are doing. | |
| 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. |
|
| 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. | |
| PolicyExplicitText: The explicit text of the user notice.This property specifies the explicit text of the user notice which is displayed when the signature is verified. | |
| PolicyUNNumbers: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES. | |
| PolicyUNOrganization: The organization part of the NoticeReference qualifier. Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES. | |
| ProductionPlace: The production place XAdES attribute.Check this property to access the ProductionPlace XAdES attribute. | |
| 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. | |
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | |
| 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:
|
|
| 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. | |
| UseUTF8Filenames: Specifies whether to use UTF-8 filenames.Set this property to False to use system encoding for filenames inside container. | |
| 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. |
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:
|
|||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
|||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||
| 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 (ASiCVerifier Component)
ASiCVerifier 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) | |
| 16777217 Unsupported level (SB_ERROR_ASIC_UNSUPPORTED_LEVEL) | |
| 16777218 Unsupported signature form (SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_FORM) | |
| 16777219 Unsupported signature type (SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_TYPE) | |
| 16777220 Unsupported extraction mode (SB_ERROR_ASIC_UNSUPPORTED_EXTRACTION_MODE) | |
| 16777221 Input file does not exist (SB_ERROR_ASIC_INPUTFILE_NOT_EXISTS) | |
| 16777222 Output file already exists (SB_ERROR_ASIC_OUTPUTFILE_ALREADY_EXISTS) |