Updated on 2024-05-09 GMT+08:00

Example of Encryption

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.

Encrypting an Object to Be Uploaded

Sample code:

// Import the OBS library.
// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
const obsClient = new ObsClient({
    //Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.ACCESS_KEY_ID,
    secret_access_key: process.env.SECRET_ACCESS_KEY,
    //CN-Hong Kong is used here as an example. Replace it with the one in your actual situation.
    server: 'https://obs.ap-southeast-1.myhuaweicloud.com'
    
});

obsClient.putObject({
       Bucket: 'bucketname',
       Key: 'objectname',
       SourceFile: 'localfile',
        // Set the SSE-C encryption algorithm. 
       SseC: 'AES256',
       SseCKey: 'your sse-c key generated by AES-256 algorithm'
}, (err, result) => {
       if(err){
              console.log('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
       }
});

obsClient.putObject({
       Bucket: 'bucketname',
       Key: 'objectname2',
       SourceFile: 'localfile2',
       // Set the SSE-KMS encryption algorithm.
       SseKms: 'kms'
}, (err, result) => {
       if(err){
              console.log('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
       }
});

Decrypting a Downloaded Object

Sample code:

// Import the OBS library.
// Use npm to install the client.
var ObsClient = require('esdk-obs-nodejs');
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
const obsClient = new ObsClient({
    //Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.ACCESS_KEY_ID,
    secret_access_key: process.env.SECRET_ACCESS_KEY,
    //CN-Hong Kong is used here as an example. Replace it with the one in your actual situation.
    server: 'https://obs.ap-southeast-1.myhuaweicloud.com'
    
});

obsClient.getObject({
       Bucket: 'bucketname',
       Key: 'objectname',
       // Set the SSE-C decryption algorithm.  
       SseC: 'AES256',
        // The key used here must be the one used for uploading the object.
       SseCKey: 'your sse-c key generated by AES-256 algorithm'
}, (err, result) => {
       if(err){
              console.log('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                     console.log('Content-->' + result.InterfaceResult.Content.toString());     
              }
       }
});