kms

package
v0.0.0-...-76a0cfc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2024 License: MIT Imports: 16 Imported by: 15

Documentation

Index

Constants

View Source
const (
	SymmetricCryptoService_Encrypt_FullMethodName         = "/yandex.cloud.kms.v1.SymmetricCryptoService/Encrypt"
	SymmetricCryptoService_Decrypt_FullMethodName         = "/yandex.cloud.kms.v1.SymmetricCryptoService/Decrypt"
	SymmetricCryptoService_ReEncrypt_FullMethodName       = "/yandex.cloud.kms.v1.SymmetricCryptoService/ReEncrypt"
	SymmetricCryptoService_GenerateDataKey_FullMethodName = "/yandex.cloud.kms.v1.SymmetricCryptoService/GenerateDataKey"
)
View Source
const (
	SymmetricKeyService_Create_FullMethodName                     = "/yandex.cloud.kms.v1.SymmetricKeyService/Create"
	SymmetricKeyService_Get_FullMethodName                        = "/yandex.cloud.kms.v1.SymmetricKeyService/Get"
	SymmetricKeyService_List_FullMethodName                       = "/yandex.cloud.kms.v1.SymmetricKeyService/List"
	SymmetricKeyService_ListVersions_FullMethodName               = "/yandex.cloud.kms.v1.SymmetricKeyService/ListVersions"
	SymmetricKeyService_Update_FullMethodName                     = "/yandex.cloud.kms.v1.SymmetricKeyService/Update"
	SymmetricKeyService_Delete_FullMethodName                     = "/yandex.cloud.kms.v1.SymmetricKeyService/Delete"
	SymmetricKeyService_SetPrimaryVersion_FullMethodName          = "/yandex.cloud.kms.v1.SymmetricKeyService/SetPrimaryVersion"
	SymmetricKeyService_ScheduleVersionDestruction_FullMethodName = "/yandex.cloud.kms.v1.SymmetricKeyService/ScheduleVersionDestruction"
	SymmetricKeyService_CancelVersionDestruction_FullMethodName   = "/yandex.cloud.kms.v1.SymmetricKeyService/CancelVersionDestruction"
	SymmetricKeyService_Rotate_FullMethodName                     = "/yandex.cloud.kms.v1.SymmetricKeyService/Rotate"
	SymmetricKeyService_ListOperations_FullMethodName             = "/yandex.cloud.kms.v1.SymmetricKeyService/ListOperations"
	SymmetricKeyService_ListAccessBindings_FullMethodName         = "/yandex.cloud.kms.v1.SymmetricKeyService/ListAccessBindings"
	SymmetricKeyService_SetAccessBindings_FullMethodName          = "/yandex.cloud.kms.v1.SymmetricKeyService/SetAccessBindings"
	SymmetricKeyService_UpdateAccessBindings_FullMethodName       = "/yandex.cloud.kms.v1.SymmetricKeyService/UpdateAccessBindings"
)

Variables

View Source
var (
	SymmetricAlgorithm_name = map[int32]string{
		0: "SYMMETRIC_ALGORITHM_UNSPECIFIED",
		1: "AES_128",
		2: "AES_192",
		3: "AES_256",
		4: "AES_256_HSM",
	}
	SymmetricAlgorithm_value = map[string]int32{
		"SYMMETRIC_ALGORITHM_UNSPECIFIED": 0,
		"AES_128":                         1,
		"AES_192":                         2,
		"AES_256":                         3,
		"AES_256_HSM":                     4,
	}
)

Enum value maps for SymmetricAlgorithm.

View Source
var (
	SymmetricKey_Status_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "INACTIVE",
	}
	SymmetricKey_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED": 0,
		"CREATING":           1,
		"ACTIVE":             2,
		"INACTIVE":           3,
	}
)

Enum value maps for SymmetricKey_Status.

View Source
var (
	SymmetricKeyVersion_Status_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "ACTIVE",
		2: "SCHEDULED_FOR_DESTRUCTION",
		3: "DESTROYED",
	}
	SymmetricKeyVersion_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED":        0,
		"ACTIVE":                    1,
		"SCHEDULED_FOR_DESTRUCTION": 2,
		"DESTROYED":                 3,
	}
)

Enum value maps for SymmetricKeyVersion_Status.

View Source
var File_yandex_cloud_kms_v1_symmetric_crypto_service_proto protoreflect.FileDescriptor
View Source
var File_yandex_cloud_kms_v1_symmetric_key_proto protoreflect.FileDescriptor
View Source
var File_yandex_cloud_kms_v1_symmetric_key_service_proto protoreflect.FileDescriptor
View Source
var SymmetricCryptoService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "yandex.cloud.kms.v1.SymmetricCryptoService",
	HandlerType: (*SymmetricCryptoServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Encrypt",
			Handler:    _SymmetricCryptoService_Encrypt_Handler,
		},
		{
			MethodName: "Decrypt",
			Handler:    _SymmetricCryptoService_Decrypt_Handler,
		},
		{
			MethodName: "ReEncrypt",
			Handler:    _SymmetricCryptoService_ReEncrypt_Handler,
		},
		{
			MethodName: "GenerateDataKey",
			Handler:    _SymmetricCryptoService_GenerateDataKey_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "yandex/cloud/kms/v1/symmetric_crypto_service.proto",
}

SymmetricCryptoService_ServiceDesc is the grpc.ServiceDesc for SymmetricCryptoService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var SymmetricKeyService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "yandex.cloud.kms.v1.SymmetricKeyService",
	HandlerType: (*SymmetricKeyServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _SymmetricKeyService_Create_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _SymmetricKeyService_Get_Handler,
		},
		{
			MethodName: "List",
			Handler:    _SymmetricKeyService_List_Handler,
		},
		{
			MethodName: "ListVersions",
			Handler:    _SymmetricKeyService_ListVersions_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _SymmetricKeyService_Update_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _SymmetricKeyService_Delete_Handler,
		},
		{
			MethodName: "SetPrimaryVersion",
			Handler:    _SymmetricKeyService_SetPrimaryVersion_Handler,
		},
		{
			MethodName: "ScheduleVersionDestruction",
			Handler:    _SymmetricKeyService_ScheduleVersionDestruction_Handler,
		},
		{
			MethodName: "CancelVersionDestruction",
			Handler:    _SymmetricKeyService_CancelVersionDestruction_Handler,
		},
		{
			MethodName: "Rotate",
			Handler:    _SymmetricKeyService_Rotate_Handler,
		},
		{
			MethodName: "ListOperations",
			Handler:    _SymmetricKeyService_ListOperations_Handler,
		},
		{
			MethodName: "ListAccessBindings",
			Handler:    _SymmetricKeyService_ListAccessBindings_Handler,
		},
		{
			MethodName: "SetAccessBindings",
			Handler:    _SymmetricKeyService_SetAccessBindings_Handler,
		},
		{
			MethodName: "UpdateAccessBindings",
			Handler:    _SymmetricKeyService_UpdateAccessBindings_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "yandex/cloud/kms/v1/symmetric_key_service.proto",
}

SymmetricKeyService_ServiceDesc is the grpc.ServiceDesc for SymmetricKeyService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSymmetricCryptoServiceServer

func RegisterSymmetricCryptoServiceServer(s grpc.ServiceRegistrar, srv SymmetricCryptoServiceServer)

func RegisterSymmetricKeyServiceServer

func RegisterSymmetricKeyServiceServer(s grpc.ServiceRegistrar, srv SymmetricKeyServiceServer)

Types

type CancelSymmetricKeyVersionDestructionMetadata

