com.aliyun.oss.crypto

Class CryptoModuleBase

java.lang.Object

com.aliyun.oss.crypto.CryptoModuleBase

All Implemented Interfaces:

CryptoModule

public abstract class CryptoModuleBase
extends Object
implements CryptoModule

Field Summary

Fields

Modifier and Type	Field and Description
protected CryptoScheme	contentCryptoScheme
protected CryptoConfiguration	cryptoConfig
protected static int	DEFAULT_BUFFER_SIZE
protected String	encryptionClientUserAgent
protected EncryptionMaterials	encryptionMaterials
protected OSSDirect	ossDirect

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CryptoModuleBase(OSSDirect ossDirect, EncryptionMaterials encryptionMaterials, CryptoConfiguration cryptoConfig)

Method Summary

Modifier and Type	Method and Description
protected OSSObject	adjustToDesiredRange(OSSObject OSSobject, long[] range)
protected ContentCryptoMaterial	buildContentCryptoMaterials()
protected ContentCryptoMaterial	createContentMaterialFromMetadata(ObjectMetadata meta)
protected OSSObject	decipherWithMetadata(GetObjectRequest req, long[] desiredRange, long[] cryptoRange, OSSObject retrieved)
protected SecretKey	generateCEK()
protected static Map<String,String>	getDescFromJsonString(String jsonString)
OSSObject	getObjectSecurely(GetObjectRequest req) Gets the object in OSS, if it was an encrypted object then decrypt it and return the result, otherwise return the object directly.
ObjectMetadata	getObjectSecurely(GetObjectRequest getObjectRequest, File file) Gets the object in OSS and write it in a file, if it was an encrypted object then decrypt it, otherwise wirte the object directly.
static boolean	hasEncryptionInfo(ObjectMetadata metadata) Checks there an encryption info in the metadata.
InitiateMultipartUploadResult	initiateMultipartUploadSecurely(InitiateMultipartUploadRequest req, MultipartUploadCryptoContext context) Initiates the multipart upload request, and bulid the crypto context.
protected long	plaintextLength(PutObjectRequest request, ObjectMetadata metadata)
PutObjectResult	putObjectSecurely(PutObjectRequest req) Puts the object with data encrypted.
protected void	safeCloseSource(Closeable is)
protected void	setUserAgent(WebServiceRequest req, String userAgent)
protected ObjectMetadata	updateMetadataWithContentCryptoMaterial(ObjectMetadata metadata, File file, ContentCryptoMaterial contentCryptoMaterial)
protected ObjectMetadata	updateMetadataWithUploadContext(ObjectMetadata metadata, MultipartUploadCryptoContext context)
UploadPartResult	uploadPartSecurely(UploadPartRequest req, MultipartUploadCryptoContext context) Uploads the part secured.
protected PutObjectRequest	wrapPutRequestWithCipher(PutObjectRequest request, ContentCryptoMaterial cekMaterial)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

protected static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

encryptionMaterials

protected final EncryptionMaterials encryptionMaterials

contentCryptoScheme

protected final CryptoScheme contentCryptoScheme

cryptoConfig

protected final CryptoConfiguration cryptoConfig

ossDirect

protected final OSSDirect ossDirect

encryptionClientUserAgent

protected final String encryptionClientUserAgent

Constructor Detail

CryptoModuleBase

protected CryptoModuleBase(OSSDirect ossDirect,
                           EncryptionMaterials encryptionMaterials,
                           CryptoConfiguration cryptoConfig)

Method Detail

putObjectSecurely

public PutObjectResult putObjectSecurely(PutObjectRequest req)

Puts the object with data encrypted.

Specified by:

putObjectSecurely in interface CryptoModule

Parameters:

req - The put object request.

Returns:

the result of the request.

wrapPutRequestWithCipher

protected final PutObjectRequest wrapPutRequestWithCipher(PutObjectRequest request,
                                                          ContentCryptoMaterial cekMaterial)

hasEncryptionInfo

public static boolean hasEncryptionInfo(ObjectMetadata metadata)

Checks there an encryption info in the metadata.

Parameters:

metadata - the object metadata.

Returns:

True if has encryption info; False if not.

getObjectSecurely

public OSSObject getObjectSecurely(GetObjectRequest req)

Gets the object in OSS, if it was an encrypted object then decrypt it and return the result, otherwise return the object directly.

Specified by:

getObjectSecurely in interface CryptoModule

Parameters:

req - The GetObjectRequest instance.

Returns:

The OSSObject instance.

decipherWithMetadata

protected OSSObject decipherWithMetadata(GetObjectRequest req,
                                         long[] desiredRange,
                                         long[] cryptoRange,
                                         OSSObject retrieved)

safeCloseSource

protected void safeCloseSource(Closeable is)

adjustToDesiredRange

protected final OSSObject adjustToDesiredRange(OSSObject OSSobject,
                                               long[] range)

getObjectSecurely

public ObjectMetadata getObjectSecurely(GetObjectRequest getObjectRequest,
                                        File file)

Gets the object in OSS and write it in a file, if it was an encrypted object then decrypt it, otherwise wirte the object directly.

Specified by:

getObjectSecurely in interface CryptoModule

Parameters:

getObjectRequest - The GetObjectRequest instance.

file - The File instance to write into.

Returns:

The ObjectMetadata instance.

initiateMultipartUploadSecurely

public InitiateMultipartUploadResult initiateMultipartUploadSecurely(InitiateMultipartUploadRequest req,
                                                                     MultipartUploadCryptoContext context)

Initiates the multipart upload request, and bulid the crypto context.

Specified by:

initiateMultipartUploadSecurely in interface CryptoModule

Parameters:

req - The InitiateMultipartUploadRequest instance.

context - The multi part crypto context contains the content crypto materials and upload information, it should created on the outside with part-size and data-size set done, the content crypto materials and other upload information will be filled after initiate request done.

Returns:

The InitiateMultipartUploadResult instance.

uploadPartSecurely

public UploadPartResult uploadPartSecurely(UploadPartRequest req,
                                           MultipartUploadCryptoContext context)

Uploads the part secured.

Specified by:

uploadPartSecurely in interface CryptoModule

Parameters:

req - The UploadPartRequest instance.

context - The multi part crypto context contains the content crypto materials and upload information, it should created on the outside with part-size and data-size set done, the content crypto materials and other upload information will be filled after initiate request done.

Returns:

The UploadPartResult instance.

plaintextLength

protected final long plaintextLength(PutObjectRequest request,
                                     ObjectMetadata metadata)

buildContentCryptoMaterials

protected final ContentCryptoMaterial buildContentCryptoMaterials()

updateMetadataWithUploadContext

protected final ObjectMetadata updateMetadataWithUploadContext(ObjectMetadata metadata,
                                                               MultipartUploadCryptoContext context)

updateMetadataWithContentCryptoMaterial

protected final ObjectMetadata updateMetadataWithContentCryptoMaterial(ObjectMetadata metadata,
                                                                       File file,
                                                                       ContentCryptoMaterial contentCryptoMaterial)

createContentMaterialFromMetadata

protected ContentCryptoMaterial createContentMaterialFromMetadata(ObjectMetadata meta)

getDescFromJsonString

protected static Map<String,String> getDescFromJsonString(String jsonString)

generateCEK

protected SecretKey generateCEK()

setUserAgent

protected void setUserAgent(WebServiceRequest req,
                            String userAgent)