Protocol Documentation

Table of Contents

cryption.proto

Top

[gRPC Service] CryptionService

CryptionService is used to encrypt or decrypt data.

Method NameRequest TypeResponse TypeDescription
Encrypt EncryptRequest EncryptResponse

Encrypt data

Decrypt DecryptRequest DecryptResponse

Decrypt data

DecryptRequest

DecryptRequest is the request of the `Decrypt` method.

FieldTypeLabelDescription
component_name string

The cryption service name, e.g. 'aliyun.kms'

cipher_text bytes

Required. The encrypted text

DecryptResponse

DecryptResponse is the response of the `Decrypt` method.

FieldTypeLabelDescription
plain_text bytes

Raw plaintext.

key_id string

The id of the key used to decrypt this text.

key_version_id string

The version of the key

EncryptRequest

EncryptRequest is the request to encrypt data.

FieldTypeLabelDescription
component_name string

The cryption service name, e.g. 'aliyun.kms'

plain_text bytes

Required. Raw plaintext.

key_id string

Required.

EncryptResponse

EncryptResponse is the response of the `Encrypt` method.

FieldTypeLabelDescription
cipher_text bytes

The encrypted text

key_id string

The id of the key used to decrypt this text.

key_version_id string

The version of the key

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)