Updated on 2026-09-22 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 API Reference.

Encrypting an Object During Object Upload

Sample code:

<?php

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an 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.
    'key' => getenv('ACCESS_KEY_ID'),
    'secret' => getenv('SECRET_ACCESS_KEY'),
    'endpoint' => 'https://your-endpoint',
]);try {
     $resp = $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'
    ]);
    printf("RequestId:%s\n", $resp['RequestId']);
} catch (ObsException $e) {
    printf("PutObjectFailed: Status:%d, Code:%s, Message:%s\n",
        $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} 

try {
     $resp = $obsClient->putObject([
         'Bucket' => 'bucketname',
         'Key' => 'objectname2',
         'SourceFile' => 'localfile2',
         // Set the SSE-KMS encryption algorithm.
         'SseKms' => 'kms'
    ]);
    printf("RequestId:%s\n", $resp['RequestId']);
} catch (ObsException $e) {
    printf("PutObjectFailed: Status:%d, Code:%s, Message:%s\n",
        $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
    $obsClient->close();
}

Decrypting an Object During Object Download

Sample code:

// Import the dependency library.
require 'vendor/autoload.php';
// Import the SDK code library during the installation with the source code.
// require 'obs-autoloader.php';
// Declare the namespace.
use Obs\ObsClient;
use Obs\ObsException;
// Create an ObsClient instance.
$obsClient = new ObsClient([ 
    // Obtain an AK/SK pair using environment variables (recommended) or import an 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.
    'key' => getenv('ACCESS_KEY_ID'),
    'secret' => getenv('SECRET_ACCESS_KEY'),
    'endpoint' => 'https://your-endpoint',
]);
try {
    $resp = $obsClient->getObject([
        'Bucket' => 'bucketname',
        'Key' => 'objectname',
        // Set the SSE-C decryption algorithm.
        'SseC' => 'AES256',
        // Specify the same key you used for encrypting the object during the upload.
        'SseCKey' => 'your sse-c key generated by AES-256 algorithm'
    ]);
    printf( "RequestId:%s\n", $resp['RequestId']);
    printf("Object Content:\n");
    // Obtain the object content.
    echo $resp['Body'];
} catch (ObsException $e) {
    // If the operation fails, obtain the exception details.
    printf("GetObjectFailed: Status:%d, Code:%s, Message:%s\n", $e->getStatusCode(), $e->getExceptionCode(), $e->getExceptionMessage());
} finally {
    $obsClient->close();
}