# CryptoKeyManager Component The CryptoKeyManager component provides a simple way to load, generate and manage generic cryptographic keys. ## Syntax ```text TsbxCryptoKeyManager ``` ## Remarks CryptoKeyManager allows you to load, save, generate, import, and export low-level cryptographic keys. Two examples of such keys are raw RSA keys stored in PKCS1 format or AES256 keys. CryptoKeyManager supports asymmetric, symmetric, and HMAC keys. CryptoKeyManager is a typical companion for low-level cryptography classes, such as PublicKeyCrypto, SymmetricCrypto, and HashFunction. It can also be used to provide external key material to certificate objects, and to derive cryptographic keys from passwords. Use [ImportBytes](#importbytes-method-cryptokeymanager-component) or [ImportFromFile](#importfromfile-method-cryptokeymanager-component) method to load the key material from a buffer or file. Use [ImportFromCert](#importfromcert-method-cryptokeymanager-component) (and remember to assign the certificate object to the Certificate property before calling it) to import a key from an X.509 certificate. Once loaded, the key will be available in the Key property. ```text // Loading an AES key and setting its IV CryptoKeyManager.ImportBytes(Key, kffDER, "AES256", "", "", ktSecret, ""); CryptoKeyManager.Key.IV = IV; // Loading an ECDSA private key from a file CryptoKeyManager.ImportFromFile("ec-secp256k1-priv-key.pem", kffAuto, "ECDSA", "NISTP256", "", ktSecret, ""); // Loading an ECDSA public key from a file CryptoKeyManager.ImportFromFile("ec-secp256k1-pub-key.pem", kffAuto, "ECDSA", "NISTP256", "", ktPublic, ""); // Importing a private key from a certificate object CertMgr.ImportFromFile("cert.pfx", "password"); CryptoKeyManager.Certificate = CertMgr.Certificate; CryptoKeyManager.ImportFromCert(); ``` To generate a new key or keypair use [Generate](#generate-method-cryptokeymanager-component) method. You can export the generated key using [ExportBytes](#exportbytes-method-cryptokeymanager-component) or [ExportToFile](#exporttofile-method-cryptokeymanager-component) method. You can attach the generated or loaded key to an external certificate object using the [ExportToCert](#exporttocert-method-cryptokeymanager-component) method. ```text // Generating an EdDSA Curve25519 keypair CryptoKeyManager.Generate("EDDSA", "CURVE25519", "", 256); // Generating an ECDSA NIST P256 curve keypair CryptoKeyManager.Generate("ECDSA", "NISTP256", "", 256); // Generating an RSA 2048 bit keypair CryptoKeyManager.Generate("RSA", "", "", 2048); // Generating a symmetric AES256 key CryptoKeyManager.Generate("AES256", "", "", 256); ``` Use [DeriveKey](#derivekey-method-cryptokeymanager-component) to derive a strong cryptographic key from a password using one of supported key derivation functions (KDFs): ```text CryptoKeyManager.DerivationAlgorithm = "PKCS5"; CryptoKeyManager.HMACAlgorithm = "SHA256"; CryptoKeyManager.DeriveIterations = 10000; CryptoKeyManager.DeriveKey(256, "password", "hex:41424344"); Key = CryptoKeyManager.Key.Key; ``` CryptoKeyManager supports the majority of modern cryptographic algorithms: - Asymmetric: RSA, ECDSA, EdDSA, ElGamal, DSS, Diffie-Hellman - Symmetric: AES, Blowfish, Camellia, CAST5, ChaCha20, DES, 3DES-EDE, IDEA, RC2, RC4, Serpent, Twofish. - KDFs: PKCS5, PBKDF2 (an alias to PKCS5), BCrypt, SCrypt, Argon2d, Argon2i, Argon2id. See the "Supported Algorithms" section in the FAQ for the complete list. Note: CryptoKeyManager can only work with one cryptographic key at a time. Use CryptoKeyStorage to access media containing more than one key. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CertBytes](#certbytes-property-cryptokeymanager-component) | Returns the raw certificate data in DER format. | | [CertCA](#certca-property-cryptokeymanager-component) | Indicates whether the certificate has a CA capability. | | [CertCAKeyID](#certcakeyid-property-cryptokeymanager-component) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [CertType](#certtype-property-cryptokeymanager-component) | Returns the type of the entity contained in the Certificate object. | | [CertCRLDistributionPoints](#certcrldistributionpoints-property-cryptokeymanager-component) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [CertCurve](#certcurve-property-cryptokeymanager-component) | Specifies the elliptic curve associated with the certificate's public key. | | [CertFingerprint](#certfingerprint-property-cryptokeymanager-component) | Contains the fingerprint (a hash imprint) of this certificate. | | [CertFriendlyName](#certfriendlyname-property-cryptokeymanager-component) | Contains an associated alias (friendly name) of the certificate. | | [CertHandle](#certhandle-property-cryptokeymanager-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [CertHashAlgorithm](#certhashalgorithm-property-cryptokeymanager-component) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [CertIssuer](#certissuer-property-cryptokeymanager-component) | The common name of the certificate issuer (CA), typically a company name. | | [CertIssuerRDN](#certissuerrdn-property-cryptokeymanager-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [CertKeyAlgorithm](#certkeyalgorithm-property-cryptokeymanager-component) | Specifies the public key algorithm of this certificate. | | [CertKeyBits](#certkeybits-property-cryptokeymanager-component) | Returns the length of the public key in bits. | | [CertKeyFingerprint](#certkeyfingerprint-property-cryptokeymanager-component) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [CertKeyUsage](#certkeyusage-property-cryptokeymanager-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [CertKeyValid](#certkeyvalid-property-cryptokeymanager-component) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [CertOCSPLocations](#certocsplocations-property-cryptokeymanager-component) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [CertOCSPNoCheck](#certocspnocheck-property-cryptokeymanager-component) | Accessor to the value of the certificate's ocsp-no-check extension. | | [CertOrigin](#certorigin-property-cryptokeymanager-component) | Returns the location that the certificate was taken or loaded from. | | [CertPolicyIDs](#certpolicyids-property-cryptokeymanager-component) | Contains identifiers (OIDs) of the applicable certificate policies. | | [CertPrivateKeyBytes](#certprivatekeybytes-property-cryptokeymanager-component) | Returns the certificate's private key in DER-encoded format. | | [CertPrivateKeyExists](#certprivatekeyexists-property-cryptokeymanager-component) | Indicates whether the certificate has a usable private key associated with it. | | [CertPrivateKeyExtractable](#certprivatekeyextractable-property-cryptokeymanager-component) | Indicates whether the private key is extractable (exportable). | | [CertPublicKeyBytes](#certpublickeybytes-property-cryptokeymanager-component) | Contains the certificate's public key in DER format. | | [CertQualified](#certqualified-property-cryptokeymanager-component) | Indicates whether the certificate is qualified. | | [CertQualifiedStatements](#certqualifiedstatements-property-cryptokeymanager-component) | Returns a simplified qualified status of the certificate. | | [CertQualifiers](#certqualifiers-property-cryptokeymanager-component) | A list of qualifiers. | | [CertSelfSigned](#certselfsigned-property-cryptokeymanager-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [CertSerialNumber](#certserialnumber-property-cryptokeymanager-component) | Returns the certificate's serial number. | | [CertSigAlgorithm](#certsigalgorithm-property-cryptokeymanager-component) | Indicates the algorithm that was used by the CA to sign this certificate. | | [CertSource](#certsource-property-cryptokeymanager-component) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [CertSubject](#certsubject-property-cryptokeymanager-component) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [CertSubjectAlternativeName](#certsubjectalternativename-property-cryptokeymanager-component) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [CertSubjectKeyID](#certsubjectkeyid-property-cryptokeymanager-component) | Contains a unique identifier of the certificate's cryptographic key. | | [CertSubjectRDN](#certsubjectrdn-property-cryptokeymanager-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [CertValid](#certvalid-property-cryptokeymanager-component) | 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. | | [CertValidFrom](#certvalidfrom-property-cryptokeymanager-component) | The time point at which the certificate becomes valid, in UTC. | | [CertValidTo](#certvalidto-property-cryptokeymanager-component) | The time point at which the certificate expires, in UTC. | | [DerivationAlgorithm](#derivationalgorithm-property-cryptokeymanager-component) | Specifies the algorithm to use for key derivation. | | [DeriveIterations](#deriveiterations-property-cryptokeymanager-component) | Specifies the number of iterations to use as part of key derivation routine. | | [FIPSMode](#fipsmode-property-cryptokeymanager-component) | Reserved. | | [HMACAlgorithm](#hmacalgorithm-property-cryptokeymanager-component) | Specifies the HMAC algorithm to use with the key derivation algorithm. | | [KeyAlgorithm](#keyalgorithm-property-cryptokeymanager-component) | The algorithm of the cryptographic key. | | [KeyBits](#keybits-property-cryptokeymanager-component) | The length of the key in bits. | | [KeyCurve](#keycurve-property-cryptokeymanager-component) | This property specifies the name of the curve the EC key is built on. | | [KeyExportable](#keyexportable-property-cryptokeymanager-component) | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. | | [KeyFingerprint](#keyfingerprint-property-cryptokeymanager-component) | Contains the fingerprint (a hash imprint) of this key. | | [KeyHandle](#keyhandle-property-cryptokeymanager-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [KeyID](#keyid-property-cryptokeymanager-component) | Provides access to a storage-specific key identifier. | | [KeyIV](#keyiv-property-cryptokeymanager-component) | The initialization vector (IV) of a symmetric key. | | [KeyNonce](#keynonce-property-cryptokeymanager-component) | A nonce value associated with a key. | | [KeyPrivate](#keyprivate-property-cryptokeymanager-component) | Returns True if the object hosts a private key, and False otherwise. | | [KeyPublic](#keypublic-property-cryptokeymanager-component) | Returns True if the object hosts a public key, and False otherwise. | | [KeySubject](#keysubject-property-cryptokeymanager-component) | Returns the key subject. | | [KeySymmetric](#keysymmetric-property-cryptokeymanager-component) | Returns True if the object contains a symmetric key, and False otherwise. | | [KeyValid](#keyvalid-property-cryptokeymanager-component) | Returns True if this key is valid. | | [KeyValue](#keyvalue-property-cryptokeymanager-component) | The byte array representation of the key value. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-cryptokeymanager-component) | Sets or retrieves a configuration setting. | | [CreateNew](#createnew-method-cryptokeymanager-component) | Creates a template for a new keypair. | | [DeriveKey](#derivekey-method-cryptokeymanager-component) | Generates a strong cryptographic key from a password. | | [DoAction](#doaction-method-cryptokeymanager-component) | Performs an additional action. | | [ExportBytes](#exportbytes-method-cryptokeymanager-component) | Exports the key to a byte array. | | [ExportToCert](#exporttocert-method-cryptokeymanager-component) | Exports the key to a certificate. | | [ExportToFile](#exporttofile-method-cryptokeymanager-component) | Exports the key to a file. | | [Generate](#generate-method-cryptokeymanager-component) | Generates a new crypto key. | | [GetKeyParam](#getkeyparam-method-cryptokeymanager-component) | Returns a binary algorithm-specific key parameter. | | [GetKeyParamStr](#getkeyparamstr-method-cryptokeymanager-component) | Returns a string algorithm-specific key parameter. | | [ImportBytes](#importbytes-method-cryptokeymanager-component) | Loads a key from a byte array. | | [ImportFromCert](#importfromcert-method-cryptokeymanager-component) | Loads a key from a certificate. | | [ImportFromFile](#importfromfile-method-cryptokeymanager-component) | Loads a key from a file. | | [Reset](#reset-method-cryptokeymanager-component) | Resets the component settings. | | [SetKeyParam](#setkeyparam-method-cryptokeymanager-component) | Sets an algorithm-specific key parameter. | | [SetKeyParamStr](#setkeyparamstr-method-cryptokeymanager-component) | Sets a string-based algorithm-specific key parameter. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-cryptokeymanager-component) | Informs about an error during an operation. | | [Notification](#notification-event-cryptokeymanager-component) | This event notifies the application about an underlying control flow event. | | [PasswordNeeded](#passwordneeded-event-cryptokeymanager-component) | This event is fired when a decryption password is needed. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Argon2MemoryCost](#Argon2MemoryCost) | Sets the memory cost parameter of Argon2 key derivation algorithm. | | [Argon2Parallelism](#Argon2Parallelism) | Sets the parallelism parameter of Argon2 key derivation algorithm. | | [DerivationAlgorithm](#DerivationAlgorithm) | The algorithm to use for key derivation. | | [DeriveIterations](#DeriveIterations) | The number of iterations to use as part of key derivation routine. | | [HMACAlgorithm](#HMACAlgorithm) | Specifies the HMAC algorithm to use with the key derivation algorithm. | | [PEMAlgorithm](#PEMAlgorithm) | Specifies the symmetric encryption algorithm to use with PEM-encrypted private keys. | | [PKCS11AlwaysAuthenticate](#PKCS11AlwaysAuthenticate) | Indicates whether the associated private key requires secondary authentication. | | [SaveKeyParameters](#SaveKeyParameters) | Controls inclusion of additional key parameters in the key blob when exporting EC keys. | | [TempPath](#TempPath) | Path for storing temporary files. | | [UseStandardKeyFormat](#UseStandardKeyFormat) | Enforces use of standard ASN.1-wrapped public and private key format. | | [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 component. | | [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 components. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. | | [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 components 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 components 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. | # CertBytes Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray CertBytes = { read=FCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only and not available at design time. ## Data Type Byte Array # CertCA Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates whether the certificate has a CA capability. ## Syntax *C++ Builder Syntax* ```text __property bool CertCA = { read=FCertCA, write=FSetCertCA }; ``` ## Default Value false ## Remarks 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 property when generating a new certificate to have its Basic Constraints extension generated automatically. This property is not available at design time. ## Data Type Boolean # CertCAKeyID Property ([CryptoKeyManager](#cryptokeymanager-component) Component) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray CertCAKeyID = { read=FCertCAKeyID }; ``` ## Remarks 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) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [CertSubjectKeyID](#certsubjectkeyid-property-cryptokeymanager-component) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only and not available at design time. ## Data Type Byte Array # CertType Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the type of the entity contained in the Certificate object. ## Syntax *C++ Builder Syntax* ```text __property TsbxCryptoKeyManagerCertTypes CertType = { read=FCertType }; enum TsbxCryptoKeyManagerCertTypes { ctUnknown=0, ctX509Certificate=1, ctX509CertificateRequest=2 }; ``` ## Default Value ctUnknown ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) component to load or create new certificate and certificate requests objects. This property is read-only and not available at design time. ## Data Type Integer # CertCRLDistributionPoints Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax *C++ Builder Syntax* ```text __property String CertCRLDistributionPoints = { read=FCertCRLDistributionPoints, write=FSetCertCRLDistributionPoints }; ``` ## Default Value "" ## Remarks 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 property 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. This property is not available at design time. ## Data Type String # CertCurve Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Specifies the elliptic curve associated with the certificate's public key. ## Syntax *C++ Builder Syntax* ```text __property String CertCurve = { read=FCertCurve, write=FSetCertCurve }; ``` ## Default Value "" ## Remarks 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 | | This property is not available at design time. ## Data Type String # CertFingerprint Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprint = { read=FCertFingerprint }; ``` ## Default Value "" ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # CertFriendlyName Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains an associated alias (friendly name) of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFriendlyName = { read=FCertFriendlyName }; ``` ## Default Value "" ## Remarks 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. This property is read-only and not available at design time. ## Data Type String # CertHandle Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 CertHandle = { read=FCertHandle, write=FSetCertHandle }; ``` ## Default Value 0 ## Remarks 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()); ``` This property is not available at design time. ## Data Type Long64 # CertHashAlgorithm Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax *C++ Builder Syntax* ```text __property String CertHashAlgorithm = { read=FCertHashAlgorithm, write=FSetCertHashAlgorithm }; ``` ## Default Value "" ## Remarks 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 [CertSigAlgorithm](#certsigalgorithm-property-cryptokeymanager-component) 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 | | This property is not available at design time. ## Data Type String # CertIssuer Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The common name of the certificate issuer (CA), typically a company name. ## Syntax *C++ Builder Syntax* ```text __property String CertIssuer = { read=FCertIssuer }; ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [CertIssuerRDN](#certissuerrdn-property-cryptokeymanager-component). This property is read-only and not available at design time. ## Data Type String # CertIssuerRDN Property ([CryptoKeyManager](#cryptokeymanager-component) Component) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *C++ Builder Syntax* ```text __property String CertIssuerRDN = { read=FCertIssuerRDN, write=FSetCertIssuerRDN }; ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* This property is not available at design time. ## Data Type String # CertKeyAlgorithm Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Specifies the public key algorithm of this certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertKeyAlgorithm = { read=FCertKeyAlgorithm, write=FSetCertKeyAlgorithm }; ``` ## Default Value "0" ## Remarks 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 [CertKeyBits](#certkeybits-property-cryptokeymanager-component), [CertCurve](#certcurve-property-cryptokeymanager-component), and [CertPublicKeyBytes](#certpublickeybytes-property-cryptokeymanager-component) properties to get more details about the key the certificate contains. This property is not available at design time. ## Data Type String # CertKeyBits Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the length of the public key in bits. ## Syntax *C++ Builder Syntax* ```text __property int CertKeyBits = { read=FCertKeyBits }; ``` ## Default Value 0 ## Remarks 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 [CertPublicKeyBytes](#certpublickeybytes-property-cryptokeymanager-component) or [CertPrivateKeyBytes](#certprivatekeybytes-property-cryptokeymanager-component) property would typically contain auxiliary values, and therefore be longer. This property is read-only and not available at design time. ## Data Type Integer # CertKeyFingerprint Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertKeyFingerprint = { read=FCertKeyFingerprint }; ``` ## Default Value "" ## Remarks 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 [CertFingerprint](#certfingerprint-property-cryptokeymanager-component) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. This property is read-only and not available at design time. ## Data Type String # CertKeyUsage Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *C++ Builder Syntax* ```text __property int CertKeyUsage = { read=FCertKeyUsage, write=FSetCertKeyUsage }; ``` ## Default Value 0 ## Remarks 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 property before generating the certificate to propagate the key usage flags to the new certificate. This property is not available at design time. ## Data Type Integer # CertKeyValid Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax *C++ Builder Syntax* ```text __property bool CertKeyValid = { read=FCertKeyValid }; ``` ## Default Value false ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. This property is read-only and not available at design time. ## Data Type Boolean # CertOCSPLocations Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax *C++ Builder Syntax* ```text __property String CertOCSPLocations = { read=FCertOCSPLocations, write=FSetCertOCSPLocations }; ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [Generate](#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. This property is not available at design time. ## Data Type String # CertOCSPNoCheck Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax *C++ Builder Syntax* ```text __property bool CertOCSPNoCheck = { read=FCertOCSPNoCheck, write=FSetCertOCSPNoCheck }; ``` ## Default Value false ## Remarks Accessor to the value of the certificate's ocsp-no-check extension. This property is not available at design time. ## Data Type Boolean # CertOrigin Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the location that the certificate was taken or loaded from. ## Syntax *C++ Builder Syntax* ```text __property int CertOrigin = { read=FCertOrigin }; ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. This property is read-only and not available at design time. ## Data Type Integer # CertPolicyIDs Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax *C++ Builder Syntax* ```text __property String CertPolicyIDs = { read=FCertPolicyIDs, write=FSetCertPolicyIDs }; ``` ## Default Value "" ## Remarks 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 property 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. This property is not available at design time. ## Data Type String # CertPrivateKeyBytes Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the certificate's private key in DER-encoded format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray CertPrivateKeyBytes = { read=FCertPrivateKeyBytes }; ``` ## Remarks Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. This property is read-only and not available at design time. ## Data Type Byte Array # CertPrivateKeyExists Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates whether the certificate has a usable private key associated with it. ## Syntax *C++ Builder Syntax* ```text __property bool CertPrivateKeyExists = { read=FCertPrivateKeyExists }; ``` ## Default Value false ## Remarks 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 property is independent from [CertPrivateKeyBytes](#certprivatekeybytes-property-cryptokeymanager-component), 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. This property is read-only and not available at design time. ## Data Type Boolean # CertPrivateKeyExtractable Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates whether the private key is extractable (exportable). ## Syntax *C++ Builder Syntax* ```text __property bool CertPrivateKeyExtractable = { read=FCertPrivateKeyExtractable }; ``` ## Default Value false ## Remarks Indicates whether the private key is extractable (exportable). This property is read-only and not available at design time. ## Data Type Boolean # CertPublicKeyBytes Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains the certificate's public key in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray CertPublicKeyBytes = { read=FCertPublicKeyBytes }; ``` ## Remarks 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. This property is read-only and not available at design time. ## Data Type Byte Array # CertQualified Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates whether the certificate is qualified. ## Syntax *C++ Builder Syntax* ```text __property bool CertQualified = { read=FCertQualified }; ``` ## Default Value false ## Remarks Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. This property is read-only and not available at design time. ## Data Type Boolean # CertQualifiedStatements Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns a simplified qualified status of the certificate. ## Syntax *C++ Builder Syntax* ```text __property TsbxCryptoKeyManagerCertQualifiedStatements CertQualifiedStatements = { read=FCertQualifiedStatements, write=FSetCertQualifiedStatements }; enum TsbxCryptoKeyManagerCertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 }; ``` ## Default Value qstNonQualified ## Remarks Returns a simplified qualified status of the certificate. This property is not available at design time. ## Data Type Integer # CertQualifiers Property ([CryptoKeyManager](#cryptokeymanager-component) Component) A list of qualifiers. ## Syntax *C++ Builder Syntax* ```text __property String CertQualifiers = { read=FCertQualifiers }; ``` ## Default Value "" ## Remarks A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. This property is read-only and not available at design time. ## Data Type String # CertSelfSigned Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *C++ Builder Syntax* ```text __property bool CertSelfSigned = { read=FCertSelfSigned }; ``` ## Default Value false ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. This property is read-only and not available at design time. ## Data Type Boolean # CertSerialNumber Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the certificate's serial number. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray CertSerialNumber = { read=FCertSerialNumber, write=FSetCertSerialNumber }; ``` ## Remarks 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. This property is not available at design time. ## Data Type Byte Array # CertSigAlgorithm Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertSigAlgorithm = { read=FCertSigAlgorithm }; ``` ## Default Value "" ## Remarks 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*. This property is read-only and not available at design time. ## Data Type String # CertSource Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax *C++ Builder Syntax* ```text __property TsbxCryptoKeyManagerCertSources CertSource = { read=FCertSource }; enum TsbxCryptoKeyManagerCertSources { pksUnknown=0, pksSignature=1, pksDocument=2, pksUser=3, pksLocal=4, pksOnline=5 }; ``` ## Default Value pksUnknown ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. This property is read-only and not available at design time. ## Data Type Integer # CertSubject Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *C++ Builder Syntax* ```text __property String CertSubject = { read=FCertSubject }; ``` ## Default Value "" ## Remarks 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 [CertSubjectRDN](#certsubjectrdn-property-cryptokeymanager-component). This property is read-only and not available at design time. ## Data Type String # CertSubjectAlternativeName Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertSubjectAlternativeName = { read=FCertSubjectAlternativeName, write=FSetCertSubjectAlternativeName }; ``` ## Default Value "" ## Remarks 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 [CertSubjectRDN](#certsubjectrdn-property-cryptokeymanager-component) 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. This property is not available at design time. ## Data Type String # CertSubjectKeyID Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains a unique identifier of the certificate's cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray CertSubjectKeyID = { read=FCertSubjectKeyID, write=FSetCertSubjectKeyID }; ``` ## Remarks 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 [CertSubjectKeyID](#certsubjectkeyid-property-cryptokeymanager-component) and [CertCAKeyID](#certcakeyid-property-cryptokeymanager-component) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. This property is not available at design time. ## Data Type Byte Array # CertSubjectRDN Property ([CryptoKeyManager](#cryptokeymanager-component) Component) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *C++ Builder Syntax* ```text __property String CertSubjectRDN = { read=FCertSubjectRDN, write=FSetCertSubjectRDN }; ``` ## Default Value "" ## Remarks 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*. This property is not available at design time. ## Data Type String # CertValid Property ([CryptoKeyManager](#cryptokeymanager-component) Component) 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. ## Syntax *C++ Builder Syntax* ```text __property bool CertValid = { read=FCertValid }; ``` ## Default Value false ## Remarks 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. This property is read-only and not available at design time. ## Data Type Boolean # CertValidFrom Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The time point at which the certificate becomes valid, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String CertValidFrom = { read=FCertValidFrom, write=FSetCertValidFrom }; ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. This property is not available at design time. ## Data Type String # CertValidTo Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The time point at which the certificate expires, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String CertValidTo = { read=FCertValidTo, write=FSetCertValidTo }; ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. This property is not available at design time. ## Data Type String # DerivationAlgorithm Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Specifies the algorithm to use for key derivation. ## Syntax *C++ Builder Syntax* ```text __property String DerivationAlgorithm = { read=FDerivationAlgorithm, write=FSetDerivationAlgorithm }; ``` ## Default Value "PKCS5" ## Remarks Use this property to specify the key derivation algorithm to use. Component supports the following algorithms: PKCS5, PBKDF2 (an alias to PKCS5), BCrypt, BCrypt2a, SCrypt, Argon2d, Argon2i, Argon2id. Note: 'BCrypt2a' is a version of BCrypt that ensures that the password string is terminated with a NULL character when hashed. The 'BCrypt' algorithm does not perform that check. ## Data Type String # DeriveIterations Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Specifies the number of iterations to use as part of key derivation routine. ## Syntax *C++ Builder Syntax* ```text __property int DeriveIterations = { read=FDeriveIterations, write=FSetDeriveIterations }; ``` ## Default Value 2048 ## Remarks Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function. ## Data Type Integer # FIPSMode Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Reserved. ## Syntax *C++ Builder Syntax* ```text __property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode }; ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # HMACAlgorithm Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Specifies the HMAC algorithm to use with the key derivation algorithm. ## Syntax *C++ Builder Syntax* ```text __property String HMACAlgorithm = { read=FHMACAlgorithm, write=FSetHMACAlgorithm }; ``` ## Default Value "SHA1" ## Remarks Use this property to specify the HMAC algorithm to use with the chosen key derivation algorithm. Component supports the following algorithms: SHA1, SHA224, SHA256, SHA384, SHA512, MD5, RIPEMD, HMAC. ## Data Type String # KeyAlgorithm Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The algorithm of the cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property String KeyAlgorithm = { read=FKeyAlgorithm, write=FSetKeyAlgorithm }; ``` ## Default Value "" ## Remarks The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH, EdDSA, ML-DSA, ML-KEM. | | | | | --- | --- | --- | | SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | | | SB_SYMMETRIC_ALGORITHM_DES | DES | | | SB_SYMMETRIC_ALGORITHM_3DES | 3DES | | | SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | | | SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | | | SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | | | SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | | | SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | | | SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | | | SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | | | SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | | | SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | | | SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | | | SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | | | SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | | | SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | | | SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | | | SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | | | SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | | | SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | | | SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | | | SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | | | SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | | | SB_SYMMETRIC_ALGORITHM_SEED | SEED | | | SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | | | SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | | | SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | | | SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 | | | | | | | --- | --- | --- | | 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 | | This property is not available at design time. ## Data Type String # KeyBits Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The length of the key in bits. ## Syntax *C++ Builder Syntax* ```text __property int KeyBits = { read=FKeyBits }; ``` ## Default Value 0 ## Remarks The length of the key in bits. This property is read-only and not available at design time. ## Data Type Integer # KeyCurve Property ([CryptoKeyManager](#cryptokeymanager-component) Component) This property specifies the name of the curve the EC key is built on. ## Syntax *C++ Builder Syntax* ```text __property String KeyCurve = { read=FKeyCurve, write=FSetKeyCurve }; ``` ## Default Value "" ## Remarks This property specifies the name of the curve the EC key is built on. This property is not available at design time. ## Data Type String # KeyExportable Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. ## Syntax *C++ Builder Syntax* ```text __property bool KeyExportable = { read=FKeyExportable }; ``` ## Default Value false ## Remarks Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. This property is read-only and not available at design time. ## Data Type Boolean # KeyFingerprint Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Contains the fingerprint (a hash imprint) of this key. ## Syntax *C++ Builder Syntax* ```text __property String KeyFingerprint = { read=FKeyFingerprint }; ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this key. This property is read-only and not available at design time. ## Data Type String # KeyHandle Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 KeyHandle = { read=FKeyHandle, write=FSetKeyHandle }; ``` ## Default Value 0 ## Remarks 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()); ``` This property is not available at design time. ## Data Type Long64 # KeyID Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Provides access to a storage-specific key identifier. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KeyID = { read=FKeyID, write=FSetKeyID }; ``` ## Remarks Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all). This property is not available at design time. ## Data Type Byte Array # KeyIV Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The initialization vector (IV) of a symmetric key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KeyIV = { read=FKeyIV, write=FSetKeyIV }; ``` ## Remarks The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers. This property is not available at design time. ## Data Type Byte Array # KeyNonce Property ([CryptoKeyManager](#cryptokeymanager-component) Component) A nonce value associated with a key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KeyNonce = { read=FKeyNonce, write=FSetKeyNonce }; ``` ## Remarks A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness. This property is not available at design time. ## Data Type Byte Array # KeyPrivate Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns True if the object hosts a private key, and False otherwise. ## Syntax *C++ Builder Syntax* ```text __property bool KeyPrivate = { read=FKeyPrivate }; ``` ## Default Value false ## Remarks Returns True if the object hosts a private key, and False otherwise. This property is read-only and not available at design time. ## Data Type Boolean # KeyPublic Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns True if the object hosts a public key, and False otherwise. ## Syntax *C++ Builder Syntax* ```text __property bool KeyPublic = { read=FKeyPublic }; ``` ## Default Value false ## Remarks Returns True if the object hosts a public key, and False otherwise. This property is read-only and not available at design time. ## Data Type Boolean # KeySubject Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns the key subject. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KeySubject = { read=FKeySubject, write=FSetKeySubject }; ``` ## Remarks Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner. This property is not available at design time. ## Data Type Byte Array # KeySymmetric Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns True if the object contains a symmetric key, and False otherwise. ## Syntax *C++ Builder Syntax* ```text __property bool KeySymmetric = { read=FKeySymmetric }; ``` ## Default Value false ## Remarks Returns True if the object contains a symmetric key, and False otherwise. This property is read-only and not available at design time. ## Data Type Boolean # KeyValid Property ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns True if this key is valid. ## Syntax *C++ Builder Syntax* ```text __property bool KeyValid = { read=FKeyValid }; ``` ## Default Value false ## Remarks Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent. This property is read-only and not available at design time. ## Data Type Boolean # KeyValue Property ([CryptoKeyManager](#cryptokeymanager-component) Component) The byte array representation of the key value. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KeyValue = { read=FKeyValue }; ``` ## Remarks The byte array representation of the key value. This may not be available for non-[KeyExportable](#keyexportable-property-cryptokeymanager-component) keys. This property used to be called *Key* in SecureBlackbox versions 2024 and older. This property is read-only and not available at design time. ## Data Type Byte Array # Config Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-cryptokeymanager-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-cryptokeymanager-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateNew Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Creates a template for a new keypair. ## Syntax *C++ Builder Syntax* ```text void __fastcall CreateNew(); ``` ## Remarks This method pre-generates a template for a new key. Adjust the properties of the Key object and call [Generate](#generate-method-cryptokeymanager-component) to complete the generation. # DeriveKey Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Generates a strong cryptographic key from a password. ## Syntax *C++ Builder Syntax* ```text void __fastcall DeriveKey(int KeyBits, String Password, String Salt); ``` ## Remarks Use this method to generate a cryptographically strong key of a needed length from a password. This method uses the key derivation function specified in [DerivationAlgorithm](#derivationalgorithm-property-cryptokeymanager-component), the HMAC algorithm provided in [HMACAlgorithm](#hmacalgorithm-property-cryptokeymanager-component), over [DeriveIterations](#deriveiterations-property-cryptokeymanager-component) iterations, to generate a cryptographic key of the needed length from a password and salt. *Salt* is expected to contain a human-readable text string. To provide a binary salt, use the *hex* prefix with base16-encoded salt value: *hex:01AB8F20004F10FE*. ```text CryptoKeyManager.DerivationAlgorithm = "PKCS5"; CryptoKeyManager.HMACAlgorithm = "SHA256"; CryptoKeyManager.DeriveIterations = 10000; CryptoKeyManager.DeriveKey(256, "password", "hex:41424344"); Key = CryptoKeyManager.Key.Key; ``` # DoAction Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Performs an additional action. ## Syntax *C++ Builder Syntax* ```text String __fastcall DoAction(String ActionID, String ActionParams); ``` ## Remarks DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (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. | # ExportBytes Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Exports the key to a byte array. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall ExportBytes(int Format, int KeyType, String Password); ``` ## Remarks Use this method to save the Key (both the public and secret parts) to a byte array. | | | | | --- | --- | --- | | kffUnknown | 0 | The key format was not recognized as one of the known formats. | | kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. | | kffDER | 2 | DER (binary) format | | kffPEM | 3 | PEM format (base64-encoded with headers) | | kffJSON | 4 | JSON key format | | | | | | --- | --- | --- | | ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. | | ktPublic | 1 | The operation should be performed on a public key. | | ktSecret | 2 | The operation should be performed on a private or secret key | # ExportToCert Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Exports the key to a certificate. ## Syntax *C++ Builder Syntax* ```text void __fastcall ExportToCert(); ``` ## Remarks Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate. # ExportToFile Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Exports the key to a file. ## Syntax *C++ Builder Syntax* ```text void __fastcall ExportToFile(String FileName, int Format, int KeyType, String Password); ``` ## Remarks Use this method to save the Key (both the public and secret parts) to the file passed via the *FileName* parameter. | | | | | --- | --- | --- | | kffUnknown | 0 | The key format was not recognized as one of the known formats. | | kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. | | kffDER | 2 | DER (binary) format | | kffPEM | 3 | PEM format (base64-encoded with headers) | | kffJSON | 4 | JSON key format | | | | | | --- | --- | --- | | ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. | | ktPublic | 1 | The operation should be performed on a public key. | | ktSecret | 2 | The operation should be performed on a private or secret key | # Generate Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Generates a new crypto key. ## Syntax *C++ Builder Syntax* ```text void __fastcall Generate(String KeyAlgorithm, String Scheme, String SchemeParams, int KeyBits); ``` ## Remarks Call this method to generate a new key or keypair with the desired *KeyAlgorithm* and *KeyBits* of length. The generated key will be populated in the Key property. For ML-DSA and ML-KEM keys, pass the parameter set in *Scheme* (for example, *ML-DSA-44* or *ML-KEM-768*) and leave *KeyBits* set to 0. ```text // Generating an EdDSA Curve25519 keypair CryptoKeyManager.Generate("EDDSA", "CURVE25519", "", 256); // Generating an ECDSA NIST P256 curve keypair CryptoKeyManager.Generate("ECDSA", "NISTP256", "", 256); // Generating an RSA 2048 bit keypair CryptoKeyManager.Generate("RSA", "", "", 2048); // Generating an ML-DSA-44 keypair CryptoKeyManager.Generate("ML-DSA", "ML-DSA-44", "", 0); // Generating an ML-KEM-768 keypair CryptoKeyManager.Generate("ML-KEM", "ML-KEM-768", "", 0); // Generating a symmetric AES256 key CryptoKeyManager.Generate("AES256", "", "", 256); ``` # GetKeyParam Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns a binary algorithm-specific key parameter. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall GetKeyParam(String Name); ``` ## Remarks Use this method to retrieve a binary algorithm-specific key parameter. The following parameters are currently supported: | | | | | --- | --- | --- | | Handle | | The PKCS#11 key object handle | | PubHandle | | The PKCS#11 public key object handle | | Label | | The PKCS#11 key object label | | PublicModulus | | RSA public modulus (big endian) | | PublicExponent | | RSA public exponent | | PrivateExponent | | RSA private exponent (private keys only) | | PublicShare | | EdDSA public share | | SecretShare | | EdDSA secret share | | P | | DSA, Elgamal, or DH P value | | Q | | DSA Q value | | G | | DSA, Elgamal, or DH G value | | X | | DSA, Elgamal, or DH X value | | Y | | DSA, Elgamal, or DH Y value | | PeerY | | The other party's DH Y value | | D | | ECDSA D value | | N | | ECDSA N value | | A | | ECDSA A value | | B | | ECDSA B value | | X | | ECDSA X value | | Y | | ECDSA Y value | | Q | | ECDSA Q value | | QX | | ECDSA QX value | | QY | | ECDSA QY value | | Base | | ECDSA Base value | | P | | ECDSA P value | | CurveOID | | Curve object identifier (ASN.1 notation) | | PublicShare | | ML-DSA public share | | SecretShare | | ML-DSA secret share | | Seed | | ML-DSA seed | | PublicShare | | ML-KEM public share | | SecretShare | | ML-KEM secret share | | Seed | | ML-KEM seed | | IV | | The symmetric key initialization vector | | Nonce | | The HMAC key nonce | # GetKeyParamStr Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Returns a string algorithm-specific key parameter. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetKeyParamStr(String Name); ``` ## Remarks Use this method to get an human-readable algorithm-specific key parameter. The following parameters are currently supported: | | | | | --- | --- | --- | | ProviderName | | The CryptoAPI provider name of the key container. | | CNGKeyHandle | | The CryptoAPI key handle. | | Handle | | The PKCS#11 key object handle | | PubHandle | | The PKCS#11 public key object handle | | Label | | The PKCS#11 key object label | | PublicModulus | | RSA public modulus (big endian, hex-encoded) | | PublicExponent | | RSA public exponent | | PrivateExponent | | RSA private exponent (private keys only) | | StrLabel | | RSA-PSS/OAEP StrLabel value | | SaltSize | | RSA-PSS/OAEP salt size | | MGFAlgorithm | | RSA-PSS/OAEP MGF algorithm | | TrailerField | | RSA-PSS/OAEP trailer field | | PublicShare | | EdDSA public share | | SecretShare | | EdDSA secret share | | P | | DSA, Elgamal, or DH P value | | Q | | DSA Q value | | G | | DSA, Elgamal, or DH G value | | X | | DSA, Elgamal, or DH X value | | Y | | DSA, Elgamal, or DH Y value | | PeerY | | The other party's DH Y value | | D | | ECDSA D value | | N | | ECDSA N value | | A | | ECDSA A value | | B | | ECDSA B value | | X | | ECDSA X value | | Y | | ECDSA Y value | | Q | | ECDSA Q value | | QX | | ECDSA QX value | | QY | | ECDSA QY value | | Base | | ECDSA Base value | | P | | ECDSA P value | | CurveOID | | Curve object identifier | | Curve | | The human-readable name of the EC curve, or dotted object identifier if not known | | PublicShare | | ML-DSA public share | | SecretShare | | ML-DSA secret share | | Seed | | ML-DSA seed | | Algorithm | | ML-DSA algorithm object identifier | | StrictKeyValidation | | ML-DSA strict key validation flag | | PublicShare | | ML-KEM public share | | SecretShare | | ML-KEM secret share | | Seed | | ML-KEM seed | | Algorithm | | ML-KEM algorithm object identifier | | StrictKeyValidation | | ML-KEM strict key validation flag | | IV | | The symmetric key initialization vector | | Nonce | | The HMAC key nonce | # ImportBytes Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Loads a key from a byte array. ## Syntax *C++ Builder Syntax* ```text void __fastcall ImportBytes(DynamicArray Value, int Format, String KeyAlgorithm, String Scheme, String SchemeParams, int KeyType, String Password); ``` ## Remarks Use this method to load a key, either public or secret, from a byte array. | | | | | --- | --- | --- | | kffUnknown | 0 | The key format was not recognized as one of the known formats. | | kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. | | kffDER | 2 | DER (binary) format | | kffPEM | 3 | PEM format (base64-encoded with headers) | | kffJSON | 4 | JSON key format | | | | | | --- | --- | --- | | ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. | | ktPublic | 1 | The operation should be performed on a public key. | | ktSecret | 2 | The operation should be performed on a private or secret key | **Example using Custom Property arrays:** ```text Mgr.ImportBytes(ThirtyTwoKeyBytes, kffDER, "AES256", "", "", ktSecret) ``` # ImportFromCert Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Loads a key from a certificate. ## Syntax *C++ Builder Syntax* ```text void __fastcall ImportFromCert(); ``` ## Remarks Use this method to load a key, either public or secret, from a certificate. # ImportFromFile Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Loads a key from a file. ## Syntax *C++ Builder Syntax* ```text void __fastcall ImportFromFile(String FileName, int Format, String KeyAlgorithm, String Scheme, String SchemeParams, int KeyType, String Password); ``` ## Remarks Use this method to load a key, either public or secret, from a file. | | | | | --- | --- | --- | | kffUnknown | 0 | The key format was not recognized as one of the known formats. | | kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. | | kffDER | 2 | DER (binary) format | | kffPEM | 3 | PEM format (base64-encoded with headers) | | kffJSON | 4 | JSON key format | | | | | | --- | --- | --- | | ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. | | ktPublic | 1 | The operation should be performed on a public key. | | ktSecret | 2 | The operation should be performed on a private or secret key | # Reset Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Resets the component settings. ## Syntax *C++ Builder Syntax* ```text void __fastcall Reset(); ``` ## Remarks Reset is a generic method available in every component. # SetKeyParam Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Sets an algorithm-specific key parameter. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetKeyParam(String Name, DynamicArray Value); ``` ## Remarks Use this method to set an algorithm-specific key parameter. The following parameters are currently supported: | | | | | --- | --- | --- | | PublicShare | | EdDSA public share | | SecretShare | | EdDSA secret share | | P | | DSA, Elgamal, or DH P value | | Q | | DSA Q value | | G | | DSA, Elgamal, or DH G value | | X | | DSA, Elgamal, or DH X value | | Y | | DSA, Elgamal, or DH Y value | | PeerY | | The other party's DH Y value | | D | | ECDSA D value | | N | | ECDSA N value | | A | | ECDSA A value | | B | | ECDSA B value | | X | | ECDSA X value | | Y | | ECDSA Y value | | Q | | ECDSA Q value | | QX | | ECDSA QX value | | QY | | ECDSA QY value | | Base | | ECDSA Base value | | P | | ECDSA P value | | CurveOID | | Curve object identifier | | PublicShare | | ML-DSA public share | | SecretShare | | ML-DSA secret share | | Seed | | ML-DSA seed | | PublicShare | | ML-KEM public share | | SecretShare | | ML-KEM secret share | | Seed | | ML-KEM seed | | IV | | The symmetric key initialization vector | | Nonce | | The HMAC key nonce | # SetKeyParamStr Method ([CryptoKeyManager](#cryptokeymanager-component) Component) Sets a string-based algorithm-specific key parameter. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetKeyParamStr(String Name, String ValueStr); ``` ## Remarks Use this method to set a string-based algorithm-specific key parameter. | | | | | --- | --- | --- | | CNGKeyHandle | | The CryptoAPI key handle. | | StrLabel | | RSA-PSS/OAEP StrLabel value | | SaltSize | | RSA-PSS/OAEP salt size | | MGFAlgorithm | | RSA-PSS/OAEP MGF algorithm | | TrailerField | | RSA-PSS/OAEP trailer field | | PublicShare | | EdDSA public share | | SecretShare | | EdDSA secret share | | P | | DSA, Elgamal, or DH P value | | Q | | DSA Q value | | G | | DSA, Elgamal, or DH G value | | X | | DSA, Elgamal, or DH X value | | Y | | DSA, Elgamal, or DH Y value | | PeerY | | The other party's DH Y value | | D | | ECDSA D value | | N | | ECDSA N value | | A | | ECDSA A value | | B | | ECDSA B value | | X | | ECDSA X value | | Y | | ECDSA Y value | | Q | | ECDSA Q value | | QX | | ECDSA QX value | | QY | | ECDSA QY value | | Base | | ECDSA Base value | | P | | ECDSA P value | | CurveOID | | Curve object identifier | | Curve | | The human-readable name of the EC curve, or dotted object identifier if not known | | PublicShare | | ML-DSA public share | | SecretShare | | ML-DSA secret share | | Seed | | ML-DSA seed | | Algorithm | | ML-DSA algorithm object identifier | | StrictKeyValidation | | ML-DSA strict key validation flag | | PublicShare | | ML-KEM public share | | SecretShare | | ML-KEM secret share | | Seed | | ML-KEM seed | | Algorithm | | ML-KEM algorithm object identifier | | StrictKeyValidation | | ML-KEM strict key validation flag | | IV | | The symmetric key initialization vector | | Nonce | | The HMAC key nonce | # Error Event ([CryptoKeyManager](#cryptokeymanager-component) Component) Informs about an error during an operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { int ErrorCode; String Description; } TsbxCryptoKeyManagerErrorEventParams; typedef void __fastcall (__closure *TsbxCryptoKeyManagerErrorEvent)(System::TObject* Sender, TsbxCryptoKeyManagerErrorEventParams *e); __property TsbxCryptoKeyManagerErrorEvent OnError = { read=FOnError, write=FOnError }; ``` ## Remarks The event is fired when an error happens in the middle of the component's work. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # Notification Event ([CryptoKeyManager](#cryptokeymanager-component) Component) This event notifies the application about an underlying control flow event. ## Syntax *C++ Builder Syntax* ```text typedef struct { String EventID; String EventParam; } TsbxCryptoKeyManagerNotificationEventParams; typedef void __fastcall (__closure *TsbxCryptoKeyManagerNotificationEvent)(System::TObject* Sender, TsbxCryptoKeyManagerNotificationEventParams *e); __property TsbxCryptoKeyManagerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification }; ``` ## Remarks The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted. # PasswordNeeded Event ([CryptoKeyManager](#cryptokeymanager-component) Component) This event is fired when a decryption password is needed. ## Syntax *C++ Builder Syntax* ```text typedef struct { String NeededFor; String Password; bool Cancel; } TsbxCryptoKeyManagerPasswordNeededEventParams; typedef void __fastcall (__closure *TsbxCryptoKeyManagerPasswordNeededEvent)(System::TObject* Sender, TsbxCryptoKeyManagerPasswordNeededEventParams *e); __property TsbxCryptoKeyManagerPasswordNeededEvent OnPasswordNeeded = { read=FOnPasswordNeeded, write=FOnPasswordNeeded }; ``` ## Remarks The component 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. # Config Settings ([CryptoKeyManager](#cryptokeymanager-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-cryptokeymanager-component) method. ### CryptoKeyManager Config Settings **Argon2MemoryCost**: Sets the memory cost parameter of Argon2 key derivation algorithm.Use this property to specify the memory cost parameter of Argon2 algorithm. The default value is 1048576. **Argon2Parallelism**: Sets the parallelism parameter of Argon2 key derivation algorithm.Use this property to specify the parallelism parameter of Argon2 algorithm. The default value is 2. **DerivationAlgorithm**: The algorithm to use for key derivation.This property specifies the key derivation algorithm to use. The following values are supported: PKCS5 (the default setting), BCrypt, SCrypt, Argon2d, Argon2i, Argon2id. **DeriveIterations**: The number of iterations to use as part of key derivation routine.Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function. **HMACAlgorithm**: Specifies the HMAC algorithm to use with the key derivation algorithm.This property specifies the HMAC algorithm to use with the chosen key derivation algorithm. Use normal hash algorithm constants with this property: SHA1, SHA224, SHA256, SHA384, SHA512, RIPEMD. **PEMAlgorithm**: Specifies the symmetric encryption algorithm to use with PEM-encrypted private keys.Use this property to specify the encryption algorithm to use with exported PEM private keys. Supported algorithms are AES128, AES192, AES256, 3DES, and DES. **PKCS11AlwaysAuthenticate**: Indicates whether the associated private key requires secondary authentication.Returns the value of the PKCS#11 CKA_ALWAYS_AUTHENTICATE attribute of the private key, which states whether the key requires a secondary per-operation authentication. **SaveKeyParameters**: Controls inclusion of additional key parameters in the key blob when exporting EC keys.Setting this property to true facilitates inclusion of additional key parameters (the curve OID) in the key blob. Use this property to make the keys you export compatible with OpenSSL ec command. **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. **UseStandardKeyFormat**: Enforces use of standard ASN.1-wrapped public and private key format.Use this setting to enable or disable the standard ASN.1-enveloped key format when exporting public and private EC keys. ### 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 component. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **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 components 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 components. **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 component. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are 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 component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **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 components. **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 ([CryptoKeyManager](#cryptokeymanager-component) Component) ### CryptoKeyManager 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)) |