MessageEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The MessageEncryptor class encrypts data and stores it in the PKCS#7 format.

Class Name

SecureBlackbox_MessageEncryptor

Procedural Interface

 secureblackbox_messageencryptor_open();
 secureblackbox_messageencryptor_close($res);
 secureblackbox_messageencryptor_register_callback($res, $id, $function);
 secureblackbox_messageencryptor_get_last_error($res);
 secureblackbox_messageencryptor_get_last_error_code($res);
 secureblackbox_messageencryptor_set($res, $id, $index, $value);
 secureblackbox_messageencryptor_get($res, $id, $index);
 secureblackbox_messageencryptor_do_addattribute($res, $oid, $value, $signedattribute);
 secureblackbox_messageencryptor_do_config($res, $configurationstring);
 secureblackbox_messageencryptor_do_doaction($res, $actionid, $actionparams);
 secureblackbox_messageencryptor_do_encrypt($res);
 secureblackbox_messageencryptor_do_reset($res);

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

MessageEncryptor can encrypt binary data into PKCS#7 EnvelopedData (asymmetric encryption) and EncryptedData (symmetric encryption) subformats. RSA and ECDH key wrapping and all popular symmetric encryption algorithms are supported.

Setting up and using MessageEncryptor is easy:

• Set up your source and destination via InputFile (InputBytes) and OutputFile (OutputBytes) properties.
• Set EncryptionType as per the desired encryption type (asymmetric, symmetric, asymmetric with authentication).
• Set EncryptionAlgorithm and, optionally, BitsInKey (if the encryption algorithm uses variable key lengths).
• For certificate-based (asymmetric) encryption, put the encryption certificate (or all of them, if there are more than one) to the EncryptionCertificates collection.
• For key-based (symmetric) encryption, assign the symmetric key to Key property.
• Call Encrypt to execute the operation.

Note that MessageEncryptor always produces binary PKCS#7-compliant encrypted messages. For S/MIME email encryption, see MailWriter. For PGP encryption, see PGPWriter. For raw symmetric encryption, see SymmetricCrypto. For XML-ENC encryption, see XMLEncryptor. MessageEncryptor encryptor = new MessageEncryptor(); // Set the encryption algorithm (default AES128) encryptor.setEncryptionAlgorithm("3DES"); // Select the file which contains the message that will be encrypted encryptor.setInputFile("decryptedMessage.txt"); // Select the file where the encrypted message will be written encryptor.setOutputFile("encryptedMessage.bin"); // We are using the public part of the certificate to encrypt data encryptor.setEncryptionCertificate(new Certificate("cert.cer")); encryptor.encrypt(); // Encrypt

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.

BitsInKey Property (SecureBlackbox_MessageEncryptor Class)

The length of the encryption key.

Object Oriented Interface

public function getBitsInKey();
public function setBitsInKey($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 1 );
secureblackbox_messageencryptor_set($res, 1, $value );

Default Value

0

Remarks

When using a variable-key encryption algorithm (typical examples are RC4, RC2, and Blowfish), provide the desired key length via this property.

This value is ignored if a fixed-key algorithm (such as AES128 or 3DES) is used.

Data Type

Integer

EncryptionAlgorithm Property (SecureBlackbox_MessageEncryptor Class)

The symmetric key algorithm to use for encryption.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 2 );
secureblackbox_messageencryptor_set($res, 2, $value );

Default Value

'AES128'

Remarks

Use this property to specify the symmetric algorithm to encrypt the data with.

Data Type

String

EncryptionCertCount Property (SecureBlackbox_MessageEncryptor Class)

The number of records in the EncryptionCert arrays.

Object Oriented Interface

