OfficeEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The OfficeEncryptor class encrypts Office documents.

Syntax

class secureblackbox.OfficeEncryptor

Remarks

OfficeEncryptor encrypts Office documents.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

document_format Property

Defines the format of the Office document.

Syntax

def get_document_format() -> int: ...

document_format = property(get_document_format, None)

Default Value

0

Remarks

This property contains the Office document format.

This property is read-only.

document_type Property

Defines the type of the Office document.

Syntax

def get_document_type() -> str: ...

document_type = property(get_document_type, None)

Default Value

""

Remarks

This property contains the Office document type.

This property is read-only.

encryption_algorithm Property

The encryption algorithm used to encrypt the document.

Syntax

def get_encryption_algorithm() -> str: ...
def set_encryption_algorithm(value: str) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

"Default"

Remarks

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

Supported values:

For Binary Office documents

For OpenXML Office documents (default = SB_SYMMETRIC_ALGORITHM_AES256)

For OpenOffice documents (default = SB_SYMMETRIC_ALGORITHM_BLOWFISH)

encryption_type Property

The encryption type used to encrypt the document.

Syntax

def get_encryption_type() -> int: ...
def set_encryption_type(value: int) -> None: ...

encryption_type = property(get_encryption_type, set_encryption_type)

Default Value

0

Remarks

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

Supported values:

oetDefault uses default encryption depending on Office document format.

oetBinaryRC4 uses RC4 encryption for Binary Office documents.

oetBinaryRC4CryptoAPI uses RC4 Crypto API encryption for Binary Office documents.

oetOpenXMLStandard uses standard encryption for OpenXML Office documents.

oetOpenXMLAgile uses agile encryption for OpenXML Office documents.

oetOpenDocument uses standard encryption for OpenOffice documents.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

input_bytes Property

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

Syntax

def get_input_bytes() -> bytes: ...
def set_input_bytes(value: bytes) -> None: ...

input_bytes = property(get_input_bytes, set_input_bytes)

Remarks

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

input_file Property

The Office file to be encrypted.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

Provide the path to the Office document to be encrypted.

output_bytes Property

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

Syntax

def get_output_bytes() -> bytes: ...

output_bytes = property(get_output_bytes, None)

Remarks

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

This property is read-only.

output_file Property

Defines where to save the encrypted document.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

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

password Property

The password used for decryption.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

Use this property to provide the decryption password.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

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

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

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

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

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

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

encrypt Method

Encrypts the whole document.

Syntax

def encrypt() -> None: ...

Remarks

Call this method to encrypt the document.

on_error Event

Information about errors during signing.

Syntax

class OfficeEncryptorErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class OfficeEncryptor:
@property
def on_error() -> Callable[[OfficeEncryptorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[OfficeEncryptorErrorEventParams], None]) -> None: ...

Remarks

This event is fired in case of exceptional conditions during the office document processing.

ErrorCode contains an error code and Description contains a textual description of the error.

on_notification Event

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

Syntax

class OfficeEncryptorNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class OfficeEncryptor:
@property
def on_notification() -> Callable[[OfficeEncryptorNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[OfficeEncryptorNotificationEventParams], None]) -> None: ...

Remarks

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

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

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

OfficeEncryptor Config Settings

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

OfficeEncryptor Config Settings

Base Config Settings

OfficeEncryptor Errors

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