operationsv1

package
v0.11.1 Latest Latest
Warning

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

Go to latest
Published: May 14, 2026 License: Apache-2.0 Imports: 13 Imported by: 1

Documentation

Index

Constants

View Source
const (
	Type                = "KeystoreInstanceKeyOperation"
	GRPCServiceFullName = "plugin.keystore.operations.v1.KeystoreInstanceKeyOperation"
)
View Source
const (
	KeystoreInstanceKeyOperation_GetKey_FullMethodName                    = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/GetKey"
	KeystoreInstanceKeyOperation_CreateKey_FullMethodName                 = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/CreateKey"
	KeystoreInstanceKeyOperation_DeleteKey_FullMethodName                 = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/DeleteKey"
	KeystoreInstanceKeyOperation_EnableKey_FullMethodName                 = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/EnableKey"
	KeystoreInstanceKeyOperation_DisableKey_FullMethodName                = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/DisableKey"
	KeystoreInstanceKeyOperation_GetImportParameters_FullMethodName       = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/GetImportParameters"
	KeystoreInstanceKeyOperation_ImportKeyMaterial_FullMethodName         = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/ImportKeyMaterial"
	KeystoreInstanceKeyOperation_ValidateKey_FullMethodName               = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/ValidateKey"
	KeystoreInstanceKeyOperation_ValidateKeyAccessData_FullMethodName     = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/ValidateKeyAccessData"
	KeystoreInstanceKeyOperation_TransformCryptoAccessData_FullMethodName = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/TransformCryptoAccessData"
	KeystoreInstanceKeyOperation_ExtractKeyRegion_FullMethodName          = "/plugin.keystore.operations.v1.KeystoreInstanceKeyOperation/ExtractKeyRegion"
)

Variables

View Source
var (
	KeyAlgorithm_name = map[int32]string{
		0: "KEY_ALGORITHM_UNSPECIFIED",
		1: "KEY_ALGORITHM_AES256",
		2: "KEY_ALGORITHM_RSA3072",
		3: "KEY_ALGORITHM_RSA4096",
	}
	KeyAlgorithm_value = map[string]int32{
		"KEY_ALGORITHM_UNSPECIFIED": 0,
		"KEY_ALGORITHM_AES256":      1,
		"KEY_ALGORITHM_RSA3072":     2,
		"KEY_ALGORITHM_RSA4096":     3,
	}
)

Enum value maps for KeyAlgorithm.

View Source
var (
	KeyType_name = map[int32]string{
		0: "KEY_TYPE_UNSPECIFIED",
		1: "KEY_TYPE_SYSTEM_MANAGED",
		2: "KEY_TYPE_BYOK",
		3: "KEY_TYPE_HYOK",
	}
	KeyType_value = map[string]int32{
		"KEY_TYPE_UNSPECIFIED":    0,
		"KEY_TYPE_SYSTEM_MANAGED": 1,
		"KEY_TYPE_BYOK":           2,
		"KEY_TYPE_HYOK":           3,
	}
)

Enum value maps for KeyType.

View Source
var File_plugin_keystore_operations_v1_operations_proto protoreflect.FileDescriptor
View Source
var KeystoreInstanceKeyOperation_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "plugin.keystore.operations.v1.KeystoreInstanceKeyOperation",
	HandlerType: (*KeystoreInstanceKeyOperationServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetKey",
			Handler:    _KeystoreInstanceKeyOperation_GetKey_Handler,
		},
		{
			MethodName: "CreateKey",
			Handler:    _KeystoreInstanceKeyOperation_CreateKey_Handler,
		},
		{
			MethodName: "DeleteKey",
			Handler:    _KeystoreInstanceKeyOperation_DeleteKey_Handler,
		},
		{
			MethodName: "EnableKey",
			Handler:    _KeystoreInstanceKeyOperation_EnableKey_Handler,
		},
		{
			MethodName: "DisableKey",
			Handler:    _KeystoreInstanceKeyOperation_DisableKey_Handler,
		},
		{
			MethodName: "GetImportParameters",
			Handler:    _KeystoreInstanceKeyOperation_GetImportParameters_Handler,
		},
		{
			MethodName: "ImportKeyMaterial",
			Handler:    _KeystoreInstanceKeyOperation_ImportKeyMaterial_Handler,
		},
		{
			MethodName: "ValidateKey",
			Handler:    _KeystoreInstanceKeyOperation_ValidateKey_Handler,
		},
		{
			MethodName: "ValidateKeyAccessData",
			Handler:    _KeystoreInstanceKeyOperation_ValidateKeyAccessData_Handler,
		},
		{
			MethodName: "TransformCryptoAccessData",
			Handler:    _KeystoreInstanceKeyOperation_TransformCryptoAccessData_Handler,
		},
		{
			MethodName: "ExtractKeyRegion",
			Handler:    _KeystoreInstanceKeyOperation_ExtractKeyRegion_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "plugin/keystore/operations/v1/operations.proto",
}

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

Functions

func KeystoreInstanceKeyOperationPluginServer

func KeystoreInstanceKeyOperationPluginServer(server KeystoreInstanceKeyOperationServer) api.PluginServer