type CancelSymmetricKeyVersionDestructionMetadata struct {

	// ID of the key whose version's destruction is being cancelled.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version whose scheduled destruction is being cancelled.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelSymmetricKeyVersionDestructionMetadata) Descriptor deprecated

Deprecated: Use CancelSymmetricKeyVersionDestructionMetadata.ProtoReflect.Descriptor instead.

func (*CancelSymmetricKeyVersionDestructionMetadata) GetKeyId

func (*CancelSymmetricKeyVersionDestructionMetadata) GetVersionId

func (*CancelSymmetricKeyVersionDestructionMetadata) ProtoMessage

func (*CancelSymmetricKeyVersionDestructionMetadata) ProtoReflect

func (*CancelSymmetricKeyVersionDestructionMetadata) Reset

func (*CancelSymmetricKeyVersionDestructionMetadata) SetKeyId

func (*CancelSymmetricKeyVersionDestructionMetadata) SetVersionId

func (*CancelSymmetricKeyVersionDestructionMetadata) String

type CancelSymmetricKeyVersionDestructionRequest

type CancelSymmetricKeyVersionDestructionRequest struct {

	// ID of the key to cancel a version's destruction for.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version whose scheduled destruction should be cancelled.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelSymmetricKeyVersionDestructionRequest) Descriptor deprecated

Deprecated: Use CancelSymmetricKeyVersionDestructionRequest.ProtoReflect.Descriptor instead.

func (*CancelSymmetricKeyVersionDestructionRequest) GetKeyId

func (*CancelSymmetricKeyVersionDestructionRequest) GetVersionId

func (*CancelSymmetricKeyVersionDestructionRequest) ProtoMessage

func (*CancelSymmetricKeyVersionDestructionRequest) ProtoReflect

func (*CancelSymmetricKeyVersionDestructionRequest) Reset

func (*CancelSymmetricKeyVersionDestructionRequest) SetKeyId

func (*CancelSymmetricKeyVersionDestructionRequest) SetVersionId

func (*CancelSymmetricKeyVersionDestructionRequest) String

type CreateSymmetricKeyMetadata

type CreateSymmetricKeyMetadata struct {

	// ID of the key being created.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the primary version of the key being created.
	PrimaryVersionId string `protobuf:"bytes,2,opt,name=primary_version_id,json=primaryVersionId,proto3" json:"primary_version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSymmetricKeyMetadata) Descriptor deprecated

func (*CreateSymmetricKeyMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateSymmetricKeyMetadata.ProtoReflect.Descriptor instead.

func (*CreateSymmetricKeyMetadata) GetKeyId

func (x *CreateSymmetricKeyMetadata) GetKeyId() string

func (*CreateSymmetricKeyMetadata) GetPrimaryVersionId

func (x *CreateSymmetricKeyMetadata) GetPrimaryVersionId() string

func (*CreateSymmetricKeyMetadata) ProtoMessage

func (*CreateSymmetricKeyMetadata) ProtoMessage()

func (*CreateSymmetricKeyMetadata) ProtoReflect

func (*CreateSymmetricKeyMetadata) Reset

func (x *CreateSymmetricKeyMetadata) Reset()

func (*CreateSymmetricKeyMetadata) SetKeyId

func (m *CreateSymmetricKeyMetadata) SetKeyId(v string)

func (*CreateSymmetricKeyMetadata) SetPrimaryVersionId

func (m *CreateSymmetricKeyMetadata) SetPrimaryVersionId(v string)

func (*CreateSymmetricKeyMetadata) String

func (x *CreateSymmetricKeyMetadata) String() string

type CreateSymmetricKeyRequest

type CreateSymmetricKeyRequest struct {

	// ID of the folder to create a symmetric KMS key in.
	FolderId string `protobuf:"bytes,1,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Name of the key.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the key.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Custom labels for the symmetric KMS key as `key:value` pairs. Maximum 64 per key.
	// For example, `"project": "mvp"` or `"source": "dictionary"`.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Encryption algorithm to be used with a new key version, generated with the next rotation.
	DefaultAlgorithm SymmetricAlgorithm `` /* 154-byte string literal not displayed */
	// Interval between automatic rotations. To disable automatic rotation, don't include
	// this field in the creation request.
	RotationPeriod *durationpb.Duration `protobuf:"bytes,6,opt,name=rotation_period,json=rotationPeriod,proto3" json:"rotation_period,omitempty"`
	// Flag that inhibits deletion of the symmetric KMS key
	DeletionProtection bool `protobuf:"varint,7,opt,name=deletion_protection,json=deletionProtection,proto3" json:"deletion_protection,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSymmetricKeyRequest) Descriptor deprecated

func (*CreateSymmetricKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateSymmetricKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateSymmetricKeyRequest) GetDefaultAlgorithm

func (x *CreateSymmetricKeyRequest) GetDefaultAlgorithm() SymmetricAlgorithm

func (*CreateSymmetricKeyRequest) GetDeletionProtection

func (x *CreateSymmetricKeyRequest) GetDeletionProtection() bool

func (*CreateSymmetricKeyRequest) GetDescription

func (x *CreateSymmetricKeyRequest) GetDescription() string

func (*CreateSymmetricKeyRequest) GetFolderId

func (x *CreateSymmetricKeyRequest) GetFolderId() string

func (*CreateSymmetricKeyRequest) GetLabels

func (x *CreateSymmetricKeyRequest) GetLabels() map[string]string

func (*CreateSymmetricKeyRequest) GetName

func (x *CreateSymmetricKeyRequest) GetName() string

func (*CreateSymmetricKeyRequest) GetRotationPeriod

func (x *CreateSymmetricKeyRequest) GetRotationPeriod() *durationpb.Duration

func (*CreateSymmetricKeyRequest) ProtoMessage

func (*CreateSymmetricKeyRequest) ProtoMessage()

func (*CreateSymmetricKeyRequest) ProtoReflect

func (*CreateSymmetricKeyRequest) Reset

func (x *CreateSymmetricKeyRequest) Reset()

func (*CreateSymmetricKeyRequest) SetDefaultAlgorithm

func (m *CreateSymmetricKeyRequest) SetDefaultAlgorithm(v SymmetricAlgorithm)

func (*CreateSymmetricKeyRequest) SetDeletionProtection

func (m *CreateSymmetricKeyRequest) SetDeletionProtection(v bool)

func (*CreateSymmetricKeyRequest) SetDescription

func (m *CreateSymmetricKeyRequest) SetDescription(v string)

func (*CreateSymmetricKeyRequest) SetFolderId

func (m *CreateSymmetricKeyRequest) SetFolderId(v string)

func (*CreateSymmetricKeyRequest) SetLabels

func (m *CreateSymmetricKeyRequest) SetLabels(v map[string]string)

func (*CreateSymmetricKeyRequest) SetName

func (m *CreateSymmetricKeyRequest) SetName(v string)

func (*CreateSymmetricKeyRequest) SetRotationPeriod

func (m *CreateSymmetricKeyRequest) SetRotationPeriod(v *durationpb.Duration)

func (*CreateSymmetricKeyRequest) String

func (x *CreateSymmetricKeyRequest) String() string

type DeleteSymmetricKeyMetadata

type DeleteSymmetricKeyMetadata struct {

	// ID of the key being deleted.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteSymmetricKeyMetadata) Descriptor deprecated

func (*DeleteSymmetricKeyMetadata) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSymmetricKeyMetadata.ProtoReflect.Descriptor instead.

func (*DeleteSymmetricKeyMetadata) GetKeyId

func (x *DeleteSymmetricKeyMetadata) GetKeyId() string

func (*DeleteSymmetricKeyMetadata) ProtoMessage

func (*DeleteSymmetricKeyMetadata) ProtoMessage()

func (*DeleteSymmetricKeyMetadata) ProtoReflect

func (*DeleteSymmetricKeyMetadata) Reset

func (x *DeleteSymmetricKeyMetadata) Reset()

func (*DeleteSymmetricKeyMetadata) SetKeyId

func (m *DeleteSymmetricKeyMetadata) SetKeyId(v string)

func (*DeleteSymmetricKeyMetadata) String

func (x *DeleteSymmetricKeyMetadata) String() string

type DeleteSymmetricKeyRequest

type DeleteSymmetricKeyRequest struct {

	// ID of the key to be deleted.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteSymmetricKeyRequest) Descriptor deprecated

func (*DeleteSymmetricKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteSymmetricKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteSymmetricKeyRequest) GetKeyId

func (x *DeleteSymmetricKeyRequest) GetKeyId() string

func (*DeleteSymmetricKeyRequest) ProtoMessage

func (*DeleteSymmetricKeyRequest) ProtoMessage()

func (*DeleteSymmetricKeyRequest) ProtoReflect

func (*DeleteSymmetricKeyRequest) Reset

func (x *DeleteSymmetricKeyRequest) Reset()

func (*DeleteSymmetricKeyRequest) SetKeyId

func (m *DeleteSymmetricKeyRequest) SetKeyId(v string)

func (*DeleteSymmetricKeyRequest) String

func (x *DeleteSymmetricKeyRequest) String() string

type GenerateDataKeyRequest

type GenerateDataKeyRequest struct {

	// ID of the symmetric KMS key that the generated data key should be encrypted with.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the key version to encrypt the generated data key with.
	// Defaults to the primary version if not specified.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Additional authenticated data (AAD context), optional.
	// If specified, this data will be required for decryption with the [SymmetricDecryptRequest].
	// Should be encoded with base64.
	AadContext []byte `protobuf:"bytes,3,opt,name=aad_context,json=aadContext,proto3" json:"aad_context,omitempty"`
	// Encryption algorithm and key length for the generated data key.
	DataKeySpec SymmetricAlgorithm `` /* 141-byte string literal not displayed */
	// If `true`, the method won't return the data key as plaintext.
	// Default value is `false`.
	SkipPlaintext bool `protobuf:"varint,5,opt,name=skip_plaintext,json=skipPlaintext,proto3" json:"skip_plaintext,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateDataKeyRequest) Descriptor deprecated

func (*GenerateDataKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateDataKeyRequest.ProtoReflect.Descriptor instead.

func (*GenerateDataKeyRequest) GetAadContext

func (x *GenerateDataKeyRequest) GetAadContext() []byte

func (*GenerateDataKeyRequest) GetDataKeySpec

func (x *GenerateDataKeyRequest) GetDataKeySpec() SymmetricAlgorithm

func (*GenerateDataKeyRequest) GetKeyId

func (x *GenerateDataKeyRequest) GetKeyId() string

func (*GenerateDataKeyRequest) GetSkipPlaintext

func (x *GenerateDataKeyRequest) GetSkipPlaintext() bool

func (*GenerateDataKeyRequest) GetVersionId

func (x *GenerateDataKeyRequest) GetVersionId() string

func (*GenerateDataKeyRequest) ProtoMessage

func (*GenerateDataKeyRequest) ProtoMessage()

func (*GenerateDataKeyRequest) ProtoReflect

func (x *GenerateDataKeyRequest) ProtoReflect() protoreflect.Message

func (*GenerateDataKeyRequest) Reset

func (x *GenerateDataKeyRequest) Reset()

func (*GenerateDataKeyRequest) SetAadContext

func (m *GenerateDataKeyRequest) SetAadContext(v []byte)

func (*GenerateDataKeyRequest) SetDataKeySpec

func (m *GenerateDataKeyRequest) SetDataKeySpec(v SymmetricAlgorithm)

func (*GenerateDataKeyRequest) SetKeyId

func (m *GenerateDataKeyRequest) SetKeyId(v string)

func (*GenerateDataKeyRequest) SetSkipPlaintext

func (m *GenerateDataKeyRequest) SetSkipPlaintext(v bool)

func (*GenerateDataKeyRequest) SetVersionId

func (m *GenerateDataKeyRequest) SetVersionId(v string)

func (*GenerateDataKeyRequest) String

func (x *GenerateDataKeyRequest) String() string

type GenerateDataKeyResponse

type GenerateDataKeyResponse struct {

	// ID of the symmetric KMS key that was used to encrypt the generated data key.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the key version that was used for encryption.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Generated data key as plaintext.
	// The field is empty, if the [GenerateDataKeyRequest.skip_plaintext] parameter
	// was set to `true`.
	DataKeyPlaintext []byte `protobuf:"bytes,3,opt,name=data_key_plaintext,json=dataKeyPlaintext,proto3" json:"data_key_plaintext,omitempty"`
	// The encrypted data key.
	DataKeyCiphertext []byte `protobuf:"bytes,4,opt,name=data_key_ciphertext,json=dataKeyCiphertext,proto3" json:"data_key_ciphertext,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateDataKeyResponse) Descriptor deprecated

func (*GenerateDataKeyResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateDataKeyResponse.ProtoReflect.Descriptor instead.

func (*GenerateDataKeyResponse) GetDataKeyCiphertext

func (x *GenerateDataKeyResponse) GetDataKeyCiphertext() []byte

func (*GenerateDataKeyResponse) GetDataKeyPlaintext

func (x *GenerateDataKeyResponse) GetDataKeyPlaintext() []byte

func (*GenerateDataKeyResponse) GetKeyId

func (x *GenerateDataKeyResponse) GetKeyId() string

func (*GenerateDataKeyResponse) GetVersionId

func (x *GenerateDataKeyResponse) GetVersionId() string

func (*GenerateDataKeyResponse) ProtoMessage

func (*GenerateDataKeyResponse) ProtoMessage()

func (*GenerateDataKeyResponse) ProtoReflect

func (x *GenerateDataKeyResponse) ProtoReflect() protoreflect.Message

func (*GenerateDataKeyResponse) Reset

func (x *GenerateDataKeyResponse) Reset()

func (*GenerateDataKeyResponse) SetDataKeyCiphertext

func (m *GenerateDataKeyResponse) SetDataKeyCiphertext(v []byte)

func (*GenerateDataKeyResponse) SetDataKeyPlaintext

func (m *GenerateDataKeyResponse) SetDataKeyPlaintext(v []byte)

func (*GenerateDataKeyResponse) SetKeyId

func (m *GenerateDataKeyResponse) SetKeyId(v string)

func (*GenerateDataKeyResponse) SetVersionId

func (m *GenerateDataKeyResponse) SetVersionId(v string)

func (*GenerateDataKeyResponse) String

func (x *GenerateDataKeyResponse) String() string

type GetSymmetricKeyRequest

type GetSymmetricKeyRequest struct {

	// ID of the symmetric KMS key to return.
	// To get the ID of a symmetric KMS key use a [SymmetricKeyService.List] request.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSymmetricKeyRequest) Descriptor deprecated

func (*GetSymmetricKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSymmetricKeyRequest.ProtoReflect.Descriptor instead.

func (*GetSymmetricKeyRequest) GetKeyId

func (x *GetSymmetricKeyRequest) GetKeyId() string

func (*GetSymmetricKeyRequest) ProtoMessage

func (*GetSymmetricKeyRequest) ProtoMessage()

func (*GetSymmetricKeyRequest) ProtoReflect

func (x *GetSymmetricKeyRequest) ProtoReflect() protoreflect.Message

func (*GetSymmetricKeyRequest) Reset

func (x *GetSymmetricKeyRequest) Reset()

func (*GetSymmetricKeyRequest) SetKeyId

func (m *GetSymmetricKeyRequest) SetKeyId(v string)

func (*GetSymmetricKeyRequest) String

func (x *GetSymmetricKeyRequest) String() string

type ListSymmetricKeyOperationsRequest

type ListSymmetricKeyOperationsRequest struct {

	// ID of the symmetric KMS key to get operations for.
	//
	// To get the key ID, use a [SymmetricKeyService.List] request.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// The maximum number of results per page that should be returned. If the number of available
	// results is larger than [page_size], the service returns a [ListSymmetricKeyOperationsResponse.next_page_token]
	// that can be used to get the next page of results in subsequent list requests.
	// Default value: 100.
	PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token. To get the next page of results, set [page_token] to the
	// [ListSymmetricKeyOperationsResponse.next_page_token] returned by a previous list request.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSymmetricKeyOperationsRequest) Descriptor deprecated

func (*ListSymmetricKeyOperationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSymmetricKeyOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListSymmetricKeyOperationsRequest) GetKeyId

func (*ListSymmetricKeyOperationsRequest) GetPageSize

func (x *ListSymmetricKeyOperationsRequest) GetPageSize() int64

func (*ListSymmetricKeyOperationsRequest) GetPageToken

func (x *ListSymmetricKeyOperationsRequest) GetPageToken() string

func (*ListSymmetricKeyOperationsRequest) ProtoMessage

func (*ListSymmetricKeyOperationsRequest) ProtoMessage()

func (*ListSymmetricKeyOperationsRequest) ProtoReflect

func (*ListSymmetricKeyOperationsRequest) Reset

func (*ListSymmetricKeyOperationsRequest) SetKeyId

func (*ListSymmetricKeyOperationsRequest) SetPageSize

func (m *ListSymmetricKeyOperationsRequest) SetPageSize(v int64)

func (*ListSymmetricKeyOperationsRequest) SetPageToken

func (m *ListSymmetricKeyOperationsRequest) SetPageToken(v string)

func (*ListSymmetricKeyOperationsRequest) String

type ListSymmetricKeyOperationsResponse

type ListSymmetricKeyOperationsResponse struct {

	// List of operations for the specified key.
	Operations []*operation.Operation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	// This token allows you to get the next page of results for list requests. If the number of results
	// is larger than [ListSymmetricKeyOperationsRequest.page_size], use the [next_page_token] as the value
	// for the [ListSymmetricKeyOperationsRequest.page_token] query parameter in the next list request.
	// Each subsequent list request will have its own [next_page_token] to continue paging through the results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSymmetricKeyOperationsResponse) Descriptor deprecated

func (*ListSymmetricKeyOperationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSymmetricKeyOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListSymmetricKeyOperationsResponse) GetNextPageToken

func (x *ListSymmetricKeyOperationsResponse) GetNextPageToken() string

func (*ListSymmetricKeyOperationsResponse) GetOperations

func (*ListSymmetricKeyOperationsResponse) ProtoMessage

func (*ListSymmetricKeyOperationsResponse) ProtoMessage()

func (*ListSymmetricKeyOperationsResponse) ProtoReflect

func (*ListSymmetricKeyOperationsResponse) Reset

func (*ListSymmetricKeyOperationsResponse) SetNextPageToken

func (m *ListSymmetricKeyOperationsResponse) SetNextPageToken(v string)

func (*ListSymmetricKeyOperationsResponse) SetOperations

func (*ListSymmetricKeyOperationsResponse) String

type ListSymmetricKeyVersionsRequest

type ListSymmetricKeyVersionsRequest struct {

	// ID of the symmetric KMS key to list versions for.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// The maximum number of results per page to return. If the number of available
	// results is larger than [page_size], the service returns a [ListSymmetricKeyVersionsResponse.next_page_token]
	// that can be used to get the next page of results in subsequent list requests.
	// Default value: 100.
	PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token. To get the next page of results, set [page_token] to the
	// [ListSymmetricKeyVersionsResponse.next_page_token] returned by a previous list request.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSymmetricKeyVersionsRequest) Descriptor deprecated

func (*ListSymmetricKeyVersionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSymmetricKeyVersionsRequest.ProtoReflect.Descriptor instead.

func (*ListSymmetricKeyVersionsRequest) GetKeyId

func (*ListSymmetricKeyVersionsRequest) GetPageSize

func (x *ListSymmetricKeyVersionsRequest) GetPageSize() int64

func (*ListSymmetricKeyVersionsRequest) GetPageToken

func (x *ListSymmetricKeyVersionsRequest) GetPageToken() string

func (*ListSymmetricKeyVersionsRequest) ProtoMessage

func (*ListSymmetricKeyVersionsRequest) ProtoMessage()

func (*ListSymmetricKeyVersionsRequest) ProtoReflect

func (*ListSymmetricKeyVersionsRequest) Reset

func (*ListSymmetricKeyVersionsRequest) SetKeyId

func (m *ListSymmetricKeyVersionsRequest) SetKeyId(v string)

func (*ListSymmetricKeyVersionsRequest) SetPageSize

func (m *ListSymmetricKeyVersionsRequest) SetPageSize(v int64)

func (*ListSymmetricKeyVersionsRequest) SetPageToken

func (m *ListSymmetricKeyVersionsRequest) SetPageToken(v string)

func (*ListSymmetricKeyVersionsRequest) String

type ListSymmetricKeyVersionsResponse

type ListSymmetricKeyVersionsResponse struct {

	// List of versions for the specified symmetric KMS key.
	KeyVersions []*SymmetricKeyVersion `protobuf:"bytes,1,rep,name=key_versions,json=keyVersions,proto3" json:"key_versions,omitempty"`
	// This token allows you to get the next page of results for list requests. If the number
	// of results is greater than the specified [ListSymmetricKeyVersionsRequest.page_size], use
	// the [next_page_token] as the value for the [ListSymmetricKeyVersionsRequest.page_token] query parameter
	// in the next list request. Each subsequent list request will have its own
	// [next_page_token] to continue paging through the results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSymmetricKeyVersionsResponse) Descriptor deprecated

func (*ListSymmetricKeyVersionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSymmetricKeyVersionsResponse.ProtoReflect.Descriptor instead.

func (*ListSymmetricKeyVersionsResponse) GetKeyVersions

func (*ListSymmetricKeyVersionsResponse) GetNextPageToken

func (x *ListSymmetricKeyVersionsResponse) GetNextPageToken() string

func (*ListSymmetricKeyVersionsResponse) ProtoMessage

func (*ListSymmetricKeyVersionsResponse) ProtoMessage()

func (*ListSymmetricKeyVersionsResponse) ProtoReflect

func (*ListSymmetricKeyVersionsResponse) Reset

func (*ListSymmetricKeyVersionsResponse) SetKeyVersions

func (m *ListSymmetricKeyVersionsResponse) SetKeyVersions(v []*SymmetricKeyVersion)

func (*ListSymmetricKeyVersionsResponse) SetNextPageToken

func (m *ListSymmetricKeyVersionsResponse) SetNextPageToken(v string)

func (*ListSymmetricKeyVersionsResponse) String

type ListSymmetricKeysRequest

type ListSymmetricKeysRequest struct {

	// ID of the folder to list symmetric KMS keys in.
	FolderId string `protobuf:"bytes,1,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// The maximum number of results per page to return. If the number of available
	// results is larger than [page_size], the service returns a [ListSymmetricKeysResponse.next_page_token]
	// that can be used to get the next page of results in subsequent list requests.
	// Default value: 100.
	PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token. To get the next page of results, set [page_token] to the
	// [ListSymmetricKeysResponse.next_page_token] returned by a previous list request.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSymmetricKeysRequest) Descriptor deprecated

func (*ListSymmetricKeysRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSymmetricKeysRequest.ProtoReflect.Descriptor instead.

func (*ListSymmetricKeysRequest) GetFolderId

func (x *ListSymmetricKeysRequest) GetFolderId() string

func (*ListSymmetricKeysRequest) GetPageSize

func (x *ListSymmetricKeysRequest) GetPageSize() int64

func (*ListSymmetricKeysRequest) GetPageToken

func (x *ListSymmetricKeysRequest) GetPageToken() string

func (*ListSymmetricKeysRequest) ProtoMessage

func (*ListSymmetricKeysRequest) ProtoMessage()

func (*ListSymmetricKeysRequest) ProtoReflect

func (x *ListSymmetricKeysRequest) ProtoReflect() protoreflect.Message

func (*ListSymmetricKeysRequest) Reset

func (x *ListSymmetricKeysRequest) Reset()

func (*ListSymmetricKeysRequest) SetFolderId

func (m *ListSymmetricKeysRequest) SetFolderId(v string)

func (*ListSymmetricKeysRequest) SetPageSize

func (m *ListSymmetricKeysRequest) SetPageSize(v int64)

func (*ListSymmetricKeysRequest) SetPageToken

func (m *ListSymmetricKeysRequest) SetPageToken(v string)

func (*ListSymmetricKeysRequest) String

func (x *ListSymmetricKeysRequest) String() string

type ListSymmetricKeysResponse

type ListSymmetricKeysResponse struct {

	// List of symmetric KMS keys in the specified folder.
	Keys []*SymmetricKey `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
	// This token allows you to get the next page of results for list requests. If the number
	// of results is greater than the specified [ListSymmetricKeysRequest.page_size], use
	// the [next_page_token] as the value for the [ListSymmetricKeysRequest.page_token] query parameter
	// in the next list request. Each subsequent list request will have its own
	// [next_page_token] to continue paging through the results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSymmetricKeysResponse) Descriptor deprecated

func (*ListSymmetricKeysResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSymmetricKeysResponse.ProtoReflect.Descriptor instead.

func (*ListSymmetricKeysResponse) GetKeys

func (x *ListSymmetricKeysResponse) GetKeys() []*SymmetricKey

func (*ListSymmetricKeysResponse) GetNextPageToken

func (x *ListSymmetricKeysResponse) GetNextPageToken() string

func (*ListSymmetricKeysResponse) ProtoMessage

func (*ListSymmetricKeysResponse) ProtoMessage()

func (*ListSymmetricKeysResponse) ProtoReflect

func (*ListSymmetricKeysResponse) Reset

func (x *ListSymmetricKeysResponse) Reset()

func (*ListSymmetricKeysResponse) SetKeys

func (m *ListSymmetricKeysResponse) SetKeys(v []*SymmetricKey)

func (*ListSymmetricKeysResponse) SetNextPageToken

func (m *ListSymmetricKeysResponse) SetNextPageToken(v string)

func (*ListSymmetricKeysResponse) String

func (x *ListSymmetricKeysResponse) String() string

type RotateSymmetricKeyMetadata

type RotateSymmetricKeyMetadata struct {

	// ID of the key being rotated.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version generated as a result of key rotation.
	NewPrimaryVersionId string `protobuf:"bytes,2,opt,name=new_primary_version_id,json=newPrimaryVersionId,proto3" json:"new_primary_version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RotateSymmetricKeyMetadata) Descriptor deprecated

func (*RotateSymmetricKeyMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RotateSymmetricKeyMetadata.ProtoReflect.Descriptor instead.

func (*RotateSymmetricKeyMetadata) GetKeyId

func (x *RotateSymmetricKeyMetadata) GetKeyId() string

func (*RotateSymmetricKeyMetadata) GetNewPrimaryVersionId

func (x *RotateSymmetricKeyMetadata) GetNewPrimaryVersionId() string

func (*RotateSymmetricKeyMetadata) ProtoMessage

func (*RotateSymmetricKeyMetadata) ProtoMessage()

func (*RotateSymmetricKeyMetadata) ProtoReflect

func (*RotateSymmetricKeyMetadata) Reset

func (x *RotateSymmetricKeyMetadata) Reset()

func (*RotateSymmetricKeyMetadata) SetKeyId

func (m *RotateSymmetricKeyMetadata) SetKeyId(v string)

func (*RotateSymmetricKeyMetadata) SetNewPrimaryVersionId

func (m *RotateSymmetricKeyMetadata) SetNewPrimaryVersionId(v string)

func (*RotateSymmetricKeyMetadata) String

func (x *RotateSymmetricKeyMetadata) String() string

type RotateSymmetricKeyRequest

type RotateSymmetricKeyRequest struct {

	// ID of the key to be rotated.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RotateSymmetricKeyRequest) Descriptor deprecated

func (*RotateSymmetricKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use RotateSymmetricKeyRequest.ProtoReflect.Descriptor instead.

func (*RotateSymmetricKeyRequest) GetKeyId

func (x *RotateSymmetricKeyRequest) GetKeyId() string

func (*RotateSymmetricKeyRequest) ProtoMessage

func (*RotateSymmetricKeyRequest) ProtoMessage()

func (*RotateSymmetricKeyRequest) ProtoReflect

func (*RotateSymmetricKeyRequest) Reset

func (x *RotateSymmetricKeyRequest) Reset()

func (*RotateSymmetricKeyRequest) SetKeyId

func (m *RotateSymmetricKeyRequest) SetKeyId(v string)

func (*RotateSymmetricKeyRequest) String

func (x *RotateSymmetricKeyRequest) String() string

type ScheduleSymmetricKeyVersionDestructionMetadata

type ScheduleSymmetricKeyVersionDestructionMetadata struct {

	// ID of the key whose version is being scheduled for destruction.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version that is being scheduled for destruction.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Time when the version is scheduled to be destroyed.
	DestroyAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=destroy_at,json=destroyAt,proto3" json:"destroy_at,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduleSymmetricKeyVersionDestructionMetadata) Descriptor deprecated

Deprecated: Use ScheduleSymmetricKeyVersionDestructionMetadata.ProtoReflect.Descriptor instead.

func (*ScheduleSymmetricKeyVersionDestructionMetadata) GetDestroyAt

func (*ScheduleSymmetricKeyVersionDestructionMetadata) GetKeyId

func (*ScheduleSymmetricKeyVersionDestructionMetadata) GetVersionId

func (*ScheduleSymmetricKeyVersionDestructionMetadata) ProtoMessage

func (*ScheduleSymmetricKeyVersionDestructionMetadata) ProtoReflect

func (*ScheduleSymmetricKeyVersionDestructionMetadata) Reset

func (*ScheduleSymmetricKeyVersionDestructionMetadata) SetDestroyAt

func (*ScheduleSymmetricKeyVersionDestructionMetadata) SetKeyId

func (*ScheduleSymmetricKeyVersionDestructionMetadata) SetVersionId

func (*ScheduleSymmetricKeyVersionDestructionMetadata) String

type ScheduleSymmetricKeyVersionDestructionRequest

type ScheduleSymmetricKeyVersionDestructionRequest struct {

	// ID of the key whose version should be scheduled for destruction.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version to be destroyed.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Time interval between the version destruction request and actual destruction.
	// Default value: 7 days.
	PendingPeriod *durationpb.Duration `protobuf:"bytes,3,opt,name=pending_period,json=pendingPeriod,proto3" json:"pending_period,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduleSymmetricKeyVersionDestructionRequest) Descriptor deprecated

Deprecated: Use ScheduleSymmetricKeyVersionDestructionRequest.ProtoReflect.Descriptor instead.

func (*ScheduleSymmetricKeyVersionDestructionRequest) GetKeyId

func (*ScheduleSymmetricKeyVersionDestructionRequest) GetPendingPeriod

func (*ScheduleSymmetricKeyVersionDestructionRequest) GetVersionId

func (*ScheduleSymmetricKeyVersionDestructionRequest) ProtoMessage

func (*ScheduleSymmetricKeyVersionDestructionRequest) ProtoReflect

func (*ScheduleSymmetricKeyVersionDestructionRequest) Reset

func (*ScheduleSymmetricKeyVersionDestructionRequest) SetKeyId

func (*ScheduleSymmetricKeyVersionDestructionRequest) SetPendingPeriod

func (*ScheduleSymmetricKeyVersionDestructionRequest) SetVersionId

func (*ScheduleSymmetricKeyVersionDestructionRequest) String

type SetPrimarySymmetricKeyVersionMetadata

type SetPrimarySymmetricKeyVersionMetadata struct {

	// ID of the key that the primary version if being changed for.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version that is being made primary for the key.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*SetPrimarySymmetricKeyVersionMetadata) Descriptor deprecated

func (*SetPrimarySymmetricKeyVersionMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SetPrimarySymmetricKeyVersionMetadata.ProtoReflect.Descriptor instead.

func (*SetPrimarySymmetricKeyVersionMetadata) GetKeyId

func (*SetPrimarySymmetricKeyVersionMetadata) GetVersionId

func (*SetPrimarySymmetricKeyVersionMetadata) ProtoMessage

func (*SetPrimarySymmetricKeyVersionMetadata) ProtoMessage()

func (*SetPrimarySymmetricKeyVersionMetadata) ProtoReflect

func (*SetPrimarySymmetricKeyVersionMetadata) Reset

func (*SetPrimarySymmetricKeyVersionMetadata) SetKeyId

func (*SetPrimarySymmetricKeyVersionMetadata) SetVersionId

func (m *SetPrimarySymmetricKeyVersionMetadata) SetVersionId(v string)

func (*SetPrimarySymmetricKeyVersionMetadata) String

type SetPrimarySymmetricKeyVersionRequest

type SetPrimarySymmetricKeyVersionRequest struct {

	// ID of the key to set a primary version for.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version that should become primary for the specified key.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// contains filtered or unexported fields
}

func (*SetPrimarySymmetricKeyVersionRequest) Descriptor deprecated

func (*SetPrimarySymmetricKeyVersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetPrimarySymmetricKeyVersionRequest.ProtoReflect.Descriptor instead.

func (*SetPrimarySymmetricKeyVersionRequest) GetKeyId

func (*SetPrimarySymmetricKeyVersionRequest) GetVersionId

func (x *SetPrimarySymmetricKeyVersionRequest) GetVersionId() string

func (*SetPrimarySymmetricKeyVersionRequest) ProtoMessage

func (*SetPrimarySymmetricKeyVersionRequest) ProtoMessage()

func (*SetPrimarySymmetricKeyVersionRequest) ProtoReflect

func (*SetPrimarySymmetricKeyVersionRequest) Reset

func (*SetPrimarySymmetricKeyVersionRequest) SetKeyId

func (*SetPrimarySymmetricKeyVersionRequest) SetVersionId

func (m *SetPrimarySymmetricKeyVersionRequest) SetVersionId(v string)

func (*SetPrimarySymmetricKeyVersionRequest) String

type SymmetricAlgorithm

type SymmetricAlgorithm int32

Supported symmetric encryption algorithms.

const (
	SymmetricAlgorithm_SYMMETRIC_ALGORITHM_UNSPECIFIED SymmetricAlgorithm = 0
	// AES algorithm with 128-bit keys.
	SymmetricAlgorithm_AES_128 SymmetricAlgorithm = 1
	// AES algorithm with 192-bit keys.
	SymmetricAlgorithm_AES_192 SymmetricAlgorithm = 2
	// AES algorithm with 256-bit keys.
	SymmetricAlgorithm_AES_256 SymmetricAlgorithm = 3
	// AES algorithm with 256-bit keys hosted by HSM
	SymmetricAlgorithm_AES_256_HSM SymmetricAlgorithm = 4
)

func (SymmetricAlgorithm) Descriptor

func (SymmetricAlgorithm) Enum

func (SymmetricAlgorithm) EnumDescriptor deprecated

func (SymmetricAlgorithm) EnumDescriptor() ([]byte, []int)

Deprecated: Use SymmetricAlgorithm.Descriptor instead.

func (SymmetricAlgorithm) Number

func (SymmetricAlgorithm) String

func (x SymmetricAlgorithm) String() string

func (SymmetricAlgorithm) Type

type SymmetricCryptoServiceClient

type SymmetricCryptoServiceClient interface {
	// Encrypts given plaintext with the specified key.
	Encrypt(ctx context.Context, in *SymmetricEncryptRequest, opts ...grpc.CallOption) (*SymmetricEncryptResponse, error)
	// Decrypts the given ciphertext with the specified key.
	Decrypt(ctx context.Context, in *SymmetricDecryptRequest, opts ...grpc.CallOption) (*SymmetricDecryptResponse, error)
	// Re-encrypts a ciphertext with the specified KMS key.
	ReEncrypt(ctx context.Context, in *SymmetricReEncryptRequest, opts ...grpc.CallOption) (*SymmetricReEncryptResponse, error)
	// Generates a new symmetric data encryption key (not a KMS key) and returns
	// the generated key as plaintext and as ciphertext encrypted with the specified symmetric KMS key.
	GenerateDataKey(ctx context.Context, in *GenerateDataKeyRequest, opts ...grpc.CallOption) (*GenerateDataKeyResponse, error)
}

SymmetricCryptoServiceClient is the client API for SymmetricCryptoService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Set of methods that perform symmetric encryption and decryption.

type SymmetricCryptoServiceServer

type SymmetricCryptoServiceServer interface {
	// Encrypts given plaintext with the specified key.
	Encrypt(context.Context, *SymmetricEncryptRequest) (*SymmetricEncryptResponse, error)
	// Decrypts the given ciphertext with the specified key.
	Decrypt(context.Context, *SymmetricDecryptRequest) (*SymmetricDecryptResponse, error)
	// Re-encrypts a ciphertext with the specified KMS key.
	ReEncrypt(context.Context, *SymmetricReEncryptRequest) (*SymmetricReEncryptResponse, error)
	// Generates a new symmetric data encryption key (not a KMS key) and returns
	// the generated key as plaintext and as ciphertext encrypted with the specified symmetric KMS key.
	GenerateDataKey(context.Context, *GenerateDataKeyRequest) (*GenerateDataKeyResponse, error)
}

SymmetricCryptoServiceServer is the server API for SymmetricCryptoService service. All implementations should embed UnimplementedSymmetricCryptoServiceServer for forward compatibility.

Set of methods that perform symmetric encryption and decryption.

type SymmetricDecryptRequest

type SymmetricDecryptRequest struct {

	// ID of the symmetric KMS key to use for decryption.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// Additional authenticated data, must be the same as was provided
	// in the corresponding [SymmetricEncryptRequest].
	// Should be encoded with base64.
	AadContext []byte `protobuf:"bytes,2,opt,name=aad_context,json=aadContext,proto3" json:"aad_context,omitempty"`
	// Ciphertext to be decrypted.
	// Should be encoded with base64.
	Ciphertext []byte `protobuf:"bytes,3,opt,name=ciphertext,proto3" json:"ciphertext,omitempty"`
	// contains filtered or unexported fields
}

func (*SymmetricDecryptRequest) Descriptor deprecated

func (*SymmetricDecryptRequest) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricDecryptRequest.ProtoReflect.Descriptor instead.

func (*SymmetricDecryptRequest) GetAadContext

func (x *SymmetricDecryptRequest) GetAadContext() []byte

func (*SymmetricDecryptRequest) GetCiphertext

func (x *SymmetricDecryptRequest) GetCiphertext() []byte

func (*SymmetricDecryptRequest) GetKeyId

func (x *SymmetricDecryptRequest) GetKeyId() string

func (*SymmetricDecryptRequest) ProtoMessage

func (*SymmetricDecryptRequest) ProtoMessage()

func (*SymmetricDecryptRequest) ProtoReflect

func (x *SymmetricDecryptRequest) ProtoReflect() protoreflect.Message

func (*SymmetricDecryptRequest) Reset

func (x *SymmetricDecryptRequest) Reset()

func (*SymmetricDecryptRequest) SetAadContext

func (m *SymmetricDecryptRequest) SetAadContext(v []byte)

func (*SymmetricDecryptRequest) SetCiphertext

func (m *SymmetricDecryptRequest) SetCiphertext(v []byte)

func (*SymmetricDecryptRequest) SetKeyId

func (m *SymmetricDecryptRequest) SetKeyId(v string)

func (*SymmetricDecryptRequest) String

func (x *SymmetricDecryptRequest) String() string

type SymmetricDecryptResponse

type SymmetricDecryptResponse struct {

	// ID of the symmetric KMS key that was used for decryption.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the key version that was used for decryption.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Decrypted plaintext.
	Plaintext []byte `protobuf:"bytes,3,opt,name=plaintext,proto3" json:"plaintext,omitempty"`
	// contains filtered or unexported fields
}

func (*SymmetricDecryptResponse) Descriptor deprecated

func (*SymmetricDecryptResponse) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricDecryptResponse.ProtoReflect.Descriptor instead.

func (*SymmetricDecryptResponse) GetKeyId

func (x *SymmetricDecryptResponse) GetKeyId() string

func (*SymmetricDecryptResponse) GetPlaintext

func (x *SymmetricDecryptResponse) GetPlaintext() []byte

func (*SymmetricDecryptResponse) GetVersionId

func (x *SymmetricDecryptResponse) GetVersionId() string

func (*SymmetricDecryptResponse) ProtoMessage

func (*SymmetricDecryptResponse) ProtoMessage()

func (*SymmetricDecryptResponse) ProtoReflect

func (x *SymmetricDecryptResponse) ProtoReflect() protoreflect.Message

func (*SymmetricDecryptResponse) Reset

func (x *SymmetricDecryptResponse) Reset()

func (*SymmetricDecryptResponse) SetKeyId

func (m *SymmetricDecryptResponse) SetKeyId(v string)

func (*SymmetricDecryptResponse) SetPlaintext

func (m *SymmetricDecryptResponse) SetPlaintext(v []byte)

func (*SymmetricDecryptResponse) SetVersionId

func (m *SymmetricDecryptResponse) SetVersionId(v string)

func (*SymmetricDecryptResponse) String

func (x *SymmetricDecryptResponse) String() string

type SymmetricEncryptRequest

type SymmetricEncryptRequest struct {

	// ID of the symmetric KMS key to use for encryption.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the key version to encrypt plaintext with.
	// Defaults to the primary version if not specified.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Additional authenticated data (AAD context), optional.
	// If specified, this data will be required for decryption with the [SymmetricDecryptRequest].
	// Should be encoded with base64.
	AadContext []byte `protobuf:"bytes,3,opt,name=aad_context,json=aadContext,proto3" json:"aad_context,omitempty"`
	// Plaintext to be encrypted.
	// Should be encoded with base64.
	Plaintext []byte `protobuf:"bytes,4,opt,name=plaintext,proto3" json:"plaintext,omitempty"`
	// contains filtered or unexported fields
}

func (*SymmetricEncryptRequest) Descriptor deprecated

func (*SymmetricEncryptRequest) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricEncryptRequest.ProtoReflect.Descriptor instead.

func (*SymmetricEncryptRequest) GetAadContext

func (x *SymmetricEncryptRequest) GetAadContext() []byte

func (*SymmetricEncryptRequest) GetKeyId

func (x *SymmetricEncryptRequest) GetKeyId() string

func (*SymmetricEncryptRequest) GetPlaintext

func (x *SymmetricEncryptRequest) GetPlaintext() []byte

func (*SymmetricEncryptRequest) GetVersionId

func (x *SymmetricEncryptRequest) GetVersionId() string

func (*SymmetricEncryptRequest) ProtoMessage

func (*SymmetricEncryptRequest) ProtoMessage()

func (*SymmetricEncryptRequest) ProtoReflect

func (x *SymmetricEncryptRequest) ProtoReflect() protoreflect.Message

func (*SymmetricEncryptRequest) Reset

func (x *SymmetricEncryptRequest) Reset()

func (*SymmetricEncryptRequest) SetAadContext

func (m *SymmetricEncryptRequest) SetAadContext(v []byte)

func (*SymmetricEncryptRequest) SetKeyId

func (m *SymmetricEncryptRequest) SetKeyId(v string)

func (*SymmetricEncryptRequest) SetPlaintext

func (m *SymmetricEncryptRequest) SetPlaintext(v []byte)

func (*SymmetricEncryptRequest) SetVersionId

func (m *SymmetricEncryptRequest) SetVersionId(v string)

func (*SymmetricEncryptRequest) String

func (x *SymmetricEncryptRequest) String() string

type SymmetricEncryptResponse

type SymmetricEncryptResponse struct {

	// ID of the symmetric KMS key that was used for encryption.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the key version that was used for encryption.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Resulting ciphertext.
	Ciphertext []byte `protobuf:"bytes,3,opt,name=ciphertext,proto3" json:"ciphertext,omitempty"`
	// contains filtered or unexported fields
}

func (*SymmetricEncryptResponse) Descriptor deprecated

func (*SymmetricEncryptResponse) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricEncryptResponse.ProtoReflect.Descriptor instead.

func (*SymmetricEncryptResponse) GetCiphertext

func (x *SymmetricEncryptResponse) GetCiphertext() []byte

func (*SymmetricEncryptResponse) GetKeyId

func (x *SymmetricEncryptResponse) GetKeyId() string

func (*SymmetricEncryptResponse) GetVersionId

func (x *SymmetricEncryptResponse) GetVersionId() string

func (*SymmetricEncryptResponse) ProtoMessage

func (*SymmetricEncryptResponse) ProtoMessage()

func (*SymmetricEncryptResponse) ProtoReflect

func (x *SymmetricEncryptResponse) ProtoReflect() protoreflect.Message

func (*SymmetricEncryptResponse) Reset

func (x *SymmetricEncryptResponse) Reset()

func (*SymmetricEncryptResponse) SetCiphertext

func (m *SymmetricEncryptResponse) SetCiphertext(v []byte)

func (*SymmetricEncryptResponse) SetKeyId

func (m *SymmetricEncryptResponse) SetKeyId(v string)

func (*SymmetricEncryptResponse) SetVersionId

func (m *SymmetricEncryptResponse) SetVersionId(v string)

func (*SymmetricEncryptResponse) String

func (x *SymmetricEncryptResponse) String() string

type SymmetricKey

type SymmetricKey struct {

	// ID of the key.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the folder that the key belongs to.
	FolderId string `protobuf:"bytes,2,opt,name=folder_id,json=folderId,proto3" json:"folder_id,omitempty"`
	// Time when the key was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Name of the key.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the key.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// Custom labels for the key as `key:value` pairs. Maximum 64 per key.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Current status of the key.
	Status SymmetricKey_Status `protobuf:"varint,7,opt,name=status,proto3,enum=yandex.cloud.kms.v1.SymmetricKey_Status" json:"status,omitempty"`
	// Primary version of the key, used as the default for all encrypt/decrypt operations,
	// when no version ID is specified.
	PrimaryVersion *SymmetricKeyVersion `protobuf:"bytes,8,opt,name=primary_version,json=primaryVersion,proto3" json:"primary_version,omitempty"`
	// Default encryption algorithm to be used with new versions of the key.
	DefaultAlgorithm SymmetricAlgorithm `` /* 154-byte string literal not displayed */
	// Time of the last key rotation (time when the last version was created).
	// Empty if the key does not have versions yet.
	RotatedAt *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=rotated_at,json=rotatedAt,proto3" json:"rotated_at,omitempty"`
	// Time period between automatic key rotations.
	RotationPeriod *durationpb.Duration `protobuf:"bytes,11,opt,name=rotation_period,json=rotationPeriod,proto3" json:"rotation_period,omitempty"`
	// Flag that inhibits deletion of the key
	DeletionProtection bool `protobuf:"varint,12,opt,name=deletion_protection,json=deletionProtection,proto3" json:"deletion_protection,omitempty"`
	// contains filtered or unexported fields
}

A symmetric KMS key that may contain several versions of the cryptographic material.

func (*SymmetricKey) Descriptor deprecated

func (*SymmetricKey) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricKey.ProtoReflect.Descriptor instead.

func (*SymmetricKey) GetCreatedAt

func (x *SymmetricKey) GetCreatedAt() *timestamppb.Timestamp

func (*SymmetricKey) GetDefaultAlgorithm

func (x *SymmetricKey) GetDefaultAlgorithm() SymmetricAlgorithm

func (*SymmetricKey) GetDeletionProtection

func (x *SymmetricKey) GetDeletionProtection() bool

func (*SymmetricKey) GetDescription

func (x *SymmetricKey) GetDescription() string

func (*SymmetricKey) GetFolderId

func (x *SymmetricKey) GetFolderId() string

func (*SymmetricKey) GetId

func (x *SymmetricKey) GetId() string

func (*SymmetricKey) GetLabels

func (x *SymmetricKey) GetLabels() map[string]string

func (*SymmetricKey) GetName

func (x *SymmetricKey) GetName() string

func (*SymmetricKey) GetPrimaryVersion

func (x *SymmetricKey) GetPrimaryVersion() *SymmetricKeyVersion

func (*SymmetricKey) GetRotatedAt

func (x *SymmetricKey) GetRotatedAt() *timestamppb.Timestamp

func (*SymmetricKey) GetRotationPeriod

func (x *SymmetricKey) GetRotationPeriod() *durationpb.Duration

func (*SymmetricKey) GetStatus

func (x *SymmetricKey) GetStatus() SymmetricKey_Status

func (*SymmetricKey) ProtoMessage

func (*SymmetricKey) ProtoMessage()

func (*SymmetricKey) ProtoReflect

func (x *SymmetricKey) ProtoReflect() protoreflect.Message

func (*SymmetricKey) Reset

func (x *SymmetricKey) Reset()

func (*SymmetricKey) SetCreatedAt

func (m *SymmetricKey) SetCreatedAt(v *timestamppb.Timestamp)

func (*SymmetricKey) SetDefaultAlgorithm

func (m *SymmetricKey) SetDefaultAlgorithm(v SymmetricAlgorithm)

func (*SymmetricKey) SetDeletionProtection

func (m *SymmetricKey) SetDeletionProtection(v bool)

func (*SymmetricKey) SetDescription

func (m *SymmetricKey) SetDescription(v string)

func (*SymmetricKey) SetFolderId

func (m *SymmetricKey) SetFolderId(v string)

func (*SymmetricKey) SetId

func (m *SymmetricKey) SetId(v string)

func (*SymmetricKey) SetLabels

func (m *SymmetricKey) SetLabels(v map[string]string)

func (*SymmetricKey) SetName

func (m *SymmetricKey) SetName(v string)

func (*SymmetricKey) SetPrimaryVersion

func (m *SymmetricKey) SetPrimaryVersion(v *SymmetricKeyVersion)

func (*SymmetricKey) SetRotatedAt

func (m *SymmetricKey) SetRotatedAt(v *timestamppb.Timestamp)

func (*SymmetricKey) SetRotationPeriod

func (m *SymmetricKey) SetRotationPeriod(v *durationpb.Duration)

func (*SymmetricKey) SetStatus

func (m *SymmetricKey) SetStatus(v SymmetricKey_Status)

func (*SymmetricKey) String

func (x *SymmetricKey) String() string

type SymmetricKeyServiceClient

type SymmetricKeyServiceClient interface {
	// Creates a symmetric KMS key in the specified folder.
	Create(ctx context.Context, in *CreateSymmetricKeyRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Returns the specified symmetric KMS key.
	//
	//	To get the list of available symmetric KMS keys, make a [SymmetricKeyService.List] request.
	Get(ctx context.Context, in *GetSymmetricKeyRequest, opts ...grpc.CallOption) (*SymmetricKey, error)
	// Returns the list of symmetric KMS keys in the specified folder.
	List(ctx context.Context, in *ListSymmetricKeysRequest, opts ...grpc.CallOption) (*ListSymmetricKeysResponse, error)
	// Returns the list of versions of the specified symmetric KMS key.
	ListVersions(ctx context.Context, in *ListSymmetricKeyVersionsRequest, opts ...grpc.CallOption) (*ListSymmetricKeyVersionsResponse, error)
	// Updates the specified symmetric KMS key.
	Update(ctx context.Context, in *UpdateSymmetricKeyRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Deletes the specified symmetric KMS key. This action also automatically schedules
	// the destruction of all of the key's versions in 72 hours.
	//
	// The key and its versions appear absent in [SymmetricKeyService.Get] and [SymmetricKeyService.List]
	// requests, but can be restored within 72 hours with a request to tech support.
	Delete(ctx context.Context, in *DeleteSymmetricKeyRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Sets the primary version for the specified key. The primary version is used
	// by default for all encrypt/decrypt operations where no version ID is specified.
	SetPrimaryVersion(ctx context.Context, in *SetPrimarySymmetricKeyVersionRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Schedules the specified key version for destruction.
	//
	// Scheduled destruction can be cancelled with the [SymmetricKeyService.CancelVersionDestruction] method.
	ScheduleVersionDestruction(ctx context.Context, in *ScheduleSymmetricKeyVersionDestructionRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Cancels previously scheduled version destruction, if the version hasn't been destroyed yet.
	CancelVersionDestruction(ctx context.Context, in *CancelSymmetricKeyVersionDestructionRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Rotates the specified key: creates a new key version and makes it the primary version.
	// The old version remains available for decryption of ciphertext encrypted with it.
	Rotate(ctx context.Context, in *RotateSymmetricKeyRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Lists operations for the specified symmetric KMS key.
	ListOperations(ctx context.Context, in *ListSymmetricKeyOperationsRequest, opts ...grpc.CallOption) (*ListSymmetricKeyOperationsResponse, error)
	// Lists existing access bindings for the specified key.
	ListAccessBindings(ctx context.Context, in *access.ListAccessBindingsRequest, opts ...grpc.CallOption) (*access.ListAccessBindingsResponse, error)
	// Sets access bindings for the key.
	SetAccessBindings(ctx context.Context, in *access.SetAccessBindingsRequest, opts ...grpc.CallOption) (*operation.Operation, error)
	// Updates access bindings for the specified key.
	UpdateAccessBindings(ctx context.Context, in *access.UpdateAccessBindingsRequest, opts ...grpc.CallOption) (*operation.Operation, error)
}

SymmetricKeyServiceClient is the client API for SymmetricKeyService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Set of methods for managing symmetric KMS keys.

type SymmetricKeyServiceServer

type SymmetricKeyServiceServer interface {
	// Creates a symmetric KMS key in the specified folder.
	Create(context.Context, *CreateSymmetricKeyRequest) (*operation.Operation, error)
	// Returns the specified symmetric KMS key.
	//
	//	To get the list of available symmetric KMS keys, make a [SymmetricKeyService.List] request.
	Get(context.Context, *GetSymmetricKeyRequest) (*SymmetricKey, error)
	// Returns the list of symmetric KMS keys in the specified folder.
	List(context.Context, *ListSymmetricKeysRequest) (*ListSymmetricKeysResponse, error)
	// Returns the list of versions of the specified symmetric KMS key.
	ListVersions(context.Context, *ListSymmetricKeyVersionsRequest) (*ListSymmetricKeyVersionsResponse, error)
	// Updates the specified symmetric KMS key.
	Update(context.Context, *UpdateSymmetricKeyRequest) (*operation.Operation, error)
	// Deletes the specified symmetric KMS key. This action also automatically schedules
	// the destruction of all of the key's versions in 72 hours.
	//
	// The key and its versions appear absent in [SymmetricKeyService.Get] and [SymmetricKeyService.List]
	// requests, but can be restored within 72 hours with a request to tech support.
	Delete(context.Context, *DeleteSymmetricKeyRequest) (*operation.Operation, error)
	// Sets the primary version for the specified key. The primary version is used
	// by default for all encrypt/decrypt operations where no version ID is specified.
	SetPrimaryVersion(context.Context, *SetPrimarySymmetricKeyVersionRequest) (*operation.Operation, error)
	// Schedules the specified key version for destruction.
	//
	// Scheduled destruction can be cancelled with the [SymmetricKeyService.CancelVersionDestruction] method.
	ScheduleVersionDestruction(context.Context, *ScheduleSymmetricKeyVersionDestructionRequest) (*operation.Operation, error)
	// Cancels previously scheduled version destruction, if the version hasn't been destroyed yet.
	CancelVersionDestruction(context.Context, *CancelSymmetricKeyVersionDestructionRequest) (*operation.Operation, error)
	// Rotates the specified key: creates a new key version and makes it the primary version.
	// The old version remains available for decryption of ciphertext encrypted with it.
	Rotate(context.Context, *RotateSymmetricKeyRequest) (*operation.Operation, error)
	// Lists operations for the specified symmetric KMS key.
	ListOperations(context.Context, *ListSymmetricKeyOperationsRequest) (*ListSymmetricKeyOperationsResponse, error)
	// Lists existing access bindings for the specified key.
	ListAccessBindings(context.Context, *access.ListAccessBindingsRequest) (*access.ListAccessBindingsResponse, error)
	// Sets access bindings for the key.
	SetAccessBindings(context.Context, *access.SetAccessBindingsRequest) (*operation.Operation, error)
	// Updates access bindings for the specified key.
	UpdateAccessBindings(context.Context, *access.UpdateAccessBindingsRequest) (*operation.Operation, error)
}

SymmetricKeyServiceServer is the server API for SymmetricKeyService service. All implementations should embed UnimplementedSymmetricKeyServiceServer for forward compatibility.

Set of methods for managing symmetric KMS keys.

type SymmetricKeyVersion

type SymmetricKeyVersion struct {

	// ID of the key version.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the symmetric KMS key that the version belongs to.
	KeyId string `protobuf:"bytes,2,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// Status of the key version.
	Status SymmetricKeyVersion_Status `protobuf:"varint,3,opt,name=status,proto3,enum=yandex.cloud.kms.v1.SymmetricKeyVersion_Status" json:"status,omitempty"`
	// Encryption algorithm that should be used when using the key version to encrypt plaintext.
	Algorithm SymmetricAlgorithm `protobuf:"varint,4,opt,name=algorithm,proto3,enum=yandex.cloud.kms.v1.SymmetricAlgorithm" json:"algorithm,omitempty"`
	// Time when the key version was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Indication of a primary version, that is to be used by default for all cryptographic
	// operations that don't have a key version explicitly specified.
	Primary bool `protobuf:"varint,6,opt,name=primary,proto3" json:"primary,omitempty"`
	// Time when the key version is going to be destroyed. Empty unless the status
	// is `SCHEDULED_FOR_DESTRUCTION`.
	DestroyAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=destroy_at,json=destroyAt,proto3" json:"destroy_at,omitempty"`
	// Indication of the version that is hosted by HSM.
	HostedByHsm bool `protobuf:"varint,8,opt,name=hosted_by_hsm,json=hostedByHsm,proto3" json:"hosted_by_hsm,omitempty"`
	// contains filtered or unexported fields
}

Symmetric KMS key version: metadata about actual cryptographic data.

func (*SymmetricKeyVersion) Descriptor deprecated

func (*SymmetricKeyVersion) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricKeyVersion.ProtoReflect.Descriptor instead.

func (*SymmetricKeyVersion) GetAlgorithm

func (x *SymmetricKeyVersion) GetAlgorithm() SymmetricAlgorithm

func (*SymmetricKeyVersion) GetCreatedAt

func (x *SymmetricKeyVersion) GetCreatedAt() *timestamppb.Timestamp

func (*SymmetricKeyVersion) GetDestroyAt

func (x *SymmetricKeyVersion) GetDestroyAt() *timestamppb.Timestamp

func (*SymmetricKeyVersion) GetHostedByHsm

func (x *SymmetricKeyVersion) GetHostedByHsm() bool

func (*SymmetricKeyVersion) GetId

func (x *SymmetricKeyVersion) GetId() string

func (*SymmetricKeyVersion) GetKeyId

func (x *SymmetricKeyVersion) GetKeyId() string

func (*SymmetricKeyVersion) GetPrimary

func (x *SymmetricKeyVersion) GetPrimary() bool

func (*SymmetricKeyVersion) GetStatus

func (*SymmetricKeyVersion) ProtoMessage

func (*SymmetricKeyVersion) ProtoMessage()

func (*SymmetricKeyVersion) ProtoReflect

func (x *SymmetricKeyVersion) ProtoReflect() protoreflect.Message

func (*SymmetricKeyVersion) Reset

func (x *SymmetricKeyVersion) Reset()

func (*SymmetricKeyVersion) SetAlgorithm

func (m *SymmetricKeyVersion) SetAlgorithm(v SymmetricAlgorithm)

func (*SymmetricKeyVersion) SetCreatedAt

func (m *SymmetricKeyVersion) SetCreatedAt(v *timestamppb.Timestamp)

func (*SymmetricKeyVersion) SetDestroyAt

func (m *SymmetricKeyVersion) SetDestroyAt(v *timestamppb.Timestamp)

func (*SymmetricKeyVersion) SetHostedByHsm

func (m *SymmetricKeyVersion) SetHostedByHsm(v bool)

func (*SymmetricKeyVersion) SetId

func (m *SymmetricKeyVersion) SetId(v string)

func (*SymmetricKeyVersion) SetKeyId

func (m *SymmetricKeyVersion) SetKeyId(v string)

func (*SymmetricKeyVersion) SetPrimary

func (m *SymmetricKeyVersion) SetPrimary(v bool)

func (*SymmetricKeyVersion) SetStatus

func (*SymmetricKeyVersion) String

func (x *SymmetricKeyVersion) String() string

type SymmetricKeyVersion_Status

type SymmetricKeyVersion_Status int32

Possible version status.

const (
	SymmetricKeyVersion_STATUS_UNSPECIFIED SymmetricKeyVersion_Status = 0
	// The version is active and can be used for encryption and decryption.
	SymmetricKeyVersion_ACTIVE SymmetricKeyVersion_Status = 1
	// The version is scheduled for destruction, the time when it will be destroyed
	// is specified in the [SymmetricKeyVersion.destroy_at] field.
	SymmetricKeyVersion_SCHEDULED_FOR_DESTRUCTION SymmetricKeyVersion_Status = 2
	// The version is destroyed and cannot be recovered.
	SymmetricKeyVersion_DESTROYED SymmetricKeyVersion_Status = 3
)

func (SymmetricKeyVersion_Status) Descriptor

func (SymmetricKeyVersion_Status) Enum

func (SymmetricKeyVersion_Status) EnumDescriptor deprecated

func (SymmetricKeyVersion_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use SymmetricKeyVersion_Status.Descriptor instead.

func (SymmetricKeyVersion_Status) Number

func (SymmetricKeyVersion_Status) String

func (SymmetricKeyVersion_Status) Type

type SymmetricKey_Status

type SymmetricKey_Status int32
const (
	SymmetricKey_STATUS_UNSPECIFIED SymmetricKey_Status = 0
	// The key is being created.
	SymmetricKey_CREATING SymmetricKey_Status = 1
	// The key is active and can be used for encryption and decryption.
	// Can be set to INACTIVE using the [SymmetricKeyService.Update] method.
	SymmetricKey_ACTIVE SymmetricKey_Status = 2
	// The key is inactive and unusable.
	// Can be set to ACTIVE using the [SymmetricKeyService.Update] method.
	SymmetricKey_INACTIVE SymmetricKey_Status = 3
)

func (SymmetricKey_Status) Descriptor

func (SymmetricKey_Status) Enum

func (SymmetricKey_Status) EnumDescriptor deprecated

func (SymmetricKey_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use SymmetricKey_Status.Descriptor instead.

func (SymmetricKey_Status) Number

func (SymmetricKey_Status) String

func (x SymmetricKey_Status) String() string

func (SymmetricKey_Status) Type

type SymmetricReEncryptRequest

type SymmetricReEncryptRequest struct {

	// ID of the new key to be used for encryption.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of the version of the new key to be used for encryption.
	// Defaults to the primary version if not specified.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Additional authenticated data to be required for decryption.
	// Should be encoded with base64.
	AadContext []byte `protobuf:"bytes,3,opt,name=aad_context,json=aadContext,proto3" json:"aad_context,omitempty"`
	// ID of the key that the ciphertext is currently encrypted with. May be the same as for the new key.
	SourceKeyId string `protobuf:"bytes,4,opt,name=source_key_id,json=sourceKeyId,proto3" json:"source_key_id,omitempty"`
	// Additional authenticated data provided with the initial encryption request.
	// Should be encoded with base64.
	SourceAadContext []byte `protobuf:"bytes,5,opt,name=source_aad_context,json=sourceAadContext,proto3" json:"source_aad_context,omitempty"`
	// Ciphertext to re-encrypt.
	// Should be encoded with base64.
	Ciphertext []byte `protobuf:"bytes,6,opt,name=ciphertext,proto3" json:"ciphertext,omitempty"`
	// contains filtered or unexported fields
}

func (*SymmetricReEncryptRequest) Descriptor deprecated

func (*SymmetricReEncryptRequest) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricReEncryptRequest.ProtoReflect.Descriptor instead.

func (*SymmetricReEncryptRequest) GetAadContext

func (x *SymmetricReEncryptRequest) GetAadContext() []byte

func (*SymmetricReEncryptRequest) GetCiphertext

func (x *SymmetricReEncryptRequest) GetCiphertext() []byte

func (*SymmetricReEncryptRequest) GetKeyId

func (x *SymmetricReEncryptRequest) GetKeyId() string

func (*SymmetricReEncryptRequest) GetSourceAadContext

func (x *SymmetricReEncryptRequest) GetSourceAadContext() []byte

func (*SymmetricReEncryptRequest) GetSourceKeyId

func (x *SymmetricReEncryptRequest) GetSourceKeyId() string

func (*SymmetricReEncryptRequest) GetVersionId

func (x *SymmetricReEncryptRequest) GetVersionId() string

func (*SymmetricReEncryptRequest) ProtoMessage

func (*SymmetricReEncryptRequest) ProtoMessage()

func (*SymmetricReEncryptRequest) ProtoReflect

func (*SymmetricReEncryptRequest) Reset

func (x *SymmetricReEncryptRequest) Reset()

func (*SymmetricReEncryptRequest) SetAadContext

func (m *SymmetricReEncryptRequest) SetAadContext(v []byte)

func (*SymmetricReEncryptRequest) SetCiphertext

func (m *SymmetricReEncryptRequest) SetCiphertext(v []byte)

func (*SymmetricReEncryptRequest) SetKeyId

func (m *SymmetricReEncryptRequest) SetKeyId(v string)

func (*SymmetricReEncryptRequest) SetSourceAadContext

func (m *SymmetricReEncryptRequest) SetSourceAadContext(v []byte)

func (*SymmetricReEncryptRequest) SetSourceKeyId

func (m *SymmetricReEncryptRequest) SetSourceKeyId(v string)

func (*SymmetricReEncryptRequest) SetVersionId

func (m *SymmetricReEncryptRequest) SetVersionId(v string)

func (*SymmetricReEncryptRequest) String

func (x *SymmetricReEncryptRequest) String() string

type SymmetricReEncryptResponse

type SymmetricReEncryptResponse struct {

	// ID of the key that the ciphertext is encrypted with now.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// ID of key version that was used for encryption.
	VersionId string `protobuf:"bytes,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// ID of the key that the ciphertext was encrypted with previously.
	SourceKeyId string `protobuf:"bytes,3,opt,name=source_key_id,json=sourceKeyId,proto3" json:"source_key_id,omitempty"`
	// ID of the key version that was used to decrypt the re-encrypted ciphertext.
	SourceVersionId string `protobuf:"bytes,4,opt,name=source_version_id,json=sourceVersionId,proto3" json:"source_version_id,omitempty"`
	// Resulting re-encrypted ciphertext.
	Ciphertext []byte `protobuf:"bytes,5,opt,name=ciphertext,proto3" json:"ciphertext,omitempty"`
	// contains filtered or unexported fields
}

func (*SymmetricReEncryptResponse) Descriptor deprecated

func (*SymmetricReEncryptResponse) Descriptor() ([]byte, []int)

Deprecated: Use SymmetricReEncryptResponse.ProtoReflect.Descriptor instead.

func (*SymmetricReEncryptResponse) GetCiphertext

func (x *SymmetricReEncryptResponse) GetCiphertext() []byte

func (*SymmetricReEncryptResponse) GetKeyId

func (x *SymmetricReEncryptResponse) GetKeyId() string

func (*SymmetricReEncryptResponse) GetSourceKeyId

func (x *SymmetricReEncryptResponse) GetSourceKeyId() string

func (*SymmetricReEncryptResponse) GetSourceVersionId

func (x *SymmetricReEncryptResponse) GetSourceVersionId() string

func (*SymmetricReEncryptResponse) GetVersionId

func (x *SymmetricReEncryptResponse) GetVersionId() string

func (*SymmetricReEncryptResponse) ProtoMessage

func (*SymmetricReEncryptResponse) ProtoMessage()

func (*SymmetricReEncryptResponse) ProtoReflect

func (*SymmetricReEncryptResponse) Reset

func (x *SymmetricReEncryptResponse) Reset()

func (*SymmetricReEncryptResponse) SetCiphertext

func (m *SymmetricReEncryptResponse) SetCiphertext(v []byte)

func (*SymmetricReEncryptResponse) SetKeyId

func (m *SymmetricReEncryptResponse) SetKeyId(v string)

func (*SymmetricReEncryptResponse) SetSourceKeyId

func (m *SymmetricReEncryptResponse) SetSourceKeyId(v string)

func (*SymmetricReEncryptResponse) SetSourceVersionId

func (m *SymmetricReEncryptResponse) SetSourceVersionId(v string)

func (*SymmetricReEncryptResponse) SetVersionId

func (m *SymmetricReEncryptResponse) SetVersionId(v string)

func (*SymmetricReEncryptResponse) String

func (x *SymmetricReEncryptResponse) String() string

type UnimplementedSymmetricCryptoServiceServer

type UnimplementedSymmetricCryptoServiceServer struct{}

UnimplementedSymmetricCryptoServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedSymmetricCryptoServiceServer) Decrypt

func (UnimplementedSymmetricCryptoServiceServer) Encrypt

func (UnimplementedSymmetricCryptoServiceServer) GenerateDataKey

func (UnimplementedSymmetricCryptoServiceServer) ReEncrypt

type UnimplementedSymmetricKeyServiceServer

type UnimplementedSymmetricKeyServiceServer struct{}

UnimplementedSymmetricKeyServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedSymmetricKeyServiceServer) Create

func (UnimplementedSymmetricKeyServiceServer) Delete

func (UnimplementedSymmetricKeyServiceServer) Get

func (UnimplementedSymmetricKeyServiceServer) Rotate

func (UnimplementedSymmetricKeyServiceServer) SetAccessBindings

func (UnimplementedSymmetricKeyServiceServer) SetPrimaryVersion

func (UnimplementedSymmetricKeyServiceServer) Update

func (UnimplementedSymmetricKeyServiceServer) UpdateAccessBindings

type UnsafeSymmetricCryptoServiceServer

type UnsafeSymmetricCryptoServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSymmetricCryptoServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SymmetricCryptoServiceServer will result in compilation errors.

type UnsafeSymmetricKeyServiceServer

type UnsafeSymmetricKeyServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSymmetricKeyServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SymmetricKeyServiceServer will result in compilation errors.

type UpdateSymmetricKeyMetadata

type UpdateSymmetricKeyMetadata struct {

	// ID of the key being updated.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSymmetricKeyMetadata) Descriptor deprecated

func (*UpdateSymmetricKeyMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSymmetricKeyMetadata.ProtoReflect.Descriptor instead.

func (*UpdateSymmetricKeyMetadata) GetKeyId

func (x *UpdateSymmetricKeyMetadata) GetKeyId() string

func (*UpdateSymmetricKeyMetadata) ProtoMessage

func (*UpdateSymmetricKeyMetadata) ProtoMessage()

func (*UpdateSymmetricKeyMetadata) ProtoReflect

func (*UpdateSymmetricKeyMetadata) Reset

func (x *UpdateSymmetricKeyMetadata) Reset()

func (*UpdateSymmetricKeyMetadata) SetKeyId

func (m *UpdateSymmetricKeyMetadata) SetKeyId(v string)

func (*UpdateSymmetricKeyMetadata) String

func (x *UpdateSymmetricKeyMetadata) String() string

type UpdateSymmetricKeyRequest

type UpdateSymmetricKeyRequest struct {

	// ID of the symmetric KMS key to update.
	// To get the ID of a symmetric KMS key use a [SymmetricKeyService.List] request.
	KeyId string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// Field mask that specifies which attributes of the symmetric KMS key are going to be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// New name for the symmetric KMS key.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// New description for the symmetric KMS key.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// New status for the symmetric KMS key.
	// Using the [SymmetricKeyService.Update] method you can only set ACTIVE or INACTIVE status.
	Status SymmetricKey_Status `protobuf:"varint,5,opt,name=status,proto3,enum=yandex.cloud.kms.v1.SymmetricKey_Status" json:"status,omitempty"`
	// Custom labels for the symmetric KMS key as `key:value` pairs. Maximum 64 per key.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Default encryption algorithm to be used with new versions of the symmetric KMS key.
	DefaultAlgorithm SymmetricAlgorithm `` /* 154-byte string literal not displayed */
	// Time period between automatic symmetric KMS key rotations.
	RotationPeriod *durationpb.Duration `protobuf:"bytes,8,opt,name=rotation_period,json=rotationPeriod,proto3" json:"rotation_period,omitempty"` // period between two automatic rotations
	// Flag that inhibits deletion of the symmetric KMS key
	DeletionProtection bool `protobuf:"varint,9,opt,name=deletion_protection,json=deletionProtection,proto3" json:"deletion_protection,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSymmetricKeyRequest) Descriptor deprecated

func (*UpdateSymmetricKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSymmetricKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateSymmetricKeyRequest) GetDefaultAlgorithm

func (x *UpdateSymmetricKeyRequest) GetDefaultAlgorithm() SymmetricAlgorithm

func (*UpdateSymmetricKeyRequest) GetDeletionProtection

func (x *UpdateSymmetricKeyRequest) GetDeletionProtection() bool

func (*UpdateSymmetricKeyRequest) GetDescription

func (x *UpdateSymmetricKeyRequest) GetDescription() string

func (*UpdateSymmetricKeyRequest) GetKeyId

func (x *UpdateSymmetricKeyRequest) GetKeyId() string

func (*UpdateSymmetricKeyRequest) GetLabels

func (x *UpdateSymmetricKeyRequest) GetLabels() map[string]string

func (*UpdateSymmetricKeyRequest) GetName

func (x *UpdateSymmetricKeyRequest) GetName() string

func (*UpdateSymmetricKeyRequest) GetRotationPeriod

func (x *UpdateSymmetricKeyRequest) GetRotationPeriod() *durationpb.Duration

func (*UpdateSymmetricKeyRequest) GetStatus

func (*UpdateSymmetricKeyRequest) GetUpdateMask

func (x *UpdateSymmetricKeyRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateSymmetricKeyRequest) ProtoMessage

func (*UpdateSymmetricKeyRequest) ProtoMessage()

func (*UpdateSymmetricKeyRequest) ProtoReflect

func (*UpdateSymmetricKeyRequest) Reset

func (x *UpdateSymmetricKeyRequest) Reset()

func (*UpdateSymmetricKeyRequest) SetDefaultAlgorithm

func (m *UpdateSymmetricKeyRequest) SetDefaultAlgorithm(v SymmetricAlgorithm)

func (*UpdateSymmetricKeyRequest) SetDeletionProtection

func (m *UpdateSymmetricKeyRequest) SetDeletionProtection(v bool)

func (*UpdateSymmetricKeyRequest) SetDescription

func (m *UpdateSymmetricKeyRequest) SetDescription(v string)

func (*UpdateSymmetricKeyRequest) SetKeyId

func (m *UpdateSymmetricKeyRequest) SetKeyId(v string)

func (*UpdateSymmetricKeyRequest) SetLabels

func (m *UpdateSymmetricKeyRequest) SetLabels(v map[string]string)

func (*UpdateSymmetricKeyRequest) SetName

func (m *UpdateSymmetricKeyRequest) SetName(v string)

func (*UpdateSymmetricKeyRequest) SetRotationPeriod

func (m *UpdateSymmetricKeyRequest) SetRotationPeriod(v *durationpb.Duration)

func (*UpdateSymmetricKeyRequest) SetStatus

func (*UpdateSymmetricKeyRequest) SetUpdateMask

func (m *UpdateSymmetricKeyRequest) SetUpdateMask(v *fieldmaskpb.FieldMask)

func (*UpdateSymmetricKeyRequest) String

func (x *UpdateSymmetricKeyRequest) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL