managementv1

package
v0.13.0 Latest Latest
Warning

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

Go to latest
Published: Jun 9, 2026 License: Apache-2.0 Imports: 12 Imported by: 1

Documentation

Index

Constants

View Source
const (
	Type                = "KeystoreProvider"
	GRPCServiceFullName = "plugin.keystore.management.v1.KeystoreProvider"
)
View Source
const (
	KeystoreProvider_CreateKeystore_FullMethodName = "/plugin.keystore.management.v1.KeystoreProvider/CreateKeystore"
	KeystoreProvider_DeleteKeystore_FullMethodName = "/plugin.keystore.management.v1.KeystoreProvider/DeleteKeystore"
	KeystoreProvider_GrantTrust_FullMethodName     = "/plugin.keystore.management.v1.KeystoreProvider/GrantTrust"
	KeystoreProvider_RemoveTrust_FullMethodName    = "/plugin.keystore.management.v1.KeystoreProvider/RemoveTrust"
)

Variables

View Source
var File_plugin_keystore_management_v1_management_proto protoreflect.FileDescriptor
View Source
var KeystoreProvider_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "plugin.keystore.management.v1.KeystoreProvider",
	HandlerType: (*KeystoreProviderServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateKeystore",
			Handler:    _KeystoreProvider_CreateKeystore_Handler,
		},
		{
			MethodName: "DeleteKeystore",
			Handler:    _KeystoreProvider_DeleteKeystore_Handler,
		},
		{
			MethodName: "GrantTrust",
			Handler:    _KeystoreProvider_GrantTrust_Handler,
		},
		{
			MethodName: "RemoveTrust",
			Handler:    _KeystoreProvider_RemoveTrust_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "plugin/keystore/management/v1/management.proto",
}

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

Functions

func KeystoreProviderPluginServer

func KeystoreProviderPluginServer(server KeystoreProviderServer) api.PluginServer

func RegisterKeystoreProviderServer

func RegisterKeystoreProviderServer(s grpc.ServiceRegistrar, srv KeystoreProviderServer)

Types

type CreateKeystoreRequest