func RegisterKeystoreInstanceKeyOperationServer

func RegisterKeystoreInstanceKeyOperationServer(s grpc.ServiceRegistrar, srv KeystoreInstanceKeyOperationServer)

Types

type CreateKeyRequest

type CreateKeyRequest struct {
	Config    *v1.KeystoreInstanceConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	Algorithm KeyAlgorithm               `protobuf:"varint,2,opt,name=algorithm,proto3,enum=plugin.keystore.operations.v1.KeyAlgorithm" json:"algorithm,omitempty"`
	Id        *string                    `protobuf:"bytes,3,opt,name=id,proto3,oneof" json:"id,omitempty"`   // Optional predefined key ID
	Region    string                     `protobuf:"bytes,4,opt,name=region,proto3" json:"region,omitempty"` // The region in which to create the key
	KeyType   KeyType                    ``                                                                  // Key type (system-managed or BYOK)
	/* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

CreateKeyRequest contains parameters for key creation

func (*CreateKeyRequest) Descriptor deprecated

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

Deprecated: Use CreateKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateKeyRequest) GetAlgorithm

func (x *CreateKeyRequest) GetAlgorithm() KeyAlgorithm

func (*CreateKeyRequest) GetConfig

func (x *CreateKeyRequest) GetConfig() *v1.KeystoreInstanceConfig

func (*CreateKeyRequest) GetId

func (x *CreateKeyRequest) GetId() string

func (*CreateKeyRequest) GetKeyType

func (x *CreateKeyRequest) GetKeyType() KeyType

func (*CreateKeyRequest) GetRegion

func (x *CreateKeyRequest) GetRegion() string

func (*CreateKeyRequest) ProtoMessage

func (*CreateKeyRequest) ProtoMessage()

func (*CreateKeyRequest) ProtoReflect

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

func (*CreateKeyRequest) Reset

func (x *CreateKeyRequest) Reset()

func (*CreateKeyRequest) String

func (x *CreateKeyRequest) String() string

type CreateKeyResponse

type CreateKeyResponse struct {
	KeyId  string `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"` // The ID of the created key
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`            // The current status of the key (e.g., enabled, disabled)
	// contains filtered or unexported fields
}

func (*CreateKeyResponse) Descriptor deprecated

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

Deprecated: Use CreateKeyResponse.ProtoReflect.Descriptor instead.

func (*CreateKeyResponse) GetKeyId

func (x *CreateKeyResponse) GetKeyId() string

func (*CreateKeyResponse) GetStatus

func (x *CreateKeyResponse) GetStatus() string

func (*CreateKeyResponse) ProtoMessage

func (*CreateKeyResponse) ProtoMessage()

func (*CreateKeyResponse) ProtoReflect

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

func (*CreateKeyResponse) Reset

func (x *CreateKeyResponse) Reset()

func (*CreateKeyResponse) String

func (x *CreateKeyResponse) String() string

type DeleteKeyRequest

type DeleteKeyRequest struct {
	Parameters *RequestParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	Window     *int32             `protobuf:"varint,2,opt,name=window,proto3,oneof" json:"window,omitempty"` // Optional deletion window in days
	// contains filtered or unexported fields
}

DeleteKeyRequest contains parameters for key deletion

func (*DeleteKeyRequest) Descriptor deprecated

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

Deprecated: Use DeleteKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteKeyRequest) GetParameters

func (x *DeleteKeyRequest) GetParameters() *RequestParameters

func (*DeleteKeyRequest) GetWindow

func (x *DeleteKeyRequest) GetWindow() int32

func (*DeleteKeyRequest) ProtoMessage

func (*DeleteKeyRequest) ProtoMessage()

func (*DeleteKeyRequest) ProtoReflect

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

func (*DeleteKeyRequest) Reset

func (x *DeleteKeyRequest) Reset()

func (*DeleteKeyRequest) String

func (x *DeleteKeyRequest) String() string

type DeleteKeyResponse

type DeleteKeyResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteKeyResponse) Descriptor deprecated

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

Deprecated: Use DeleteKeyResponse.ProtoReflect.Descriptor instead.

func (*DeleteKeyResponse) ProtoMessage

func (*DeleteKeyResponse) ProtoMessage()

func (*DeleteKeyResponse) ProtoReflect

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

func (*DeleteKeyResponse) Reset

func (x *DeleteKeyResponse) Reset()

func (*DeleteKeyResponse) String

func (x *DeleteKeyResponse) String() string

type DisableKeyRequest

type DisableKeyRequest struct {
	Parameters *RequestParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

DisableKeyRequest contains parameters for key disablement

func (*DisableKeyRequest) Descriptor deprecated

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

Deprecated: Use DisableKeyRequest.ProtoReflect.Descriptor instead.

func (*DisableKeyRequest) GetParameters

func (x *DisableKeyRequest) GetParameters() *RequestParameters

func (*DisableKeyRequest) ProtoMessage

func (*DisableKeyRequest) ProtoMessage()

func (*DisableKeyRequest) ProtoReflect

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

func (*DisableKeyRequest) Reset

func (x *DisableKeyRequest) Reset()

func (*DisableKeyRequest) String

func (x *DisableKeyRequest) String() string

type DisableKeyResponse

type DisableKeyResponse struct {
	// contains filtered or unexported fields
}

func (*DisableKeyResponse) Descriptor deprecated

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

Deprecated: Use DisableKeyResponse.ProtoReflect.Descriptor instead.

func (*DisableKeyResponse) ProtoMessage

func (*DisableKeyResponse) ProtoMessage()

func (*DisableKeyResponse) ProtoReflect

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

func (*DisableKeyResponse) Reset

func (x *DisableKeyResponse) Reset()

func (*DisableKeyResponse) String

func (x *DisableKeyResponse) String() string

type EnableKeyRequest

type EnableKeyRequest struct {
	Parameters *RequestParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

EnableKeyRequest contains parameters for key enablement

func (*EnableKeyRequest) Descriptor deprecated

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

Deprecated: Use EnableKeyRequest.ProtoReflect.Descriptor instead.

func (*EnableKeyRequest) GetParameters

func (x *EnableKeyRequest) GetParameters() *RequestParameters

func (*EnableKeyRequest) ProtoMessage

func (*EnableKeyRequest) ProtoMessage()

func (*EnableKeyRequest) ProtoReflect

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

func (*EnableKeyRequest) Reset

func (x *EnableKeyRequest) Reset()

func (*EnableKeyRequest) String

func (x *EnableKeyRequest) String() string

type EnableKeyResponse

type EnableKeyResponse struct {
	// contains filtered or unexported fields
}

func (*EnableKeyResponse) Descriptor deprecated

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

Deprecated: Use EnableKeyResponse.ProtoReflect.Descriptor instead.

func (*EnableKeyResponse) ProtoMessage

func (*EnableKeyResponse) ProtoMessage()

func (*EnableKeyResponse) ProtoReflect

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

func (*EnableKeyResponse) Reset

func (x *EnableKeyResponse) Reset()

func (*EnableKeyResponse) String

func (x *EnableKeyResponse) String() string

type ExtractKeyRegionRequest added in v0.3.0

type ExtractKeyRegionRequest struct {
	NativeKeyId          string           `protobuf:"bytes,1,opt,name=native_key_id,json=nativeKeyId,proto3" json:"native_key_id,omitempty"`                            // The region can be derived from the native key ID
	ManagementAccessData *structpb.Struct `protobuf:"bytes,2,opt,name=management_access_data,json=managementAccessData,proto3" json:"management_access_data,omitempty"` // Or the access details of the management role
	// contains filtered or unexported fields
}

ExtractKeyRegionRequest contains parameters for extracting the key region

func (*ExtractKeyRegionRequest) Descriptor deprecated added in v0.3.0

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

Deprecated: Use ExtractKeyRegionRequest.ProtoReflect.Descriptor instead.

func (*ExtractKeyRegionRequest) GetManagementAccessData added in v0.3.0

func (x *ExtractKeyRegionRequest) GetManagementAccessData() *structpb.Struct

func (*ExtractKeyRegionRequest) GetNativeKeyId added in v0.3.0

func (x *ExtractKeyRegionRequest) GetNativeKeyId() string

func (*ExtractKeyRegionRequest) ProtoMessage added in v0.3.0

func (*ExtractKeyRegionRequest) ProtoMessage()

func (*ExtractKeyRegionRequest) ProtoReflect added in v0.3.0

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

func (*ExtractKeyRegionRequest) Reset added in v0.3.0

func (x *ExtractKeyRegionRequest) Reset()

func (*ExtractKeyRegionRequest) String added in v0.3.0

func (x *ExtractKeyRegionRequest) String() string

type ExtractKeyRegionResponse added in v0.3.0

type ExtractKeyRegionResponse struct {
	Region string `protobuf:"bytes,1,opt,name=region,proto3" json:"region,omitempty"` // The extracted region from the key attributes
	// contains filtered or unexported fields
}

ExtractKeyRegionResponse contains the extracted key region

func (*ExtractKeyRegionResponse) Descriptor deprecated added in v0.3.0

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

Deprecated: Use ExtractKeyRegionResponse.ProtoReflect.Descriptor instead.

func (*ExtractKeyRegionResponse) GetRegion added in v0.3.0

func (x *ExtractKeyRegionResponse) GetRegion() string

func (*ExtractKeyRegionResponse) ProtoMessage added in v0.3.0

func (*ExtractKeyRegionResponse) ProtoMessage()

func (*ExtractKeyRegionResponse) ProtoReflect added in v0.3.0

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

func (*ExtractKeyRegionResponse) Reset added in v0.3.0

func (x *ExtractKeyRegionResponse) Reset()

func (*ExtractKeyRegionResponse) String added in v0.3.0

func (x *ExtractKeyRegionResponse) String() string

type GetImportParametersRequest

type GetImportParametersRequest struct {
	Parameters *RequestParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	Algorithm  KeyAlgorithm       `protobuf:"varint,2,opt,name=algorithm,proto3,enum=plugin.keystore.operations.v1.KeyAlgorithm" json:"algorithm,omitempty"`
	// contains filtered or unexported fields
}

GetImportParametersRequest contains parameters for retrieving import parameters

func (*GetImportParametersRequest) Descriptor deprecated

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

Deprecated: Use GetImportParametersRequest.ProtoReflect.Descriptor instead.

func (*GetImportParametersRequest) GetAlgorithm

func (x *GetImportParametersRequest) GetAlgorithm() KeyAlgorithm

func (*GetImportParametersRequest) GetParameters

func (x *GetImportParametersRequest) GetParameters() *RequestParameters

func (*GetImportParametersRequest) ProtoMessage

func (*GetImportParametersRequest) ProtoMessage()

func (*GetImportParametersRequest) ProtoReflect

func (*GetImportParametersRequest) Reset

func (x *GetImportParametersRequest) Reset()

func (*GetImportParametersRequest) String

func (x *GetImportParametersRequest) String() string

type GetImportParametersResponse

type GetImportParametersResponse struct {
	KeyId            string           `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	ImportParameters *structpb.Struct `protobuf:"bytes,2,opt,name=import_parameters,json=importParameters,proto3" json:"import_parameters,omitempty"` // The parameters needed for importing key material
	// contains filtered or unexported fields
}

ImportKeyMaterialRequest contains parameters for importing key material

func (*GetImportParametersResponse) Descriptor deprecated

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

Deprecated: Use GetImportParametersResponse.ProtoReflect.Descriptor instead.

func (*GetImportParametersResponse) GetImportParameters

func (x *GetImportParametersResponse) GetImportParameters() *structpb.Struct

func (*GetImportParametersResponse) GetKeyId

func (x *GetImportParametersResponse) GetKeyId() string

func (*GetImportParametersResponse) ProtoMessage

func (*GetImportParametersResponse) ProtoMessage()

func (*GetImportParametersResponse) ProtoReflect

func (*GetImportParametersResponse) Reset

func (x *GetImportParametersResponse) Reset()

func (*GetImportParametersResponse) String

func (x *GetImportParametersResponse) String() string

type GetKeyRequest

type GetKeyRequest struct {
	Parameters *RequestParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

GetKeyRequest contains parameters for key retrieval

func (*GetKeyRequest) Descriptor deprecated

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

Deprecated: Use GetKeyRequest.ProtoReflect.Descriptor instead.

func (*GetKeyRequest) GetParameters

func (x *GetKeyRequest) GetParameters() *RequestParameters

func (*GetKeyRequest) ProtoMessage

func (*GetKeyRequest) ProtoMessage()

func (*GetKeyRequest) ProtoReflect

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

func (*GetKeyRequest) Reset

func (x *GetKeyRequest) Reset()

func (*GetKeyRequest) String

func (x *GetKeyRequest) String() string

type GetKeyResponse

type GetKeyResponse struct {
	KeyId              string                 `protobuf:"bytes,1,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`                                                // The ID of the retrieved key
	Algorithm          KeyAlgorithm           `protobuf:"varint,2,opt,name=algorithm,proto3,enum=plugin.keystore.operations.v1.KeyAlgorithm" json:"algorithm,omitempty"`    // The algorithm used for the key
	Status             string                 `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`                                                           // The current status of the key (e.g., enabled, disabled)
	Usage              string                 `protobuf:"bytes,4,opt,name=usage,proto3" json:"usage,omitempty"`                                                             // The intended usage of the key (e.g., encryption, signing)
	LatestKeyVersionId string                 `protobuf:"bytes,5,opt,name=latest_key_version_id,json=latestKeyVersionId,proto3" json:"latest_key_version_id,omitempty"`     // The ID of the latest key version
	LatestRotationTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=latest_rotation_time,json=latestRotationTime,proto3,oneof" json:"latest_rotation_time,omitempty"` // The timestamp of the latest key rotation
	// contains filtered or unexported fields
}

func (*GetKeyResponse) Descriptor deprecated

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

Deprecated: Use GetKeyResponse.ProtoReflect.Descriptor instead.

func (*GetKeyResponse) GetAlgorithm

func (x *GetKeyResponse) GetAlgorithm() KeyAlgorithm

func (*GetKeyResponse) GetKeyId

func (x *GetKeyResponse) GetKeyId() string

func (*GetKeyResponse) GetLatestKeyVersionId added in v0.10.0

func (x *GetKeyResponse) GetLatestKeyVersionId() string

func (*GetKeyResponse) GetLatestRotationTime added in v0.10.0

func (x *GetKeyResponse) GetLatestRotationTime() *timestamppb.Timestamp

func (*GetKeyResponse) GetStatus

func (x *GetKeyResponse) GetStatus() string

func (*GetKeyResponse) GetUsage

func (x *GetKeyResponse) GetUsage() string

func (*GetKeyResponse) ProtoMessage

func (*GetKeyResponse) ProtoMessage()

func (*GetKeyResponse) ProtoReflect

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

func (*GetKeyResponse) Reset

func (x *GetKeyResponse) Reset()

func (*GetKeyResponse) String

func (x *GetKeyResponse) String() string

type ImportKeyMaterialRequest

type ImportKeyMaterialRequest struct {
	Parameters           *RequestParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	ImportParameters     *structpb.Struct   `protobuf:"bytes,2,opt,name=import_parameters,json=importParameters,proto3" json:"import_parameters,omitempty"`               // The parameters needed for importing key material
	EncryptedKeyMaterial string             `protobuf:"bytes,3,opt,name=encrypted_key_material,json=encryptedKeyMaterial,proto3" json:"encrypted_key_material,omitempty"` // The encrypted key material to be imported
	// contains filtered or unexported fields
}

ImportKeyMaterialRequest contains parameters for importing key material

func (*ImportKeyMaterialRequest) Descriptor deprecated

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

Deprecated: Use ImportKeyMaterialRequest.ProtoReflect.Descriptor instead.

func (*ImportKeyMaterialRequest) GetEncryptedKeyMaterial

func (x *ImportKeyMaterialRequest) GetEncryptedKeyMaterial() string

func (*ImportKeyMaterialRequest) GetImportParameters

func (x *ImportKeyMaterialRequest) GetImportParameters() *structpb.Struct

func (*ImportKeyMaterialRequest) GetParameters

func (x *ImportKeyMaterialRequest) GetParameters() *RequestParameters

func (*ImportKeyMaterialRequest) ProtoMessage

func (*ImportKeyMaterialRequest) ProtoMessage()

func (*ImportKeyMaterialRequest) ProtoReflect

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

func (*ImportKeyMaterialRequest) Reset

func (x *ImportKeyMaterialRequest) Reset()

func (*ImportKeyMaterialRequest) String

func (x *ImportKeyMaterialRequest) String() string

type ImportKeyMaterialResponse

type ImportKeyMaterialResponse struct {
	// contains filtered or unexported fields
}

ImportKeyMaterialResponse contains the response for key material import

func (*ImportKeyMaterialResponse) Descriptor deprecated

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

Deprecated: Use ImportKeyMaterialResponse.ProtoReflect.Descriptor instead.

func (*ImportKeyMaterialResponse) ProtoMessage

func (*ImportKeyMaterialResponse) ProtoMessage()

func (*ImportKeyMaterialResponse) ProtoReflect

func (*ImportKeyMaterialResponse) Reset

func (x *ImportKeyMaterialResponse) Reset()

func (*ImportKeyMaterialResponse) String

func (x *ImportKeyMaterialResponse) String() string

type KeyAlgorithm

type KeyAlgorithm int32

KeyAlgorithm defines the supported key algorithms across all operations

const (
	KeyAlgorithm_KEY_ALGORITHM_UNSPECIFIED KeyAlgorithm = 0
	KeyAlgorithm_KEY_ALGORITHM_AES256      KeyAlgorithm = 1
	KeyAlgorithm_KEY_ALGORITHM_RSA3072     KeyAlgorithm = 2
	KeyAlgorithm_KEY_ALGORITHM_RSA4096     KeyAlgorithm = 3
)

func (KeyAlgorithm) Descriptor

func (KeyAlgorithm) Enum

func (x KeyAlgorithm) Enum() *KeyAlgorithm

func (KeyAlgorithm) EnumDescriptor deprecated

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

Deprecated: Use KeyAlgorithm.Descriptor instead.

func (KeyAlgorithm) Number

func (KeyAlgorithm) String

func (x KeyAlgorithm) String() string

func (KeyAlgorithm) Type

type KeyType

type KeyType int32
const (
	KeyType_KEY_TYPE_UNSPECIFIED    KeyType = 0
	KeyType_KEY_TYPE_SYSTEM_MANAGED KeyType = 1 // System-managed key
	KeyType_KEY_TYPE_BYOK           KeyType = 2 // Bring Your Own Key
	KeyType_KEY_TYPE_HYOK           KeyType = 3 // Hold Your Own Key
)

func (KeyType) Descriptor

func (KeyType) Descriptor() protoreflect.EnumDescriptor

func (KeyType) Enum

func (x KeyType) Enum() *KeyType

func (KeyType) EnumDescriptor deprecated

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

Deprecated: Use KeyType.Descriptor instead.

func (KeyType) Number

func (x KeyType) Number() protoreflect.EnumNumber

func (KeyType) String

func (x KeyType) String() string

func (KeyType) Type

func (KeyType) Type() protoreflect.EnumType

type KeystoreInstanceKeyOperationClient

type KeystoreInstanceKeyOperationClient interface {
	// GetKey retrieves the details of a key by its ID
	// * Returns error "code = InvalidArgument desc = failed to authenticate with the keystore provider"
	// if the provided access data is invalid
	// * Returns error "code = NotFound desc = key not found in the keystore provider"
	// if the key does not exist
	GetKey(ctx context.Context, in *GetKeyRequest, opts ...grpc.CallOption) (*GetKeyResponse, error)
	// CreateKey generates a new key with the specified algorithm
	CreateKey(ctx context.Context, in *CreateKeyRequest, opts ...grpc.CallOption) (*CreateKeyResponse, error)
	// DeleteKey removes a key, optionally with a deletion window
	DeleteKey(ctx context.Context, in *DeleteKeyRequest, opts ...grpc.CallOption) (*DeleteKeyResponse, error)
	// EnableKey activates a previously disabled key
	EnableKey(ctx context.Context, in *EnableKeyRequest, opts ...grpc.CallOption) (*EnableKeyResponse, error)
	// DisableKey deactivates a key while maintaining its existence
	DisableKey(ctx context.Context, in *DisableKeyRequest, opts ...grpc.CallOption) (*DisableKeyResponse, error)
	// Gets the parameters needed for importing key material
	GetImportParameters(ctx context.Context, in *GetImportParametersRequest, opts ...grpc.CallOption) (*GetImportParametersResponse, error)
	// Imports key material into a KMS key
	ImportKeyMaterial(ctx context.Context, in *ImportKeyMaterialRequest, opts ...grpc.CallOption) (*ImportKeyMaterialResponse, error)
	// Validate the key attributes against the plugin's requirements
	ValidateKey(ctx context.Context, in *ValidateKeyRequest, opts ...grpc.CallOption) (*ValidateKeyResponse, error)
	// ValidateKeyAccessData checks the access data for key management and crypto operations
	ValidateKeyAccessData(ctx context.Context, in *ValidateKeyAccessDataRequest, opts ...grpc.CallOption) (*ValidateKeyAccessDataResponse, error)
	// TransformCryptoAccessData transforms the JSON-stored crypto access data into protobuf wire format for a given key
	TransformCryptoAccessData(ctx context.Context, in *TransformCryptoAccessDataRequest, opts ...grpc.CallOption) (*TransformCryptoAccessDataResponse, error)
	// ExtractKeyRegion extracts the region from key attributes
	ExtractKeyRegion(ctx context.Context, in *ExtractKeyRegionRequest, opts ...grpc.CallOption) (*ExtractKeyRegionResponse, error)
}

KeystoreInstanceKeyOperationClient is the client API for KeystoreInstanceKeyOperation 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.

KeystoreInstanceKeyOperation service defines the operations available for key management

type KeystoreInstanceKeyOperationPluginClient

type KeystoreInstanceKeyOperationPluginClient struct {
	KeystoreInstanceKeyOperationClient
}

func (*KeystoreInstanceKeyOperationPluginClient) GRPCServiceName

func (c *KeystoreInstanceKeyOperationPluginClient) GRPCServiceName() string

func (*KeystoreInstanceKeyOperationPluginClient) InitClient

func (*KeystoreInstanceKeyOperationPluginClient) IsInitialized

func (KeystoreInstanceKeyOperationPluginClient) Type

type KeystoreInstanceKeyOperationServer

type KeystoreInstanceKeyOperationServer interface {
	// GetKey retrieves the details of a key by its ID
	// * Returns error "code = InvalidArgument desc = failed to authenticate with the keystore provider"
	// if the provided access data is invalid
	// * Returns error "code = NotFound desc = key not found in the keystore provider"
	// if the key does not exist
	GetKey(context.Context, *GetKeyRequest) (*GetKeyResponse, error)
	// CreateKey generates a new key with the specified algorithm
	CreateKey(context.Context, *CreateKeyRequest) (*CreateKeyResponse, error)
	// DeleteKey removes a key, optionally with a deletion window
	DeleteKey(context.Context, *DeleteKeyRequest) (*DeleteKeyResponse, error)
	// EnableKey activates a previously disabled key
	EnableKey(context.Context, *EnableKeyRequest) (*EnableKeyResponse, error)
	// DisableKey deactivates a key while maintaining its existence
	DisableKey(context.Context, *DisableKeyRequest) (*DisableKeyResponse, error)
	// Gets the parameters needed for importing key material
	GetImportParameters(context.Context, *GetImportParametersRequest) (*GetImportParametersResponse, error)
	// Imports key material into a KMS key
	ImportKeyMaterial(context.Context, *ImportKeyMaterialRequest) (*ImportKeyMaterialResponse, error)
	// Validate the key attributes against the plugin's requirements
	ValidateKey(context.Context, *ValidateKeyRequest) (*ValidateKeyResponse, error)
	// ValidateKeyAccessData checks the access data for key management and crypto operations
	ValidateKeyAccessData(context.Context, *ValidateKeyAccessDataRequest) (*ValidateKeyAccessDataResponse, error)
	// TransformCryptoAccessData transforms the JSON-stored crypto access data into protobuf wire format for a given key
	TransformCryptoAccessData(context.Context, *TransformCryptoAccessDataRequest) (*TransformCryptoAccessDataResponse, error)
	// ExtractKeyRegion extracts the region from key attributes
	ExtractKeyRegion(context.Context, *ExtractKeyRegionRequest) (*ExtractKeyRegionResponse, error)
	// contains filtered or unexported methods
}

KeystoreInstanceKeyOperationServer is the server API for KeystoreInstanceKeyOperation service. All implementations must embed UnimplementedKeystoreInstanceKeyOperationServer for forward compatibility.

KeystoreInstanceKeyOperation service defines the operations available for key management

type RequestParameters

type RequestParameters struct {
	Config *v1.KeystoreInstanceConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	KeyId  string                     `protobuf:"bytes,2,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
	// contains filtered or unexported fields
}

RequestParameters contains the common fields needed for most key operations

func (*RequestParameters) Descriptor deprecated

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

Deprecated: Use RequestParameters.ProtoReflect.Descriptor instead.

func (*RequestParameters) GetConfig

func (*RequestParameters) GetKeyId

func (x *RequestParameters) GetKeyId() string

func (*RequestParameters) ProtoMessage

func (*RequestParameters) ProtoMessage()

func (*RequestParameters) ProtoReflect

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

func (*RequestParameters) Reset

func (x *RequestParameters) Reset()

func (*RequestParameters) String

func (x *RequestParameters) String() string

type TransformCryptoAccessDataRequest added in v0.4.0

type TransformCryptoAccessDataRequest struct {
	NativeKeyId string `protobuf:"bytes,1,opt,name=native_key_id,json=nativeKeyId,proto3" json:"native_key_id,omitempty"` // The native key ID for which the access data is transformed
	AccessData  []byte `protobuf:"bytes,2,opt,name=access_data,json=accessData,proto3" json:"access_data,omitempty"`      // The JSON crypto access data to be transformed
	// contains filtered or unexported fields
}

TransformCryptoAccessDataRequest contains parameters for transforming crypto access data

func (*TransformCryptoAccessDataRequest) Descriptor deprecated added in v0.4.0

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

Deprecated: Use TransformCryptoAccessDataRequest.ProtoReflect.Descriptor instead.

func (*TransformCryptoAccessDataRequest) GetAccessData added in v0.4.0

func (x *TransformCryptoAccessDataRequest) GetAccessData() []byte

func (*TransformCryptoAccessDataRequest) GetNativeKeyId added in v0.4.0

func (x *TransformCryptoAccessDataRequest) GetNativeKeyId() string

func (*TransformCryptoAccessDataRequest) ProtoMessage added in v0.4.0

func (*TransformCryptoAccessDataRequest) ProtoMessage()

func (*TransformCryptoAccessDataRequest) ProtoReflect added in v0.4.0

func (*TransformCryptoAccessDataRequest) Reset added in v0.4.0

func (*TransformCryptoAccessDataRequest) String added in v0.4.0

type TransformCryptoAccessDataResponse added in v0.4.0

type TransformCryptoAccessDataResponse struct {
	TransformedAccessData map[string][]byte `` // The transformed crypto access data in wire format
	/* 200-byte string literal not displayed */
	// contains filtered or unexported fields
}

