Si se habilita el cifrado del lado del cliente, los objetos se cifran localmente antes de cargarse en Object Storage Service (OSS). De esta manera, se mejora la seguridad de los datos durante su transmisión y almacenamiento.
Aviso legal
Cuando utilice el cifrado del lado del cliente, asegúrese de mantener la integridad y validez de la clave maestra del cliente (CMK). Si la CMK se usa de forma incorrecta o se pierde por un mantenimiento inadecuado, usted asume la responsabilidad de todas las pérdidas y consecuencias derivadas de fallos en el descifrado.
Al copiar o migrar datos cifrados, usted es responsable de la integridad y validez de los metadatos del objeto. Si los metadatos cifrados son incorrectos o se pierden por un mantenimiento inadecuado, usted asume la responsabilidad de todas las pérdidas y consecuencias que resulten de fallos al descifrar los datos.
Escenarios
Datos altamente confidenciales: cuando la información es extremadamente sensible, como datos de identificación personal (PII), registros de transacciones financieras o datos médicos y de salud, los usuarios pueden cifrarla antes de que salga del entorno local. Esto garantiza una protección eficaz de los datos originales durante la transmisión.
Requisitos de cumplimiento: normativas específicas, como HIPAA y GDPR, exigen una gestión estricta del cifrado de datos. El cifrado del lado del cliente cumple con estos requisitos porque los usuarios gestionan las CMK y estas no viajan por la red.
Control riguroso de permisos: si una empresa o un desarrollador necesita control total sobre el proceso de cifrado, incluida la selección de algoritmos y la gestión de las CMK, este método resulta ideal. Así se garantiza que solo los usuarios autorizados legalmente puedan descifrar y acceder a los datos.
Seguridad en la migración de datos entre regiones: esta técnica ayuda a mantener los datos cifrados antes y después de una migración entre regiones, lo cual refuerza la seguridad de la transmisión por Internet.
Contexto
En el cifrado del lado del cliente, se genera una clave de datos aleatoria para cada objeto con el fin de aplicar un cifrado simétrico. El cliente utiliza una CMK para cifrar dicha clave aleatoria. La clave cifrada se carga como parte de los metadatos del objeto y se almacena en el servidor de OSS. Al descargar un objeto cifrado, el cliente emplea la CMK para descifrar la clave de datos y, posteriormente, usa esa clave descifrada para descifrar el objeto. Para garantizar la seguridad, la CMK se utiliza únicamente en el cliente; no se transmite por la red ni se almacena en el servidor.
El cifrado del lado del cliente admite cargas multiparte para objetos mayores a 5 GB. Cuando use este tipo de carga, especifique el tamaño total del objeto y el tamaño de cada parte. Todas las partes, excepto la última, deben tener el mismo tamaño y ser múltiplos enteros de 16.
Si carga un objeto cifrado en un cliente local, los metadatos cifrados quedan protegidos y no se pueden modificar mediante llamadas a CopyObject.
Para el cifrado del lado del cliente se pueden usar dos tipos de CMK:
Para consultar el código de ejemplo completo, visite GitHub.
Uso de CMK gestionadas por KMS
Si utiliza una CMK gestionada por Key Management Service (KMS) para el cifrado del lado del cliente, solo necesita especificar un identificador de CMK al cargar un objeto. No es necesario proporcionar una clave de datos al cliente de cifrado. A continuación se muestra el proceso de cifrado.
-
Cifrar y cargar un objeto
-
Obtenga una clave de datos.
El cliente solicita una clave de datos a KMS mediante el identificador de CMK especificado para cifrar un objeto. KMS genera una clave aleatoria y devuelve el texto sin formato y el texto cifrado de la clave de datos.
-
Cifre el objeto y cárguelo en OSS.
El cliente usa el texto sin formato de la clave de datos para cifrar el objeto localmente. Después, carga el objeto cifrado y el texto cifrado de la clave de datos en OSS.
-
-
Descargar y descifrar un objeto
-
Descargue el objeto.
El cliente descarga desde OSS el objeto cifrado junto con el texto cifrado de la clave de datos.
-
Descifre el objeto.
El cliente envía a KMS el texto cifrado de la clave de datos y el identificador de CMK correspondiente. KMS utiliza la CMK enviada por el cliente para descifrar el objeto y devuelve el texto sin formato de la clave de datos al cliente.
-
El cliente utiliza una clave de datos única para cifrar cada objeto que se va a cargar.
Para garantizar la seguridad de los datos, se recomienda rotar o actualizar la CMK periódicamente.
Es obligatorio mantener la relación de asignación entre los identificadores de CMK y los objetos cifrados.
Uso de CMK gestionadas por el cliente
Para utilizar CMK gestionadas por el cliente en el cifrado del lado del cliente, debe generarlas y gestionarlas manualmente. Además, es necesario cargar una CMK simétrica o asimétrica en el cliente de cifrado para proteger los objetos. A continuación se muestra el proceso de cifrado.
-
Cifrar y cargar un objeto
Proporcione al cliente una CMK simétrica o asimétrica.
El cliente usa la CMK para generar una clave de datos simétrica de un solo uso, destinada exclusivamente a cifrar el objeto que se va a cargar. Se genera una clave de datos aleatoria y única para cada objeto.
El cliente emplea la clave de datos para cifrar el objeto y la CMK para cifrar dicha clave de datos.
El cliente carga el objeto cifrado en OSS e incluye la clave de datos cifrada dentro de los metadatos del objeto.
-
Descargar y descifrar un objeto
El cliente descarga desde OSS el objeto cifrado y sus metadatos.
Con base en el material de clave indicado por los metadatos, el cliente usa la CMK correspondiente para descifrar la clave de datos cifrada. Luego, aplica esa clave descifrada para descifrar el objeto.
El cliente no envía las CMK ni los datos sin cifrar a OSS. Mantenga sus CMK seguras. Si pierde una CMK, no podrá descifrar los objetos protegidos con las claves de datos generadas a partir de ella.
El cliente genera las claves de datos de forma aleatoria.
Uso de los SDK de OSS
A continuación se presentan ejemplos de código para configurar el cifrado del lado del cliente mediante los SDK de OSS en lenguajes de programación comunes. Para obtener más información sobre cómo configurarlo con otros lenguajes, consulte 简介.
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.crypto.SimpleRSAEncryptionMaterials;
import com.aliyun.oss.model.OSSObject;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.InputStreamReader;
import java.security.KeyPair;
import java.security.interfaces.RSAPrivateKey;
import java.security.interfaces.RSAPublicKey;
import java.util.HashMap;
import java.util.Map;
public class Demo {
public static void main(String[] args) throws Throwable {
// In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint.
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// Specify the name of the bucket. Example: examplebucket.
String bucketName = "examplebucket";
// Specify the full path of the object. Example: exampleobject.txt. Do not include the bucket name in the full path.
String objectName = "exampleobject.txt";
String content = "Hello OSS!";
// Specify your RSA private key string. You can generate the string by using OpenSSL. The following lines show a sample RSA private key string.
final String PRIVATE_PKCS1_PEM =
"-----BEGIN RSA PRIVATE KEY-----\n" +
"MIICWwIBAAKBgQCokfiAVXXf5ImFzKDw+XO/UByW6mse2QsIgz3ZwBtMNu59fR5z\n" +
"ttSx+8fB7vR4CN3bTztrP9A6bjoN0FFnhlQ3vNJC5MFO1PByrE/MNd5AAfSVba93\n" +
"I6sx8NSk5MzUCA4NJzAUqYOEWGtGBcom6kEF6MmR1EKib1Id8hpooY5xaQIDAQAB\n" +
"AoGAOPUZgkNeEMinrw31U3b2JS5sepG6oDG2CKpPu8OtdZMaAkzEfVTJiVoJpP2Y\n" +
"nPZiADhFW3e0ZAnak9BPsSsySRaSNmR465cG9tbqpXFKh9Rp/sCPo4Jq2n65yood\n" +
"JBrnGr6/xhYvNa14sQ6xjjfSgRNBSXD1XXNF4kALwgZyCAECQQDV7t4bTx9FbEs5\n" +
"36nAxPsPM6aACXaOkv6d9LXI7A0J8Zf42FeBV6RK0q7QG5iNNd1WJHSXIITUizVF\n" +
"6aX5NnvFAkEAybeXNOwUvYtkgxF4s28s6gn11c5HZw4/a8vZm2tXXK/QfTQrJVXp\n" +
"VwxmSr0FAajWAlcYN/fGkX1pWA041CKFVQJAG08ozzekeEpAuByTIOaEXgZr5MBQ\n" +
"gBbHpgZNBl8Lsw9CJSQI15wGfv6yDiLXsH8FyC9TKs+d5Tv4Cvquk0efOQJAd9OC\n" +
"lCKFs48hdyaiz9yEDsc57PdrvRFepVdj/gpGzD14mVerJbOiOF6aSV19ot27u4on\n" +
"Td/3aifYs0CveHzFPQJAWb4LCDwqLctfzziG7/S7Z74gyq5qZF4FUElOAZkz123E\n" +
"yZvADwuz/4aK0od0lX9c4Jp7Mo5vQ4TvdoBnPuGo****\n" +
"-----END RSA PRIVATE KEY-----";
// Specify your RSA public key string. You can generate the string by using OpenSSL. The following lines show a sample RSA public key string.
final String PUBLIC_X509_PEM =
"-----BEGIN PUBLIC KEY-----\n" +
"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCokfiAVXXf5ImFzKDw+XO/UByW\n" +
"6mse2QsIgz3ZwBtMNu59fR5zttSx+8fB7vR4CN3bTztrP9A6bjoN0FFnhlQ3vNJC\n" +
"5MFO1PByrE/MNd5AAfSVba93I6sx8NSk5MzUCA4NJzAUqYOEWGtGBcom6kEF6MnR\n" +
"1EKib1Id8hpooY5xaQID****\n" +
"-----END PUBLIC KEY-----";
// Create an RSA key pair.
RSAPrivateKey privateKey = SimpleRSAEncryptionMaterials.getPrivateKeyFromPemPKCS1(PRIVATE_PKCS1_PEM);
RSAPublicKey publicKey = SimpleRSAEncryptionMaterials.getPublicKeyFromPemX509(PUBLIC_X509_PEM);
KeyPair keyPair = new KeyPair(publicKey, privateKey);
// Specify the description of the CMK. The description cannot be modified after it is specified. You can specify only one description for a CMK.
// If all objects that you want to encrypt share a CMK, you can leave the description of the CMK empty. In this case, the CMK cannot be replaced.
// If you leave the description of the CMK empty, the client cannot determine which CMK to use for decryption.
// We recommend that you specify a description for each CMK and store the mapping relationship between the CMK and the description on the client. The server does not store the mapping relationship.
Map<String, String> matDesc = new HashMap<String, String>();
matDesc.put("desc-key", "desc-value");
// Create RSA encryption materials.
SimpleRSAEncryptionMaterials encryptionMaterials = new SimpleRSAEncryptionMaterials(keyPair, matDesc);
// To download and decrypt objects encrypted by using other CMKs, add these CMKs and their descriptions to the encryption materials.
// encryptionMaterials.addKeyPairDescMaterial(<otherKeyPair>, <otherKeyPairMatDesc>);
// Create a client for client-side encryption.
// Call the shutdown method to release associated resources when the client is no longer in use.
OSSEncryptionClient ossEncryptionClient = new OSSEncryptionClientBuilder().
build(endpoint, credentialsProvider, encryptionMaterials);
try {
// Encrypt and upload the object.
ossEncryptionClient.putObject(bucketName, objectName, new ByteArrayInputStream(content.getBytes()));
// Download the object. The object is automatically decrypted.
OSSObject ossObject = ossEncryptionClient.getObject(bucketName, objectName);
BufferedReader reader = new BufferedReader(new InputStreamReader(ossObject.getObjectContent()));
StringBuffer buffer = new StringBuffer();
String line;
while ((line = reader.readLine()) != null) {
buffer.append(line);
}
reader.close();
// Check whether the decrypted content is the same as the uploaded object in plaintext.
System.out.println("Put plain text: " + content);
System.out.println("Get and decrypted text: " + buffer.toString());
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossEncryptionClient != null) {
ossEncryptionClient.shutdown();
}
}
}
}import argparse
import base64
import json
from aliyunsdkkms.request.v20160120.DecryptRequest import DecryptRequest
from aliyunsdkkms.request.v20160120.EncryptRequest import EncryptRequest
from alibabacloud_dkms_transfer.kms_transfer_acs_client import KmsTransferAcsClient
from typing import Optional, Dict
import alibabacloud_oss_v2 as oss
# Parse the command line parameters
parser = argparse.ArgumentParser(description="encryption kms sample")
# Add the --region command line parameter, which specifies the region where the bucket is located. This parameter is required.
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# Add the --bucket command line parameter, which specifies the name of the bucket. This parameter is required.
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# Add the --endpoint command line parameter, which specifies the domain name used by other services to access OSS. This parameter is optional.
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# Add the --key command line parameter, which specifies the name of the object (file path). This parameter is required.
parser.add_argument('--key', help='The name of the object.', required=True)
# Add the --kms_id command line parameter, which specifies the user's CMK (Customer Master Key) ID. This parameter is required.
parser.add_argument('--kms_id', help='The id of the your CMK ID.', required=True)
# Custom master key encryptor class, inheriting from oss.crypto.MasterCipher
class MasterKmsCipher(oss.crypto.MasterCipher):
def __init__(
self,
mat_desc: Optional[Dict] = None,
kms_client: Optional[KmsTransferAcsClient] = None,
kms_id: Optional[str] = None,
):
self.kms_client = kms_client
self.kms_id = kms_id
self._mat_desc = None
# If a description of the master key is provided, serialize it to a JSON string
if mat_desc is not None and len(mat_desc.items()) > 0:
self._mat_desc = json.dumps(mat_desc)
def get_wrap_algorithm(self) -> str:
# Return the encryption algorithm name, fixed as 'KMS/ALICLOUD'
return 'KMS/ALICLOUD'
def get_mat_desc(self) -> str:
return self._mat_desc or ''
def encrypt(self, data: bytes) -> bytes:
"""
Encrypt data using the KMS service
:param data: Original data to be encrypted (in bytes format)
:return: Encrypted data (in bytes format)
"""
# Encode the original data in Base64 format
base64_crypto = base64.b64encode(data)
# Construct an encryption request object
request = EncryptRequest()
request.set_KeyId(self.kms_id) # Set the CMK ID
request.set_Plaintext(base64_crypto) # Set the Base64 data to be encrypted
# Call the KMS client to perform the encryption operation and get the response
response = self.kms_client.do_action_with_exception(request)
# Parse the encrypted data field in the response and decode it to bytes format
return base64.b64decode(json.loads(response).get('CiphertextBlob'))
def decrypt(self, data: bytes) -> bytes:
"""
Decrypt data using the KMS service
:param data: Encrypted data (in bytes format)
:return: Decrypted original data (in bytes format)
"""
# Encode the encrypted data in Base64 format
base64_crypto = base64.b64encode(data)
# Construct a decryption request object
request = DecryptRequest()
request.set_CiphertextBlob(base64_crypto) # Set the encrypted data
# Call the KMS client to perform the decryption operation and get the response
response = self.kms_client.do_action_with_exception(request)
# Parse the plaintext field in the response and decode it to bytes format
return base64.b64decode(json.loads(response).get('Plaintext'))
def main():
# Parse the command line arguments
args = parser.parse_args()
# Load credential information (AccessKeyId and AccessKeySecret) from environment variables
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# Load the default configuration of the SDK
cfg = oss.config.load_default()
# Specify the credential provider
cfg.credentials_provider = credentials_provider
# Set the region where the bucket is located
cfg.region = args.region
# If the user provides a custom endpoint, set it in the configuration
if args.endpoint is not None:
cfg.endpoint = args.endpoint
# Initialize the OSS client with the configuration object
client = oss.Client(cfg)
# Initialize the KMS client for interacting with the KMS service
kms_client = KmsTransferAcsClient(
ak=credentials_provider._credentials.access_key_id, # Get AccessKeyId from the credential provider
secret=credentials_provider._credentials.access_key_secret, # Get AccessKeySecret from the credential provider
region_id=args.region # Specify region information
)
# Initialize the master key encryptor (MasterKmsCipher) for encryption and decryption operations
mc = MasterKmsCipher(
mat_desc={"desc": "your master encrypt key material describe information"}, # Master key description information
kms_client=kms_client, # KMS client instance
kms_id=args.kms_id # User's CMK ID
)
# Create an encryption client
encryption_client = oss.EncryptionClient(client, mc)
# Define the data to upload
data = b'hello world'
# Call the put_object method of the encryption client to upload the encrypted object
result = encryption_client.put_object(
oss.PutObjectRequest(
bucket=args.bucket, # Specify the name of the target bucket
key=args.key, # Specify the name of the object (file path)
body=data, # Specify the data to upload
)
)
# Print the result of uploading the encrypted object
print(vars(result))
# Call the get_object method of the encryption client to get the content of the encrypted object
result = encryption_client.get_object(
oss.GetObjectRequest(
bucket=args.bucket, # Specify the name of the target bucket
key=args.key, # Specify the name of the object (file path)
)
)
# Print the result of getting the encrypted object
print(vars(result))
# Print the decrypted object content
print(result.body.read())
if __name__ == "__main__":
# Program entry, call the main function to execute the logic
main()
package main
import (
"bytes"
"io"
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
osscrypto "github.com/aliyun/aliyun-oss-go-sdk/oss/crypto"
)
func main() {
// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured.
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error creating credentials provider: %v", err)
}
// Create an OSSClient instance.
// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint.
// Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou. Specify the actual region.
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// Specify the version of the signature algorithm.
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error creating OSS client: %v", err)
}
// Specify a description for the CMK. The description cannot be modified after being specified. You can specify only one description for a CMK.
// If all objects share a CMK, you can leave the description of the CMK empty. In this case, the CMK cannot be replaced.
// If the description of the CMK is left empty, the client cannot determine which CMK to use for decryption.
// We recommend that you configure a description in the form of a JSON string for each CMK and store the mapping relationship between the CMK and the description on the client. The server does not store the mapping relationship.
// Obtain the mapping relationship based on the CMK description that is a JSON string.
materialDesc := map[string]string{
"desc": "your master encrypt key material describe information",
}
// Create a CMK object based on the description of the CMK.
// Set yourRsaPublicKey to the public key of the CMK that you manage, and set yourRsaPrivateKey to the private key of the CMK that you manage.
masterRsaCipher, err := osscrypto.CreateMasterRsa(materialDesc, "yourRsaPublicKey", "yourRsaPrivateKey")
if err != nil {
log.Fatalf("Error creating master RSA cipher: %v", err)
}
// Create an encryption operation based on the CMK object and perform encryption in AES CTR mode.
contentProvider := osscrypto.CreateAesCtrCipher(masterRsaCipher)
// Obtain an existing bucket to be used for client-side encryption.
// The bucket for which client-side encryption is configured is used in the same manner in which a common bucket is used.
cryptoBucket, err := osscrypto.GetCryptoBucket(client, "yourBucketName", contentProvider)
if err != nil {
log.Fatalf("Error getting crypto bucket: %v", err)
}
// Encryption is automatically performed when you call the PutObject operation.
err = cryptoBucket.PutObject("yourObjectName", bytes.NewReader([]byte("yourObjectValueByteArrary")))
if err != nil {
log.Fatalf("Error putting object: %v", err)
}
// Decryption is automatically performed when you call the GetObject operation.
body, err := cryptoBucket.GetObject("yourObjectName")
if err != nil {
log.Fatalf("Error getting object: %v", err)
}
defer body.Close()
data, err := io.ReadAll(body)
if err != nil {
log.Fatalf("Error reading object data: %v", err)
}
log.Printf("Data: %s", string(data))
}
#include <alibabacloud/oss/OssEncryptionClient.h>
using namespace AlibabaCloud::OSS;
int main(void)
{
/* Initialize the OSS account information. */
/* Set yourEndpoint to the Endpoint of the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the Endpoint to https://oss-cn-hangzhou.aliyuncs.com. */
std::string Endpoint = "yourEndpoint";
/* Set yourRegion to the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the Region to cn-hangzhou. */
std::string Region = "yourRegion";
/* Specify the bucket name. Example: examplebucket. */
std::string BucketName = "examplebucket";
/* Specify the full path of the object. The full path cannot contain the bucket name. Example: exampledir/exampleobject.txt. */
std::string ObjectName = "exampledir/exampleobject.txt";
/* The master key and its description. */
std::string RSAPublicKey = "your rsa public key";
std::string RSAPrivateKey = "your rsa private key";
std::map<std::string, std::string> desc;
desc["comment"] = "your comment";
/* Initialize network resources. */
InitializeSdk();
ClientConfiguration conf;
conf.signatureVersion = SignatureVersionType::V4;
/* Obtain access credentials from environment variables. Before you run this code example, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set. */
auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
OssClient client(Endpoint, credentialsProvider, conf);
client.SetRegion(Region);
CryptoConfiguration cryptoConf;
auto materials = std::make_shared<SimpleRSAEncryptionMaterials>(RSAPublicKey, RSAPrivateKey, desc);
OssEncryptionClient client(Endpoint, credentialsProvider, conf, materials, cryptoConf);
/* Upload the file. */
auto outcome = client.PutObject(BucketName, ObjectName, "yourLocalFilename");
if (!outcome.isSuccess()) {
/* Handle exceptions. */
std::cout << "PutObject fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
return -1;
}
/* Release network resources. */
ShutdownSdk();
return 0;
}<?php
// Introduce autoload files to load dependent libraries.
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Dkms\Gcs\Sdk\Client as KmsClient;
use AlibabaCloud\Oss\V2 as Oss;
// Specify descriptions for command line parameters.
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // (Required) Specify the region in which the bucket is located.
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // (Optional) Specify the endpoint that can be used by other services to access OSS.
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // (Required) Specify the name of the bucket.
"key" => ['help' => 'The name of the object', 'required' => True], // (Required) Specify the name of the object.
];
// Generate a long options list to parse the command line parameters.
$longopts = \array_map(function ($key) {
return "$key:"; // Add a colon (:) to the end of each parameter to indicate that a value is required.
}, array_keys($optsdesc));
// Parse the command line parameters.
$options = getopt("", $longopts);
// Check whether the required parameters are configured.
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help'];
echo "Error: the following arguments are required: --$key, $help"; // Indicate that the required parameters are not configured.
exit(1);
}
}
// Obtain the values of the command line parameters.
$region = $options["region"]; // The region in which the bucket is located.
$bucket = $options["bucket"]; // The name of the bucket.
$key = $options["key"]; // The name of the object.
// Use environment variables to load the AccessKey ID and AccessKey secret.
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// Specify the KMS encryption and decryption class to call the MasterCipherInterface operation.
class KmsCipher implements Oss\Crypto\MasterCipherInterface
{
private $matDesc;
private ?KmsClient $kmsClient;
private ?string $keyId;
private ?string $algorithm;
public function __construct(
$matDesc = null,
?string $keyId = null,
?KmsClient $kmsClient = null,
?string $algorithm = null
)
{
$this->keyId = $keyId;
$this->matDesc = null;
if (\is_array($matDesc)) {
$val = json_encode($matDesc);
if ($val !== false) {
$this->matDesc = $val;
}
} else if (is_string($matDesc)) {
$this->matDesc = $matDesc;
}
$this->kmsClient = $kmsClient;
$this->algorithm = $algorithm;
}
// Specify the encryption method.
public function encrypt(string $data): string
{
$encryptRequest = new \AlibabaCloud\Dkms\Gcs\Sdk\Models\AdvanceEncryptRequest();
$encryptRequest->algorithm = $this->algorithm;
$encryptRequest->keyId = $this->keyId;
$encryptRequest->plaintext = \AlibabaCloud\Tea\Utils\Utils::toBytes($data);
$runtimeOptions = new \AlibabaCloud\Dkms\Gcs\OpenApi\Util\Models\RuntimeOptions();
$encryptResponse = $this->kmsClient->advanceEncryptWithOptions($encryptRequest, $runtimeOptions);
return base64_decode((string)$encryptResponse->ciphertextBlob);
}
// Specify the decryption method.
public function decrypt(string $data): string
{
$decryptRequest = new \AlibabaCloud\Dkms\Gcs\Sdk\Models\AdvanceDecryptRequest();
$decryptRequest->keyId = $this->keyId;
$decryptRequest->ciphertextBlob = $data;
$decryptRequest->algorithm = $this->algorithm;
$runtimeOptions = new \AlibabaCloud\Dkms\Gcs\OpenApi\Util\Models\RuntimeOptions();
$decryptResponse = $this->kmsClient->advanceDecryptWithOptions($decryptRequest, $runtimeOptions);
return base64_decode((string)$decryptResponse->plaintext);
}
// Obtain the wrapping algorithm.
public function getWrapAlgorithm(): string
{
return "KMS/ALICLOUD";
}
public function getMatDesc(): string
{
return $this->matDesc;
}
}
/**
* Create a dedicated KMS SDK client.
* @return KmsClient
*/
function getDkmsGcsSdkClient()
{
global $clientKeyFile, $password, $endpoint;
// Create configurations for the dedicated KMS SDK client.
$config = new \AlibabaCloud\Dkms\Gcs\OpenApi\Models\Config();
$config->protocol = 'https';
$config->clientKeyFile = $clientKeyFile;
$config->password = $password;
$config->endpoint = $endpoint;
// Verify the certificate.
$config->caFilePath = 'path/to/caCert.pem';
// Create a KMS SDK client.
return new \AlibabaCloud\Dkms\Gcs\Sdk\Client($config);
}
// Specify the path of the file that stores the client key of the KMS instance.
$clientKeyFile = '<your client key file path>';
// Specify the password when you create the client key file.
$password = '<your dkms client passowrd>';
// Specify the endpoint of the KMS instance.
$endpoint = '<your dkms instance service address>';
// Specify the ID of the key that you created in KMS.
$kmsKeyId = '<your cmk id>';
// Specify the encryption and decryption algorithms.
$algorithm = '<your encrypt algorithm>';
// Specify the dedicated KMS SDK client.
$kmsClient = getDkmsGcsSdkClient();
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider);
$cfg->setRegion($region);
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]);
}
$client = new Oss\Client($cfg);
$materialDesc = ['desc' => 'your kms encrypt key material describe information'];
$masterKmsCipher = new KmsCipher($materialDesc, $kmsKeyId, $kmsClient, $algorithm);
$eClient = new \AlibabaCloud\Oss\V2\EncryptionClient($client, $masterKmsCipher);
$eClient->putObject(new Oss\Models\PutObjectRequest(
bucket: $bucket,
key: $key,
body: Oss\Utils::streamFor('hi kms')
));
$result = $eClient->getObject(new Oss\Models\GetObjectRequest(
bucket: $bucket,
key: $key,
));
$data = $result->body->getContents();
echo "get object data: " . $data;