type CreateKeystoreRequest struct {
	Values *structpb.Struct `protobuf:"bytes,1,opt,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

CreateKeystoreRequest represents the request to create a new keystore instance. The values field contains the necessary parameters for creating the keystore, which can vary depending on the implementation and requirements of the keystore provider.

func (*CreateKeystoreRequest) Descriptor deprecated

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

Deprecated: Use CreateKeystoreRequest.ProtoReflect.Descriptor instead.

func (*CreateKeystoreRequest) GetValues

func (x *CreateKeystoreRequest) GetValues() *structpb.Struct

func (*CreateKeystoreRequest) ProtoMessage

func (*CreateKeystoreRequest) ProtoMessage()

func (*CreateKeystoreRequest) ProtoReflect

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

func (*CreateKeystoreRequest) Reset

func (x *CreateKeystoreRequest) Reset()

func (*CreateKeystoreRequest) String

func (x *CreateKeystoreRequest) String() string

type CreateKeystoreResponse

type CreateKeystoreResponse struct {

	// Deprecated: Marked as deprecated in plugin/keystore/management/v1/management.proto.
	Config               *v1.KeystoreInstanceConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	RoleManagementConfig *ManagementConfig          `protobuf:"bytes,2,opt,name=role_management_config,json=roleManagementConfig,proto3" json:"role_management_config,omitempty"`
	KeyManagementConfig  *ManagementConfig          `protobuf:"bytes,3,opt,name=key_management_config,json=keyManagementConfig,proto3" json:"key_management_config,omitempty"`
	SupportedRegions     []*SupportedRegion         `protobuf:"bytes,4,rep,name=supported_regions,json=supportedRegions,proto3" json:"supported_regions,omitempty"`
	// contains filtered or unexported fields
}

CreateKeystoreResponse represents the response after creating a new keystore instance. - The config field (deprecated) contains the configuration details of the created keystore instance, including fields: locality_id, common_name, management_access_data, and supported_regions.

func (*CreateKeystoreResponse) Descriptor deprecated

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

Deprecated: Use CreateKeystoreResponse.ProtoReflect.Descriptor instead.

func (*CreateKeystoreResponse) GetConfig deprecated

Deprecated: Marked as deprecated in plugin/keystore/management/v1/management.proto.

func (*CreateKeystoreResponse) GetKeyManagementConfig added in v0.13.0

func (x *CreateKeystoreResponse) GetKeyManagementConfig() *ManagementConfig

func (*CreateKeystoreResponse) GetRoleManagementConfig added in v0.13.0

func (x *CreateKeystoreResponse) GetRoleManagementConfig() *ManagementConfig

func (*CreateKeystoreResponse) GetSupportedRegions added in v0.13.0

func (x *CreateKeystoreResponse) GetSupportedRegions() []*SupportedRegion

func (*CreateKeystoreResponse) ProtoMessage

func (*CreateKeystoreResponse) ProtoMessage()

func (*CreateKeystoreResponse) ProtoReflect

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

func (*CreateKeystoreResponse) Reset

func (x *CreateKeystoreResponse) Reset()

func (*CreateKeystoreResponse) String

func (x *CreateKeystoreResponse) String() string

type DeleteKeystoreRequest

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

func (*DeleteKeystoreRequest) Descriptor deprecated

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

Deprecated: Use DeleteKeystoreRequest.ProtoReflect.Descriptor instead.

func (*DeleteKeystoreRequest) GetConfig

func (*DeleteKeystoreRequest) ProtoMessage

func (*DeleteKeystoreRequest) ProtoMessage()

func (*DeleteKeystoreRequest) ProtoReflect

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

func (*DeleteKeystoreRequest) Reset

func (x *DeleteKeystoreRequest) Reset()

func (*DeleteKeystoreRequest) String

func (x *DeleteKeystoreRequest) String() string

type DeleteKeystoreResponse

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

func (*DeleteKeystoreResponse) Descriptor deprecated

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

Deprecated: Use DeleteKeystoreResponse.ProtoReflect.Descriptor instead.

func (*DeleteKeystoreResponse) ProtoMessage

func (*DeleteKeystoreResponse) ProtoMessage()

func (*DeleteKeystoreResponse) ProtoReflect

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

func (*DeleteKeystoreResponse) Reset

func (x *DeleteKeystoreResponse) Reset()

func (*DeleteKeystoreResponse) String

func (x *DeleteKeystoreResponse) String() string

type GrantTrustRequest added in v0.13.0

type GrantTrustRequest struct {
	Config  *v1.KeystoreInstanceConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	Subject string                     `protobuf:"bytes,2,opt,name=subject,proto3" json:"subject,omitempty"`
	Region  string                     `protobuf:"bytes,3,opt,name=region,proto3" json:"region,omitempty"`
	// contains filtered or unexported fields
}

GrantTrustRequest represents the request to grant trust to a client certificate subject pattern for accessing a keystore instance from the crypto layer. - The config field contains the authentication configuration of the role management role for the keystore instance, which is used to authenticate the request to grant trust. - The subject field contains the client certificate subject to grant trust to - The region field specifies the logical region for which the trust is being granted

func (*GrantTrustRequest) Descriptor deprecated added in v0.13.0

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

Deprecated: Use GrantTrustRequest.ProtoReflect.Descriptor instead.

func (*GrantTrustRequest) GetConfig added in v0.13.0

func (*GrantTrustRequest) GetRegion added in v0.13.0

func (x *GrantTrustRequest) GetRegion() string

func (*GrantTrustRequest) GetSubject added in v0.13.0

func (x *GrantTrustRequest) GetSubject() string

func (*GrantTrustRequest) ProtoMessage added in v0.13.0

func (*GrantTrustRequest) ProtoMessage()

func (*GrantTrustRequest) ProtoReflect added in v0.13.0

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

func (*GrantTrustRequest) Reset added in v0.13.0

func (x *GrantTrustRequest) Reset()

func (*GrantTrustRequest) String added in v0.13.0

func (x *GrantTrustRequest) String() string

type GrantTrustResponse added in v0.13.0

type GrantTrustResponse struct {
	AccessData *structpb.Struct `protobuf:"bytes,1,opt,name=access_data,json=accessData,proto3" json:"access_data,omitempty"`
	// contains filtered or unexported fields
}

GrantTrustResponse represents the response after granting trust to a client certificate subject pattern for accessing a keystore instance. Returns the access data of the configured trust

func (*GrantTrustResponse) Descriptor deprecated added in v0.13.0

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

Deprecated: Use GrantTrustResponse.ProtoReflect.Descriptor instead.

func (*GrantTrustResponse) GetAccessData added in v0.13.0

func (x *GrantTrustResponse) GetAccessData() *structpb.Struct

func (*GrantTrustResponse) ProtoMessage added in v0.13.0

func (*GrantTrustResponse) ProtoMessage()

func (*GrantTrustResponse) ProtoReflect added in v0.13.0

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

func (*GrantTrustResponse) Reset added in v0.13.0

func (x *GrantTrustResponse) Reset()

func (*GrantTrustResponse) String added in v0.13.0

func (x *GrantTrustResponse) String() string

type KeystoreProviderClient

type KeystoreProviderClient interface {
	// Create a new keystore instance
	CreateKeystore(ctx context.Context, in *CreateKeystoreRequest, opts ...grpc.CallOption) (*CreateKeystoreResponse, error)
	// Delete an existing keystore instance
	DeleteKeystore(ctx context.Context, in *DeleteKeystoreRequest, opts ...grpc.CallOption) (*DeleteKeystoreResponse, error)
	// Grant trust to a client certificate subject pattern for accessing the keystore instance
	GrantTrust(ctx context.Context, in *GrantTrustRequest, opts ...grpc.CallOption) (*GrantTrustResponse, error)
	// Remove trust for a client certificate subject pattern to revoke access to the keystore instance
	RemoveTrust(ctx context.Context, in *RemoveTrustRequest, opts ...grpc.CallOption) (*RemoveTrustResponse, error)
}

KeystoreProviderClient is the client API for KeystoreProvider 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.

type KeystoreProviderPluginClient

type KeystoreProviderPluginClient struct {
	KeystoreProviderClient
}

func (*KeystoreProviderPluginClient) GRPCServiceName

func (c *KeystoreProviderPluginClient) GRPCServiceName() string

func (*KeystoreProviderPluginClient) InitClient

func (*KeystoreProviderPluginClient) IsInitialized

func (c *KeystoreProviderPluginClient) IsInitialized() bool

func (KeystoreProviderPluginClient) Type

type KeystoreProviderServer

type KeystoreProviderServer interface {
	// Create a new keystore instance
	CreateKeystore(context.Context, *CreateKeystoreRequest) (*CreateKeystoreResponse, error)
	// Delete an existing keystore instance
	DeleteKeystore(context.Context, *DeleteKeystoreRequest) (*DeleteKeystoreResponse, error)
	// Grant trust to a client certificate subject pattern for accessing the keystore instance
	GrantTrust(context.Context, *GrantTrustRequest) (*GrantTrustResponse, error)
	// Remove trust for a client certificate subject pattern to revoke access to the keystore instance
	RemoveTrust(context.Context, *RemoveTrustRequest) (*RemoveTrustResponse, error)
	// contains filtered or unexported methods
}

KeystoreProviderServer is the server API for KeystoreProvider service. All implementations must embed UnimplementedKeystoreProviderServer for forward compatibility.

type ManagementConfig added in v0.13.0

type ManagementConfig struct {
	LocalityId string                     `protobuf:"bytes,1,opt,name=locality_id,json=localityId,proto3" json:"locality_id,omitempty"`
	CommonName string                     `protobuf:"bytes,2,opt,name=common_name,json=commonName,proto3" json:"common_name,omitempty"`
	AccessData *v1.KeystoreInstanceConfig `protobuf:"bytes,3,opt,name=access_data,json=accessData,proto3" json:"access_data,omitempty"`
	// contains filtered or unexported fields
}

ManagementConfig represents the configuration details for the management role of a keystore instance.

func (*ManagementConfig) Descriptor deprecated added in v0.13.0

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

Deprecated: Use ManagementConfig.ProtoReflect.Descriptor instead.

func (*ManagementConfig) GetAccessData added in v0.13.0

func (x *ManagementConfig) GetAccessData() *v1.KeystoreInstanceConfig

func (*ManagementConfig) GetCommonName added in v0.13.0

func (x *ManagementConfig) GetCommonName() string

func (*ManagementConfig) GetLocalityId added in v0.13.0

func (x *ManagementConfig) GetLocalityId() string

func (*ManagementConfig) ProtoMessage added in v0.13.0

func (*ManagementConfig) ProtoMessage()

func (*ManagementConfig) ProtoReflect added in v0.13.0

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

func (*ManagementConfig) Reset added in v0.13.0

func (x *ManagementConfig) Reset()

func (*ManagementConfig) String added in v0.13.0

func (x *ManagementConfig) String() string

type RemoveTrustRequest added in v0.13.0

type RemoveTrustRequest struct {
	Config     *v1.KeystoreInstanceConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	AccessData *structpb.Struct           `protobuf:"bytes,2,opt,name=access_data,json=accessData,proto3" json:"access_data,omitempty"`
	// contains filtered or unexported fields
}

RemoveTrustRequest represents the request to remove trust for a client certificate subject pattern to revoke access to a keystore instance. - The config field contains the authentication configuration of the role management role for the keystore instance, which is used to authenticate the request to remove trust. - The access_data field contains the access data of the trust to be removed

func (*RemoveTrustRequest) Descriptor deprecated added in v0.13.0

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

Deprecated: Use RemoveTrustRequest.ProtoReflect.Descriptor instead.

func (*RemoveTrustRequest) GetAccessData added in v0.13.0

func (x *RemoveTrustRequest) GetAccessData() *structpb.Struct

func (*RemoveTrustRequest) GetConfig added in v0.13.0

func (*RemoveTrustRequest) ProtoMessage added in v0.13.0

func (*RemoveTrustRequest) ProtoMessage()

func (*RemoveTrustRequest) ProtoReflect added in v0.13.0

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

func (*RemoveTrustRequest) Reset added in v0.13.0

func (x *RemoveTrustRequest) Reset()

func (*RemoveTrustRequest) String added in v0.13.0

func (x *RemoveTrustRequest) String() string

type RemoveTrustResponse added in v0.13.0

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

func (*RemoveTrustResponse) Descriptor deprecated added in v0.13.0

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

Deprecated: Use RemoveTrustResponse.ProtoReflect.Descriptor instead.

func (*RemoveTrustResponse) ProtoMessage added in v0.13.0

func (*RemoveTrustResponse) ProtoMessage()

func (*RemoveTrustResponse) ProtoReflect added in v0.13.0

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

func (*RemoveTrustResponse) Reset added in v0.13.0

func (x *RemoveTrustResponse) Reset()

func (*RemoveTrustResponse) String added in v0.13.0

func (x *RemoveTrustResponse) String() string

type SupportedRegion added in v0.13.0

type SupportedRegion struct {
	Name          string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	TechnicalName string `protobuf:"bytes,2,opt,name=technical_name,json=technicalName,proto3" json:"technical_name,omitempty"`
	// contains filtered or unexported fields
}

SupportedRegion represents a region where the keystore can be created or accessed.

func (*SupportedRegion) Descriptor deprecated added in v0.13.0

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

Deprecated: Use SupportedRegion.ProtoReflect.Descriptor instead.

func (*SupportedRegion) GetName added in v0.13.0

func (x *SupportedRegion) GetName() string

func (*SupportedRegion) GetTechnicalName added in v0.13.0

func (x *SupportedRegion) GetTechnicalName() string

func (*SupportedRegion) ProtoMessage added in v0.13.0

func (*SupportedRegion) ProtoMessage()

func (*SupportedRegion) ProtoReflect added in v0.13.0

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

func (*SupportedRegion) Reset added in v0.13.0

func (x *SupportedRegion) Reset()

func (*SupportedRegion) String added in v0.13.0

func (x *SupportedRegion) String() string

type UnimplementedKeystoreProviderServer

type UnimplementedKeystoreProviderServer struct{}

UnimplementedKeystoreProviderServer 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 (UnimplementedKeystoreProviderServer) CreateKeystore

func (UnimplementedKeystoreProviderServer) DeleteKeystore

func (UnimplementedKeystoreProviderServer) GrantTrust added in v0.13.0

func (UnimplementedKeystoreProviderServer) RemoveTrust added in v0.13.0

type UnsafeKeystoreProviderServer

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

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

Jump to

Keyboard shortcuts

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