TransformCryptoAccessDataResponse contains the transformed crypto access data

func (*TransformCryptoAccessDataResponse) Descriptor deprecated added in v0.4.0

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

Deprecated: Use TransformCryptoAccessDataResponse.ProtoReflect.Descriptor instead.

func (*TransformCryptoAccessDataResponse) GetTransformedAccessData added in v0.4.0

func (x *TransformCryptoAccessDataResponse) GetTransformedAccessData() map[string][]byte

func (*TransformCryptoAccessDataResponse) ProtoMessage added in v0.4.0

func (*TransformCryptoAccessDataResponse) ProtoMessage()

func (*TransformCryptoAccessDataResponse) ProtoReflect added in v0.4.0

func (*TransformCryptoAccessDataResponse) Reset added in v0.4.0

func (*TransformCryptoAccessDataResponse) String added in v0.4.0

type UnimplementedKeystoreInstanceKeyOperationServer

type UnimplementedKeystoreInstanceKeyOperationServer struct{}

UnimplementedKeystoreInstanceKeyOperationServer must 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 (UnimplementedKeystoreInstanceKeyOperationServer) CreateKey

func (UnimplementedKeystoreInstanceKeyOperationServer) DeleteKey

func (UnimplementedKeystoreInstanceKeyOperationServer) DisableKey

