com.tencent.cos.xml.crypto

类 CryptoModuleBase

java.lang.Object

com.tencent.cos.xml.crypto.CryptoModuleBase

所有已实现的接口:

CryptoModule

直接已知子类:

CryptoModuleAE

public abstract class CryptoModuleBase
extends java.lang.Object
implements CryptoModule

Common implementation for different COS cryptographic modules.

字段概要

字段

限定符和类型	字段和说明
protected com.tencent.cos.xml.crypto.ContentCryptoScheme	contentCryptoScheme
protected CosXmlSimpleService	cos
protected com.tencent.cos.xml.crypto.COSCryptoScheme	cryptoScheme
protected static int	DEFAULT_BUFFER_SIZE
protected EncryptionMaterialsProvider	kekMaterialsProvider
protected QCLOUDKMS	kms
protected java.util.Map<java.lang.String,MultipartUploadCryptoContext>	multipartUploadContexts Map of data about in progress encrypted multipart uploads.

构造器概要

构造器

限定符	构造器和说明
protected	CryptoModuleBase(CosXmlSimpleService cos, QCloudCredentialProvider credentialsProvider, EncryptionMaterialsProvider kekMaterialsProvider) For testing purposes only.
protected	CryptoModuleBase(QCLOUDKMS kms, CosXmlSimpleService cos, QCloudCredentialProvider credentialsProvider, EncryptionMaterialsProvider kekMaterialsProvider)

方法概要

限定符和类型	方法和说明
protected InitMultipartUploadRequest	cipherInitMultipartUploadRequest(InitMultipartUploadRequest request)
protected abstract long	ciphertextLength(long plaintextLength) Returns the length of the ciphertext computed from the length of the plaintext.
CompleteMultiUploadResult	completeMultipartUploadSecurely(CompleteMultiUploadRequest req)
protected com.tencent.cos.xml.crypto.ContentCryptoMaterial	createContentCryptoMaterial(CosXmlRequest req) Creates and returns a non-null content crypto material for the given request.
protected javax.crypto.SecretKey	generateCEK(EncryptionMaterials kekMaterials, java.security.Provider providerIn)
com.tencent.cos.xml.crypto.COSCryptoScheme	getCOSCryptoScheme()
MultipartUploadCryptoContext	getCryptoContext(java.lang.String uploadId)
boolean	hasMultipartUploadContext(java.lang.String uploadId)
InitMultipartUploadResult	initMultipartUploadSecurely(InitMultipartUploadRequest request)
CipherLiteInputStream	newCOSCipherLiteInputStream(PutObjectRequest req, com.tencent.cos.xml.crypto.CipherLite cipherLite)
CipherLiteInputStream	newMultipartCOSCipherInputStream(UploadPartRequest req, com.tencent.cos.xml.crypto.CipherLite cipherLite)
protected long	plaintextLength(PutObjectRequest request, ObjectMetadata metadata) Returns the plaintext length from the request and metadata; or -1 if unknown.
PutObjectResult	putObjectSecurely(PutObjectRequest req)
protected ObjectMetadata	updateMetadataWithContentCryptoMaterial(ObjectMetadata metadata, com.tencent.cos.xml.crypto.ContentCryptoMaterial instruction)
void	uploadPartAsyncSecurely(UploadPartRequest req, CosXmlResultListener resultListener)
UploadPartResult	uploadPartSecurely(UploadPartRequest req) NOTE: Because the encryption process requires context from previous blocks, parts uploaded with the COSEncryptionClient (as opposed to the normal COSClient) must be uploaded serially, and in order.
protected PutObjectRequest	wrapWithCipher(PutObjectRequest request, com.tencent.cos.xml.crypto.ContentCryptoMaterial cekMaterial) Returns the given PutObjectRequest but has the content as input stream wrapped with a cipher, and configured with some meta data and user metadata.

从类继承的方法 java.lang.Object

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

从接口继承的方法 com.tencent.cos.xml.crypto.CryptoModule

getObjectSecurely

字段详细资料

DEFAULT_BUFFER_SIZE

protected static final int DEFAULT_BUFFER_SIZE

另请参阅:

常量字段值

kekMaterialsProvider

protected final EncryptionMaterialsProvider kekMaterialsProvider

cryptoScheme

protected final com.tencent.cos.xml.crypto.COSCryptoScheme cryptoScheme

contentCryptoScheme

protected final com.tencent.cos.xml.crypto.ContentCryptoScheme contentCryptoScheme

multipartUploadContexts

protected final java.util.Map<java.lang.String,MultipartUploadCryptoContext> multipartUploadContexts

Map of data about in progress encrypted multipart uploads.

cos

protected final CosXmlSimpleService cos

kms

protected final QCLOUDKMS kms

构造器详细资料

CryptoModuleBase

