Cloud Keys 2020 Python Edition

Questions / Feedback?

encrypt Method

Encrypts data using a key.

Syntax

def encrypt(key_name: str, version_id: str) -> None: ...

Remarks

This method encrypts data using the key specified by KeyName and (for asymmetric keys) VersionId.

The data to encrypt is taken from the the specified input_file or the input_data property. The encrypted data is output to the the specified output_file or the output_data property.

For symmetric keys, VersionId must be empty; the server always uses the primary version of the symmetric key. (Unless the ForceSymmetricEncryption configuration setting is enabled, in which case VersionId can be used to specify a non-primary version.)

For asymmetric keys, VersionId must be specified. Note, however, that Google does not support server-side asymmetric encryption (only decryption), so this method will instead call get_public_key internally and then use the public key to encrypt the input data locally. This functionality is offered as a convenience.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Python Edition - Version 20.0 [Build 8157]