# PGPWriter Class The PGPWriter class protects data using PGP keys. ## Class Name **SecureBlackbox_PGPWriter** ## Procedural Interface ```text secureblackbox_pgpwriter_open(); secureblackbox_pgpwriter_close($res); secureblackbox_pgpwriter_register_callback($res, $id, $function); secureblackbox_pgpwriter_get_last_error($res); secureblackbox_pgpwriter_get_last_error_code($res); secureblackbox_pgpwriter_set($res, $id, $index, $value); secureblackbox_pgpwriter_get($res, $id, $index); secureblackbox_pgpwriter_do_cleartextsign($res); secureblackbox_pgpwriter_do_config($res, $configurationstring); secureblackbox_pgpwriter_do_doaction($res, $actionid, $actionparams); secureblackbox_pgpwriter_do_encrypt($res); secureblackbox_pgpwriter_do_encryptandsign($res); secureblackbox_pgpwriter_do_reset($res); secureblackbox_pgpwriter_do_sign($res, $detached); ``` ## Remarks PGPWriter lets you encrypt, sign, armor, and compress files and data in accordance with PGP standard. PGPWriter supports all modern PGP keys and formats, from last-century PGP 2.6.x to the state-of-the art PGP 6. Single- and multi-file, as well as for-your-eyes-only PGP containers are supported. **Important note.** Starting with SecureBlackbox 2024, PGPWriter and PGPReader fully support PGPv6 specification. Introduction of PGPv6 comes with certain upgrade of the default security settings used in these components. Although any projects that rely on earlier SecureBlackbox versions are likely to migrate to SecureBlackbox 2024 without any issues, the mentioned upgrade in security defaults may make protected files that your software produces incompatible with the software on the other end (particularly if that software is on the older scale of age). While every care was taken to preserve interoperability wherever possible, some security settings could not be upgraded without the risk of affecting it. That said, none of the functionality was removed, so if you start encountering compatibility problems after upgrading to SecureBlackbox 2024, there is always a way back to the 'working' settings. Please see the section at the end of this topic for the summary of differences between SBB 2022 and SBB 2024 in terms of security settings. ### Preparing keys Encryption and signing in PGP is done with asymmetric keys. Keys are normally stored in files called keyrings. More often that not they consist of a pair of files: a public keyring (e.g pubring.pkr) and a secret keyring (secring.skr), although there are exceptions. Sometimes, recipients provide senders with standalone public keys that they want them to encrypt data with. Whichever form your keyring takes, use [PGPKeyring](PGPKeyring.md#PGPKeyring) to load it first. It is recommended to load all the keyring files that you have to make sure you have all the keys loaded. [PGPKeyring](PGPKeyring.md#PGPKeyring) can detect duplicate keys, so don't worry about loading the same key twice - any duplicates will be neatly merged together into one key object. ```text PGPKeyring keyring = new PGPKeyring(); keyring.ImportFromFile("pubring.pkr"); keyring.ImportFromFile("secring.skr"); ``` Now that you've loaded the keyring files, it is time to identify the key(s) that you need to use and pass them to PGPWriter. The best way to do it may differ between environments. Among the options available are iterating over the whole Keys collection of the PGPKeyring object, using its [Select](PGPKeyring.md#PGPKeyring_m_Select) method to filter keys by UserID, or just using the whole set of keys if loading a standalone key. Whichever way you choose to select the keys, there are a few considerations that need to be taken into account. First, keep in mind that the Keys collection contains both the primary keys and their subkeys. PGP is very flexible on how the 'key trees' can be formed, which means that keys from different vendors may use different key tree patterns. The most commonly used key tree pattern is where the primary key is sign-only, and its only subkey is encrypt-only. However, there can be different arrangements: for example, there can be more than one subkey in the key tree, or the primary key can be used for encryption alongside the subkey. Please take extra care to figure out what kind of key tree you are dealing with, and select appropriate keys with that structure in mind. The following properties of the key objects might be helpful in filtering the keys by their purpose: - and properties of the key objects provide information on the key algorithm capabilities. If you are looking to encrypt data, a key or subkey with its CanEncrypt set to false can be safely excluded from the candidate list. - and specify whether the key contains the public or private part of the keypair. If you are looking to sign data, keys with their IsSecret set to false can be discarded, as signing can only be done with private keys. - specifies the key's expiration date. Expired keys can be ignored. This is often useful where the vendor updates their keys by issuing fresh subkeys while keeping older ones in the key tree. Now that you've identified the appropriate keys, you can add them to the respective collections of PGPWriter: EncryptingKeys and SigningKeys. However, there is one important catch that you need to keep in mind. Private PGP keys are typically protected with passwords. To be able to use them, you need to provide the valid password to the component. You can do that in one of the following two ways: - By assigning the password to property. You can check whether the provided passphrase is valid using the property. - By subscribing to [KeyPassphraseNeeded](#keypassphraseneeded-event-secureblackbox_pgpwriter-class) event and providing the password from within the event handler. This event will be fired for each private key for which no valid password was provided. ### Configuring protection Protection configuration if quite straightforward and encompasses adjustment of the following settings: - Provide the input data via the [InputFile](#inputfile-property-secureblackbox_pgpwriter-class) (or [InputBytes](#inputbytes-property-secureblackbox_pgpwriter-class)) property. - Provide the destination in [OutputFile](#outputfile-property-secureblackbox_pgpwriter-class). If no output destination is provided, the output will be generated in [OutputBytes](#outputbytes-property-secureblackbox_pgpwriter-class). - Provide the filename for the file being protected in [Filename](#filename-property-secureblackbox_pgpwriter-class). - Set [EncryptionAlgorithm](#encryptionalgorithm-property-secureblackbox_pgpwriter-class) and [HashAlgorithm](#hashalgorithm-property-secureblackbox_pgpwriter-class), as (and if) required. - Set [Compress](#compress-property-secureblackbox_pgpwriter-class) to true if you would like the input compressed. You can tune up compression further with [CompressionAlgorithm](#compressionalgorithm-property-secureblackbox_pgpwriter-class) and [CompressionLevel](#compressionlevel-property-secureblackbox_pgpwriter-class) settings. - Set [Armor](#armor-property-secureblackbox_pgpwriter-class) if you would like the output to be base64-armored. ### Protecting the file You are all set now. Call the appropriate protection method to proceed with the file protection: - [Encrypt](#encrypt-method-secureblackbox_pgpwriter-class): encrypt the input data with all the public keys provided in EncryptingKeys. - [Sign](#sign-method-secureblackbox_pgpwriter-class): sign the input data with all the private keys provided in SigningKeys. - [EncryptAndSign](#encryptandsign-method-secureblackbox_pgpwriter-class): encrypt the input data with all the public keys provided in EncryptingKeys and sign it with all the private keys provided in SigningKeys. - [ClearTextSign](#cleartextsign-method-secureblackbox_pgpwriter-class): sign the input data in email-like way with all the private keys provided in SigningKeys. This method only works with textual ASCII data. ```text Writer.InputFile = "C:\files\input.txt"; Writer.OutputFile = "C:\files\output.pgp"; Writer.Filename = "input.txt"; Writer.EncryptionAlgorithm = "AES256"; Writer.SigningKeys.Add(Keyring.Keys[0]); Writer.EncryptingKeys.Add(Keyring.Keys[1]); Writer.EncryptAndSign(); ``` **Summary of changes in security defaults between SBB 2022 and SBB 2024** **Protection type**. While the set of [Protection](#protection-property-secureblackbox_pgpwriter-class) elements stayed the same, the meaning of the elements changed (deflated): - pptNone: stayed the same - pptLow in version 2024 corresponds to the protection settings that used to be marked as pptNormal in version 2022. - pptNormal in version 2024 corresponds to the protection settings that used to be marked as pptHigh in version 2022. - pptHigh has no equivalent level of protection in version 2022. It corresponds to strong authenticated encryption (AEAD) and KDF introduced in PGP v5 and v6. **Cryptographic algorithms** The default value of [HashAlgorithm](#hashalgorithm-property-secureblackbox_pgpwriter-class) has changed from SHA1 (SBB 2022) to SHA256 (SBB 2024). The default value of [EncryptionAlgorithm](#encryptionalgorithm-property-secureblackbox_pgpwriter-class) changed from CAST5 (SBB 2022) to AES128 (SBB 2024). This change applies throughout all the PGP components. **UseNewFeatures configuration setting** In SBB 2022 and earlier versions the meaning behind this configuration setting was about enforcing 'new' RFC4880 features, such as MDC packets for authenticated encryption and one-pass signatures. In SBB 2024, this setting regained its 'new' connotation and applies to PGP v6 features such as AEAD encryption. Use this setting with care as older PGP implementations may struggle to process files protected with PGP v6 features. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Armor](#armor-property-secureblackbox_pgpwriter-class) | Specifies whether the data should be armored. | | [ArmorBoundary](#armorboundary-property-secureblackbox_pgpwriter-class) | A boundary to put around the base64 armor. | | [ArmorHeaders](#armorheaders-property-secureblackbox_pgpwriter-class) | Additional headers to include with the armored message. | | [Compress](#compress-property-secureblackbox_pgpwriter-class) | Whether to compress the data before encrypting it. | | [CompressionAlgorithm](#compressionalgorithm-property-secureblackbox_pgpwriter-class) | The compression algorithm to use. | | [CompressionLevel](#compressionlevel-property-secureblackbox_pgpwriter-class) | The compression level to use. | | [EncryptingKeyCount](#encryptingkeycount-property-secureblackbox_pgpwriter-class) | The number of records in the EncryptingKey arrays. | | [EncryptingKeyHandle](#encryptingkeyhandle-property-secureblackbox_pgpwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [EncryptingKeyKeyFP](#encryptingkeykeyfp-property-secureblackbox_pgpwriter-class) | The 20-byte fingerprint (hash value) of this key. | | [EncryptingKeyKeyID](#encryptingkeykeyid-property-secureblackbox_pgpwriter-class) | Contains a 8-byte key identifier. | | [EncryptingKeyUsername](#encryptingkeyusername-property-secureblackbox_pgpwriter-class) | Specifies the name of the user bound to this key. | | [EncryptionAlgorithm](#encryptionalgorithm-property-secureblackbox_pgpwriter-class) | A symmetric algorithm to use for data encryption. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-secureblackbox_pgpwriter-class) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-secureblackbox_pgpwriter-class) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-secureblackbox_pgpwriter-class) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-secureblackbox_pgpwriter-class) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-secureblackbox_pgpwriter-class) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_pgpwriter-class) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_pgpwriter-class) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-secureblackbox_pgpwriter-class) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-secureblackbox_pgpwriter-class) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-secureblackbox_pgpwriter-class) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FileName](#filename-property-secureblackbox_pgpwriter-class) | Specifies the name of the file being protected. | | [FIPSMode](#fipsmode-property-secureblackbox_pgpwriter-class) | Reserved. | | [HashAlgorithm](#hashalgorithm-property-secureblackbox_pgpwriter-class) | The hash algorithm to use for signing. | | [InputBytes](#inputbytes-property-secureblackbox_pgpwriter-class) | Use this property to pass the input to class in byte array form. | | [InputFile](#inputfile-property-secureblackbox_pgpwriter-class) | Provides a filename of a file to process. | | [InputIsText](#inputistext-property-secureblackbox_pgpwriter-class) | Whether the input data is text. | | [OutputBytes](#outputbytes-property-secureblackbox_pgpwriter-class) | Use this property to read the output the class object has produced. | | [OutputFile](#outputfile-property-secureblackbox_pgpwriter-class) | The file where the encrypted and/or signed data will be saved. | | [Passphrase](#passphrase-property-secureblackbox_pgpwriter-class) | The encryption password. | | [Profile](#profile-property-secureblackbox_pgpwriter-class) | Specifies a pre-defined profile to apply when creating the signature. | | [Protection](#protection-property-secureblackbox_pgpwriter-class) | Specifies a password protection level. | | [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) | The number of records in the SigningKey arrays. | | [SigningKeyHandle](#signingkeyhandle-property-secureblackbox_pgpwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningKeyKeyFP](#signingkeykeyfp-property-secureblackbox_pgpwriter-class) | The 20-byte fingerprint (hash value) of this key. | | [SigningKeyKeyID](#signingkeykeyid-property-secureblackbox_pgpwriter-class) | Contains a 8-byte key identifier. | | [SigningKeyPassphrase](#signingkeypassphrase-property-secureblackbox_pgpwriter-class) | The key protection password. | | [SigningKeyPassphraseValid](#signingkeypassphrasevalid-property-secureblackbox_pgpwriter-class) | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. | | [SigningKeyUsername](#signingkeyusername-property-secureblackbox_pgpwriter-class) | Specifies the name of the user bound to this key. | | [Timestamp](#timestamp-property-secureblackbox_pgpwriter-class) | The date and time of the last modification of the protected data file (in UTC). | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ClearTextSign](#cleartextsign-method-secureblackbox_pgpwriter-class) | Creates a cleartext signature over the provided data. | | [Config](#config-method-secureblackbox_pgpwriter-class) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-secureblackbox_pgpwriter-class) | Performs an additional action. | | [Encrypt](#encrypt-method-secureblackbox_pgpwriter-class) | Encrypts data. | | [EncryptAndSign](#encryptandsign-method-secureblackbox_pgpwriter-class) | Encrypts and signs data. | | [Reset](#reset-method-secureblackbox_pgpwriter-class) | Resets the class settings. | | [Sign](#sign-method-secureblackbox_pgpwriter-class) | Signs data. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-secureblackbox_pgpwriter-class) | Information about errors during PGP encryption. | | [ExternalSign](#externalsign-event-secureblackbox_pgpwriter-class) | Handles remote or external signing initiated by the SignExternal method or other source. | | [KeyPassphraseNeeded](#keypassphraseneeded-event-secureblackbox_pgpwriter-class) | Requests a key protection password from the application. | | [Notification](#notification-event-secureblackbox_pgpwriter-class) | This event notifies the application about an underlying control flow event. | | [Progress](#progress-event-secureblackbox_pgpwriter-class) | Reports the progress of the decryption operation. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [PasswordAttempts](#PasswordAttempts) | The number of attempts allowed for entering password. | | [PreserveFilePaths](#PreserveFilePaths) | Whether to preserve full file names when saving the PGP file. | | [SignBufferingMethod](#SignBufferingMethod) | The type of buffering used during signing. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TextCompatibilityMode](#TextCompatibilityMode) | Whether whitespaces must be trimmed from the signature. | | [UndefInputLength](#UndefInputLength) | Set this property if you are working with non-seekable streams. | | [UseNewFeatures](#UseNewFeatures) | Whether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed. | | [UseOldPackets](#UseOldPackets) | Whether signature packets of old format, compatible with PGP 2.6.3, should be used. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # Armor Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies whether the data should be armored. ## Object Oriented Interface ```text public function getArmor(); public function setArmor($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 1 ); secureblackbox_pgpwriter_set($res, 1, $value ); ``` ## Default Value false ## Remarks Switch this property on to armor the protected data by encoding it in base64 and enveloping with BEGIN and END markings. ## Data Type Boolean # ArmorBoundary Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) A boundary to put around the base64 armor. ## Object Oriented Interface ```text public function getArmorBoundary(); public function setArmorBoundary($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 2 ); secureblackbox_pgpwriter_set($res, 2, $value ); ``` ## Default Value '' ## Remarks Use this property to specify the boundary to put around the base64 armor. If set to 'PGP MESSAGE', the armored data will be enveloped with '-----BEGIN PGP MESSAGE-----' and '-----END PGP MESSAGE-----' lines. This property only makes sense if [Armor](#armor-property-secureblackbox_pgpwriter-class) is set True. ## Data Type String # ArmorHeaders Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Additional headers to include with the armored message. ## Object Oriented Interface ```text public function getArmorHeaders(); public function setArmorHeaders($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 3 ); secureblackbox_pgpwriter_set($res, 3, $value ); ``` ## Default Value '' ## Remarks Use this property to specify additional headers to be included with the armored message. Assign this property with a multi-line text, with each line being of "header: value" form (without quotes). ## Data Type String # Compress Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Whether to compress the data before encrypting it. ## Object Oriented Interface ```text public function getCompress(); public function setCompress($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 4 ); secureblackbox_pgpwriter_set($res, 4, $value ); ``` ## Default Value false ## Remarks Set this property to True to compress the data before encryption. Use [CompressionAlgorithm](#compressionalgorithm-property-secureblackbox_pgpwriter-class) and [CompressionLevel](#compressionlevel-property-secureblackbox_pgpwriter-class) to tune up compression parameters. ## Data Type Boolean # CompressionAlgorithm Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The compression algorithm to use. ## Object Oriented Interface ```text public function getCompressionAlgorithm(); public function setCompressionAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 5 ); secureblackbox_pgpwriter_set($res, 5, $value ); ``` ## Default Value 'Uncompressed' ## Remarks Use this property to specify the compression algorithm to use before encrypting the data. This property only makes sense if [Compress](#compress-property-secureblackbox_pgpwriter-class) is True. | | | | | --- | --- | --- | | SB_PGP_COMPRESSION_ALGORITHM_NONE | Uncompressed | | | SB_PGP_COMPRESSION_ALGORITHM_ZIP | ZIP | | | SB_PGP_COMPRESSION_ALGORITHM_ZLIB | Zlib | | | SB_PGP_COMPRESSION_ALGORITHM_BZIP2 | Bzip2 | | ## Data Type String # CompressionLevel Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The compression level to use. ## Object Oriented Interface ```text public function getCompressionLevel(); public function setCompressionLevel($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 6 ); secureblackbox_pgpwriter_set($res, 6, $value ); ``` ## Default Value 0 ## Remarks Use this property to specify the compression level, from 1 (fastest) to 9 (best). ## Data Type Integer # EncryptingKeyCount Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The number of records in the EncryptingKey arrays. ## Object Oriented Interface ```text public function getEncryptingKeyCount(); public function setEncryptingKeyCount($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 7 ); secureblackbox_pgpwriter_set($res, 7, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [EncryptingKeyHandle](#encryptingkeyhandle-property-secureblackbox_pgpwriter-class) - [EncryptingKeyKeyFP](#encryptingkeykeyfp-property-secureblackbox_pgpwriter-class) - [EncryptingKeyKeyID](#encryptingkeykeyid-property-secureblackbox_pgpwriter-class) - [EncryptingKeyUsername](#encryptingkeyusername-property-secureblackbox_pgpwriter-class) The array indices start at *0* and end at *EncryptingKeyCount - 1*. This property is not available at design time. ## Data Type Integer # EncryptingKeyHandle Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getEncryptingKeyHandle($encryptingkeyindex); public function setEncryptingKeyHandle($encryptingkeyindex, $value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 14 , $encryptingkeyindex); secureblackbox_pgpwriter_set($res, 14, $value , $encryptingkeyindex); ``` ## 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()); ``` The *$encryptingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EncryptingKeyCount](#encryptingkeycount-property-secureblackbox_pgpwriter-class) property. This property is not available at design time. ## Data Type Long64 # EncryptingKeyKeyFP Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The 20-byte fingerprint (hash value) of this key. ## Object Oriented Interface ```text public function getEncryptingKeyKeyFP($encryptingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 18 , $encryptingkeyindex); ``` ## Default Value '' ## Remarks The 20-byte fingerprint (hash value) of this key. KeyFP could be used to distinguish two keys with the same KeyID. The *$encryptingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EncryptingKeyCount](#encryptingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type String # EncryptingKeyKeyID Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Contains a 8-byte key identifier. ## Object Oriented Interface ```text public function getEncryptingKeyKeyID($encryptingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 19 , $encryptingkeyindex); ``` ## Default Value '' ## Remarks Contains a 8-byte key identifier. It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user. The *$encryptingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EncryptingKeyCount](#encryptingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type String # EncryptingKeyUsername Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies the name of the user bound to this key. ## Object Oriented Interface ```text public function getEncryptingKeyUsername($encryptingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 27 , $encryptingkeyindex); ``` ## Default Value '' ## Remarks Specifies the name of the user bound to this key. The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string. The *$encryptingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EncryptingKeyCount](#encryptingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type String # EncryptionAlgorithm Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) A symmetric algorithm to use for data encryption. ## Object Oriented Interface ```text public function getEncryptionAlgorithm(); public function setEncryptionAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 30 ); secureblackbox_pgpwriter_set($res, 30, $value ); ``` ## Default Value 'AES128' ## Remarks Use this property to specify a symmetric algorithm to use for data encryption. | | | | | --- | --- | --- | | SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT | Plaintext | | | SB_PGP_SYMMETRIC_ALGORITHM_IDEA | Idea | | | SB_PGP_SYMMETRIC_ALGORITHM_3DES | 3DES | | | SB_PGP_SYMMETRIC_ALGORITHM_CAST5 | CAST5 | | | SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | | | SB_PGP_SYMMETRIC_ALGORITHM_AES128 | AES128 | | | SB_PGP_SYMMETRIC_ALGORITHM_AES192 | AES192 | | | SB_PGP_SYMMETRIC_ALGORITHM_AES256 | AES256 | | | SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | | ## Data Type String # ExternalCryptoAsyncDocumentID Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Object Oriented Interface ```text public function getExternalCryptoAsyncDocumentID(); public function setExternalCryptoAsyncDocumentID($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 31 ); secureblackbox_pgpwriter_set($res, 31, $value ); ``` ## Default Value '' ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. ## Data Type String # ExternalCryptoCustomParams Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Custom parameters to be passed to the signing service (uninterpreted). ## Object Oriented Interface ```text public function getExternalCryptoCustomParams(); public function setExternalCryptoCustomParams($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 32 ); secureblackbox_pgpwriter_set($res, 32, $value ); ``` ## Default Value '' ## Remarks Custom parameters to be passed to the signing service (uninterpreted). This property is not available at design time. ## Data Type String # ExternalCryptoData Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Additional data to be included in the async state and mirrored back by the requestor. ## Object Oriented Interface ```text public function getExternalCryptoData(); public function setExternalCryptoData($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 33 ); secureblackbox_pgpwriter_set($res, 33, $value ); ``` ## Default Value '' ## Remarks Additional data to be included in the async state and mirrored back by the requestor. This property is not available at design time. ## Data Type String # ExternalCryptoExternalHashCalculation Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies whether the message hash is to be calculated at the external endpoint. ## Object Oriented Interface ```text public function getExternalCryptoExternalHashCalculation(); public function setExternalCryptoExternalHashCalculation($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 34 ); secureblackbox_pgpwriter_set($res, 34, $value ); ``` ## Default Value false ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. ## Data Type Boolean # ExternalCryptoHashAlgorithm Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies the request's signature hash algorithm. ## Object Oriented Interface ```text public function getExternalCryptoHashAlgorithm(); public function setExternalCryptoHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 35 ); secureblackbox_pgpwriter_set($res, 35, $value ); ``` ## Default Value 'SHA256' ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | ## Data Type String # ExternalCryptoKeyID Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The ID of the pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeyID(); public function setExternalCryptoKeyID($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 36 ); secureblackbox_pgpwriter_set($res, 36, $value ); ``` ## Default Value '' ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_pgpwriter-class) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # ExternalCryptoKeySecret Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeySecret(); public function setExternalCryptoKeySecret($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 37 ); secureblackbox_pgpwriter_set($res, 37, $value ); ``` ## Default Value '' ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_pgpwriter-class) topic. ## Data Type String # ExternalCryptoMethod Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies the asynchronous signing method. ## Object Oriented Interface ```text public function getExternalCryptoMethod(); public function setExternalCryptoMethod($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 38 ); secureblackbox_pgpwriter_set($res, 38, $value ); ``` ## Possible Values ```text PGPWRITER_EXTERNALCRYPTOMETHOD_PKCS1(0), PGPWRITER_EXTERNALCRYPTOMETHOD_PKCS7(1) ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | ## Data Type Integer # ExternalCryptoMode Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies the external cryptography mode. ## Object Oriented Interface ```text public function getExternalCryptoMode(); public function setExternalCryptoMode($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 39 ); secureblackbox_pgpwriter_set($res, 39, $value ); ``` ## Possible Values ```text PGPWRITER_EXTERNALCRYPTOMODE_DEFAULT(0), PGPWRITER_EXTERNALCRYPTOMODE_DISABLED(1), PGPWRITER_EXTERNALCRYPTOMODE_GENERIC(2), PGPWRITER_EXTERNALCRYPTOMODE_DCAUTH(3), PGPWRITER_EXTERNALCRYPTOMODE_DCAUTH_JSON(4) ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | This property is not available at design time. ## Data Type Integer # ExternalCryptoPublicKeyAlgorithm Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Object Oriented Interface ```text public function getExternalCryptoPublicKeyAlgorithm(); public function setExternalCryptoPublicKeyAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 40 ); secureblackbox_pgpwriter_set($res, 40, $value ); ``` ## Default Value '' ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | 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 | | ## Data Type String # FileName Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies the name of the file being protected. ## Object Oriented Interface ```text public function getFileName(); public function setFileName($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 41 ); secureblackbox_pgpwriter_set($res, 41, $value ); ``` ## Default Value '' ## Remarks Use this property to set the name of the file being protected, such as 'document.txt'. If Filename is empty or its value is "_CONSOLE", the data will be protected for-your-eyes-only, meaning the decryptor will only be able to read it on their screen, but not save. ## Data Type String # FIPSMode Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 42 ); secureblackbox_pgpwriter_set($res, 42, $value ); ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # HashAlgorithm Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The hash algorithm to use for signing. ## Object Oriented Interface ```text public function getHashAlgorithm(); public function setHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 43 ); secureblackbox_pgpwriter_set($res, 43, $value ); ``` ## Default Value '' ## Remarks Use this property to specify the hash algorithm to use for calculating signatures. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | 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_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | ## Data Type String # InputBytes Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Use this property to pass the input to class in byte array form. ## Object Oriented Interface ```text public function getInputBytes(); public function setInputBytes($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 44 ); secureblackbox_pgpwriter_set($res, 44, $value ); ``` ## Remarks Assign a byte array containing the data to be processed to this property. This property is not available at design time. ## Data Type Byte Array # InputFile Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Provides a filename of a file to process. ## Object Oriented Interface ```text public function getInputFile(); public function setInputFile($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 45 ); secureblackbox_pgpwriter_set($res, 45, $value ); ``` ## Default Value '' ## Remarks Use this property to provide a path to the file to be encrypted and/or signed. If you assign this property with a directory name, all the files contained in the directory will be packed into the resulting protected file. ## Data Type String # InputIsText Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Whether the input data is text. ## Object Oriented Interface ```text public function getInputIsText(); public function setInputIsText($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 46 ); secureblackbox_pgpwriter_set($res, 46, $value ); ``` ## Default Value false ## Remarks Set this property to true to indicate that the supplied data should be treated as text. ## Data Type Boolean # OutputBytes Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Use this property to read the output the class object has produced. ## Object Oriented Interface ```text public function getOutputBytes(); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 47 ); ``` ## Remarks Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [OutputFile](#outputfile-property-secureblackbox_pgpwriter-class) and OutputStream properties had not been assigned. This property is read-only and not available at design time. ## Data Type Byte Array # OutputFile Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The file where the encrypted and/or signed data will be saved. ## Object Oriented Interface ```text public function getOutputFile(); public function setOutputFile($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 48 ); secureblackbox_pgpwriter_set($res, 48, $value ); ``` ## Default Value '' ## Remarks Use this property to provide a path to the file where the class should store the encrypted and/or signed data. ## Data Type String # Passphrase Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The encryption password. ## Object Oriented Interface ```text public function getPassphrase(); public function setPassphrase($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 49 ); secureblackbox_pgpwriter_set($res, 49, $value ); ``` ## Default Value '' ## Remarks Use this property to provide the encryption password. If an encryption password is used, no key will be needed to decrypt the data. ## Data Type String # Profile Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies a pre-defined profile to apply when creating the signature. ## Object Oriented Interface ```text public function getProfile(); public function setProfile($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 50 ); secureblackbox_pgpwriter_set($res, 50, $value ); ``` ## Default Value '' ## Remarks Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile. ## Data Type String # Protection Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies a password protection level. ## Object Oriented Interface ```text public function getProtection(); public function setProtection($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 51 ); secureblackbox_pgpwriter_set($res, 51, $value ); ``` ## Possible Values ```text PGPWRITER_PROTECTION_NONE(0), PGPWRITER_PROTECTION_LOW(1), PGPWRITER_PROTECTION_NORMAL(2), PGPWRITER_PROTECTION_HIGH(3) ``` ## Default Value 0 ## Remarks This property specifies the complexity of key derivation function for password-protected documents. Allowed values: | | | | | --- | --- | --- | | pptNone | 0 | Key is not encrypted | | pptLow | 1 | Only the password hash is used to derive the secret key | | pptNormal | 2 | Password hash with salt is used to derive the secret key | | pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation | ## Data Type Integer # SigningKeyCount Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The number of records in the SigningKey arrays. ## Object Oriented Interface ```text public function getSigningKeyCount(); public function setSigningKeyCount($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 52 ); secureblackbox_pgpwriter_set($res, 52, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SigningKeyHandle](#signingkeyhandle-property-secureblackbox_pgpwriter-class) - [SigningKeyKeyFP](#signingkeykeyfp-property-secureblackbox_pgpwriter-class) - [SigningKeyKeyID](#signingkeykeyid-property-secureblackbox_pgpwriter-class) - [SigningKeyPassphrase](#signingkeypassphrase-property-secureblackbox_pgpwriter-class) - [SigningKeyPassphraseValid](#signingkeypassphrasevalid-property-secureblackbox_pgpwriter-class) - [SigningKeyUsername](#signingkeyusername-property-secureblackbox_pgpwriter-class) The array indices start at *0* and end at *SigningKeyCount - 1*. This property is not available at design time. ## Data Type Integer # SigningKeyHandle Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getSigningKeyHandle($signingkeyindex); public function setSigningKeyHandle($signingkeyindex, $value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 59 , $signingkeyindex); secureblackbox_pgpwriter_set($res, 59, $value , $signingkeyindex); ``` ## 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()); ``` The *$signingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) property. This property is not available at design time. ## Data Type Long64 # SigningKeyKeyFP Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The 20-byte fingerprint (hash value) of this key. ## Object Oriented Interface ```text public function getSigningKeyKeyFP($signingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 63 , $signingkeyindex); ``` ## Default Value '' ## Remarks The 20-byte fingerprint (hash value) of this key. KeyFP could be used to distinguish two keys with the same KeyID. The *$signingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type String # SigningKeyKeyID Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Contains a 8-byte key identifier. ## Object Oriented Interface ```text public function getSigningKeyKeyID($signingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 64 , $signingkeyindex); ``` ## Default Value '' ## Remarks Contains a 8-byte key identifier. It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user. The *$signingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type String # SigningKeyPassphrase Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The key protection password. ## Object Oriented Interface ```text public function getSigningKeyPassphrase($signingkeyindex); public function setSigningKeyPassphrase($signingkeyindex, $value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 65 , $signingkeyindex); secureblackbox_pgpwriter_set($res, 65, $value , $signingkeyindex); ``` ## Default Value '' ## Remarks The key protection password. The *$signingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) property. This property is not available at design time. ## Data Type String # SigningKeyPassphraseValid Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. ## Object Oriented Interface ```text public function getSigningKeyPassphraseValid($signingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 66 , $signingkeyindex); ``` ## Default Value false ## Remarks Use this property to check whether the specified [SigningKeyPassphrase](#signingkeypassphrase-property-secureblackbox_pgpwriter-class) is valid and can be used to unlock the secret key. The *$signingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type Boolean # SigningKeyUsername Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Specifies the name of the user bound to this key. ## Object Oriented Interface ```text public function getSigningKeyUsername($signingkeyindex); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 72 , $signingkeyindex); ``` ## Default Value '' ## Remarks Specifies the name of the user bound to this key. The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string. The *$signingkeyindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningKeyCount](#signingkeycount-property-secureblackbox_pgpwriter-class) property. This property is read-only and not available at design time. ## Data Type String # Timestamp Property ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) The date and time of the last modification of the protected data file (in UTC). ## Object Oriented Interface ```text public function getTimestamp(); public function setTimestamp($value); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_get($res, 75 ); secureblackbox_pgpwriter_set($res, 75, $value ); ``` ## Default Value '' ## Remarks Use this property to set a timestamp for the data being protected. ## Data Type String # ClearTextSign Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Creates a cleartext signature over the provided data. ## Object Oriented Interface ```text public function doClearTextSign(); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_cleartextsign($res); ``` ## Remarks Call this method to create a cleartext signature over the provided data buffer ([InputBytes](#inputbytes-property-secureblackbox_pgpwriter-class)). Only textual data can be signed in cleartext. Pass the signing key(s) via SigningKeys property. # Config Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pgpwriter-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-pgpwriter-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_doaction($res, $actionid, $actionparams); ``` ## Remarks DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # Encrypt Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Encrypts data. ## Object Oriented Interface ```text public function doEncrypt(); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_encrypt($res); ``` ## Remarks Use this method to encrypt input data from a byte array ([InputBytes](#inputbytes-property-secureblackbox_pgpwriter-class)), a file ([InputFile](#inputfile-property-secureblackbox_pgpwriter-class)) or a stream (InputStream) and get the protected message in another byte array ([OutputBytes](#outputbytes-property-secureblackbox_pgpwriter-class)), or another file ([OutputFile](#outputfile-property-secureblackbox_pgpwriter-class)), or another stream (OutputStream). Specify encryption keys in EncryptingKeys property, and/or encryption password via [Passphrase](#passphrase-property-secureblackbox_pgpwriter-class) property. # EncryptAndSign Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Encrypts and signs data. ## Object Oriented Interface ```text public function doEncryptAndSign(); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_encryptandsign($res); ``` ## Remarks Use this method to encrypt and sign a byte array ([InputBytes](#inputbytes-property-secureblackbox_pgpwriter-class)), a file ([InputFile](#inputfile-property-secureblackbox_pgpwriter-class)) or a stream (InputStream) and get the protected message in another byte array ([OutputBytes](#outputbytes-property-secureblackbox_pgpwriter-class)), or another file ([OutputFile](#outputfile-property-secureblackbox_pgpwriter-class)), or another stream (OutputStream). Specify encryption keys in EncryptingKeys property, and/or encryption password via [Passphrase](#passphrase-property-secureblackbox_pgpwriter-class) property. Use SigningKeys to provide the signing keys. Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via [KeyPassphraseNeeded](#keypassphraseneeded-event-secureblackbox_pgpwriter-class) event, or by assigning the passphrase to the key object's *Passphrase* property. # Reset Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # Sign Method ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Signs data. ## Object Oriented Interface ```text public function doSign($detached); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_do_sign($res, $detached); ``` ## Remarks Use this method to sign a byte array ([InputBytes](#inputbytes-property-secureblackbox_pgpwriter-class)), a file ([InputFile](#inputfile-property-secureblackbox_pgpwriter-class)) or a stream (InputStream) and get the signed message in another byte array ([OutputBytes](#outputbytes-property-secureblackbox_pgpwriter-class)), or another file ([OutputFile](#outputfile-property-secureblackbox_pgpwriter-class)), or another stream (OutputStream). Use SigningKeys to provide the signing keys. Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via [KeyPassphraseNeeded](#keypassphraseneeded-event-secureblackbox_pgpwriter-class) event, or by assigning the passphrase to the key object's *Passphrase* property. # Error Event ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Information about errors during PGP encryption. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_register_callback($res, 1, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## Remarks The event is fired in case of exceptional conditions during data encryption or signing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # ExternalSign Event ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Handles remote or external signing initiated by the SignExternal method or other source. ## Object Oriented Interface ```text public function fireExternalSign($param); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_register_callback($res, 2, array($this, 'fireExternalSign')); ``` ## Parameter List ```text 'operationid' 'hashalgorithm' 'pars' 'data' 'signeddata' ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # KeyPassphraseNeeded Event ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Requests a key protection password from the application. ## Object Oriented Interface ```text public function fireKeyPassphraseNeeded($param); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_register_callback($res, 3, array($this, 'fireKeyPassphraseNeeded')); ``` ## Parameter List ```text 'keyid' 'userid' 'mainkey' 'passphrase' 'skip' ``` ## Remarks The class fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The class fires it when it attempts to use a secret key to sign the data. This event is fired for every protected secret key residing in SigningKeys. *KeyID* specifies the key for which the password is requested, and *UserID* identifies its user. *MainKey* tells whether the key is a master key or a subkey. The handler should provide password via the *Passphrase* parameter, or set *Skip* to True to skip this key. For each key *KeyPassphraseNeeded* is called in a loop until the correct password is provided or the maximum number of password attempts reached. # Notification Event ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_register_callback($res, 4, array($this, 'fireNotification')); ``` ## Parameter List ```text 'eventid' 'eventparam' ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. # Progress Event ([SecureBlackbox_PGPWriter](#pgpwriter-class) Class) Reports the progress of the decryption operation. ## Object Oriented Interface ```text public function fireProgress($param); ``` ## Procedural Interface ```text secureblackbox_pgpwriter_register_callback($res, 5, array($this, 'fireProgress')); ``` ## Parameter List ```text 'current' 'total' 'cancel' ``` ## Remarks The class fires this event repeatedly to report the progress of the file protection operation. *Current* indicates the amount of processed data in bytes, and *Total* is the total number of bytes to be processed. Use *Cancel* to terminate the protection process. # Config Settings ([PGPWriter](#pgpwriter-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-secureblackbox_pgpwriter-class) method. ### PGPWriter Config Settings **PasswordAttempts**: The number of attempts allowed for entering password.Use this property to specify how many times a wrong password may be entered. **PreserveFilePaths**: Whether to preserve full file names when saving the PGP file.When this property is False, the Encrypt and Sign methods save only the file names (without full paths) to the PGP file. When this property is True, the file names are saved exactly as they are passed to the above mentioned methods, including full paths. This lets you to save directory structures to the encrypted and/or signed PGP files. **SignBufferingMethod**: The type of buffering used during signing.Specifies the behaviour of the signer when operating with the input stream. Allowed values are: 0 - create a temporary stream and copy all data into it; 1 - rewind the input stream. The last option is useful when you have a stream which doesn't support seek operation such as a network stream or a decompressor stream. **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. **TextCompatibilityMode**: Whether whitespaces must be trimmed from the signature.Several versions of PGP have a bug in their implementations which results in creation of incorrect text signatures because they only remove trailing whitespaces from cleartext signatures. Technically, such signatures are not OpenPGP-compliant. Set this property to True if you want to interoperate with these implementations. Set this property to False if you need to create only OpenPGP-compliant messages. **UndefInputLength**: Set this property if you are working with non-seekable streams.Use this property to turn on support for streams with unknown length and position parameters, such as network or database streams. It prevents the class from checking input stream length or position. **UseNewFeatures**: Whether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed.Use this property for compatibility with old versions of PGP-compatible software. If this property is set to True, then newer and stronger algorithms will be used. In this case ClearTextSign and Sign will be compatible with PGP 2.6.x, while Encrypt and EncryptAndSign will not. If the property is set to False, then the result will be compatible with PGP 2.6.x, while the keys are compatible (i.e. don't use features not supported by PGP 2.6.x). **UseOldPackets**: Whether signature packets of old format, compatible with PGP 2.6.3, should be used.The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([PGPWriter](#pgpwriter-class) Class) ### PGPWriter 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)) | | 27262977 | The file was not found ([SB_ERROR_PGP_FILE_NOT_EXISTS](constants.md#const_SBERRORPGPFILENOTEXISTS)) | | 27262978 | Invalid signing key ([SB_ERROR_PGP_INVALID_KEY](constants.md#const_SBERRORPGPINVALIDKEY)) | | 27262980 | No secret key is available ([SB_ERROR_PGP_NO_SECRET_KEY](constants.md#const_SBERRORPGPNOSECRETKEY)) | | 27262982 | The operation is not supported on a subkey ([SB_ERROR_PGP_OPERATION_ON_SUBKEY](constants.md#const_SBERRORPGPOPERATIONONSUBKEY)) |