Documentation ¶
Index ¶
- Variables
- func KeyManagerPluginServer(server KeyManagerServer) pluginsdk.PluginServer
- func RegisterKeyManagerServer(s grpc.ServiceRegistrar, srv KeyManagerServer)
- type FetchPrivateKeyRequest
- type FetchPrivateKeyResponse
- func (*FetchPrivateKeyResponse) Descriptor() ([]byte, []int)deprecated
- func (x *FetchPrivateKeyResponse) GetPrivateKey() []byte
- func (*FetchPrivateKeyResponse) ProtoMessage()
- func (x *FetchPrivateKeyResponse) ProtoReflect() protoreflect.Message
- func (x *FetchPrivateKeyResponse) Reset()
- func (x *FetchPrivateKeyResponse) String() string
- type GenerateKeyPairRequest
- type GenerateKeyPairResponse
- func (*GenerateKeyPairResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GenerateKeyPairResponse) GetPrivateKey() []byte
- func (x *GenerateKeyPairResponse) GetPublicKey() []byte
- func (*GenerateKeyPairResponse) ProtoMessage()
- func (x *GenerateKeyPairResponse) ProtoReflect() protoreflect.Message
- func (x *GenerateKeyPairResponse) Reset()
- func (x *GenerateKeyPairResponse) String() string
- type KeyManagerClient
- type KeyManagerPluginClient
- type KeyManagerServer
- type StorePrivateKeyRequest
- func (*StorePrivateKeyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StorePrivateKeyRequest) GetPrivateKey() []byte
- func (*StorePrivateKeyRequest) ProtoMessage()
- func (x *StorePrivateKeyRequest) ProtoReflect() protoreflect.Message
- func (x *StorePrivateKeyRequest) Reset()
- func (x *StorePrivateKeyRequest) String() string
- type StorePrivateKeyResponse
- type UnimplementedKeyManagerServer
- func (UnimplementedKeyManagerServer) Configure(context.Context, *plugin.ConfigureRequest) (*plugin.ConfigureResponse, error)
- func (UnimplementedKeyManagerServer) FetchPrivateKey(context.Context, *FetchPrivateKeyRequest) (*FetchPrivateKeyResponse, error)
- func (UnimplementedKeyManagerServer) GenerateKeyPair(context.Context, *GenerateKeyPairRequest) (*GenerateKeyPairResponse, error)
- func (UnimplementedKeyManagerServer) GetPluginInfo(context.Context, *plugin.GetPluginInfoRequest) (*plugin.GetPluginInfoResponse, error)
- func (UnimplementedKeyManagerServer) StorePrivateKey(context.Context, *StorePrivateKeyRequest) (*StorePrivateKeyResponse, error)
- type UnsafeKeyManagerServer
Constants ¶
This section is empty.
Variables ¶
var File_spire_plugin_agent_keymanager_v0_keymanager_proto protoreflect.FileDescriptor
var KeyManager_ServiceDesc = grpc.ServiceDesc{ ServiceName: "spire.agent.keymanager.KeyManager", HandlerType: (*KeyManagerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GenerateKeyPair", Handler: _KeyManager_GenerateKeyPair_Handler, }, { MethodName: "StorePrivateKey", Handler: _KeyManager_StorePrivateKey_Handler, }, { MethodName: "FetchPrivateKey", Handler: _KeyManager_FetchPrivateKey_Handler, }, { MethodName: "Configure", Handler: _KeyManager_Configure_Handler, }, { MethodName: "GetPluginInfo", Handler: _KeyManager_GetPluginInfo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "spire/plugin/agent/keymanager/v0/keymanager.proto", }
KeyManager_ServiceDesc is the grpc.ServiceDesc for KeyManager service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func KeyManagerPluginServer ¶
func KeyManagerPluginServer(server KeyManagerServer) pluginsdk.PluginServer
func RegisterKeyManagerServer ¶
func RegisterKeyManagerServer(s grpc.ServiceRegistrar, srv KeyManagerServer)
Types ¶
type FetchPrivateKeyRequest ¶
type FetchPrivateKeyRequest struct {
// contains filtered or unexported fields
}
* Represents an empty request
func (*FetchPrivateKeyRequest) Descriptor
deprecated
func (*FetchPrivateKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use FetchPrivateKeyRequest.ProtoReflect.Descriptor instead.
func (*FetchPrivateKeyRequest) ProtoMessage ¶
func (*FetchPrivateKeyRequest) ProtoMessage()
func (*FetchPrivateKeyRequest) ProtoReflect ¶
func (x *FetchPrivateKeyRequest) ProtoReflect() protoreflect.Message
func (*FetchPrivateKeyRequest) Reset ¶
func (x *FetchPrivateKeyRequest) Reset()
func (*FetchPrivateKeyRequest) String ¶
func (x *FetchPrivateKeyRequest) String() string
type FetchPrivateKeyResponse ¶
type FetchPrivateKeyResponse struct { //* Private key PrivateKey []byte `protobuf:"bytes,1,opt,name=privateKey,proto3" json:"privateKey,omitempty"` // contains filtered or unexported fields }
* Represents a private key
func (*FetchPrivateKeyResponse) Descriptor
deprecated
func (*FetchPrivateKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use FetchPrivateKeyResponse.ProtoReflect.Descriptor instead.
func (*FetchPrivateKeyResponse) GetPrivateKey ¶
func (x *FetchPrivateKeyResponse) GetPrivateKey() []byte
func (*FetchPrivateKeyResponse) ProtoMessage ¶
func (*FetchPrivateKeyResponse) ProtoMessage()
func (*FetchPrivateKeyResponse) ProtoReflect ¶
func (x *FetchPrivateKeyResponse) ProtoReflect() protoreflect.Message
func (*FetchPrivateKeyResponse) Reset ¶
func (x *FetchPrivateKeyResponse) Reset()
func (*FetchPrivateKeyResponse) String ¶
func (x *FetchPrivateKeyResponse) String() string
type GenerateKeyPairRequest ¶
type GenerateKeyPairRequest struct {
// contains filtered or unexported fields
}
* Represents an empty request
func (*GenerateKeyPairRequest) Descriptor
deprecated
func (*GenerateKeyPairRequest) Descriptor() ([]byte, []int)
Deprecated: Use GenerateKeyPairRequest.ProtoReflect.Descriptor instead.
func (*GenerateKeyPairRequest) ProtoMessage ¶
func (*GenerateKeyPairRequest) ProtoMessage()
func (*GenerateKeyPairRequest) ProtoReflect ¶
func (x *GenerateKeyPairRequest) ProtoReflect() protoreflect.Message
func (*GenerateKeyPairRequest) Reset ¶
func (x *GenerateKeyPairRequest) Reset()
func (*GenerateKeyPairRequest) String ¶
func (x *GenerateKeyPairRequest) String() string
type GenerateKeyPairResponse ¶
type GenerateKeyPairResponse struct { //* Public key PublicKey []byte `protobuf:"bytes,1,opt,name=publicKey,proto3" json:"publicKey,omitempty"` //* Private key PrivateKey []byte `protobuf:"bytes,2,opt,name=privateKey,proto3" json:"privateKey,omitempty"` // contains filtered or unexported fields }
* Represents a public and private key pair
func (*GenerateKeyPairResponse) Descriptor
deprecated
func (*GenerateKeyPairResponse) Descriptor() ([]byte, []int)
Deprecated: Use GenerateKeyPairResponse.ProtoReflect.Descriptor instead.
func (*GenerateKeyPairResponse) GetPrivateKey ¶
func (x *GenerateKeyPairResponse) GetPrivateKey() []byte
func (*GenerateKeyPairResponse) GetPublicKey ¶
func (x *GenerateKeyPairResponse) GetPublicKey() []byte
func (*GenerateKeyPairResponse) ProtoMessage ¶
func (*GenerateKeyPairResponse) ProtoMessage()
func (*GenerateKeyPairResponse) ProtoReflect ¶
func (x *GenerateKeyPairResponse) ProtoReflect() protoreflect.Message
func (*GenerateKeyPairResponse) Reset ¶
func (x *GenerateKeyPairResponse) Reset()
func (*GenerateKeyPairResponse) String ¶
func (x *GenerateKeyPairResponse) String() string
type KeyManagerClient ¶
type KeyManagerClient interface { //* Creates a new key pair. GenerateKeyPair(ctx context.Context, in *GenerateKeyPairRequest, opts ...grpc.CallOption) (*GenerateKeyPairResponse, error) //* Persists a private key to the key manager's storage system. StorePrivateKey(ctx context.Context, in *StorePrivateKeyRequest, opts ...grpc.CallOption) (*StorePrivateKeyResponse, error) //* Returns the most recently stored private key. For use after node restarts. FetchPrivateKey(ctx context.Context, in *FetchPrivateKeyRequest, opts ...grpc.CallOption) (*FetchPrivateKeyResponse, error) //* Applies the plugin configuration and returns configuration errors. Configure(ctx context.Context, in *plugin.ConfigureRequest, opts ...grpc.CallOption) (*plugin.ConfigureResponse, error) //* Returns the version and related metadata of the plugin. GetPluginInfo(ctx context.Context, in *plugin.GetPluginInfoRequest, opts ...grpc.CallOption) (*plugin.GetPluginInfoResponse, error) }
KeyManagerClient is the client API for KeyManager 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.
func NewKeyManagerClient ¶
func NewKeyManagerClient(cc grpc.ClientConnInterface) KeyManagerClient
type KeyManagerPluginClient ¶
type KeyManagerPluginClient struct {
KeyManagerClient
}
func (*KeyManagerPluginClient) GRPCServiceName ¶
func (c *KeyManagerPluginClient) GRPCServiceName() string
func (*KeyManagerPluginClient) InitClient ¶
func (c *KeyManagerPluginClient) InitClient(conn grpc.ClientConnInterface) interface{}
func (*KeyManagerPluginClient) IsInitialized ¶
func (c *KeyManagerPluginClient) IsInitialized() bool
func (KeyManagerPluginClient) Type ¶
func (s KeyManagerPluginClient) Type() string
type KeyManagerServer ¶
type KeyManagerServer interface { //* Creates a new key pair. GenerateKeyPair(context.Context, *GenerateKeyPairRequest) (*GenerateKeyPairResponse, error) //* Persists a private key to the key manager's storage system. StorePrivateKey(context.Context, *StorePrivateKeyRequest) (*StorePrivateKeyResponse, error) //* Returns the most recently stored private key. For use after node restarts. FetchPrivateKey(context.Context, *FetchPrivateKeyRequest) (*FetchPrivateKeyResponse, error) //* Applies the plugin configuration and returns configuration errors. Configure(context.Context, *plugin.ConfigureRequest) (*plugin.ConfigureResponse, error) //* Returns the version and related metadata of the plugin. GetPluginInfo(context.Context, *plugin.GetPluginInfoRequest) (*plugin.GetPluginInfoResponse, error) // contains filtered or unexported methods }
KeyManagerServer is the server API for KeyManager service. All implementations must embed UnimplementedKeyManagerServer for forward compatibility
type StorePrivateKeyRequest ¶
type StorePrivateKeyRequest struct { //* Private key PrivateKey []byte `protobuf:"bytes,1,opt,name=privateKey,proto3" json:"privateKey,omitempty"` // contains filtered or unexported fields }
* Represents a private key
func (*StorePrivateKeyRequest) Descriptor
deprecated
func (*StorePrivateKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use StorePrivateKeyRequest.ProtoReflect.Descriptor instead.
func (*StorePrivateKeyRequest) GetPrivateKey ¶
func (x *StorePrivateKeyRequest) GetPrivateKey() []byte
func (*StorePrivateKeyRequest) ProtoMessage ¶
func (*StorePrivateKeyRequest) ProtoMessage()
func (*StorePrivateKeyRequest) ProtoReflect ¶
func (x *StorePrivateKeyRequest) ProtoReflect() protoreflect.Message
func (*StorePrivateKeyRequest) Reset ¶
func (x *StorePrivateKeyRequest) Reset()
func (*StorePrivateKeyRequest) String ¶
func (x *StorePrivateKeyRequest) String() string
type StorePrivateKeyResponse ¶
type StorePrivateKeyResponse struct {
// contains filtered or unexported fields
}
* Represents an empty response
func (*StorePrivateKeyResponse) Descriptor
deprecated
func (*StorePrivateKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use StorePrivateKeyResponse.ProtoReflect.Descriptor instead.
func (*StorePrivateKeyResponse) ProtoMessage ¶
func (*StorePrivateKeyResponse) ProtoMessage()
func (*StorePrivateKeyResponse) ProtoReflect ¶
func (x *StorePrivateKeyResponse) ProtoReflect() protoreflect.Message
func (*StorePrivateKeyResponse) Reset ¶
func (x *StorePrivateKeyResponse) Reset()
func (*StorePrivateKeyResponse) String ¶
func (x *StorePrivateKeyResponse) String() string
type UnimplementedKeyManagerServer ¶
type UnimplementedKeyManagerServer struct { }
UnimplementedKeyManagerServer must be embedded to have forward compatible implementations.
func (UnimplementedKeyManagerServer) Configure ¶
func (UnimplementedKeyManagerServer) Configure(context.Context, *plugin.ConfigureRequest) (*plugin.ConfigureResponse, error)
func (UnimplementedKeyManagerServer) FetchPrivateKey ¶
func (UnimplementedKeyManagerServer) FetchPrivateKey(context.Context, *FetchPrivateKeyRequest) (*FetchPrivateKeyResponse, error)
func (UnimplementedKeyManagerServer) GenerateKeyPair ¶
func (UnimplementedKeyManagerServer) GenerateKeyPair(context.Context, *GenerateKeyPairRequest) (*GenerateKeyPairResponse, error)
func (UnimplementedKeyManagerServer) GetPluginInfo ¶
func (UnimplementedKeyManagerServer) GetPluginInfo(context.Context, *plugin.GetPluginInfoRequest) (*plugin.GetPluginInfoResponse, error)
func (UnimplementedKeyManagerServer) StorePrivateKey ¶
func (UnimplementedKeyManagerServer) StorePrivateKey(context.Context, *StorePrivateKeyRequest) (*StorePrivateKeyResponse, error)
type UnsafeKeyManagerServer ¶
type UnsafeKeyManagerServer interface {
// contains filtered or unexported methods
}
UnsafeKeyManagerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to KeyManagerServer will result in compilation errors.