OfficeDecryptor Class
Properties Methods Events Config Settings Errors
The OfficeDecryptor class decrypts Office documents.
Syntax
secureblackbox.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 the byte array form. |
InputFile | The Office file to be decrypted. |
InputStream | Stream containing the Office document. |
OutputBytes | Use this property to read the output the class object has produced. |
OutputFile | Defines where to save the decrypted document. |
OutputStream | The stream where the decrypted document would be saved. |
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. |
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. |
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 class (supported for HTTPClient, RESTClient and SOAPClient only). |
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 classes 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 Class)
Defines the format of the Office document.
Syntax
public int getDocumentFormat(); Enumerated values: public final static int odfUnknown = 0; public final static int odfBinary = 1; public final static int odfOpenXML = 2; public final static int odfOpenXPS = 3; public final static int odfOpenDocument = 4;
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 and not available at design time.
DocumentType Property (OfficeDecryptor Class)
Defines the type of the Office document.
Syntax
public String getDocumentType();
Default Value
""
Remarks
This property contains the Office document type.
This property is read-only and not available at design time.
EncryptionAlgorithm Property (OfficeDecryptor Class)
The encryption algorithm used to encrypt the document.
Syntax
public String 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.
EncryptionType Property (OfficeDecryptor Class)
The encryption type used to encrypt the document.
Syntax
public int getEncryptionType(); Enumerated values: public final static int oetDefault = 0; public final static int oetBinaryRC4 = 1; public final static int oetBinaryRC4CryptoAPI = 2; public final static int oetOpenXMLStandard = 3; public final static int oetOpenXMLAgile = 4; public final static int oetOpenDocument = 5;
Default Value
0
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.
FIPSMode Property (OfficeDecryptor Class)
Reserved.
Syntax
public boolean isFIPSMode(); public void setFIPSMode(boolean FIPSMode);
Default Value
False
Remarks
This property is reserved for future use.
InputBytes Property (OfficeDecryptor Class)
Use this property to pass the input to class in the byte array form.
Syntax
public byte[] getInputBytes(); public void setInputBytes(byte[] 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 Class)
The Office file to be decrypted.
Syntax
public String getInputFile(); public void setInputFile(String inputFile);
Default Value
""
Remarks
Provide the path to the Office document to be decrypted.
InputStream Property (OfficeDecryptor Class)
Stream containing the Office document.
Syntax
public java.io.InputStream getInputStream(); public void setInputStream(java.io.InputStream inputStream);
Default Value
null
Remarks
Use this property to feed the document to the class via a stream.
This property is not available at design time.
OutputBytes Property (OfficeDecryptor Class)
Use this property to read the output the class object has produced.
Syntax
public byte[] getOutputBytes();
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 Class)
Defines where to save the decrypted document.
Syntax
public String getOutputFile(); public void setOutputFile(String outputFile);
Default Value
""
Remarks
Specifies the path where the decrypted Office document should be saved.
OutputStream Property (OfficeDecryptor Class)
The stream where the decrypted document would be saved.
Syntax
public java.io.OutputStream getOutputStream(); public void setOutputStream(java.io.OutputStream outputStream);
Default Value
null
Remarks
Use this property to save the decrypted document to the stream.
This property is not available at design time.
Password Property (OfficeDecryptor Class)
The password used for decryption.
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
Use this property to provide the decryption password.
Config Method (Officedecryptor Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
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.
Decrypt Method (Officedecryptor Class)
Decrypts the whole document.
Syntax
public void decrypt();
Remarks
Call this method to decrypt the document.
DoAction Method (Officedecryptor Class)
Performs an additional action.
Syntax
public String doAction(String actionID, String actionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insencitive) 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 Class)
Request to provide decryption password during decryption.
Syntax
public class DefaultOfficedecryptorEventListener implements OfficedecryptorEventListener { ... public void decryptionPasswordNeeded(OfficedecryptorDecryptionPasswordNeededEvent e) {} ... } public class OfficedecryptorDecryptionPasswordNeededEvent { public boolean cancelDecryption; }
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
public class DefaultOfficedecryptorEventListener implements OfficedecryptorEventListener { ... public void error(OfficedecryptorErrorEvent e) {} ... } public class OfficedecryptorErrorEvent { public int errorCode; public String description; }
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
public class DefaultOfficedecryptorEventListener implements OfficedecryptorEventListener { ... public void notification(OfficedecryptorNotificationEvent e) {} ... } public class OfficedecryptorNotificationEvent { public String eventID; public String eventParam; }
Remarks
The class 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 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. | ||||||||||||||||||||||||||||||
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 Config 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 class.
Supported values are:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).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. | ||||||||||||||||||||||||||||||
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". | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
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)
OfficeDecryptor Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class 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) |