OfficeDecryptor Class

Properties Methods Events Config Settings Errors

The OfficeDecryptor class decrypts Office documents.

Syntax

OfficeDecryptor

Remarks

OfficeDecryptor decrypts encrypted Office documents, with support for several different Office formats.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


DocumentFormat	Defines the format of the Office document.
DocumentType	Defines the type of the Office document.
EncryptionAlgorithm	The encryption algorithm used to encrypt the document.
EncryptionType	The encryption type used to encrypt the document.
FIPSMode	Reserved.
InputBytes	Use this property to pass the input to class in byte array form.
InputFile	The Office file to be decrypted.
OutputBytes	Use this property to read the output the class object has produced.
OutputFile	Defines where to save the decrypted 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.
Decrypt	Decrypts the whole document.
DoAction	Performs an additional action.
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.


DecryptionPasswordNeeded	Request to provide decryption password during decryption.
Error	Information about errors during signing.
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.

DocumentFormat Property (OfficeDecryptor Class)

Defines the format of the Office document.

Syntax

ANSI (Cross Platform)
int GetDocumentFormat();

Unicode (Windows)
INT GetDocumentFormat();

Possible Values

ODF_UNKNOWN(0), 
ODF_BINARY(1), 
ODF_OPEN_XML(2), 
ODF_OPEN_XPS(3), 
ODF_OPEN_DOCUMENT(4)

int secureblackbox_officedecryptor_getdocumentformat(void* lpObj);

int GetDocumentFormat();

Default Value

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 and not available at design time.

Data Type

Integer

DocumentType Property (OfficeDecryptor Class)

Defines the type of the Office document.

Syntax

ANSI (Cross Platform)
char* GetDocumentType();

Unicode (Windows)
LPWSTR GetDocumentType();

char* secureblackbox_officedecryptor_getdocumenttype(void* lpObj);

QString GetDocumentType();

Default Value

Remarks

This property contains the Office document type.

This property is read-only and not available at design time.

Data Type

String

EncryptionAlgorithm Property (OfficeDecryptor Class)

The encryption algorithm used to encrypt the document.

Syntax

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();

char* secureblackbox_officedecryptor_getencryptionalgorithm(void* lpObj);

QString GetEncryptionAlgorithm();

Default Value

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


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: AES128, AES192, AES256, Blowfish


