MessageEncryptor Class
Properties Methods Events Config Settings Errors
The MessageEncryptor class encrypts data and stores it in the PKCS#7 format.
Syntax
class secureblackbox.MessageEncryptor
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.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| bits_in_key | The length of the encryption key. |
| encryption_algorithm | The symmetric key algorithm to use for encryption. |
| encryption_cert_bytes | Returns the raw certificate data in DER format. |
| encryption_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encryption_type | Specifies the kind of encrypted message to create. |
| fips_mode | Reserved. |
| input_bytes | Use this property to pass the input to class in byte array form. |
| input_file | A path to the source file. |
| key | The symmetric key to use for encryption. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | A path to the output file. |
| signed_attribute_count | The number of records in the SignedAttribute arrays. |
| signed_attribute_oid | The object identifier of the attribute. |
| signed_attribute_value | The value of the attribute. |
| unsigned_attribute_count | The number of records in the UnsignedAttribute arrays. |
| unsigned_attribute_oid | The object identifier of the attribute. |
| unsigned_attribute_value | The value of the attribute. |
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. |
| do_action | Performs an additional action. |
| encrypt | Encrypts data. |
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.
| on_error | Information about errors during PKCS#7 message encryption. |
| on_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.
| NoOuterContentInfo | Whether the message has outer content. |
| OAEPHashAlgorithm | Hash algorithm for RSA-OAEP. |
| TempPath | Path for storing temporary files. |
| UseOAEP | Whether to use RSA-OAEP. |
| UseUndefSize | Allows or forbids the use of ASN.1 tags of undefined size. |
| 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. |
| 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. |
bits_in_key Property
The length of the encryption key.
Syntax
def get_bits_in_key() -> int: ... def set_bits_in_key(value: int) -> None: ...
bits_in_key = property(get_bits_in_key, set_bits_in_key)
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.
encryption_algorithm Property
The symmetric key algorithm to use for encryption.
Syntax
def get_encryption_algorithm() -> str: ... def set_encryption_algorithm(value: str) -> None: ...
encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)
Default Value
"AES128"
Remarks
Use this property to specify the symmetric algorithm to encrypt the data with.
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_DES | DES | |
| SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
| SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
| SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
| SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
| SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
| SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
| SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
| SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
| SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
| SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
| SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
| SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
| SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
| SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
| SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
encryption_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_encryption_cert_bytes() -> bytes: ...
encryption_cert_bytes = property(get_encryption_cert_bytes, None)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
encryption_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_encryption_cert_handle() -> int: ... def set_encryption_cert_handle(value: int) -> None: ...
encryption_cert_handle = property(get_encryption_cert_handle, set_encryption_cert_handle)
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());
encryption_type Property
Specifies the kind of encrypted message to create.
Syntax
def get_encryption_type() -> int: ... def set_encryption_type(value: int) -> None: ...
encryption_type = property(get_encryption_type, set_encryption_type)
Default Value
1
Remarks
Possible values:
| metUnknown | 0 | Unknown or unsupported encryption type |
| metCertEncrypted | 1 | Certificate-based encryption |
| metKeyEncrypted | 2 | Symmetric key-based encryption |
| metCertEncryptedAndAuthenticated | 3 | Certificate-based encryption with authentication (AEAD) |
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
A path to the source file.
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
Use this property to provide a path to the file containing the data to be encrypted.
key Property
The symmetric key to use for encryption.
Syntax
def get_key() -> bytes: ... def set_key(value: bytes) -> None: ...
key = property(get_key, set_key)
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.
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
A path to the output file.
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
Use this property to specify the file to save the encrypted message to.
signed_attribute_count Property
The number of records in the SignedAttribute arrays.
Syntax
def get_signed_attribute_count() -> int: ... def set_signed_attribute_count(value: int) -> None: ...
signed_attribute_count = property(get_signed_attribute_count, set_signed_attribute_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at signed_attribute_count - 1.signed_attribute_oid Property
The object identifier of the attribute.
Syntax
def get_signed_attribute_oid(signed_attribute_index: int) -> str: ... def set_signed_attribute_oid(signed_attribute_index: int, value: str) -> None: ...
Default Value
""
Remarks
The object identifier of the attribute.
The signed_attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the signed_attribute_count property.
signed_attribute_value Property
The value of the attribute.
Syntax
def get_signed_attribute_value(signed_attribute_index: int) -> bytes: ... def set_signed_attribute_value(signed_attribute_index: int, value: bytes) -> None: ...
Remarks
The value of the attribute.
The signed_attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the signed_attribute_count property.
unsigned_attribute_count Property
The number of records in the UnsignedAttribute arrays.
Syntax
def get_unsigned_attribute_count() -> int: ... def set_unsigned_attribute_count(value: int) -> None: ...
unsigned_attribute_count = property(get_unsigned_attribute_count, set_unsigned_attribute_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at unsigned_attribute_count - 1.unsigned_attribute_oid Property
The object identifier of the attribute.
Syntax
def get_unsigned_attribute_oid(unsigned_attribute_index: int) -> str: ... def set_unsigned_attribute_oid(unsigned_attribute_index: int, value: str) -> None: ...
Default Value
""
Remarks
The object identifier of the attribute.
The unsigned_attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the unsigned_attribute_count property.
unsigned_attribute_value Property
The value of the attribute.
Syntax
def get_unsigned_attribute_value(unsigned_attribute_index: int) -> bytes: ... def set_unsigned_attribute_value(unsigned_attribute_index: int, value: bytes) -> None: ...
Remarks
The value of the attribute.
The unsigned_attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the unsigned_attribute_count property.
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 data.
Syntax
def encrypt() -> None: ...
Remarks
This method encrypts the data provided via input_file or input_stream in accordance with PKCS#7 standard.
If encrypted with an encryption_certificate 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.
on_error Event
Information about errors during PKCS#7 message encryption.
Syntax
class MessageEncryptorErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class MessageEncryptor: @property def on_error() -> Callable[[MessageEncryptorErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[MessageEncryptorErrorEventParams], None]) -> None: ...
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.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class MessageEncryptorNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class MessageEncryptor: @property def on_notification() -> Callable[[MessageEncryptorNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[MessageEncryptorNotificationEventParams], 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.
MessageEncryptor 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.MessageEncryptor 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.
MessageEncryptor Errors
MessageEncryptor 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) |