func (UnimplementedKeystoreInstanceKeyOperationServer) EnableKey

func (UnimplementedKeystoreInstanceKeyOperationServer) ExtractKeyRegion added in v0.3.0

func (UnimplementedKeystoreInstanceKeyOperationServer) GetImportParameters

func (UnimplementedKeystoreInstanceKeyOperationServer) GetKey

func (UnimplementedKeystoreInstanceKeyOperationServer) ImportKeyMaterial

func (UnimplementedKeystoreInstanceKeyOperationServer) TransformCryptoAccessData added in v0.4.0

func (UnimplementedKeystoreInstanceKeyOperationServer) ValidateKey added in v0.3.0

func (UnimplementedKeystoreInstanceKeyOperationServer) ValidateKeyAccessData added in v0.3.0

type UnsafeKeystoreInstanceKeyOperationServer

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

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

type ValidateKeyAccessDataRequest added in v0.3.0

type ValidateKeyAccessDataRequest struct {
	Management *structpb.Struct `protobuf:"bytes,1,opt,name=management,proto3" json:"management,omitempty"`
	Crypto     *structpb.Struct `protobuf:"bytes,2,opt,name=crypto,proto3" json:"crypto,omitempty"`
	// contains filtered or unexported fields
}

ValidateKeyAccessDataRequest contains access data for key management and crypto operations

