additional_data Property

Additional data to send when performing symmetric encryption or decryption.

Syntax

def get_additional_data() -> bytes: ...
def set_additional_data(value: bytes) -> None: ...

additional_data = property(get_additional_data, set_additional_data)

Default Value

""

Remarks

This property can be set before calling encrypt or decrypt with a symmetric key to have the server include the specified data, known as additional authenticated data, when performing the cryptographic operation. If such data is provided during encryption, it must also be provided in order to successfully decrypt the data. Refer to the Google Cloud KMS documentation for more information.

Up to 65536 bytes of data may be provided. Note that this property is ignored when asymmetric encryption or decryption is performed.