# CertificateStorage Class The CertificateStorage class works with collections of certificates. ## Syntax ```text CertificateStorage ``` ## Remarks CertificateStorage can work with certificates residing on a variety of media. Among others, it can access certificates residing in files, Windows and macOS system stores, and PKCS#11 devices. All such kinds of media can be accessed via a simple, unified interface, which makes CertificateStorage a handy certificate access option. Most users of SecureBlackbox use this component to access certificates residing on hardware devices. CertificateStorage is also a good alternative to CertificateManager where the certificate file contains more than one certificate. To access certificates stored on certain type of media, start with the [Open](#open-method-certificatestorage-class) method. Provide the location of your certificates via a uniform URI-like specifier. Once the storage has been opened, you can access the certificates contained in it via the [Certificates](#certificates-property-certificatestorage-class) property. Iterate over certificates by using the [Certificates](#certificates-property-certificatestorage-class) property, or use filtering facilities such as [Select](#select-method-certificatestorage-class) and [SelectChain](#selectchain-method-certificatestorage-class). You can add certificates to the storage with the [ImportBytes](#importbytes-method-certificatestorage-class), [ImportFromFile](#importfromfile-method-certificatestorage-class), and [ImportPinned](#importpinned-method-certificatestorage-class) methods. In the latter case please assign the certificate object to be imported to the [PinnedCert](#pinnedcert-property-certificatestorage-class) property. Use [CreateNew](#createnew-method-certificatestorage-class) method to create a new storage. Note that not all storage kinds can be created. When you have finished working with the certificate storage, close it with the [Close](#close-method-certificatestorage-class) method. Certain types of stores must be kept open for the certificates to continue to be usable. This means that while you can copy a certificate to a different storage, or assign it to a different component, you still must keep the storage it originates from open for as long as you intend to use that certificate in your code. This is because the storage is often a bridge between a certificate and its private key, and by closing the storage early you are destroying this bridge prematurely. See the code example below: ```text // This code, although syntactically correct, will fail because the storage is closed too early: storage.Open("pkcs11://user:12345@localhost/C:/Windows/System32/asepkcs.dll"); pdfSigner.SigningCertificate = storage.Certificates[0]; storage.Close(false); // the private key of the SigningCertificate gets lost after this call pdfSigner.Sign(); // returns an error // This code will work as expected storage.Open("pkcs11://user:12345@localhost/C:/Windows/System32/asepkcs.dll"); pdfSigner.SigningCertificate = storage.Certificates[0]; pdfSigner.Sign(); storage.Close(false); ``` ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Certificates](#certificates-property-certificatestorage-class) | A collection of certificates contained in the storage. | | [CRLs](#crls-property-certificatestorage-class) | A collection of CRLs contained in the storage. | | [FIPSMode](#fipsmode-property-certificatestorage-class) | Reserved. | | [OCSPs](#ocsps-property-certificatestorage-class) | A collection of OCSP responses contained in the storage. | | [Opened](#opened-property-certificatestorage-class) | Indicates whether the storage is in the open state. | | [PinnedCert](#pinnedcert-property-certificatestorage-class) | A pinned certificate. | | [PinnedCRL](#pinnedcrl-property-certificatestorage-class) | A pinned CRL object. | | [PinnedOCSP](#pinnedocsp-property-certificatestorage-class) | A pinned OCSP response object. | | [SelectedCertificates](#selectedcertificates-property-certificatestorage-class) | A collection of selected certificates. | | [StorageID](#storageid-property-certificatestorage-class) | A unique identifier of this storage. | | [StorageLocation](#storagelocation-property-certificatestorage-class) | Specifies the location of the currently opened storage. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Clear](#clear-method-certificatestorage-class) | Removes all certificates from the storage. | | [Close](#close-method-certificatestorage-class) | Closes the certificate storage. | | [Config](#config-method-certificatestorage-class) | Sets or retrieves a configuration setting. | | [CreateNew](#createnew-method-certificatestorage-class) | Creates a new storage. | | [DoAction](#doaction-method-certificatestorage-class) | Performs an additional action. | | [ExportBytes](#exportbytes-method-certificatestorage-class) | Exports the certificates in the chosen format. | | [ExportToFile](#exporttofile-method-certificatestorage-class) | Exports the certificates to a file. | | [ExportToStream](#exporttostream-method-certificatestorage-class) | Exports the certificate to a stream. | | [GetStorageProperty](#getstorageproperty-method-certificatestorage-class) | Returns the value of a custom certificate storage property. | | [ImportBytes](#importbytes-method-certificatestorage-class) | Imports a certificate. | | [ImportFromFile](#importfromfile-method-certificatestorage-class) | Loads a certificate from a file. | | [ImportFromStream](#importfromstream-method-certificatestorage-class) | Loads a certificate from a stream. | | [ImportPinned](#importpinned-method-certificatestorage-class) | Adds the pinned certificate to the storage. | | [ListStores](#liststores-method-certificatestorage-class) | Returns a list of individual stores available within the storage. | | [Login](#login-method-certificatestorage-class) | Signs in to a session or elevates the session rights. | | [Logout](#logout-method-certificatestorage-class) | Signs out of an opened session. | | [Open](#open-method-certificatestorage-class) | Opens existing storage or creates one in memory. | | [Refresh](#refresh-method-certificatestorage-class) | Refreshes all storage keychains. | | [Remove](#remove-method-certificatestorage-class) | Removes a certificate from the storage. | | [RemoveCRL](#removecrl-method-certificatestorage-class) | Removes a CRL from the storage. | | [RemoveOCSP](#removeocsp-method-certificatestorage-class) | Removes an OCSP response from the storage. | | [Reset](#reset-method-certificatestorage-class) | Resets the class settings. | | [Select](#select-method-certificatestorage-class) | Allows the selection of certificates from the system store. | | [SelectChain](#selectchain-method-certificatestorage-class) | Selects a chain of certificates given its index. | | [SetStorageProperty](#setstorageproperty-method-certificatestorage-class) | Sets the value of a custom certificate storage property. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-certificatestorage-class) | Information about errors during certificate loading or saving. | | [Notification](#notification-event-certificatestorage-class) | This event notifies the application about an underlying control flow event. | | [PasswordNeeded](#passwordneeded-event-certificatestorage-class) | This event is fired when a decryption password is needed. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthAttempts](#AuthAttempts) | The number of auth/login attempts to try. | | [CertValidationTimes\[i\]](#CertValidationTimes[i]) | . | | [CertValidities\[i\]](#CertValidities[i]) | . | | [CertValidityReasons\[i\]](#CertValidityReasons[i]) | . | | [ContainerName](#ContainerName) | Specifies the key container name for the imported certificate. | | [FriendlyName](#FriendlyName) | Gets or sets the certificate friendly name. | | [KeyExportable](#KeyExportable) | Specifies the Exportable setting for the imported key. | | [KeyProtected](#KeyProtected) | Specifies the Protected setting for the imported key. | | [PfxAlgorithm](#PfxAlgorithm) | Sets the PFX encryption algorithm. | | [PKCS11ActiveSlot](#PKCS11ActiveSlot) | The index of the slot that the class is working with. | | [PKCS11EnforceProtectedPath](#PKCS11EnforceProtectedPath) | Enforces the Protected Authentication Path mechanism to be used. | | [PKCS11Label](#PKCS11Label) | Returns the HSM label. | | [PKCS11Login](#PKCS11Login) | Gets or sets the current PKCS#11 login type. | | [PKCS11NewPIN](#PKCS11NewPIN) | Changes the current user's PIN. | | [PKCS11NewUserPIN](#PKCS11NewUserPIN) | Registers a new user PIN. | | [PKCS11PIN](#PKCS11PIN) | Sets the operation PIN. | | [PKCS11ProviderDescription](#PKCS11ProviderDescription) | Returns the description of the currently loaded PKCS#11 provider. | | [PKCS11ProviderManufacturer](#PKCS11ProviderManufacturer) | Returns the manufacturer of the currently loaded PKCS#11 provider. | | [PKCS11ProviderVersion](#PKCS11ProviderVersion) | Returns the version of the provider library. | | [PKCS11Slot](#PKCS11Slot) | Controls the number of a PKCS#11 slot to be opened. | | [PKCS11SlotCount](#PKCS11SlotCount) | The number of slots exposed in the storage. | | [PKCS11SlotDescription\[i\]](#PKCS11SlotDescription[i]) | A human-readable description of the slot. | | [PKCS11SlotLoggedIn\[i\]](#PKCS11SlotLoggedIn[i]) | Whether slot i has an active session associated with it. | | [PKCS11SlotLoginRequired\[i\]](#PKCS11SlotLoginRequired[i]) | Specifies whether the token expects the user to sign in. | | [PKCS11SlotPinNeeded\[i\]](#PKCS11SlotPinNeeded[i]) | Whether slot i requires you to provide a PIN to log in or sign. | | [PKCS11SlotReadOnly\[i\]](#PKCS11SlotReadOnly[i]) | Whether slot i only supports read-only access. | | [PKCS11SlotTokenFlags\[i\]](#PKCS11SlotTokenFlags[i]) | The capabilities flags of the inserted token. | | [PKCS11SlotTokenLabel\[i\]](#PKCS11SlotTokenLabel[i]) | The label assigned to the token. | | [PKCS11SlotTokenModel\[i\]](#PKCS11SlotTokenModel[i]) | The token model. | | [PKCS11SlotTokenPresent\[i\]](#PKCS11SlotTokenPresent[i]) | Indicates whether there is a token in the slot. | | [PKCS11SlotTokenSerial\[i\]](#PKCS11SlotTokenSerial[i]) | The serial number of the token. | | [PKCS11SlotTokenVendorID\[i\]](#PKCS11SlotTokenVendorID[i]) | The manufacturer ID of the inserted token. | | [PKCS11SlotVendorID\[i\]](#PKCS11SlotVendorID[i]) | Returns the manufacturer ID of the slot. | | [PKCS11TextEncodingMode](#PKCS11TextEncodingMode) | The encoding mode to apply to non-ASCII text strings. | | [StoreName](#StoreName) | Specifies the name of the system store to import the certificate to. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # Certificates Property ([CertificateStorage](#certificatestorage-class) Class) A collection of certificates contained in the storage. ## Syntax ```text SecureBlackboxList* GetCertificates(); ``` ## Remarks Use this property to access all certificates contained in the opened storage. This property is read-only and not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # CRLs Property ([CertificateStorage](#certificatestorage-class) Class) A collection of CRLs contained in the storage. ## Syntax ```text SecureBlackboxList* GetCRLs(); ``` ## Remarks Use this property to access all CRLs contained in the opened storage. This property is read-only and not available at design time. ## Data Type [SecureBlackboxCRL](#crl-type) # FIPSMode Property ([CertificateStorage](#certificatestorage-class) Class) Reserved. ## Syntax ```text ANSI (Cross Platform) int GetFIPSMode();int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode); ``` ## Default Value FALSE ## Remarks This property is reserved for future use. ## Data Type Boolean # OCSPs Property ([CertificateStorage](#certificatestorage-class) Class) A collection of OCSP responses contained in the storage. ## Syntax ```text SecureBlackboxList* GetOCSPs(); ``` ## Remarks Use this property to access all OCSP responses contained in the opened storage. This property is read-only and not available at design time. ## Data Type [SecureBlackboxOCSPResponse](#ocspresponse-type) # Opened Property ([CertificateStorage](#certificatestorage-class) Class) Indicates whether the storage is in the open state. ## Syntax ```text ANSI (Cross Platform) int GetOpened(); Unicode (Windows) BOOL GetOpened(); ``` ## Default Value FALSE ## Remarks Use this property to check if the storage has been 'opened.' Different kinds of certificate storages imply different meanings for 'being opened', but generally a storage is open if it is available for operations. Use [Open](#open-method-certificatestorage-class) method to open a storage. This property is read-only and not available at design time. ## Data Type Boolean # PinnedCert Property ([CertificateStorage](#certificatestorage-class) Class) A pinned certificate. ## Syntax ```text SecureBlackboxCertificate* GetPinnedCert(); int SetPinnedCert(SecureBlackboxCertificate* val); ``` ## Remarks Use this property to pin a certificate before adding it to the storage with [ImportPinned](#importpinned-method-certificatestorage-class) method. This property is not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # PinnedCRL Property ([CertificateStorage](#certificatestorage-class) Class) A pinned CRL object. ## Syntax ```text SecureBlackboxCRL* GetPinnedCRL(); int SetPinnedCRL(SecureBlackboxCRL* val); ``` ## Remarks Use this property to pin a CRL before adding it to the storage with [ImportPinned](#importpinned-method-certificatestorage-class) method. This property is not available at design time. ## Data Type [SecureBlackboxCRL](#crl-type) # PinnedOCSP Property ([CertificateStorage](#certificatestorage-class) Class) A pinned OCSP response object. ## Syntax ```text SecureBlackboxOCSPResponse* GetPinnedOCSP(); int SetPinnedOCSP(SecureBlackboxOCSPResponse* val); ``` ## Remarks Use this property to pin an OCSP response before adding it to the storage with [ImportPinned](#importpinned-method-certificatestorage-class) method. This property is not available at design time. ## Data Type [SecureBlackboxOCSPResponse](#ocspresponse-type) # SelectedCertificates Property ([CertificateStorage](#certificatestorage-class) Class) A collection of selected certificates. ## Syntax ```text SecureBlackboxList* GetSelectedCertificates(); ``` ## Remarks This property contains a list of certificates returned by [Select](#select-method-certificatestorage-class) or [SelectChain](#selectchain-method-certificatestorage-class) method. This property is read-only and not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # StorageID Property ([CertificateStorage](#certificatestorage-class) Class) A unique identifier of this storage. ## Syntax ```text ANSI (Cross Platform) char* GetStorageID(); Unicode (Windows) LPWSTR GetStorageID(); ``` ## Default Value "" ## Remarks Use this property to get a unique ID of this storage. The format of ID may differ for different kinds of certificate storages, and may range from a file path for a file storage, to a URI-like ID for a PKCS#11 storage, to an empty value for an in-memory storage. This property is read-only. ## Data Type String # StorageLocation Property ([CertificateStorage](#certificatestorage-class) Class) Specifies the location of the currently opened storage. ## Syntax ```text ANSI (Cross Platform) char* GetStorageLocation(); Unicode (Windows) LPWSTR GetStorageLocation(); ``` ## Default Value "" ## Remarks Use this property to get the location of the active storage. The location indicates the nature of the storage and can be assigned with one of the below values (more values may be added in future): | | | | | --- | --- | --- | | cslUnspecified | unspecified | | | cslMemory | memory | in-memory storage | | cslFile | file | file storage | | cslSystem | system | OS-specific certificate storage (e.g. CryptoAPI) | | cslPKCS11 | pkcs11 | PKCS#11 compatible device | | cslKMIP | kmip | | | cslApple | apple | Apple certificates storage (macOS and iOS only) | | cslJava | java | java key storage | This property is read-only. ## Data Type String # Clear Method ([CertificateStorage](#certificatestorage-class) Class) Removes all certificates from the storage. ## Syntax ```text ANSI (Cross Platform) int Clear(); Unicode (Windows) INT Clear(); ``` ## Remarks Use this method to empty the storage. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Close Method ([CertificateStorage](#certificatestorage-class) Class) Closes the certificate storage. ## Syntax ```text ANSI (Cross Platform) int Close(int bSave); Unicode (Windows) INT Close(BOOL bSave); ``` ## Remarks Use this method to close the storage component and clean up any resources associated with it. This method releases all memory objects and handles associated with the certificates contained in the storage. Any certificate objects originating from the storage become invalid as soon as the storage is closed, and should not be used. *Save* parameter only applies to certain types of stores, such as file stores. Set it to True to commit any changes to the underlying media. Note that PKCS#11 and Win32 storage types are of transactional nature and commit any changes immediately, so the value of the *Save* parameter does not make any difference with them. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Config Method ([CertificateStorage](#certificatestorage-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-certificatestorage-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-certificatestorage-class), you must call *Config("PROPERTY")*. The value will be returned as a string. ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # CreateNew Method ([CertificateStorage](#certificatestorage-class) Class) Creates a new storage. ## Syntax ```text ANSI (Cross Platform) int CreateNew(const char* lpszStorageLocation, const char* lpszStorageID); Unicode (Windows) INT CreateNew(LPCWSTR lpszStorageLocation, LPCWSTR lpszStorageID); ``` ## Remarks Use this method to create new certificate storage. *StorageLocation* specifies where the new storage should be created, and *StorageID* contains a unique storage identifier. | | | | | --- | --- | --- | | cslUnspecified | unspecified | | | cslMemory | memory | in-memory storage | | cslFile | file | file storage | | cslSystem | system | OS-specific certificate storage (e.g. CryptoAPI) | | cslPKCS11 | pkcs11 | PKCS#11 compatible device | | cslKMIP | kmip | | | cslApple | apple | Apple certificates storage (macOS and iOS only) | | cslJava | java | java key storage | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # DoAction Method ([CertificateStorage](#certificatestorage-class) Class) Performs an additional action. ## Syntax ```text ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams); ``` ## Remarks DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # ExportBytes Method ([CertificateStorage](#certificatestorage-class) Class) Exports the certificates in the chosen format. ## Syntax ```text ANSI (Cross Platform) char* ExportBytes(int iWhat, int iFormat, const char* lpszPassword, int *lpSize = NULL); Unicode (Windows) LPSTR ExportBytes(INT iWhat, INT iFormat, LPCWSTR lpszPassword, LPINT lpSize = NULL); ``` ## Remarks Use this method to save the certificates or other objects contained in the storage in one of the formats defined below. Pass the encryption password via the *Password* parameter if needed. | | | | | --- | --- | --- | | cfmUnknown | 0 | Unknown certificate format | | cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported | | cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. | | cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. | | cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. | | cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. | | cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. | | cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. | Use *What* parameter to limit the kind of objects to export. Passing *cekUnknown* (0) as *What* tells the component to export all the objects. | | | | | --- | --- | --- | | cekUnknown | 0 | Unknown or unsupported element type | | cekCertificate | 1 | An X.509 certificate | | cekCRL | 2 | A CRL | | cekOCSP | 3 | An OCSP response | Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates. ## Error Handling (C++) This method returns a Byte Array value (with length *lpSize*); after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # ExportToFile Method ([CertificateStorage](#certificatestorage-class) Class) Exports the certificates to a file. ## Syntax ```text ANSI (Cross Platform) int ExportToFile(int iWhat, const char* lpszFileName, int iFormat, const char* lpszPassword); Unicode (Windows) INT ExportToFile(INT iWhat, LPCWSTR lpszFileName, INT iFormat, LPCWSTR lpszPassword); ``` ## Remarks Use this method to save the certificates or other objects contained in the storage to a file in one of the formats given below. Pass the encryption password via the *Password* parameter. | | | | | --- | --- | --- | | cfmUnknown | 0 | Unknown certificate format | | cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported | | cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. | | cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. | | cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. | | cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. | | cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. | | cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. | Use *What* parameter to limit the kind of objects to export. Passing *cekUnknown* (0) as *What* tells the component to export all the objects. | | | | | --- | --- | --- | | cekUnknown | 0 | Unknown or unsupported element type | | cekCertificate | 1 | An X.509 certificate | | cekCRL | 2 | A CRL | | cekOCSP | 3 | An OCSP response | Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ExportToStream Method ([CertificateStorage](#certificatestorage-class) Class) Exports the certificate to a stream. ## Syntax ```text ANSI (Cross Platform) int ExportToStream(int iWhat, SecureBlackboxStream* sCertStream, int iFormat, const char* lpszPassword); Unicode (Windows) INT ExportToStream(INT iWhat, SecureBlackboxStream* sCertStream, INT iFormat, LPCWSTR lpszPassword); ``` ## Remarks Use this method to save the certificate or other objects contained in the storage to a stream in one of the formats given below. Pass the encryption password via the *Password* parameter. | | | | | --- | --- | --- | | cfmUnknown | 0 | Unknown certificate format | | cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported | | cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. | | cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. | | cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. | | cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. | | cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. | | cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. | Use *What* parameter to limit the kind of objects to export. Passing *cekUnknown* (0) as *What* tells the component to export all the objects. | | | | | --- | --- | --- | | cekUnknown | 0 | Unknown or unsupported element type | | cekCertificate | 1 | An X.509 certificate | | cekCRL | 2 | A CRL | | cekOCSP | 3 | An OCSP response | Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # GetStorageProperty Method ([CertificateStorage](#certificatestorage-class) Class) Returns the value of a custom certificate storage property. ## Syntax ```text ANSI (Cross Platform) char* GetStorageProperty(const char* lpszName); Unicode (Windows) LPWSTR GetStorageProperty(LPCWSTR lpszName); ``` ## Remarks This method, together with [SetStorageProperty](#setstorageproperty-method-certificatestorage-class), provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios. The following certificate storage properties can be read using this method: | | | | --- | --- | | PKCS11SlotCount | Returns the number of slots available in an opened PKCS#11 storage. | | PKCS11ActiveSlot | Returns the index of the PKCS#11 slot that is currently being accessed. | | PKCS11PIN | The PIN for the storage and/or operation, previously set with [SetStorageProperty](#setstorageproperty-method-certificatestorage-class) call. | | PKCS11TextEncodingMode | The string encoding mode to apply to the PIN when passing it to C_Login() method. This can be changed by passing the relevant setting to [SetStorageProperty](#setstorageproperty-method-certificatestorage-class). | | PKCS11Slot | The slot number to open, set previously with [SetStorageProperty](#setstorageproperty-method-certificatestorage-class). | | PKCS11Login | The user account to sign in with, set previously with [SetStorageProperty](#setstorageproperty-method-certificatestorage-class) | | PKCS11SlotLoggedIn[i] | Returns true if there is an active session associated with slot number i. | | PKCS11SlotPinNeeded[i] | Returns true if you need to provide a PIN to sign in to the session for slot i. | | PKCS11SlotReadOnly[i] | Returns the availability of the slot for write operations. | | PKCS11SlotVendorID[i] | Returns the manufacturer name associated with the slot. | | PKCS11SlotDescription[i] | A human-readable description of the slot. | | PKCS11SlotTokenPresent[i] | Indicates whether there is a token in the slot. | | PKCS11SlotTokenVendorID[i] | The manufacturer ID of the inserted token. | | PKCS11SlotTokenLabel[i] | The label assigned to the token. | | PKCS11SlotTokenModel[i] | The token model. | | PKCS11SlotTokenSerial[i] | The serial number of the token. | | PKCS11SlotTokenFlags[i] | The value of the PKCS#11 token flags parameter. | ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # ImportBytes Method ([CertificateStorage](#certificatestorage-class) Class) Imports a certificate. ## Syntax ```text ANSI (Cross Platform) int ImportBytes(const char* lpCertBytes, int lenCertBytes, const char* lpszPassword, int bClear); Unicode (Windows) INT ImportBytes(LPCSTR lpCertBytes, INT lenCertBytes, LPCWSTR lpszPassword, BOOL bClear); ``` ## Remarks Use this method to load a certificate or certificates from a byte array. Provide the password via the *Password* parameter. The *Password* parameter is optional. If it is omitted and it is later discovered that the certificate is password-encrypted, the [PasswordNeeded](#passwordneeded-event-certificatestorage-class) event will be fired to request it. This method supports certificates in DER, PEM, PFX, and SPC formats. Multi-certificate blobs certificate files are supported. Use the *Clear* parameter to tell the component whether it should empty the storage before importing the new certificates. Hint: use this method with *Clear* set to false to mimic the behavior of the previous version's Add() method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ImportFromFile Method ([CertificateStorage](#certificatestorage-class) Class) Loads a certificate from a file. ## Syntax ```text ANSI (Cross Platform) int ImportFromFile(const char* lpszPath, const char* lpszPassword, int bClear); Unicode (Windows) INT ImportFromFile(LPCWSTR lpszPath, LPCWSTR lpszPassword, BOOL bClear); ``` ## Remarks This method can load certificates saved in a file in one of the following formats: DER, PEM, PFX, SPC. Use the *Path* parameter to provide a path to the certificate file, and *Password* to specify the password. The *Password* parameter is optional. If it is omitted and it is later discovered that the certificate is password-encrypted, the [PasswordNeeded](#passwordneeded-event-certificatestorage-class) event will be fired to request it. This method supports certificates in DER, PEM, PFX, and SPC formats. Multi-certificate blobs certificate files are supported. Use the *Clear* parameter to tell the component whether it should empty the storage before importing the new certificates. Hint: use this method with *Clear* set to false to mimic the behavior of the previous version's AddFromFile() method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ImportFromStream Method ([CertificateStorage](#certificatestorage-class) Class) Loads a certificate from a stream. ## Syntax ```text ANSI (Cross Platform) int ImportFromStream(SecureBlackboxStream* sCertStream, const char* lpszPassword, int bClear); Unicode (Windows) INT ImportFromStream(SecureBlackboxStream* sCertStream, LPCWSTR lpszPassword, BOOL bClear); ``` ## Remarks This method can load certificates saved in one of the following formats: DER, PEM, PFX, SPC. Use the *CertStream* parameter to provide a stream containing the certificate data, and *Password* to specify the password. The *Password* parameter is optional. If it is omitted and it is later discovered that the certificate is password-encrypted, the [PasswordNeeded](#passwordneeded-event-certificatestorage-class) event will be fired to request it. This method supports certificates in DER, PEM, PFX, and SPC formats. Multi-certificate blobs certificate files are supported. Use the *Clear* parameter to tell the component whether it should empty the storage before importing the new certificates. Hint: use this method with *Clear* set to false to mimic the behavior of the previous version's AddFromStream() method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ImportPinned Method ([CertificateStorage](#certificatestorage-class) Class) Adds the pinned certificate to the storage. ## Syntax ```text ANSI (Cross Platform) int ImportPinned(int bClear); Unicode (Windows) INT ImportPinned(BOOL bClear); ``` ## Remarks This method adds a certificate attached to the [PinnedCert](#pinnedcert-property-certificatestorage-class) property into the storage. This method is a handy way of adding certificates generated/returned by other components. Use the *Clear* parameter to tell the component whether it should empty the storage before importing the new certificate. Hint: use this method with *Clear* set to false to mimic the behavior of the previous version's AddPinned() method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ListStores Method ([CertificateStorage](#certificatestorage-class) Class) Returns a list of individual stores available within the storage. ## Syntax ```text ANSI (Cross Platform) char* ListStores(); Unicode (Windows) LPWSTR ListStores(); ``` ## Remarks Use this method to query a list of individual stores available in the opened storage. The contents of the list depends on the type of the store used and the parameters it is opened with. For system (CryptoAPI) stores the method returns a list of available system stores for the chosen access type, as returned by Windows (e.g. MY, ADDRESSBOOK, CA). For PKCS#11 stores the method returns a list of slot descriptions for all slots published by the driver. The store names are separated from each other with a CRLF sequence. ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # Login Method ([CertificateStorage](#certificatestorage-class) Class) Signs in to a session or elevates the session rights. ## Syntax ```text ANSI (Cross Platform) int Login(int iSessionType, const char* lpszPin, int bReadOnly); Unicode (Windows) INT Login(INT iSessionType, LPCWSTR lpszPin, BOOL bReadOnly); ``` ## Remarks Use this method to sign in to a session with a required access type. Note that in some cases you may call this method more than one time for a specific session to elevate your access rights, for example: ```text // open an unauthenticated session storage.Login(stUnauthenticated, "", false); // elevate the access rights for the session storage.Login(stUser, "password", false); ``` Sessions are currently supported for PKCS#11 storage types only. | | | | | --- | --- | --- | | stUnauthenticated | 0 | | | stUser | 1 | | | stAdministrator | 2 | | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Logout Method ([CertificateStorage](#certificatestorage-class) Class) Signs out of an opened session. ## Syntax ```text ANSI (Cross Platform) int Logout(int bCloseSesion); Unicode (Windows) INT Logout(BOOL bCloseSesion); ``` ## Remarks Use this method to sign out of a session. Pass true to *CloseSession* to shut the session down altogether. This method is currently support for PKCS#11 storage type only. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Open Method ([CertificateStorage](#certificatestorage-class) Class) Opens existing storage or creates one in memory. ## Syntax ```text ANSI (Cross Platform) int Open(const char* lpszStorageID); Unicode (Windows) INT Open(LPCWSTR lpszStorageID); ``` ## Remarks Use this method to open the storage with the given *StorageID*. Certificate storages can come from several different locations, detailed below. **Memory** A storage can be created in memory by passing an empty string (""). **File** A storage can be opened from a file using one of two syntaxes: - *C:\Certs\certs.pem* - *file://C:/Certs/certs.pem* **Windows System** A storage can be opened from the Windows System using this syntax: *system://{user}@{host}/?{params}* *user* is one of these values: - currentuser - localmachine - currentservice *host* is either "localhost", an IP address, or FQDN. *params* are chosen from this list: - store (required), is the name of the Windows store to access (e.g. "MY") - readonly, whether to access the store with only read permissions. Use 0 for false, and 1 for true. Example: *system://currentuser@localhost/?store=MY&readonly=1* **PKCS#11 Device** A storage can be opened from a PKCS#11 device using this syntax: *pkcs11://{user}:{pin}@/{driverpath}?{params}* *user* is the username used to access the device; typically it's either "user" or "admin". *pin* is the pin code used to access the device. *driverpath* is the path to the driver used to access the device. *params* are chosen from this list: - *slot*, the token slot to access on the device. If not provided, one will be chosen automatically. If set to -1, no session will be opened. - *readonly*, whether to access the device with only read permissions. Use 0 for false, and 1 for true. - *login*, whether to sign in to the device with a PIN. Use 0 or *no* to avoid signing in, or 1 or *yes* to enforce it. When not specified, the *yes* mode is used. - *slotevt* enables slot event notifications. Set to 'standard' or 'true' to enable native PKCS#11 notifications, or to 'synchronous' to enable polling-based notifications for drivers that do not support native notifications. Set to 'false' to disable notifications. The following parameters can be used to tweak the low-level behaviour of the component and may be handy when overcoming compatibility issues with certain drivers: - *singlethreaded* allows to use or enforce the simplest, thread-agnostic access mode when working with the driver. Setting this to 1 (try) or 2 (enforce) may help overcome issues with certain drivers. - *accessmode* allows to choose the compatibility mode ('full' or 'compatible'). - *importfirst* specifies which object is created first when importing a new certificate. The options are: key, cert, pubkey. - *ptrsize*, *intsize*, *alignment* allow to provide the details of the system architecture manually. - *slotevtinterval* specifies the polling interval for polling-based notifications. The default is 1000 (one second). - *slotevtsync* (Delphi only) when set to true tells the component to align all the slot events with the main thread through a Synchronize() envelope. Example: *pkcs11://user:1234@/c:/windows/system32/asepkcs.dll?slot=0&readonly=1* **macOS** A keychain can be opened on macOS using this syntax: *macos://:{password}@/{keychain}?{params}* This is the right way to perform cryptographic operations using private keys, including non-exportable private keys. By now, only certificates with RSA keys are supported, other certificates are not listed and are not used. *keychain* is the path to a keychain file. If no keychain specified, the default keychain is opened. *password* is the keychain access password. If no password is provided, it will be asked by macOS UI if necessary. To access a keychain in readonly mode, no password is needed usually. *params* are chosen from this list: - *readonly*, whether to access the keychain with only read permissions. Use 0 for false, and 1 for true. Example: *macos://:f00Keys@/Users/test/Documents/test.keychain?readonly=0* **iOS** A keychain can be opened on iOS using this syntax: *ios:///?{params}* iOS doesn't support keychains located in files. By now, only certificates with RSA keys are supported, other certificates are not listed and are not used. *params* are chosen from this list: - *readonly*, whether to access the keychain with only read permissions. Use 0 for false, and 1 for true. Example: *ios:///?readonly=1* **KMIP Server** A storage can be opened from a KMIP server using this syntax: *mailto:{password}@{remotehost}:{remoteport}/?{params}* *password* is the password use to authenticate to the server. *remotehost* is the FQDN to the server. *remoteport* is the server port to connect to. *params* are chosen from this list: - encoder, the message encoding used to communicate with the server. Possible values are: - 1 (XML) - 2 (JSON) - 3 (TTLV) Example: *mailto:password@kmip.website.com:5696/?encoder=1* **Apple** A storage can be opened on macOS using this syntax: *apple:///{path}/?{params}* This is a legacy way to work with keychains on macOS and iOS. *path* is the path for storage file. *params* are chosen from this list: - keychainindex, key chain index. If not provided, one will be set to 0. - readonly, whether to access the storage with only read permissions. Use 0 for false, and 1 for true. Example: *apple:///Users/test/Documents/test.storage?readonly=1* A storage can be opened on iOS using this syntax: *apple:///?{params}* *params* are chosen from this list: - readonly, whether to access the storage with only read permissions. Use 0 for false, and 1 for true. Example: *apple:///?readonly=1* In Xamarin projects for iOS keychain support should be enabled manually. To do this: 1. Double click on Entitlements.plist file, go to "Entitlements" tab and turn "Enable Keychain" option on. 2. Go to project options, select "iOS Bundle Signing", choose correct configuration and platform and set "Custom Entitlements" to "Entitlements.plist" value. **Azure Key Vault** A storage can be opened from the Azure Key Vault service using this syntax: *vault://{clientid}:{clientsecret}@{vaultname}.{vaulthost}/* *clientid* is the client id obtained from Azure Portal when registering an app. *clientsecret* is the client secret obtained from Azure Portal when registering an app. *vaultname* is the name of the vault to connect to. *vaulthost* is the Cloud environment where the vault is located; supported environments are: | | | | --- | --- | | Cloud environment | vaulthost | | Azure Cloud | vault.azure.net | | Azure China Cloud | vault.azure.cn | | Azure US Government | vault.usgovcloudapi.net | | Azure German Cloud | vault.microsoftazure.de | Example: *vault://xxxx:yyyy@myvault.vault.azure.net/* **Environment Storages** An environment storage can be opened using this syntax: *env:///?{store}* *store* is one of these values: - trusted - known - blocked To enable usage of those environment storages use UseEnvStorages configuration setting. Example: *env:///?store=trusted* ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Refresh Method ([CertificateStorage](#certificatestorage-class) Class) Refreshes all storage keychains. ## Syntax ```text ANSI (Cross Platform) int Refresh(); Unicode (Windows) INT Refresh(); ``` ## Remarks Call this method to refresh the storage. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Remove Method ([CertificateStorage](#certificatestorage-class) Class) Removes a certificate from the storage. ## Syntax ```text ANSI (Cross Platform) int Remove(int iIndex); Unicode (Windows) INT Remove(INT iIndex); ``` ## Remarks Use this method to remove the certificate from the storage given its index. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # RemoveCRL Method ([CertificateStorage](#certificatestorage-class) Class) Removes a CRL from the storage. ## Syntax ```text ANSI (Cross Platform) int RemoveCRL(int iIndex); Unicode (Windows) INT RemoveCRL(INT iIndex); ``` ## Remarks Use this method to remove a CRL from the storage given its index. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # RemoveOCSP Method ([CertificateStorage](#certificatestorage-class) Class) Removes an OCSP response from the storage. ## Syntax ```text ANSI (Cross Platform) int RemoveOCSP(int iIndex); Unicode (Windows) INT RemoveOCSP(INT iIndex); ``` ## Remarks Use this method to remove an OCSP response from the storage given its index. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Reset Method ([CertificateStorage](#certificatestorage-class) Class) Resets the class settings. ## Syntax ```text ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset(); ``` ## Remarks Reset is a generic method available in every class. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Select Method ([CertificateStorage](#certificatestorage-class) Class) Allows the selection of certificates from the system store. ## Syntax ```text ANSI (Cross Platform) int Select(const char* lpszFilter, int bPrivateKeyNeeded, int iMaxCount); Unicode (Windows) INT Select(LPCWSTR lpszFilter, BOOL bPrivateKeyNeeded, INT iMaxCount); ``` ## Remarks This function allows the user to select certificates from the system store by *Filter* and save them to [SelectedCertificates](#selectedcertificates-property-certificatestorage-class). *PrivateKeyNeeded* specifies whether the method only should consider certificates having associated private keys. *MaxCount* limits the number of certificates selected. The supported filters are listed below. Split the name and value of a specific filter with colon (:). Use | separator to pass more than one filter. During the search, the filters are joined using OR logic. - **subjectkeyid**: the subject key identifier, in hexadecimal format. - **cakeyid**: the key identifier of the issuing certificate, in hexadecimal format. - **serialnumber**: the serial number of the certificate, in hexadecimal format. - **keyusage**: certificate key usage flags. Use bitwise OR to specify several key usage flags using the values shown below. - **fingerprint**: certificate fingerprint in hexadecimal format. MD5, SHA1, SHA256, and SHA512 fingerprints are supported. - **email**: the e-mail parameter of the certificate subject. - **subject**: the subject of the certificate, either as an RDN, or as its common name parameter. - **issuer**: the issuer of the certificate, either as an RDN or a common name. - **ui** (Windows system stores only): whether to use UI dialog to select a certificate. Supported values: true, false, 1, 0. All other filters are ignored if this filter is specified. - ***** (asterisk): selects all certificates. This filter should always be used as a single character, not as a name:value pair. **Examples of filters** ui:1 - use Windows certificate selection dialog to let the user select a certificate visually. * - select all certificates. email:user@server.com - select all certificates with subject RDNs containing this e-mail address. fingerprint:0a1b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d - select all certificates with this SHA1 fingerprint. subject:/C=US/O=Big Company Inc/CN=Signing Certificate - select all certificates with the specified subject RDN. keyusage:3|email:user@server.com - select all certificates with key usages of Digital Signature or Non-Repudiation, or those having this e-mail address in their subject. **Key usage flags** | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # SelectChain Method ([CertificateStorage](#certificatestorage-class) Class) Selects a chain of certificates given its index. ## Syntax ```text ANSI (Cross Platform) int SelectChain(int iIndex); Unicode (Windows) INT SelectChain(INT iIndex); ``` ## Remarks Use this method to select a certificate chain given its index. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # SetStorageProperty Method ([CertificateStorage](#certificatestorage-class) Class) Sets the value of a custom certificate storage property. ## Syntax ```text ANSI (Cross Platform) int SetStorageProperty(const char* lpszName, const char* lpszValue); Unicode (Windows) INT SetStorageProperty(LPCWSTR lpszName, LPCWSTR lpszValue); ``` ## Remarks This method, together with [GetStorageProperty](#getstorageproperty-method-certificatestorage-class), provides an extensible way of managing the certificate storage's settings that are not available through the primary properties of the component. The list of settings may be extended in future, in response to emergence of new storage variants and recognition of non-obvious storage usage scenarios. The following certificate storage properties can be read using this method: | | | | --- | --- | | PKCS11PIN | Use this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage. | | PKCS11NewUserPIN | Setting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session. | | PKCS11NewPIN | Setting this property will change the current users' PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts. | | PKCS11TextEncodingMode | The string encoding mode to apply to the PIN when passing it to C_Login() method. This can be changed by passing the relevant setting to SetStorageProperty. | | PKCS11Slot | Specifies the slot number to open, from 0 to (PKCS11SlotCount - 1). Use the 'auto' value to let the component pick the slot automatically, or -1 to stop the component from opening any slots. | | PKCS11Login | Provides a PKCS#11 user ID to sign in with. The following options are available: 'user' (normal user), 'so' (security officer), or 'no' (do not sign in). | ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Error Event ([CertificateStorage](#certificatestorage-class) Class) Information about errors during certificate loading or saving. ## Syntax ```text ANSI (Cross Platform) virtual int FireError(CertificateStorageErrorEventParams *e); typedef struct { int ErrorCode; const char *Description; int reserved; } CertificateStorageErrorEventParams; Unicode (Windows) virtual INT FireError(CertificateStorageErrorEventParams *e); typedef struct { INT ErrorCode; LPCWSTR Description; INT reserved; } CertificateStorageErrorEventParams; ``` ## Remarks Reports exceptional conditions during certificate loading or exporting. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # Notification Event ([CertificateStorage](#certificatestorage-class) Class) This event notifies the application about an underlying control flow event. ## Syntax ```text ANSI (Cross Platform) virtual int FireNotification(CertificateStorageNotificationEventParams *e); typedef struct { const char *EventID; const char *EventParam; int reserved; } CertificateStorageNotificationEventParams; Unicode (Windows) virtual INT FireNotification(CertificateStorageNotificationEventParams *e); typedef struct { LPCWSTR EventID; LPCWSTR EventParam; INT reserved; } CertificateStorageNotificationEventParams; ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. This class can fire this event with the following *EventID* values: | | | | --- | --- | | PKCS11BeforeLoadDriver | Fires before the driver DLL is loaded. | | PKCS11BeforeLogin | Fires before the C_Login() function is called. | | PKCS11BeforeOpenSession | Fires before C_OpenSession() is called. | | PKCS11DriverLoaded | Reports that the driver has been successfully loaded. | | PKCS11LoggedIn | Notifies about successful sign-in. | | PKCS11LoginError | Notifies about a sign-in issue. | | PKCS11SessionOpened | Notifies the application that the session has been opened. | | PKCS11SlotEvent | Notifies the application about a slot event (insertion / removal) that has occurred. The parameters provide the details of the slot and token, if available. | # PasswordNeeded Event ([CertificateStorage](#certificatestorage-class) Class) This event is fired when a decryption password is needed. ## Syntax ```text ANSI (Cross Platform) virtual int FirePasswordNeeded(CertificateStoragePasswordNeededEventParams *e); typedef struct { const char *NeededFor; char *Password; int Cancel; int reserved; } CertificateStoragePasswordNeededEventParams; Unicode (Windows) virtual INT FirePasswordNeeded(CertificateStoragePasswordNeededEventParams *e); typedef struct { LPCWSTR NeededFor; LPWSTR Password; BOOL Cancel; INT reserved; } CertificateStoragePasswordNeededEventParams; ``` ## Remarks The class fires this event when a password is needed to decrypt a certificate or a private key. In the handler of this event, assign the password to the *Password* parameter, or set *Cancel* to true to abort the operation. The *NeededFor* parameter identifies the certificate for which the password is requested. # Certificate Type Encapsulates an individual X.509 certificate. ## Syntax *SecureBlackboxCertificate* (declared in *secureblackbox.h*) ## Remarks This type keeps and provides access to X.509 certificate details. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [Handle](#Certificate_f_Handle) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **Bytes** *char* (read-only)* *Default Value: * Returns the raw certificate data in DER format. **CA** *int* *Default Value: FALSE* Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this field when generating a new certificate to have its Basic Constraints extension generated automatically. **CAKeyID** *char* (read-only)* *Default Value: * A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **CertType** *int (read-only)* *Default Value: 0* Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects. **CRLDistributionPoints** *char** *Default Value: ""* Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **Curve** *char** *Default Value: ""* Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | **Fingerprint** *char* (read-only)* *Default Value: ""* Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. **FriendlyName** *char* (read-only)* *Default Value: ""* Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. **Handle** *int64* *Default Value: 0* Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` **HashAlgorithm** *char** *Default Value: ""* Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigAlgorithm](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **Issuer** *char* (read-only)* *Default Value: ""* The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN). **IssuerRDN** *char** *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **KeyAlgorithm** *char** *Default Value: "0"* Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains. **KeyBits** *int (read-only)* *Default Value: 0* Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer. **KeyFingerprint** *char* (read-only)* *Default Value: ""* Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **KeyUsage** *int* *Default Value: 0* Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this field before generating the certificate to propagate the key usage flags to the new certificate. **KeyValid** *int (read-only)* *Default Value: FALSE* Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. **OCSPLocations** *char** *Default Value: ""* Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **OCSPNoCheck** *int* *Default Value: FALSE* Accessor to the value of the certificate's ocsp-no-check extension. **Origin** *int (read-only)* *Default Value: 0* Returns the location that the certificate was taken or loaded from. **PolicyIDs** *char** *Default Value: ""* Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this field when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. **PrivateKeyBytes** *char* (read-only)* *Default Value: * Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. **PrivateKeyExists** *int (read-only)* *Default Value: FALSE* Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. **PrivateKeyExtractable** *int (read-only)* *Default Value: FALSE* Indicates whether the private key is extractable (exportable). **PublicKeyBytes** *char* (read-only)* *Default Value: * Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. **Qualified** *int (read-only)* *Default Value: FALSE* Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. **QualifiedStatements** *int* *Default Value: 0* Returns a simplified qualified status of the certificate. **Qualifiers** *char* (read-only)* *Default Value: ""* A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **SelfSigned** *int (read-only)* *Default Value: FALSE* Indicates whether the certificate is self-signed (root) or signed by an external CA. **SerialNumber** *char** *Default Value: * Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. **SigAlgorithm** *char* (read-only)* *Default Value: ""* Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. **Source** *int (read-only)* *Default Value: 0* Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **Subject** *char* (read-only)* *Default Value: ""* The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [SubjectRDN](#Certificate_f_SubjectRDN). **SubjectAlternativeName** *char** *Default Value: ""* Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. **SubjectKeyID** *char** *Default Value: * Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **SubjectRDN** *char** *Default Value: ""* A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. **Valid** *int (read-only)* *Default Value: FALSE* Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. **ValidFrom** *char** *Default Value: ""* The time point at which the certificate becomes valid, in UTC. **ValidTo** *char** *Default Value: ""* The time point at which the certificate expires, in UTC. ## Constructors ```text Certificate() ``` Creates a new object with default field values. # CRL Type Represents a Certificate Revocation List. ## Syntax *SecureBlackboxCRL* (declared in *secureblackbox.h*) ## Remarks CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons. Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations. Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid. The following fields are available: - [Bytes](#CRL_f_Bytes) - [CAKeyID](#CRL_f_CAKeyID) - [EntryCount](#CRL_f_EntryCount) - [Handle](#CRL_f_Handle) - [Issuer](#CRL_f_Issuer) - [IssuerRDN](#CRL_f_IssuerRDN) - [Location](#CRL_f_Location) - [NextUpdate](#CRL_f_NextUpdate) - [SigAlgorithm](#CRL_f_SigAlgorithm) - [Source](#CRL_f_Source) - [TBS](#CRL_f_TBS) - [ThisUpdate](#CRL_f_ThisUpdate) ## Fields **Bytes** *char* (read-only)* *Default Value: * Returns the raw CRL data in DER format. **CAKeyID** *char** *Default Value: * A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. **EntryCount** *int (read-only)* *Default Value: 0* Returns the number of certificate status entries in the CRL. **Handle** *int64* *Default Value: 0* Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` **Issuer** *char* (read-only)* *Default Value: ""* The common name of the CRL issuer (CA), typically a company name. **IssuerRDN** *char* (read-only)* *Default Value: ""* A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. **Location** *char* (read-only)* *Default Value: ""* The URL that the CRL was downloaded from. **NextUpdate** *char** *Default Value: ""* The planned time and date of the next version of this CRL to be published. **SigAlgorithm** *char** *Default Value: "0"* The public key algorithm that was used by the CA to sign this CRL. **Source** *int (read-only)* *Default Value: 0* Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **TBS** *char* (read-only)* *Default Value: * The to-be-signed part of the CRL (the CRL without the signature part). **ThisUpdate** *char** *Default Value: ""* The date and time at which this version of the CRL was published. ## Constructors ```text CRL() ``` Creates an empty CRL object. # OCSPResponse Type Represents a single OCSP response originating from an OCSP responder. ## Syntax *SecureBlackboxOCSPResponse* (declared in *secureblackbox.h*) ## Remarks OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs). An OCSP response is a snapshot of the certificate status at a given time. The following fields are available: - [Bytes](#OCSPResponse_f_Bytes) - [EntryCount](#OCSPResponse_f_EntryCount) - [Handle](#OCSPResponse_f_Handle) - [Issuer](#OCSPResponse_f_Issuer) - [IssuerRDN](#OCSPResponse_f_IssuerRDN) - [Location](#OCSPResponse_f_Location) - [ProducedAt](#OCSPResponse_f_ProducedAt) - [SigAlgorithm](#OCSPResponse_f_SigAlgorithm) - [Source](#OCSPResponse_f_Source) ## Fields **Bytes** *char* (read-only)* *Default Value: * A buffer containing the raw OCSP response data. **EntryCount** *int (read-only)* *Default Value: 0* The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. **Handle** *int64* *Default Value: 0* Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` **Issuer** *char* (read-only)* *Default Value: ""* Indicates the issuer of this response (a CA or its authorized representative). **IssuerRDN** *char* (read-only)* *Default Value: ""* Indicates the RDN of the issuer of this response (a CA or its authorized representative). **Location** *char* (read-only)* *Default Value: ""* The location of the OCSP responder. **ProducedAt** *char** *Default Value: ""* Specifies the time when the response was produced, in UTC. **SigAlgorithm** *char** *Default Value: "0"* The public key algorithm that was used by the CA to sign this OCSP response. **Source** *int (read-only)* *Default Value: 0* Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Constructors ```text OCSPResponse() ``` Creates an empty OCSP response object. # SecureBlackboxList Type ## Syntax *SecureBlackboxList* (declared in *secureblackbox.h*) ## Remarks *SecureBlackboxList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the CertificateStorage class. ```text int GetCount() {} ``` ```text int SetCount(int count) {} ``` ```text T* Get(int index) {} ``` ```text T* Set(int index, T* value) {} ``` | | | | --- | --- | | Methods | | | GetCount | This method returns the current size of the collection. | | SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. | | Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. | | Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. | # SecureBlackboxStream Type ## Syntax *SecureBlackboxStream* (declared in *secureblackbox.h*) ## Remarks The CertificateStorage class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the CertificateStorage class an instance of that concrete class. When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur. ```text bool CanRead() { return true; } ``` ```text bool CanSeek() { return true; } ``` ```text bool CanWrite() { return true; } ``` ```text int64 GetLength() = 0; ``` ```text void Close() {} ``` ```text int Flush() { return 0; } ``` ```text int Read(void* buffer, int count) = 0; ``` ```text int64 Seek(int64 offset, int seekOrigin) = 0; ``` ```text int Write(const void* buffer, int count) = 0; ``` | | | | --- | --- | | Properties | | | CanRead | Whether the stream supports reading. | | CanSeek | Whether the stream supports seeking. | | CanWrite | Whether the stream supports writing. | | Length | Gets the length of the stream, in bytes. | | Methods | | | Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecureBlackboxStream object is deleted. | | Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. | | Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. | | Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. | | Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. | # Config Settings ([CertificateStorage](#certificatestorage-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-certificatestorage-class) method. ### CertificateStorage Config Settings **AuthAttempts**: The number of auth/login attempts to try.Specifies the number of tries to authenticate to the storage (the default is 3). The control will fire PasswordNeeded event after each unsuccessful attempt. Applicable to: PKCS11. **CertValidationTimes[i]**: .Returns the validation moments for every certificate in the store. **CertValidities[i]**: .Returns the validity markers of the certificate objects. **CertValidityReasons[i]**: .Returns the validation details for each of the certificate objects in the store. **ContainerName**: Specifies the key container name for the imported certificate.This setting allows to provide a key container name for the certificate that is to be imported. This is often used when associating CA-provided certificate with a previously generated private key. **FriendlyName**: Gets or sets the certificate friendly name.Use this read-only indexed property to obtain the friendly name of a specific certificate in the storage. **KeyExportable**: Specifies the Exportable setting for the imported key.*KeyExportable* and *KeyProtected* configs allow the application to specify the desired private key protection parameters for certificates imported into a Windows system store. **KeyProtected**: Specifies the Protected setting for the imported key.*KeyExportable* and *KeyProtected* configs allow the application to specify the desired private key protection parameters for certificates imported into a Windows system store. Protected keys invoke a warning UI dialog when accessed. **PfxAlgorithm**: Sets the PFX encryption algorithm.Use this property to adjust the encryption algorithm(s) that will be used when saving the certificate to PFX format. This setting accepts a string containing either one PBE algorithm name (in which case it will be used to encrypt both the certificate and its private key), or two semicolon-separated PBE algorithm names (in which case the first will be used to encrypt the private key, and the second to encrypt the certificate). The following values are supported for either algorithm: - PBES2-PBKDF2-SHA256-AES256 - PBES2-PBKDF2-SHA1-AES256 - PBE-SHA1-RC4-128 - PBE-SHA1-RC4-40 - PBE-SHA1-3DES - PBE-SHA1-RC2-128 - PBE-SHA1-RC2-40 Apart from the above, a special *legacy* alias is supported that maps to PBE-SHA1-3DES when used for the private key part, or to PBE-SHA1-RC2-40 when used for the certificate part. **PKCS11ActiveSlot**: The index of the slot that the component is working with.Returns the index of the PKCS#11 slot that is currently being accessed. **PKCS11EnforceProtectedPath**: Enforces the Protected Authentication Path mechanism to be used.Enables or disables protected authentication path mechanism. When enabled, the device will stick to the built-in authentication mechanism, such as a PIN pad or the driver's PIN dialog, to request the authentication credential from the user, instead of accepting the PIN in code. **PKCS11Label**: Returns the HSM label.Returns the label of the currently opened PKCS#11 device. **PKCS11Login**: Gets or sets the current PKCS#11 login type.The primary purpose of this setting is to allow provision/change of the login type on a later stage (when the storage has already been opened). The two common PKCS#11 login types are *user* and *admin*. **PKCS11NewPIN**: Changes the current user's PIN.Setting this property will change the current users' PIN to the provided value. Most HSMs require the user to be signed in to perform this operation. This is the way to change your own PIN, either for admin or regular user accounts. **PKCS11NewUserPIN**: Registers a new user PIN.Setting this property will register a new PIN to the HSM user account. This property is the way to administratively reset the user's PIN, and can only be set from under the 'admin' session. **PKCS11PIN**: Sets the operation PIN.Use this property to provide your PIN on the fly for an operation requiring the private key (e.g. signing). This may be useful if the PIN was not provided on the Open stage. **PKCS11ProviderDescription**: Returns the description of the currently loaded PKCS#11 provider.Returns the library description as returned by the PKCS#11 provider loaded into the storage object. **PKCS11ProviderManufacturer**: Returns the manufacturer of the currently loaded PKCS#11 provider.Returns the manufacturer string as returned by the PKCS#11 provider loaded into the storage object. **PKCS11ProviderVersion**: Returns the version of the provider library.Returns the PKCS#11 provider version as a 16 bit integer, with the HSB containing the major part and the LSB the minor part of the version. **PKCS11Slot**: Controls the number of a PKCS#11 slot to be opened.Use this property to set the number of slot to be opened late into the process (after the storage has been opened). Use the *auto* placeholder to tell the component to select the slot automatically. **PKCS11SlotCount**: The number of slots exposed in the storage.Returns the number of slots available in an opened PKCS#11 storage. **PKCS11SlotDescription[i]**: A human-readable description of the slot.Returns a human-readable description of slot i. **PKCS11SlotLoggedIn[i]**: Whether slot i has an active session associated with it.Returns true if there is an active session associated with slot number i. **PKCS11SlotLoginRequired[i]**: Specifies whether the token expects the user to sign in.Specifies whether the token in the slot #i expects the user to sign in to perform further operations with the token. **PKCS11SlotPinNeeded[i]**: Whether slot i requires you to provide a PIN to log in or sign.Returns true if you need to provide a PIN to sign in to the session for slot i. **PKCS11SlotReadOnly[i]**: Whether slot i only supports read-only access.Returns the availability of the slot for write operations. **PKCS11SlotTokenFlags[i]**: The capabilities flags of the inserted token.Returns the capabilities flags for the token inserted into slot number i. **PKCS11SlotTokenLabel[i]**: The label assigned to the token.Returns the label assigned to the token. **PKCS11SlotTokenModel[i]**: The token model.Returns the model of the token as provided by the driver. **PKCS11SlotTokenPresent[i]**: Indicates whether there is a token in the slot.Returns true if slot number i has a token inserted. **PKCS11SlotTokenSerial[i]**: The serial number of the token.Returns the serial number of the token. **PKCS11SlotTokenVendorID[i]**: The manufacturer ID of the inserted token.Returns vendor ID string for slot number i. **PKCS11SlotVendorID[i]**: Returns the manufacturer ID of the slot.Returns the manufacturer name associated with the slot. **PKCS11TextEncodingMode**: The encoding mode to apply to non-ASCII text strings.Specifies the method to approach strings (e.g. PINs) containing international characters when accessing PKCS#11 devices. The following options are available: - standard: use UTF8, as instructed by the PKCS#11 specification. - ansi: use Ansi (local) code page to convert text to the byte arrays that are passed over to the driver. - smart: if the standard approach fails, try the ansi approach automatically **StoreName**: Specifies the name of the system store to import the certificate to.Use this property to adjust the name of the certificate store where the certificate should be imported to. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **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 class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class 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. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **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. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **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 classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **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 classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) 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 divided 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 class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class 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. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **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. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **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. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([CertificateStorage](#certificatestorage-class) Class) ## Error Handling (C++) Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. ### CertificateStorage Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |