object_peer

package
v0.51.6 Latest Latest
Warning

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

Go to latest
Published: May 11, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source
const ConfigID = ControllerID

ConfigID is the config identifier.

View Source
const ControllerID = "object/peer"

ControllerID is the controller id.

Variables

View Source
var Version = semver.MustParse("0.0.1")

Version is the component version

Functions

func NewFactory

func NewFactory(b bus.Bus) controller.Factory

NewFactory constructs the component factory.

Types

type Config

type Config struct {

	// ObjectStoreId is the hydra object store to open to store the private key.
	// Required.
	ObjectStoreId string `protobuf:"bytes,1,opt,name=object_store_id,json=objectStoreId,proto3" json:"objectStoreId,omitempty"`
	// VolumeId is the volume id to use for the object store.
	// Can be empty to select any.
	VolumeId string `protobuf:"bytes,2,opt,name=volume_id,json=volumeId,proto3" json:"volumeId,omitempty"`
	// ObjectStoreKey is the key to use in the object store for the private key.
	//
	// Defaults to "priv"
	ObjectStoreKey string `protobuf:"bytes,3,opt,name=object_store_key,json=objectStoreKey,proto3" json:"objectStoreKey,omitempty"`
	// TransformConf transforms the private key before storing it in storage.
	TransformConf *transform.Config `protobuf:"bytes,4,opt,name=transform_conf,json=transformConf,proto3" json:"transformConf,omitempty"`
	// contains filtered or unexported fields
}

Config configures the object store peer controller. The controller stores a peer private key in an ObjectStore.

It can optionally apply the provided transform config to the key data.

func (*Config) CloneMessageVT

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT

func (this *Config) EqualVT(that *Config) bool

func (*Config) EqualsConfig

func (c *Config) EqualsConfig(other config.Config) bool

EqualsConfig checks if the config is equal to another.

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Config) GetObjectStoreId

func (x *Config) GetObjectStoreId() string

func (*Config) GetObjectStoreKey

func (x *Config) GetObjectStoreKey() string

func (*Config) GetTransformConf

func (x *Config) GetTransformConf() *transform.Config

func (*Config) GetVolumeId

func (x *Config) GetVolumeId() string

func (*Config) MarshalJSON

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText

func (x *Config) MarshalProtoText() string

func (*Config) MarshalToSizedBufferVT

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (x *Config) Reset()

func (*Config) SizeVT

func (m *Config) SizeVT() (n int)

func (*Config) String

func (x *Config) String() string

func (*Config) UnmarshalJSON

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

func (*Config) UnmarshalVT

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type Controller

type Controller struct {
	*bus.BusController[*Config]
	// contains filtered or unexported fields
}

Controller is the root resource controller.

func NewController

func NewController(base *bus.BusController[*Config]) (*Controller, error)

NewController constructs a new Controller.

func (*Controller) Execute

func (c *Controller) Execute(ctx context.Context) error

Execute executes the controller.

func (*Controller) HandleDirective

func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)

HandleDirective asks if the handler can resolve the directive. If it can, it returns a resolver. If not, returns nil. Any unexpected errors are returned for logging. It is safe to add a reference to the directive during this call.

func (*Controller) ResolvePeer

func (c *Controller) ResolvePeer(ctx context.Context, released func()) (peer.Peer, func(), error)

ResolvePeer adds a reference to the Peer and waits for a value. Returns the value, reference, and any error. If err != nil, value and reference will be nil. Returns a release function.

type StoredValue

type StoredValue struct {

	// PrivKeyPem is the private key value in pem format.
	PrivKeyPem string `protobuf:"bytes,1,opt,name=priv_key_pem,json=privKeyPem,proto3" json:"privKeyPem,omitempty"`
	// contains filtered or unexported fields
}

StoredValue is the value for the ObjectStore containing the private key.

func (*StoredValue) CloneMessageVT

func (m *StoredValue) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*StoredValue) CloneVT

func (m *StoredValue) CloneVT() *StoredValue

func (*StoredValue) EqualMessageVT

func (this *StoredValue) EqualMessageVT(thatMsg any) bool

func (*StoredValue) EqualVT

func (this *StoredValue) EqualVT(that *StoredValue) bool

func (*StoredValue) GetPrivKeyPem

func (x *StoredValue) GetPrivKeyPem() string

func (*StoredValue) MarshalJSON

func (x *StoredValue) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StoredValue to JSON.

func (*StoredValue) MarshalProtoJSON

func (x *StoredValue) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StoredValue message to JSON.

func (*StoredValue) MarshalProtoText

func (x *StoredValue) MarshalProtoText() string

func (*StoredValue) MarshalToSizedBufferVT

func (m *StoredValue) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*StoredValue) MarshalToVT

func (m *StoredValue) MarshalToVT(dAtA []byte) (int, error)

func (*StoredValue) MarshalVT

func (m *StoredValue) MarshalVT() (dAtA []byte, err error)

func (*StoredValue) ProtoMessage

func (*StoredValue) ProtoMessage()

func (*StoredValue) Reset

func (x *StoredValue) Reset()

func (*StoredValue) SizeVT

func (m *StoredValue) SizeVT() (n int)

func (*StoredValue) String

func (x *StoredValue) String() string

func (*StoredValue) UnmarshalJSON

func (x *StoredValue) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StoredValue from JSON.

func (*StoredValue) UnmarshalProtoJSON

func (x *StoredValue) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StoredValue message from JSON.

func (*StoredValue) UnmarshalVT

func (m *StoredValue) UnmarshalVT(dAtA []byte) error

Jump to

Keyboard shortcuts

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