Docs

SecureBlackbox 2022 Delphi Edition

Version 22.0 [Build 8174]

OfficeDecryptor Component

Properties   Methods   Events   Configuration Settings   Errors  

The OfficeDecryptor component decrypts Office documents.

Syntax

TsbxOfficeDecryptor

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 component with short descriptions. Click on the links for further details.

DocumentFormatDefines the format of the Office document.
EncryptionAlgorithmThe encryption algorithm used to encrypt the document.
EncryptionTypeThe encryption type used to encrypt the document.
FIPSModeReserved.
InputBytesUse this property to pass the input to component in the byte array form.
InputFileThe Office file to be decrypted.
OutputBytesUse this property to read the output the component object has produced.
OutputFileDefines where to save the decrypted document.
PasswordThe password used for decryption.

Method List


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

ConfigSets or retrieves a configuration setting.
DecryptDecrypts the whole document.
DoActionPerforms an additional action.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

DecryptionPasswordNeededRequest to provide decryption password during decryption.
ErrorInformation about errors during signing.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

ChecksumAlgorithmSpecifies checksum algorithm that should be used.
EncryptDocumentPropertiesSpecifies if document properties should be encrypted.
HardenedKeyGenerationSpecifies if hardened Key generation should be used.
HashAlgorithmSpecifies hash algorithm that should be used.
RC4KeyBitsSpecifies the number of key bits used for RC4 algorithm.
SaltSizeSpecifies salt size that should be used.
SpinCountSpecifies spin count that should be used.
StartKeyGenerationAlgorithmSpecifies start key generation algorithm that should be used.
TempPathLocation where the temporary files are stored.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

DocumentFormat Property (OfficeDecryptor Component)

Defines the format of the Office document.

Syntax

property DocumentFormat: TsbxOfficeDocumentFormats read get_DocumentFormat;
TsbxOfficeDocumentFormats = ( odfUnknown, odfBinary, odfOpenXML, odfOpenXPS, odfOpenDocument );

Default Value

odfUnknown

Remarks

This property contains the Office document format.

odfUnknown0Unknown document format
odfBinary1Binary Office document
odfOpenXML2OpenXML Office document
odfOpenXPS3OpenXPS document
odfOpenDocument4OpenOffice document

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

EncryptionAlgorithm Property (OfficeDecryptor Component)

The encryption algorithm used to encrypt the document.

Syntax

property EncryptionAlgorithm: String read get_EncryptionAlgorithm;

Default Value

''

Remarks

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

Supported values:

For Binary Office documents

SB_SYMMETRIC_ALGORITHM_RC4RC4

For OpenXML Office documents

SB_SYMMETRIC_ALGORITHM_RC2RC2
SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_DESDES
SB_SYMMETRIC_ALGORITHM_3DES3DES
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256

For OpenOffice documents: AES128, AES192, AES256, Blowfish

SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES192AES192
SB_SYMMETRIC_ALGORITHM_AES256AES256
SB_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish

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

EncryptionType Property (OfficeDecryptor Component)

The encryption type used to encrypt the document.

Syntax

property EncryptionType: TsbxOfficeEncryptionTypes read get_EncryptionType;
TsbxOfficeEncryptionTypes = ( oetDefault, oetBinaryRC4, oetBinaryRC4CryptoAPI, oetOpenXMLStandard, oetOpenXMLAgile, oetOpenDocument );

Default Value

oetDefault

Remarks

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

Supported values:

oetDefault0Uses default encryption depending on Office document format
oetBinaryRC41Uses RC4 encryption for Binary Office documents
oetBinaryRC4CryptoAPI2Uses RC4 Crypto API encryption for Binary Office documents
oetOpenXMLStandard3Uses standard encryption for OpenXML Office documents
oetOpenXMLAgile4Uses agile encryption for OpenXML Office documents
oetOpenDocument5Uses standard encryption for OpenOffice documents

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

FIPSMode Property (OfficeDecryptor Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

InputBytes Property (OfficeDecryptor Component)

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

Syntax

property InputBytes: TBytes read get_InputBytes write set_InputBytes;

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

InputFile Property (OfficeDecryptor Component)

The Office file to be decrypted.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

Default Value

''

Remarks

Provide the path to the Office document to be decrypted.

OutputBytes Property (OfficeDecryptor Component)

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

Syntax

property OutputBytes: TBytes read get_OutputBytes;

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

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

OutputFile Property (OfficeDecryptor Component)

Defines where to save the decrypted document.

Syntax

property OutputFile: String read get_OutputFile write set_OutputFile;

Default Value

''

Remarks

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

Password Property (OfficeDecryptor Component)

The password used for decryption.

Syntax

property Password: String read get_Password write set_Password;

Default Value

''

Remarks

Use this property to provide the decryption password.

Config Method (OfficeDecryptor Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (OfficeDecryptor Component)

Decrypts the whole document.

Syntax

procedure Decrypt();

Remarks

Call this method to decrypt the document.

DoAction Method (OfficeDecryptor Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): String;

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DecryptionPasswordNeeded Event (OfficeDecryptor Component)

Request to provide decryption password during decryption.

Syntax

type TDecryptionPasswordNeededEvent = procedure (
  Sender: TObject;
  var CancelDecryption: Boolean
) of Object;

property OnDecryptionPasswordNeeded: TDecryptionPasswordNeededEvent read FOnDecryptionPasswordNeeded write FOnDecryptionPasswordNeeded;

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 Component)

Information about errors during signing.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

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 Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This component can fire this event with the following EventID values:

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

Configuration Settings (OfficeDecryptor Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

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

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:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

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 components that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

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.

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 Component)

OfficeDecryptor Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
24117249   Input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS)
24117250   Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT)
24117251   Document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE)
24117252   Document is not signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED)
24117253   Document is encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED)
24117254   Document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE)
24117255   Document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED)
24117256   Unknown encryption algorithm (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION)
24117257   Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD)
24117258   Signature not found (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 Delphi Edition - Version 22.0 [Build 8174]