Шифрование данных с помощью SDK Yandex Cloud
С Yandex Key Management Service можно работать с помощью SDK Yandex Cloud. Реализация SDK есть на Java, Go, Python и Node.js.
SDK Yandex Cloud наиболее удобен для шифрования данных небольшого размера (ограничение на размер открытого текста – 32 КБ). Для шифрования данных большего объема рекомендуется использовать AWS Encryption SDK или Google Tink. Они шифруют данные по схеме envelope encryption.
Добавление зависимостей
Перед началом работы необходимо добавить зависимости.
Добавьте зависимости с помощью Apache Maven:
<dependency>
<groupId>com.yandex.cloud</groupId>
<artifactId>java-sdk-services</artifactId>
<version>2.4.2</version>
</dependency>
Установите SDK:
go get github.com/yandex-cloud/go-sdk
Аутентификация
Аутентифицироваться можно с помощью:
- сервисного аккаунта, привязанного к виртуальной машине Yandex Cloud;
- произвольного сервисного аккаунта;
- пользовательского аккаунта.
Аутентификация с сервисным аккаунтом, привязанным к виртуальной машине Yandex Cloud
Аутентифицируйтесь с сервисным аккаунтом, привязанным к ВМ:
CredentialProvider credentialProvider = Auth.computeEngineBuilder().build();
Аутентифицируйтесь с сервисным аккаунтом, привязанным к ВМ:
credentials := ycsdk.InstanceServiceAccount()
Аутентификация с произвольным сервисным аккаунтом
В key.json должен содержаться авторизованный ключ сервисного аккаунта. Как создать авторизованный ключ читайте в разделе Создать авторизованный ключ.
Аутентифицируйтесь с произвольным сервисным аккаунтом:
CredentialProvider credentialProvider = Auth.apiKeyBuilder().fromFile(Paths.get("key.json")).build();
Аутентифицируйтесь с произвольным сервисным аккаунтом:
authorizedKey, err := iamkey.ReadFromJSONFile("key.json")
if err != nil {...}
credentials, err := ycsdk.ServiceAccountKey(authorizedKey)
if err != nil {...}
Аутентификация с пользовательским аккаунтом
Пользовательским аккаунтом считается аккаунт на Яндексе, федеративный и локальный аккаунт.
Важно
Аутентификация с пользовательским аккаунтом может быть небезопасна. Рекомендуем использовать сервисный аккаунт.
Переменная token — это ваш IAM-токен. Подробнее о получении IAM-токена читайте в документации Yandex Identity and Access Management.
CredentialProvider credentialProvider = Auth.iamTokenBuilder()
.token(token)
.build();
credentials := ycsdk.NewIAMTokenCredentials(token)
Шифрование и расшифрование данных
Примечание
Изменения, вызванные eventually consistent операциями, становятся применимыми для шифрования и расшифрования с задержкой до трех часов.
Используйте методы encrypt и decrypt для шифрования и расшифрования данных. В коде используются следующие переменные:
endpoint–api.yandexcloud.kz:443.keyId– идентификатор ключа KMS.plaintext– открытый текст (не более 32 КБ).ciphertext– шифртекст.aad– AAD-контекст.
SymmetricCryptoServiceBlockingStub symmetricCryptoService = ServiceFactory.builder()
.endpoint(endpoint)
.credentialProvider(credentialProvider)
.build()
.create(
SymmetricCryptoServiceBlockingStub.class,
SymmetricCryptoServiceGrpc::newBlockingStub
);
...
byte[] ciphertext = symmetricCryptoService.encrypt(SymmetricEncryptRequest.newBuilder()
.setKeyId(keyId)
.setPlaintext(ByteString.copyFrom(plaintext))
.setAadContext(ByteString.copyFrom(aad))
.build()
).getCiphertext().toByteArray();
...
byte[] plaintext = symmetricCryptoService.decrypt(SymmetricDecryptRequest.newBuilder()
.setKeyId(keyId)
.setCiphertext(ByteString.copyFrom(ciphertext))
.setAadContext(ByteString.copyFrom(aad))
.build()
).getPlaintext().toByteArray();
sdk, err := ycsdk.Build(context, ycsdk.Config{
Endpoint: endpoint,
Credentials: credentials,
})
if err != nil {...}
...
response, err := sdk.KMSCrypto().SymmetricCrypto().Encrypt(context, &kms.SymmetricEncryptRequest{
KeyId: keyId,
Plaintext: plaintext,
AadContext: aad,
})
if err != nil {...}
ciphertext := response.Ciphertext
...
response, err := sdk.KMSCrypto().SymmetricCrypto().Decrypt(context, &kms.SymmetricDecryptRequest{
KeyId: keyId,
Ciphertext: ciphertext,
AadContext: aad,
})
if err != nil {...}
plaintext := response.Plaintext