OfficeEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The OfficeEncryptor class encrypts Office documents.

Class Name

SecureBlackbox_OfficeEncryptor

Procedural Interface

 secureblackbox_officeencryptor_open();
 secureblackbox_officeencryptor_close($res);
 secureblackbox_officeencryptor_register_callback($res, $id, $function);
 secureblackbox_officeencryptor_get_last_error($res);
 secureblackbox_officeencryptor_get_last_error_code($res);
 secureblackbox_officeencryptor_set($res, $id, $index, $value);
 secureblackbox_officeencryptor_get($res, $id, $index);
 secureblackbox_officeencryptor_do_config($res, $configurationstring);
 secureblackbox_officeencryptor_do_doaction($res, $actionid, $actionparams);
 secureblackbox_officeencryptor_do_encrypt($res);

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.

DocumentFormat Property (SecureBlackbox_OfficeEncryptor Class)

Defines the format of the Office document.

Object Oriented Interface

public function getDocumentFormat();

Procedural Interface

secureblackbox_officeencryptor_get($res, 1 );

Default Value

0

Remarks

This property contains the Office document format.

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

Data Type

Integer

DocumentType Property (SecureBlackbox_OfficeEncryptor Class)

Defines the type of the Office document.

Object Oriented Interface

public function getDocumentType();

Procedural Interface

secureblackbox_officeencryptor_get($res, 2 );

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

The encryption algorithm used to encrypt the document.

Object Oriented Interface

public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 3 );


secureblackbox_officeencryptor_set($res, 3, $value );

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)

Data Type

String

EncryptionType Property (SecureBlackbox_OfficeEncryptor Class)

The encryption type used to encrypt the document.

Object Oriented Interface

public function getEncryptionType();


public function setEncryptionType($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 4 );


secureblackbox_officeencryptor_set($res, 4, $value );

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.

Data Type

Integer

FIPSMode Property (SecureBlackbox_OfficeEncryptor Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 5 );


secureblackbox_officeencryptor_set($res, 5, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_OfficeEncryptor Class)

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

Object Oriented Interface

public function getInputBytes();


public function setInputBytes($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 6 );


secureblackbox_officeencryptor_set($res, 6, $value );

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

The Office file to be encrypted.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 7 );


secureblackbox_officeencryptor_set($res, 7, $value );

Default Value

''

Remarks

Provide the path to the Office document to be encrypted.

Data Type

String

OutputBytes Property (SecureBlackbox_OfficeEncryptor Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_officeencryptor_get($res, 8 );

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

Defines where to save the encrypted document.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 9 );


secureblackbox_officeencryptor_set($res, 9, $value );

Default Value

''

Remarks

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

Data Type

String

Password Property (SecureBlackbox_OfficeEncryptor Class)

The password used for decryption.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

secureblackbox_officeencryptor_get($res, 10 );


secureblackbox_officeencryptor_set($res, 10, $value );

Default Value

''

Remarks

Use this property to provide the decryption password.

Data Type

String

Config Method (SecureBlackbox_OfficeEncryptor Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_officeencryptor_do_config($res, $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.

DoAction Method (SecureBlackbox_OfficeEncryptor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_officeencryptor_do_doaction($res, $actionid, $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 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 (SecureBlackbox_OfficeEncryptor Class)

Encrypts the whole document.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

secureblackbox_officeencryptor_do_encrypt($res);

Remarks

Call this method to encrypt the document.

Error Event (SecureBlackbox_OfficeEncryptor Class)

Information about errors during signing.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_officeencryptor_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 '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 (SecureBlackbox_OfficeEncryptor Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_officeencryptor_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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:

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

OfficeEncryptor Config Settings

Base Config Settings

Trappable Errors (OfficeEncryptor Class)

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)