func (*ValidateKeyAccessDataRequest) Descriptor deprecated added in v0.3.0

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

Deprecated: Use ValidateKeyAccessDataRequest.ProtoReflect.Descriptor instead.

func (*ValidateKeyAccessDataRequest) GetCrypto added in v0.3.0

func (*ValidateKeyAccessDataRequest) GetManagement added in v0.3.0

func (x *ValidateKeyAccessDataRequest) GetManagement() *structpb.Struct

func (*ValidateKeyAccessDataRequest) ProtoMessage added in v0.3.0

func (*ValidateKeyAccessDataRequest) ProtoMessage()

func (*ValidateKeyAccessDataRequest) ProtoReflect added in v0.3.0

func (*ValidateKeyAccessDataRequest) Reset added in v0.3.0

func (x *ValidateKeyAccessDataRequest) Reset()

func (*ValidateKeyAccessDataRequest) String added in v0.3.0

type ValidateKeyAccessDataResponse added in v0.3.0

type ValidateKeyAccessDataResponse struct {
	IsValid bool   `protobuf:"varint,1,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"` // Indicates if the key access data is valid
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`                 // Additional information about the validation result
	// contains filtered or unexported fields
}

ValidateKeyAccessDataResponse contains the result of key access data validation

func (*ValidateKeyAccessDataResponse) Descriptor deprecated added in v0.3.0

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

Deprecated: Use ValidateKeyAccessDataResponse.ProtoReflect.Descriptor instead.

func (*ValidateKeyAccessDataResponse) GetIsValid added in v0.3.0

func (x *ValidateKeyAccessDataResponse) GetIsValid() bool

func (*ValidateKeyAccessDataResponse) GetMessage added in v0.3.0

func (x *ValidateKeyAccessDataResponse) GetMessage() string

func (*ValidateKeyAccessDataResponse) ProtoMessage added in v0.3.0

func (*ValidateKeyAccessDataResponse) ProtoMessage()

func (*ValidateKeyAccessDataResponse) ProtoReflect added in v0.3.0

func (*ValidateKeyAccessDataResponse) Reset added in v0.3.0

func (x *ValidateKeyAccessDataResponse) Reset()

func (*ValidateKeyAccessDataResponse) String added in v0.3.0

type ValidateKeyRequest added in v0.3.0

type ValidateKeyRequest struct {
	KeyType     KeyType      `` /* 126-byte string literal not displayed */
	Algorithm   KeyAlgorithm `protobuf:"varint,2,opt,name=algorithm,proto3,enum=plugin.keystore.operations.v1.KeyAlgorithm" json:"algorithm,omitempty"`
	Region      string       `protobuf:"bytes,3,opt,name=region,proto3" json:"region,omitempty"`                                // The region in which the key is to be validated
	NativeKeyId string       `protobuf:"bytes,4,opt,name=native_key_id,json=nativeKeyId,proto3" json:"native_key_id,omitempty"` // The native key ID if applicable
	// contains filtered or unexported fields
}

ValidateKeyRequest contains parameters for validating key attributes

func (*ValidateKeyRequest) Descriptor deprecated added in v0.3.0

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

Deprecated: Use ValidateKeyRequest.ProtoReflect.Descriptor instead.

func (*ValidateKeyRequest) GetAlgorithm added in v0.3.0

func (x *ValidateKeyRequest) GetAlgorithm() KeyAlgorithm

func (*ValidateKeyRequest) GetKeyType added in v0.3.0

func (x *ValidateKeyRequest) GetKeyType() KeyType

func (*ValidateKeyRequest) GetNativeKeyId added in v0.3.0

func (x *ValidateKeyRequest) GetNativeKeyId() string

func (*ValidateKeyRequest) GetRegion added in v0.3.0

func (x *ValidateKeyRequest) GetRegion() string

func (*ValidateKeyRequest) ProtoMessage added in v0.3.0

func (*ValidateKeyRequest) ProtoMessage()

func (*ValidateKeyRequest) ProtoReflect added in v0.3.0

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

func (*ValidateKeyRequest) Reset added in v0.3.0

func (x *ValidateKeyRequest) Reset()

func (*ValidateKeyRequest) String added in v0.3.0

func (x *ValidateKeyRequest) String() string

type ValidateKeyResponse added in v0.3.0

type ValidateKeyResponse struct {
	IsValid bool   `protobuf:"varint,1,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"` // Indicates if the key attributes are valid
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`                 // Additional information about the validation result
	// contains filtered or unexported fields
}

ValidateKeyResponse contains the result of key validation

func (*ValidateKeyResponse) Descriptor deprecated added in v0.3.0

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

Deprecated: Use ValidateKeyResponse.ProtoReflect.Descriptor instead.

func (*ValidateKeyResponse) GetIsValid added in v0.3.0

func (x *ValidateKeyResponse) GetIsValid() bool

func (*ValidateKeyResponse) GetMessage added in v0.3.0

func (x *ValidateKeyResponse) GetMessage() string

func (*ValidateKeyResponse) ProtoMessage added in v0.3.0

func (*ValidateKeyResponse) ProtoMessage()

func (*ValidateKeyResponse) ProtoReflect added in v0.3.0

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

func (*ValidateKeyResponse) Reset added in v0.3.0

func (x *ValidateKeyResponse) Reset()

func (*ValidateKeyResponse) String added in v0.3.0

func (x *ValidateKeyResponse) String() string

Jump to

Keyboard shortcuts

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