def decrypt(**kwargs):
"""
Returns a CryptoResult containing decrypted bytes.
This function requires that 'data' is in the format generated by the
encrypt functionality in this SDK as well as other OCI SDKs that support
client side encryption.
Note this function cannot decrypt data encrypted by the KMS 'encrypt' APIs.
:param oci.encryption.MasterKeyProvider master_key_provider: (required)
A MasterKeyProvider to use for decrypting the data.
:param bytes data: (required)
The data to be decrypted. If a string is passed, it will be converted to
bytes using UTF-8 encoding. Note that this conversion will require creating
a copy of the data which may be undesirable for large payloads.
:rtype: oci.encryption.CryptoResult
"""
_ensure_required_kwargs_present(
required_kwargs=['master_key_provider', 'data'],
provided_kwargs=kwargs)
# leaves input alone if it is alread bytes, otherwise converts to bytes using default encoding
# this is for convenience of the caller, but will create a copy of the data if it is not already a
# bytes-like object
data = convert_to_bytes(kwargs.get('data'))
# as long as we only read from the stream, BytesIO does not create a copy of the data so this doesn't
# add memory overhead
with io.BytesIO(data) as stream_to_decrypt:
decryptor = StreamDecryptor(
stream_to_decrypt=stream_to_decrypt,
master_key_provider=kwargs.get('master_key_provider'))
return CryptoResult(
data=decryptor.read(),
encryption_context=decryptor.get_encryption_context())
def create_decryption_stream(**kwargs):
"""
Returns a CryptoResultStream which produces decrypted data based on the underlying stream
supplied as 'stream_to_decrypt'.
Note this function cannot decrypt data encrypted by the KMS 'decrypt' APIs.
:param oci.encryption.MasterKeyProvider master_key_provider: (required)
A MasterKeyProvider to use for decrypting the data.
:param stream stream_to_decrypt: (required)
The stream to be decrypted.
:rtype: oci.encryption.models.CryptoResultStream
"""
_ensure_required_kwargs_present(
required_kwargs=['master_key_provider', 'stream_to_decrypt'],
provided_kwargs=kwargs)
return StreamDecryptor(
stream_to_decrypt=kwargs.get('stream_to_decrypt'),
master_key_provider=kwargs.get('master_key_provider'))