Documentation
¶
Overview ¶
Implementation of the KMS Plugin API v1.
Package v1beta1 is a generated protocol buffer package.
It is generated from these files:
service.proto
It has these top-level messages:
VersionRequest VersionResponse DecryptRequest DecryptResponse EncryptRequest EncryptResponse
Index ¶
- func RegisterKeyManagementServiceServer(s *grpc.Server, srv KeyManagementServiceServer)
- type DecryptRequest
- type DecryptResponse
- type EncryptRequest
- type EncryptResponse
- type HealthChecker
- type KeyManagementServiceClient
- type KeyManagementServiceServer
- type Plugin
- func (g *Plugin) Decrypt(ctx context.Context, request *DecryptRequest) (*DecryptResponse, error)
- func (g *Plugin) Encrypt(ctx context.Context, request *EncryptRequest) (*EncryptResponse, error)
- func (g *Plugin) Register(s *grpc.Server)
- func (g *Plugin) Version(ctx context.Context, request *VersionRequest) (*VersionResponse, error)
- type VersionRequest
- type VersionResponse
- func (*VersionResponse) Descriptor() ([]byte, []int)
- func (m *VersionResponse) GetRuntimeName() string
- func (m *VersionResponse) GetRuntimeVersion() string
- func (m *VersionResponse) GetVersion() string
- func (*VersionResponse) ProtoMessage()
- func (m *VersionResponse) Reset()
- func (m *VersionResponse) String() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterKeyManagementServiceServer ¶
func RegisterKeyManagementServiceServer(s *grpc.Server, srv KeyManagementServiceServer)
Types ¶
type DecryptRequest ¶
type DecryptRequest struct { // Version of the KMS plugin API. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // The data to be decrypted. Cipher []byte `protobuf:"bytes,2,opt,name=cipher,proto3" json:"cipher,omitempty"` }
func (*DecryptRequest) Descriptor ¶
func (*DecryptRequest) Descriptor() ([]byte, []int)
func (*DecryptRequest) GetCipher ¶
func (m *DecryptRequest) GetCipher() []byte
func (*DecryptRequest) GetVersion ¶
func (m *DecryptRequest) GetVersion() string
func (*DecryptRequest) ProtoMessage ¶
func (*DecryptRequest) ProtoMessage()
func (*DecryptRequest) Reset ¶
func (m *DecryptRequest) Reset()
func (*DecryptRequest) String ¶
func (m *DecryptRequest) String() string
type DecryptResponse ¶
type DecryptResponse struct { // The decrypted data. Plain []byte `protobuf:"bytes,1,opt,name=plain,proto3" json:"plain,omitempty"` }
func (*DecryptResponse) Descriptor ¶
func (*DecryptResponse) Descriptor() ([]byte, []int)
func (*DecryptResponse) GetPlain ¶
func (m *DecryptResponse) GetPlain() []byte
func (*DecryptResponse) ProtoMessage ¶
func (*DecryptResponse) ProtoMessage()
func (*DecryptResponse) Reset ¶
func (m *DecryptResponse) Reset()
func (*DecryptResponse) String ¶
func (m *DecryptResponse) String() string
type EncryptRequest ¶
type EncryptRequest struct { // Version of the KMS plugin API. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // The data to be encrypted. Plain []byte `protobuf:"bytes,2,opt,name=plain,proto3" json:"plain,omitempty"` }
func (*EncryptRequest) Descriptor ¶
func (*EncryptRequest) Descriptor() ([]byte, []int)
func (*EncryptRequest) GetPlain ¶
func (m *EncryptRequest) GetPlain() []byte
func (*EncryptRequest) GetVersion ¶
func (m *EncryptRequest) GetVersion() string
func (*EncryptRequest) ProtoMessage ¶
func (*EncryptRequest) ProtoMessage()
func (*EncryptRequest) Reset ¶
func (m *EncryptRequest) Reset()
func (*EncryptRequest) String ¶
func (m *EncryptRequest) String() string
type EncryptResponse ¶
type EncryptResponse struct { // The encrypted data. Cipher []byte `protobuf:"bytes,1,opt,name=cipher,proto3" json:"cipher,omitempty"` }
func (*EncryptResponse) Descriptor ¶
func (*EncryptResponse) Descriptor() ([]byte, []int)
func (*EncryptResponse) GetCipher ¶
func (m *EncryptResponse) GetCipher() []byte
func (*EncryptResponse) ProtoMessage ¶
func (*EncryptResponse) ProtoMessage()
func (*EncryptResponse) Reset ¶
func (m *EncryptResponse) Reset()
func (*EncryptResponse) String ¶
func (m *EncryptResponse) String() string
type HealthChecker ¶
type HealthChecker struct{}
func NewHealthChecker ¶
func NewHealthChecker() *HealthChecker
func (*HealthChecker) PingKMS ¶
func (h *HealthChecker) PingKMS(ctx context.Context, conn *grpc.ClientConn) error
func (*HealthChecker) PingRPC ¶
func (h *HealthChecker) PingRPC(ctx context.Context, conn *grpc.ClientConn) error
type KeyManagementServiceClient ¶
type KeyManagementServiceClient interface { // Version returns the runtime name and runtime version of the KMS provider. Version(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error) // Execute decryption operation in KMS provider. Decrypt(ctx context.Context, in *DecryptRequest, opts ...grpc.CallOption) (*DecryptResponse, error) // Execute encryption operation in KMS provider. Encrypt(ctx context.Context, in *EncryptRequest, opts ...grpc.CallOption) (*EncryptResponse, error) }
func NewKeyManagementServiceClient ¶
func NewKeyManagementServiceClient(cc *grpc.ClientConn) KeyManagementServiceClient
type KeyManagementServiceServer ¶
type KeyManagementServiceServer interface { // Version returns the runtime name and runtime version of the KMS provider. Version(context.Context, *VersionRequest) (*VersionResponse, error) // Execute decryption operation in KMS provider. Decrypt(context.Context, *DecryptRequest) (*DecryptResponse, error) // Execute encryption operation in KMS provider. Encrypt(context.Context, *EncryptRequest) (*EncryptResponse, error) }
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin is the v1 implementation of a plugin.
func NewPlugin ¶
func NewPlugin(keyService *cloudkms.ProjectsLocationsKeyRingsCryptoKeysService, keyURI string) *Plugin
NewPlugin creates a new v1 plugin
func (*Plugin) Decrypt ¶
func (g *Plugin) Decrypt(ctx context.Context, request *DecryptRequest) (*DecryptResponse, error)
Decrypt decrypts payload supplied by K8S API Server.
func (*Plugin) Encrypt ¶
func (g *Plugin) Encrypt(ctx context.Context, request *EncryptRequest) (*EncryptResponse, error)
Encrypt encrypts payload provided by K8S API Server.
func (*Plugin) Version ¶
func (g *Plugin) Version(ctx context.Context, request *VersionRequest) (*VersionResponse, error)
Version returns the version of KMS Plugin.
type VersionRequest ¶
type VersionRequest struct { // Version of the KMS plugin API. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` }
func (*VersionRequest) Descriptor ¶
func (*VersionRequest) Descriptor() ([]byte, []int)
func (*VersionRequest) GetVersion ¶
func (m *VersionRequest) GetVersion() string
func (*VersionRequest) ProtoMessage ¶
func (*VersionRequest) ProtoMessage()
func (*VersionRequest) Reset ¶
func (m *VersionRequest) Reset()
func (*VersionRequest) String ¶
func (m *VersionRequest) String() string
type VersionResponse ¶
type VersionResponse struct { // Version of the KMS plugin API. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // Name of the KMS provider. RuntimeName string `protobuf:"bytes,2,opt,name=runtime_name,json=runtimeName,proto3" json:"runtime_name,omitempty"` // Version of the KMS provider. The string must be semver-compatible. RuntimeVersion string `protobuf:"bytes,3,opt,name=runtime_version,json=runtimeVersion,proto3" json:"runtime_version,omitempty"` }
func (*VersionResponse) Descriptor ¶
func (*VersionResponse) Descriptor() ([]byte, []int)
func (*VersionResponse) GetRuntimeName ¶
func (m *VersionResponse) GetRuntimeName() string
func (*VersionResponse) GetRuntimeVersion ¶
func (m *VersionResponse) GetRuntimeVersion() string
func (*VersionResponse) GetVersion ¶
func (m *VersionResponse) GetVersion() string
func (*VersionResponse) ProtoMessage ¶
func (*VersionResponse) ProtoMessage()
func (*VersionResponse) Reset ¶
func (m *VersionResponse) Reset()
func (*VersionResponse) String ¶
func (m *VersionResponse) String() string
Click to show internal directories.
Click to hide internal directories.