public function getEncryptionCertCount();
public function setEncryptionCertCount($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 3 );
secureblackbox_messageencryptor_set($res, 3, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EncryptionCertBytes
• EncryptionCertHandle

The array indices start at 0 and end at EncryptionCertCount - 1.

This property is not available at design time.

Data Type

Integer

EncryptionCertBytes Property (SecureBlackbox_MessageEncryptor Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertBytes($encryptioncertindex);

Procedural Interface

secureblackbox_messageencryptor_get($res, 4 , $encryptioncertindex);

Remarks

Returns the raw certificate data in DER format.

The $encryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

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

Data Type

Byte Array

EncryptionCertHandle Property (SecureBlackbox_MessageEncryptor Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getEncryptionCertHandle($encryptioncertindex);
public function setEncryptionCertHandle($encryptioncertindex, $value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 12 , $encryptioncertindex);
secureblackbox_messageencryptor_set($res, 12, $value , $encryptioncertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $encryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is not available at design time.

Data Type

Long64

EncryptionType Property (SecureBlackbox_MessageEncryptor Class)

Specifies the kind of encrypted message to create.

Object Oriented Interface

public function getEncryptionType();
public function setEncryptionType($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 43 );
secureblackbox_messageencryptor_set($res, 43, $value );

Default Value

1

Remarks

Possible values:

Data Type

Integer

FIPSMode Property (SecureBlackbox_MessageEncryptor Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 44 );
secureblackbox_messageencryptor_set($res, 44, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_MessageEncryptor 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_messageencryptor_get($res, 45 );
secureblackbox_messageencryptor_set($res, 45, $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_MessageEncryptor Class)

A path to the source file.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 46 );
secureblackbox_messageencryptor_set($res, 46, $value );

Default Value

''

Remarks

Use this property to provide a path to the file containing the data to be encrypted.

Data Type

String

Key Property (SecureBlackbox_MessageEncryptor Class)

The symmetric key to use for encryption.

Object Oriented Interface

public function getKey();
public function setKey($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 47 );
secureblackbox_messageencryptor_set($res, 47, $value );

Remarks

Use this property to provide a symmetric key to use for encryption. If the symmetric key is provided, an output message of EncryptedData type will be formed. The recipient of this message will need to have the same key to decrypt it.

This property is not available at design time.

Data Type

Byte Array

OutputBytes Property (SecureBlackbox_MessageEncryptor Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_messageencryptor_get($res, 48 );

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_MessageEncryptor Class)

A path to the output file.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 49 );
secureblackbox_messageencryptor_set($res, 49, $value );

Default Value

''

Remarks

Use this property to specify the file to save the encrypted message to.

Data Type

String

SignedAttributeCount Property (SecureBlackbox_MessageEncryptor Class)

The number of records in the SignedAttribute arrays.

Object Oriented Interface

public function getSignedAttributeCount();
public function setSignedAttributeCount($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 50 );
secureblackbox_messageencryptor_set($res, 50, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignedAttributeOID
• SignedAttributeValue

The array indices start at 0 and end at SignedAttributeCount - 1.

This property is not available at design time.

Data Type

Integer

SignedAttributeOID Property (SecureBlackbox_MessageEncryptor Class)

The object identifier of the attribute.

Object Oriented Interface

public function getSignedAttributeOID($signedattributeindex);
public function setSignedAttributeOID($signedattributeindex, $value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 51 , $signedattributeindex);
secureblackbox_messageencryptor_set($res, 51, $value , $signedattributeindex);

Default Value

''

Remarks

The object identifier of the attribute.

The $signedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

This property is not available at design time.

Data Type

String

SignedAttributeValue Property (SecureBlackbox_MessageEncryptor Class)

The value of the attribute.

Object Oriented Interface

public function getSignedAttributeValue($signedattributeindex);
public function setSignedAttributeValue($signedattributeindex, $value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 52 , $signedattributeindex);
secureblackbox_messageencryptor_set($res, 52, $value , $signedattributeindex);

Remarks

The value of the attribute.

The $signedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

This property is not available at design time.

Data Type

Byte Array

UnsignedAttributeCount Property (SecureBlackbox_MessageEncryptor Class)

The number of records in the UnsignedAttribute arrays.

Object Oriented Interface

public function getUnsignedAttributeCount();
public function setUnsignedAttributeCount($value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 53 );
secureblackbox_messageencryptor_set($res, 53, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UnsignedAttributeOID
• UnsignedAttributeValue

The array indices start at 0 and end at UnsignedAttributeCount - 1.

This property is not available at design time.

Data Type

Integer

UnsignedAttributeOID Property (SecureBlackbox_MessageEncryptor Class)

The object identifier of the attribute.

Object Oriented Interface

public function getUnsignedAttributeOID($unsignedattributeindex);
public function setUnsignedAttributeOID($unsignedattributeindex, $value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 54 , $unsignedattributeindex);
secureblackbox_messageencryptor_set($res, 54, $value , $unsignedattributeindex);

Default Value

''

Remarks

The object identifier of the attribute.

The $unsignedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

This property is not available at design time.

Data Type

String

UnsignedAttributeValue Property (SecureBlackbox_MessageEncryptor Class)

The value of the attribute.

Object Oriented Interface

public function getUnsignedAttributeValue($unsignedattributeindex);
public function setUnsignedAttributeValue($unsignedattributeindex, $value);

Procedural Interface

secureblackbox_messageencryptor_get($res, 55 , $unsignedattributeindex);
secureblackbox_messageencryptor_set($res, 55, $value , $unsignedattributeindex);

Remarks

The value of the attribute.

The $unsignedattributeindex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

This property is not available at design time.

Data Type

Byte Array

AddAttribute Method (SecureBlackbox_MessageEncryptor Class)

Adds an attribute to the signature.

Object Oriented Interface

public function doAddAttribute($oid, $value, $signedattribute);

Procedural Interface

secureblackbox_messageencryptor_do_addattribute($res, $oid, $value, $signedattribute);

Remarks

Use this method to add a signed or unsigned attribute to the collection of attributes included in the new signature.

Note that CAdESSigner creates certain mandatory and/or widely used attributes automatically in accordance with requirements for a specific signing profile. For example, attributes such as SigningCertificateV2 or SigningTime are always added. Policy attributes are added if specified via the PolicyID or PolicyURI properties of the signature object.

Use the OID parameter to provide the object identifier of the attribute, in string form. For example, the OID for the SigningCertificateV2 attribute is 1.2.840.113549.1.9.16.2.47. The Value parameter should contain a well-formed, DER-encoded representation of the attribute value, in accordance with its specification.

Config Method (SecureBlackbox_MessageEncryptor Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_messageencryptor_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_MessageEncryptor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_messageencryptor_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;....

Common ActionIDs:

Encrypt Method (SecureBlackbox_MessageEncryptor Class)

Encrypts data.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

secureblackbox_messageencryptor_do_encrypt($res);

Remarks

This method encrypts the data provided via InputFile or InputStream in accordance with PKCS#7 standard.

If encrypted with an EncryptionCertificate a message of EnvelopedData subtype is created. The private key that corresponds to the certificate is needed to decrypt the data.

If encrypted with Key, a message of EncryptedData subtype is formed. The receiving party needs the same key as provided in Key to decrypt the message.

Reset Method (SecureBlackbox_MessageEncryptor Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_messageencryptor_do_reset($res);

Remarks

Reset is a generic method available in every class.

Error Event (SecureBlackbox_MessageEncryptor Class)

Information about errors during PKCS#7 message encryption.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Messages section.

Notification Event (SecureBlackbox_MessageEncryptor Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

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

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

MessageEncryptor Config Settings

Base Config Settings

Trappable Errors (MessageEncryptor Class)

MessageEncryptor Errors