OfficeDecryptor Component
Properties Methods Events Config 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.
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 component in byte array form. |
InputFile | The Office file to be decrypted. |
OutputBytes | Use this property to read the output the component 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 component 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. |
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.
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 component 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. |
SpinCount | Specifies spin count that should be used. |
StartKeyGenerationAlgorithm | Specifies start key generation algorithm that should be used. |
TempPath | Location where the temporary files are stored. |
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 component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
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. |
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. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
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 Component)
Defines the format of the Office document.
Syntax
__property TsbxOfficeDecryptorDocumentFormats DocumentFormat = { read=FDocumentFormat };
enum TsbxOfficeDecryptorDocumentFormats { odfUnknown=0, odfBinary=1, odfOpenXML=2, odfOpenXPS=3, odfOpenDocument=4 };
Default Value
odfUnknown
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 Component)
Defines the type of the Office document.
Syntax
__property String DocumentType = { read=FDocumentType };
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 Component)
The encryption algorithm used to encrypt the document.
Syntax
__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm };
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 Component)
The encryption type used to encrypt the document.
Syntax
__property TsbxOfficeDecryptorEncryptionTypes EncryptionType = { read=FEncryptionType };
enum TsbxOfficeDecryptorEncryptionTypes { oetDefault=0, oetBinaryRC4=1, oetBinaryRC4CryptoAPI=2, oetOpenXMLStandard=3, oetOpenXMLAgile=4, oetOpenDocument=5 };
Default Value
oetDefault
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 Component)
Reserved.
Syntax
__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
InputBytes Property (OfficeDecryptor Component)
Use this property to pass the input to component in byte array form.
Syntax
__property DynamicArrayInputBytes = { read=FInputBytes, write=FSetInputBytes };
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 Component)
The Office file to be decrypted.
Syntax
__property String InputFile = { read=FInputFile, write=FSetInputFile };
Default Value
""
Remarks
Provide the path to the Office document to be decrypted.
Data Type
String
OutputBytes Property (OfficeDecryptor Component)
Use this property to read the output the component object has produced.
Syntax
__property DynamicArrayOutputBytes = { read=FOutputBytes };
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 Component)
Defines where to save the decrypted document.
Syntax
__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };
Default Value
""
Remarks
Specifies the path where the decrypted Office document should be saved.
Data Type
String
Password Property (OfficeDecryptor Component)
The password used for decryption.
Syntax
__property String Password = { read=FPassword, write=FSetPassword };
Default Value
""
Remarks
Use this property to provide the decryption password.
Data Type
String
Config Method (OfficeDecryptor Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
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
void __fastcall Decrypt();
Remarks
Call this method to decrypt the document.
DoAction Method (OfficeDecryptor Component)
Performs an additional action.
Syntax
String __fastcall DoAction(String ActionID, String ActionParams);
Remarks
DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
DecryptionPasswordNeeded Event (OfficeDecryptor Component)
Request to provide decryption password during decryption.
Syntax
typedef struct { bool CancelDecryption; } TsbxOfficeDecryptorDecryptionPasswordNeededEventParams; typedef void __fastcall (__closure *TsbxOfficeDecryptorDecryptionPasswordNeededEvent)(System::TObject* Sender, TsbxOfficeDecryptorDecryptionPasswordNeededEventParams *e); __property TsbxOfficeDecryptorDecryptionPasswordNeededEvent OnDecryptionPasswordNeeded = { 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
typedef struct { int ErrorCode; String Description; } TsbxOfficeDecryptorErrorEventParams; typedef void __fastcall (__closure *TsbxOfficeDecryptorErrorEvent)(System::TObject* Sender, TsbxOfficeDecryptorErrorEventParams *e); __property TsbxOfficeDecryptorErrorEvent OnError = { 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
typedef struct { String EventID; String EventParam; } TsbxOfficeDecryptorNotificationEventParams; typedef void __fastcall (__closure *TsbxOfficeDecryptorNotificationEvent)(System::TObject* Sender, TsbxOfficeDecryptorNotificationEventParams *e); __property TsbxOfficeDecryptorNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This component 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 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 Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
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) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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) |