symmetric_key Property

The symmetric key used to encrypt and decrypt the XML.

Syntax

def get_symmetric_key() -> bytes: ...
def set_symmetric_key(value: bytes) -> None: ...

symmetric_key = property(get_symmetric_key, set_symmetric_key)

Default Value

""

Remarks

This property specifies the symmetric key used to encrypt and decrypt the XML.

Encrypt Notes

When calling encrypt if the RecipientCert* properties are set, then the symmetric_key will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the symmetric_key allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the symmetric_key is required by the recipient.

If the RecipientCert* properties are set and symmetric_key is left empty, then a symmetric_key value will automatically be generated by the class when encrypt is called.

When calling encrypt if the RecipientCert* properties are are not set, then the symmetric_key value must be known by the recipient before the message can be decrypted.

Decrypt Notes

When calling decrypt if the data contains an encrypted key the class will attempt to use the certificate specified by the Cert* properties to decrypt the encrypted key and this property is ignored.

When calling decrypt if the data does not contain an encrypted key then symmetric_key must be set either before calling decrypt, or within the on_encrypted_data_info event.

Legal Key and Block Sizes (in bits)