OfficeEncryptor Class
Properties Methods Events Config Settings Errors
The OfficeEncryptor class encrypts Office documents.
Syntax
class secureblackbox.OfficeEncryptor
Remarks
OfficeEncryptor encrypts Office documents.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| document_format | Defines the format of the Office document. |
| document_type | Defines the type of the Office document. |
| encryption_algorithm | The encryption algorithm used to encrypt the document. |
| encryption_type | The encryption type used to encrypt the document. |
| fips_mode | Reserved. |
| input_bytes | Use this property to pass the input to class in byte array form. |
| input_file | The Office file to be encrypted. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | Defines where to save the encrypted document. |
| password | The password used for decryption. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| encrypt | Encrypts the whole document. |
| reset | Resets the class settings. |
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.
| on_error | Information about errors during signing. |
| on_notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| ChecksumAlgorithm | Specifies checksum algorithm that should be used. |
| EncryptDocumentProperties | Specifies if document properties should be encrypted. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| HashAlgorithm | Specifies hash algorithm that should be used. |
| RC4KeyBits | Specifies the number of key bits used for RC4 algorithm. |
| SaltSize | Specifies salt size that should be used. |
| SignatureLineAdditionalSignatureInfo[Index] | Contains additional signature information. |
| SignatureLineAllowComments[Index] | Indicates if comments are allowed. |
| SignatureLineCount | The number of signature lines. |
| SignatureLineId[Index] | Contains signature unique ID. |
| SignatureLineImageData[Index] | Contains signature image. |
| SignatureLineShowSignDate[Index] | Indicates if signing date should be shown. |
| SignatureLineSignatureIndex[Index] | The index of the signature that signs signature line. |
| SignatureLineSignatureProviderId[Index] | Contains signature provider ID. |
| SignatureLineSignatureProviderUrl[Index] | Contains signature provider URL. |
| SignatureLineSigned[Index] | Indicates if signature line is signed. |
| SignatureLineSigningInstructions[Index] | Contains signing instructions. |
| SignatureLineSuggestedSigner2[Index] | Suggested signer line two. |
| SignatureLineSuggestedSigner[Index] | Suggested signer line one. |
| SignatureLineSuggestedSignerEmail[Index] | Suggested signer email address. |
| SpinCount | Specifies spin count that should be used. |
| StartKeyGenerationAlgorithm | Specifies start key generation algorithm that should be used. |
| TempPath | Path for storing temporary files. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
document_format Property
Defines the format of the Office document.
Syntax
def get_document_format() -> int: ...
document_format = property(get_document_format, None)
Default Value
0
Remarks
This property contains the Office document format.
| odfUnknown | 0 | Unknown document format |
| odfBinary | 1 | Binary Office document |
| odfOpenXML | 2 | OpenXML Office document |
| odfOpenXPS | 3 | OpenXPS document |
| odfOpenDocument | 4 | OpenOffice document |
This property is read-only.
document_type Property
Defines the type of the Office document.
Syntax
def get_document_type() -> str: ...
document_type = property(get_document_type, None)
Default Value
""
Remarks
This property contains the Office document type.
This property is read-only.
encryption_algorithm Property
The encryption algorithm used to encrypt the document.
Syntax
def get_encryption_algorithm() -> str: ... def set_encryption_algorithm(value: str) -> None: ...
encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)
Default Value
"Default"
Remarks
This property contains the encryption algorithm used to encrypt the Office document.
Supported values:
For Binary Office documents
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 |
For OpenXML Office documents (default = SB_SYMMETRIC_ALGORITHM_AES256)
| SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_DES | DES | |
| SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
For OpenOffice documents (default = SB_SYMMETRIC_ALGORITHM_BLOWFISH)
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
| SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish |
encryption_type Property
The encryption type used to encrypt the document.
Syntax
def get_encryption_type() -> int: ... def set_encryption_type(value: int) -> None: ...
encryption_type = property(get_encryption_type, set_encryption_type)
Default Value
0
Remarks
This property contains the encryption type used to encrypt the Office document.
Supported values:
oetDefault uses default encryption depending on Office document format.
oetBinaryRC4 uses RC4 encryption for Binary Office documents.
oetBinaryRC4CryptoAPI uses RC4 Crypto API encryption for Binary Office documents.
oetOpenXMLStandard uses standard encryption for OpenXML Office documents.
oetOpenXMLAgile uses agile encryption for OpenXML Office documents.
oetOpenDocument uses standard encryption for OpenOffice documents.
fips_mode Property
Reserved.
Syntax
def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
Default Value
FALSE
Remarks
This property is reserved for future use.
input_bytes Property
Use this property to pass the input to class in byte array form.
Syntax
def get_input_bytes() -> bytes: ... def set_input_bytes(value: bytes) -> None: ...
input_bytes = property(get_input_bytes, set_input_bytes)
Remarks
Assign a byte array containing the data to be processed to this property.
input_file Property
The Office file to be encrypted.
Syntax
def get_input_file() -> str: ... def set_input_file(value: str) -> None: ...
input_file = property(get_input_file, set_input_file)
Default Value
""
Remarks
Provide the path to the Office document to be encrypted.
output_bytes Property
Use this property to read the output the class object has produced.
Syntax
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
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 output_file and output_stream properties had not been assigned.
This property is read-only.
output_file Property
Defines where to save the encrypted document.
Syntax
def get_output_file() -> str: ... def set_output_file(value: str) -> None: ...
output_file = property(get_output_file, set_output_file)
Default Value
""
Remarks
Specifies the path where the encrypted Office document should be saved.
password Property
The password used for decryption.
Syntax
def get_password() -> str: ... def set_password(value: str) -> None: ...
password = property(get_password, set_password)
Default Value
""
Remarks
Use this property to provide the decryption password.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.
do_action Method
Performs an additional action.
Syntax
def do_action(action_id: str, action_params: str) -> str: ...
Remarks
do_action 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;....
encrypt Method
Encrypts the whole document.
Syntax
def encrypt() -> None: ...
Remarks
Call this method to encrypt the document.
reset Method
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
on_error Event
Information about errors during signing.
Syntax
class OfficeEncryptorErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class OfficeEncryptor: @property def on_error() -> Callable[[OfficeEncryptorErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[OfficeEncryptorErrorEventParams], None]) -> None: ...
Remarks
This event is fired in case of exceptional conditions during the office document processing.
ErrorCode contains an error code and Description contains a textual description of the error.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class OfficeEncryptorNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class OfficeEncryptor: @property def on_notification() -> Callable[[OfficeEncryptorNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[OfficeEncryptorNotificationEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
| DocumentLoaded | Reports the completion of Office document processing by the component. Use the event handler to access document-related information. The EventParam value passed with this EventID is empty. |
| SignatureLoaded | Reports the completion of signature loading. When this event fires, you can expect the signatures to be fully loaded. The EventParam value passed with this EventID is empty. |
OfficeEncryptor Config Settings
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 method.OfficeEncryptor Config Settings
ChecksumAlgorithm:
Specifies checksum algorithm that should be used.Specifies checksum algorithm when OpenOffice documents is used.
EncryptDocumentProperties:
Specifies if document properties should be encrypted.Specifies if the document properties should be encrypted when RC4 Crypto API encryption type for Binary Office documents is used.
HardenedKeyGeneration:
Specifies if hardened Key generation should be used.Specifies if hardened Key generation should be used when RC4 Crypto API encryption type for Binary Office documents is used.
HashAlgorithm:
Specifies hash algorithm that should be used.Specifies hash algorithm when Agile encryption type for OpenXML documents is used.
RC4KeyBits:
Specifies the number of key bits used for RC4 algorithm.Specifies the number of key bits when RC4 Crypto API encryption type for Binary Office documents is used.
SaltSize:
Specifies salt size that should be used.Specifies size of the random salt when Agile encryption type for OpenXML documents is used.
SignatureLineAdditionalSignatureInfo[Index]:
Contains additional signature information.This property contains additional signature information.
SignatureLineAllowComments[Index]:
Indicates if comments are allowed.This property contains the True value if comments are allowed.
SignatureLineCount:
The number of signature lines.Returns the number of the signature lines available for Office Open XML (OOXML) documents.
SignatureLineId[Index]:
Contains signature unique ID.This property contains signature unique ID.
SignatureLineImageData[Index]:
Contains signature image.This property contains signature image.
SignatureLineShowSignDate[Index]:
Indicates if signing date should be shown.This property contains the True value if the signature line should include the signing date.
SignatureLineSignatureIndex[Index]:
The index of the signature that signs signature line.This property contains the index of the signature that signs this signature line.
SignatureLineSignatureProviderId[Index]:
Contains signature provider ID.This property contains a unique ID identifying which signature provider created the signature line.
SignatureLineSignatureProviderUrl[Index]:
Contains signature provider URL.This property contains a signature provider download URL.
SignatureLineSigned[Index]:
Indicates if signature line is signed.This property contains the True value if signature line is signed.
SignatureLineSigningInstructions[Index]:
Contains signing instructions.This property contains the instructions, shown to the user at signing time.
SignatureLineSuggestedSigner2[Index]:
Suggested signer line two.This property contains the second line of information of who should sign the signature line.
SignatureLineSuggestedSigner[Index]:
Suggested signer line one.This property contains the first line of information of who should sign the signature line.
SignatureLineSuggestedSignerEmail[Index]:
Suggested signer email address.This property contains the email address of who should sign the signature line.
SpinCount:
Specifies spin count that should be used.Specifies the number of times to iterate the password hash when creating the key used to encrypt data when Agile encryption type for OpenXML documents is used.
StartKeyGenerationAlgorithm:
Specifies start key generation algorithm that should be used.Specifies start key generation algorithm when OpenOffice documents is used.
TempPath:
Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored.
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.
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: auto, enable, or disable.
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.
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 devided by the | (pipe) character.
StaticIPAddresses:
Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions.
If StaticDNS of the 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 chached 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).
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).
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.
OfficeEncryptor Errors
OfficeEncryptor Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 24117249 | The input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS) |
| 24117250 | Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT) |
| 24117251 | The document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE) |
| 24117253 | The document is already encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED) |
| 24117254 | The document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE) |
| 24117255 | The document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED) |
| 24117256 | Unsupported encryption type (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION) |
| 24117257 | Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD) |
| 24117258 | No signature found to complete the asynchronous signing (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND) |