com.qcloud.cos.internal.crypto

Class COSCryptoModuleAE

java.lang.Object

com.qcloud.cos.internal.crypto.COSCryptoModule

com.qcloud.cos.internal.crypto.COSCryptoModuleBase

com.qcloud.cos.internal.crypto.COSCryptoModuleAE

Direct Known Subclasses:

COSCryptoModuleAECbc, COSCryptoModuleAEStrict

public class COSCryptoModuleAE
extends COSCryptoModuleBase

Field Summary

Fields inherited from class com.qcloud.cos.internal.crypto.COSCryptoModuleBase

contentCryptoScheme, cos, cryptoConfig, cryptoScheme, DEFAULT_BUFFER_SIZE, kekMaterialsProvider, kms, log, multipartUploadContexts

Constructor Summary

Constructors

Constructor and Description
COSCryptoModuleAE(COSDirect cos, COSCredentialsProvider credentialsProvider, EncryptionMaterialsProvider kekMaterialsProvider, CryptoConfiguration cryptoConfig)
COSCryptoModuleAE(QCLOUDKMS kms, COSDirect cos, COSCredentialsProvider credentialsProvider, EncryptionMaterialsProvider kekMaterialsProvider, CryptoConfiguration cryptoConfig)

Method Summary

Modifier and Type	Method and Description
protected COSObjectWrapper	adjustToDesiredRange(COSObjectWrapper cosObject, long[] range, Map<String,String> instruction) Adjusts the retrieved COSObject so that the object contents contain only the range of bytes desired by the user.
protected long	ciphertextLength(long originalContentLength) Returns the length of the ciphertext computed from the length of the plaintext.
COSObject	getObjectSecurely(GetObjectRequest req)
ObjectMetadata	getObjectSecurely(GetObjectRequest getObjectRequest, File destinationFile)
protected boolean	isStrict() Returns true if a strict encryption mode is in use in the current crypto module; false otherwise.

Methods inherited from class com.qcloud.cos.internal.crypto.COSCryptoModuleBase

abortMultipartUploadSecurely, completeMultipartUploadSecurely, copyPartSecurely, createContentCryptoMaterial, createInstructionPutRequest, generateCEK, getCOSCryptoScheme, initiateMultipartUploadSecurely, newMultipartCOSCipherInputStream, plaintextLength, putInstructionFileSecurely, putObjectSecurely, securityCheck, updateInstructionPutRequest, updateMetadataWithContentCryptoMaterial, uploadPartSecurely, wrapWithCipher

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

COSCryptoModuleAE

public COSCryptoModuleAE(COSDirect cos,
                         COSCredentialsProvider credentialsProvider,
                         EncryptionMaterialsProvider kekMaterialsProvider,
                         CryptoConfiguration cryptoConfig)

COSCryptoModuleAE

public COSCryptoModuleAE(QCLOUDKMS kms,
                         COSDirect cos,
                         COSCredentialsProvider credentialsProvider,
                         EncryptionMaterialsProvider kekMaterialsProvider,
                         CryptoConfiguration cryptoConfig)

Method Detail

isStrict

protected boolean isStrict()

Returns true if a strict encryption mode is in use in the current crypto module; false otherwise.

getObjectSecurely

public COSObject getObjectSecurely(GetObjectRequest req)

Specified by:

getObjectSecurely in class COSCryptoModule

adjustToDesiredRange

protected final COSObjectWrapper adjustToDesiredRange(COSObjectWrapper cosObject,
                                                      long[] range,
                                                      Map<String,String> instruction)

Adjusts the retrieved COSObject so that the object contents contain only the range of bytes desired by the user. Since encrypted contents can only be retrieved in CIPHER_BLOCK_SIZE (16 bytes) chunks, the COSObject potentially contains more bytes than desired, so this method adjusts the contents range.

Parameters:

cosObject - The COSObject retrieved from COS that could possibly contain more bytes than desired by the user.

range - A two-element array of longs corresponding to the start and finish (inclusive) of a desired range of bytes.

instruction - Instruction file in JSON or null if no instruction file is involved

Returns:

The COSObject with adjusted object contents containing only the range desired by the user. If the range specified is invalid, then the COSObject is returned without any modifications.

getObjectSecurely

public ObjectMetadata getObjectSecurely(GetObjectRequest getObjectRequest,
                                        File destinationFile)

Specified by:

getObjectSecurely in class COSCryptoModule

ciphertextLength

protected long ciphertextLength(long originalContentLength)

Description copied from class: COSCryptoModuleBase

Returns the length of the ciphertext computed from the length of the plaintext.

Specified by:

ciphertextLength in class COSCryptoModuleBase

Parameters:

originalContentLength - a non-negative number

Returns:

a non-negative number