protected CryptoModuleBase(QCLOUDKMS kms,
                           CosXmlSimpleService cos,
                           QCloudCredentialProvider credentialsProvider,
                           EncryptionMaterialsProvider kekMaterialsProvider)

CryptoModuleBase

protected CryptoModuleBase(CosXmlSimpleService cos,
                           QCloudCredentialProvider credentialsProvider,
                           EncryptionMaterialsProvider kekMaterialsProvider)

For testing purposes only.

方法详细资料

ciphertextLength

protected abstract long ciphertextLength(long plaintextLength)

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

参数:

plaintextLength - a non-negative number

返回:

a non-negative number

putObjectSecurely

public PutObjectResult putObjectSecurely(PutObjectRequest req)
                                  throws CosXmlClientException,
                                         CosXmlServiceException

指定者:

putObjectSecurely 在接口中 CryptoModule

抛出:

CosXmlClientException

CosXmlServiceException

initMultipartUploadSecurely

public InitMultipartUploadResult initMultipartUploadSecurely(InitMultipartUploadRequest request)
                                                      throws CosXmlClientException,
                                                             CosXmlServiceException

指定者:

initMultipartUploadSecurely 在接口中 CryptoModule

抛出:

CosXmlClientException

CosXmlServiceException

hasMultipartUploadContext

public boolean hasMultipartUploadContext(java.lang.String uploadId)

getCryptoContext

public MultipartUploadCryptoContext getCryptoContext(java.lang.String uploadId)

uploadPartSecurely

public UploadPartResult uploadPartSecurely(UploadPartRequest req)
                                    throws CosXmlClientException,
                                           CosXmlServiceException

NOTE: Because the encryption process requires context from previous blocks, parts uploaded with the COSEncryptionClient (as opposed to the normal COSClient) must be uploaded serially, and in order. Otherwise, the previous encryption context isn't available to use when encrypting the current part.

指定者:

uploadPartSecurely 在接口中 CryptoModule

抛出:

CosXmlClientException

CosXmlServiceException

uploadPartAsyncSecurely

public void uploadPartAsyncSecurely(UploadPartRequest req,
                                    CosXmlResultListener resultListener)

指定者:

uploadPartAsyncSecurely 在接口中 CryptoModule

newMultipartCOSCipherInputStream

public final CipherLiteInputStream newMultipartCOSCipherInputStream(UploadPartRequest req,
                                                                    com.tencent.cos.xml.crypto.CipherLite cipherLite)
                                                             throws CosXmlClientException

抛出:

CosXmlClientException

completeMultipartUploadSecurely

public CompleteMultiUploadResult completeMultipartUploadSecurely(CompleteMultiUploadRequest req)
                                                          throws CosXmlClientException,
                                                                 CosXmlServiceException

指定者:

completeMultipartUploadSecurely 在接口中 CryptoModule

抛出:

CosXmlClientException

CosXmlServiceException

updateMetadataWithContentCryptoMaterial

protected final ObjectMetadata updateMetadataWithContentCryptoMaterial(ObjectMetadata metadata,
                                                                       com.tencent.cos.xml.crypto.ContentCryptoMaterial instruction)
                                                                throws CosXmlClientException

抛出:

CosXmlClientException

createContentCryptoMaterial

protected final com.tencent.cos.xml.crypto.ContentCryptoMaterial createContentCryptoMaterial(CosXmlRequest req)
                                                                                      throws CosXmlClientException

Creates and returns a non-null content crypto material for the given request.

抛出:

CosXmlClientException - if no encryption material can be found.

generateCEK

protected final javax.crypto.SecretKey generateCEK(EncryptionMaterials kekMaterials,
                                                   java.security.Provider providerIn)
                                            throws CosXmlClientException

参数:

kekMaterials - non-null encryption materials

抛出:

CosXmlClientException

wrapWithCipher

protected final PutObjectRequest wrapWithCipher(PutObjectRequest request,
                                                com.tencent.cos.xml.crypto.ContentCryptoMaterial cekMaterial)
                                         throws CosXmlClientException

Returns the given PutObjectRequest but has the content as input stream wrapped with a cipher, and configured with some meta data and user metadata.

抛出:

CosXmlClientException

cipherInitMultipartUploadRequest

protected final InitMultipartUploadRequest cipherInitMultipartUploadRequest(InitMultipartUploadRequest request)

newCOSCipherLiteInputStream

public CipherLiteInputStream newCOSCipherLiteInputStream(PutObjectRequest req,
                                                         com.tencent.cos.xml.crypto.CipherLite cipherLite)
                                                  throws CosXmlClientException

抛出:

CosXmlClientException

plaintextLength

protected final long plaintextLength(PutObjectRequest request,
                                     ObjectMetadata metadata)

Returns the plaintext length from the request and metadata; or -1 if unknown.

getCOSCryptoScheme

public final com.tencent.cos.xml.crypto.COSCryptoScheme getCOSCryptoScheme()