SB_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`

This property is read-only and not available at design time.

Data Type

String

EncryptionType Property (OfficeDecryptor Class)

The encryption type used to encrypt the document.

Syntax

ANSI (Cross Platform)
int GetEncryptionType();

Unicode (Windows)
INT GetEncryptionType();

Possible Values

OET_DEFAULT(0), 
OET_BINARY_RC4(1), 
OET_BINARY_RC4CRYPTO_API(2), 
OET_OPEN_XMLSTANDARD(3), 
OET_OPEN_XMLAGILE(4), 
OET_OPEN_DOCUMENT(5)

int secureblackbox_officedecryptor_getencryptiontype(void* lpObj);

int GetEncryptionType();

Default Value

Remarks

This property contains the encryption type used to encrypt the Office document.

Supported values:


oetDefault	`0`	Uses default encryption depending on Office document format
oetBinaryRC4	`1`	Uses RC4 encryption for Binary Office documents
oetBinaryRC4CryptoAPI	`2`	Uses RC4 Crypto API encryption for Binary Office documents
oetOpenXMLStandard	`3`	Uses standard encryption for OpenXML Office documents
oetOpenXMLAgile	`4`	Uses agile encryption for OpenXML Office documents
oetOpenDocument	`5`	Uses standard encryption for OpenOffice documents

This property is read-only and not available at design time.

Data Type

Integer

FIPSMode Property (OfficeDecryptor Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_officedecryptor_getfipsmode(void* lpObj);
int secureblackbox_officedecryptor_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (OfficeDecryptor Class)

Use this property to pass the input to class in byte array form.

Syntax

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_officedecryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_officedecryptor_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

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 (OfficeDecryptor Class)

The Office file to be decrypted.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_officedecryptor_getinputfile(void* lpObj);
int secureblackbox_officedecryptor_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

Remarks

Provide the path to the Office document to be decrypted.

Data Type

String

OutputBytes Property (OfficeDecryptor Class)

Use this property to read the output the class object has produced.

Syntax

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_officedecryptor_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

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 and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (OfficeDecryptor Class)

Defines where to save the decrypted document.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_officedecryptor_getoutputfile(void* lpObj);
int secureblackbox_officedecryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

Remarks

Specifies the path where the decrypted Office document should be saved.

Data Type

String

Password Property (OfficeDecryptor Class)

The password used for decryption.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* secureblackbox_officedecryptor_getpassword(void* lpObj);
int secureblackbox_officedecryptor_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

Use this property to provide the decryption password.

Data Type

String

Config Method (OfficeDecryptor Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_officedecryptor_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Decrypt Method (OfficeDecryptor Class)

Decrypts the whole document.

Syntax

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int secureblackbox_officedecryptor_decrypt(void* lpObj);

int Decrypt();

Remarks

Call this method to decrypt the document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoAction Method (OfficeDecryptor Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_officedecryptor_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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;....

Error Handling (C++)

Reset Method (OfficeDecryptor Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_officedecryptor_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

DecryptionPasswordNeeded Event (OfficeDecryptor Class)

Request to provide decryption password during decryption.

Syntax

ANSI (Cross Platform)
virtual int FireDecryptionPasswordNeeded(OfficeDecryptorDecryptionPasswordNeededEventParams *e);

typedef struct {
  int CancelDecryption;
  int reserved;
} OfficeDecryptorDecryptionPasswordNeededEventParams;


Unicode (Windows)
virtual INT FireDecryptionPasswordNeeded(OfficeDecryptorDecryptionPasswordNeededEventParams *e);

typedef struct {
  BOOL CancelDecryption;
  INT reserved;
} OfficeDecryptorDecryptionPasswordNeededEventParams;

#define EID_OFFICEDECRYPTOR_DECRYPTIONPASSWORDNEEDED 1

virtual INT SECUREBLACKBOX_CALL FireDecryptionPasswordNeeded(BOOL &bCancelDecryption);

class OfficeDecryptorDecryptionPasswordNeededEventParams {
public:
  bool CancelDecryption();
  void SetCancelDecryption(bool bCancelDecryption);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DecryptionPasswordNeeded(OfficeDecryptorDecryptionPasswordNeededEventParams *e);

// Or, subclass OfficeDecryptor and override this emitter function.
virtual int FireDecryptionPasswordNeeded(OfficeDecryptorDecryptionPasswordNeededEventParams *e) {...}

Remarks

This event is fired when the component needs decryption password from the user.

if CancelDecryption property is set to true value (default value) then decryption would fail if provided password is invalid. Otherwise this event would be fired again.

Error Event (OfficeDecryptor Class)

Information about errors during signing.

Syntax

ANSI (Cross Platform)
virtual int FireError(OfficeDecryptorErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} OfficeDecryptorErrorEventParams;


Unicode (Windows)
virtual INT FireError(OfficeDecryptorErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} OfficeDecryptorErrorEventParams;

#define EID_OFFICEDECRYPTOR_ERROR 2

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class OfficeDecryptorErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(OfficeDecryptorErrorEventParams *e);

// Or, subclass OfficeDecryptor and override this emitter function.
virtual int FireError(OfficeDecryptorErrorEventParams *e) {...}

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.

Notification Event (OfficeDecryptor Class)

This event notifies the application about an underlying control flow event.

Syntax

ANSI (Cross Platform)
virtual int FireNotification(OfficeDecryptorNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} OfficeDecryptorNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(OfficeDecryptorNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} OfficeDecryptorNotificationEventParams;

#define EID_OFFICEDECRYPTOR_NOTIFICATION 3

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class OfficeDecryptorNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(OfficeDecryptorNotificationEventParams *e);

// Or, subclass OfficeDecryptor and override this emitter function.
virtual int FireNotification(OfficeDecryptorNotificationEventParams *e) {...}

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.

Config Settings (OfficeDecryptor 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 method.

OfficeDecryptor 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.

Trappable Errors (OfficeDecryptor Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

OfficeDecryptor 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`)