Encryption Description
If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference.
The following table lists APIs related to server-side encryption:
Method in OBS BrowserJS SDK |
Description |
Supported Encryption Type |
---|---|---|
ObsClient.putObject |
Sets the encryption algorithm and key during object upload to enable server-side encryption. |
SSE-KMS SSE-C |
ObsClient.getObject |
Sets the decryption algorithm and key during object download to decrypt the object. |
SSE-C |
ObsClient.copyObject |
|
SSE-KMS SSE-C |
ObsClient.getObjectMetadata |
Sets the decryption algorithm and key when obtaining the object metadata to decrypt the object. |
SSE-C |
ObsClient.initiateMultipartUpload |
Sets the encryption algorithm and key when initializing a multipart upload to enable server-side encryption for the final object generated. |
SSE-KMS SSE-C |
ObsClient.uploadPart |
Sets the encryption algorithm and key during multipart upload to enable server-side encryption for parts. |
SSE-C |
ObsClient.copyPart |
|
SSE-C |
OBS BrowserJS SDK supports the following two types of encryption/decryption mode:
Encryption/Decryption Type |
Request Parameter |
Description |
---|---|---|
SSE-KMS |
SseKms |
Indicates that SSE-KMS mode is used. Currently, only kms is supported. |
SseKmsKey |
Indicates the master key used in SSE-KMS mode. The value can be null. |
|
SSE-C |
SseC |
Indicates that SSE-C mode is used. Currently, only AES256 is supported. |
SseCKey |
Indicates the key in SSE-C mode. It is calculated using the AES256 algorithm. This parameter can be used to encrypt an object to be uploaded and decrypt an object to be downloaded. Note that Base64 encoding is not required. |
|
CopySourceSseC |
Indicates the source object decrypted in SSE-C mode. The value can only be AES256. This parameter is applicable to ObsClient.copyObject and ObsClient.copyPart. |
|
CopySourceSseCKey |
Indicates the key used by a source object for decryption in SSE-C mode. It is calculated using the AES256 algorithm. This parameter is applicable to ObsClient.copyObject and ObsClient.copyPart. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot