configpb

package
v1.2.2 Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package configpb holds a config protobuf for Migrillian.

Index

Constants

This section is empty.

Variables

View Source 
var (
	IdentityFunction_name = map[int32]string{
		0: "UNKNOWN_IDENTITY_FUNCTION",
		1: "SHA256_CERT_DATA",
		2: "SHA256_LEAF_INDEX",
	}
	IdentityFunction_value = map[string]int32{
		"UNKNOWN_IDENTITY_FUNCTION": 0,
		"SHA256_CERT_DATA":          1,
		"SHA256_LEAF_INDEX":         2,
	}
)

Enum value maps for IdentityFunction.

View Source 
var File_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type IdentityFunction added in v1.2.1 

type IdentityFunction int32

IdentityFunction specifies how Trillian identity hash is computed. 

const (
	IdentityFunction_UNKNOWN_IDENTITY_FUNCTION IdentityFunction = 0
	// Returns SHA256 hash of the certificate DER. This is the same function that
	// CTFE uses when submitting add-[pre-]chain entries to Trillian.
	//
	// For example, it can be used when migrating a CT log to Trillian. Using the
	// same function as CTFE makes any newly submitted entries compatible with the
	// ones that migrated from the source log.
	IdentityFunction_SHA256_CERT_DATA IdentityFunction = 1
	// Returns SHA256 hash of the leaf index.
	//
	// For example, this function can be used for mirroring CT logs. Since the
	// source logs might have duplicates of different kinds (depends on the
	// operator), this function allows storing them all (unlike SHA256_CERT_DATA).
	// Note that the CTFE log must stay read-only (mirror), as CTFE's identity
	// hash is incompatible.
	IdentityFunction_SHA256_LEAF_INDEX IdentityFunction = 2
)

func (IdentityFunction) Descriptor added in v1.2.1 

func (IdentityFunction) Descriptor() protoreflect.EnumDescriptor

func (IdentityFunction) Enum added in v1.2.1 

func (x IdentityFunction) Enum() *IdentityFunction

func (IdentityFunction) EnumDescriptor deprecated added in v1.2.1 

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

Deprecated: Use IdentityFunction.Descriptor instead.

func (IdentityFunction) Number added in v1.2.1 

func (x IdentityFunction) Number() protoreflect.EnumNumber

func (IdentityFunction) String added in v1.2.1 

func (x IdentityFunction) String() string

func (IdentityFunction) Type added in v1.2.1 

func (IdentityFunction) Type() protoreflect.EnumType

type MigrationConfig 

type MigrationConfig struct {

	// The URI of the source CT log, e.g. "https://ct.googleapis.com/pilot".
	SourceUri string `protobuf:"bytes,1,opt,name=source_uri,json=sourceUri,proto3" json:"source_uri,omitempty"`
	// The public key of the source log.
	PublicKey *keyspb.PublicKey `protobuf:"bytes,2,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// The name of the backend which this log migrates to. The name must be one of
	// those defined in the LogBackendSet.
	//
	// Deprecated. TODO(pavelkalinnikov): Remove it.
	//
	// Deprecated: Do not use.
	LogBackendName string `protobuf:"bytes,3,opt,name=log_backend_name,json=logBackendName,proto3" json:"log_backend_name,omitempty"`
	// The ID of a Trillian PREORDERED_LOG tree that stores the log data.
	LogId int64 `protobuf:"varint,4,opt,name=log_id,json=logId,proto3" json:"log_id,omitempty"`
	// Max number of entries per get-entries request from the source log.
	BatchSize int32 `protobuf:"varint,5,opt,name=batch_size,json=batchSize,proto3" json:"batch_size,omitempty"`
	// Determines whether the migration should run continuously, i.e. watch and
	// follow the updates of the source log's STH. For example, this mode can be
	// used to support a mirror CT log.
	IsContinuous bool `protobuf:"varint,6,opt,name=is_continuous,json=isContinuous,proto3" json:"is_continuous,omitempty"`
	// The log entry index to start fetching at. If negative, then it is assumed
	// equal to the current Trillian tree size.
	// Ignored in continuous mode which starts at the point where it stopped (e.g.
	// the current Trillian tree size in a simple case).
	StartIndex int64 `protobuf:"varint,7,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// The log index to end fetching at, non-inclusive. If zero, fetch up to the
	// source log's current STH. Ignored in continuous mode which keeps updating
	// STH and fetching up to that.
	EndIndex int64 `protobuf:"varint,8,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// The number of parallel get-entries fetchers. Assumed equal to 1 if not
	// specified.
	NumFetchers int32 `protobuf:"varint,9,opt,name=num_fetchers,json=numFetchers,proto3" json:"num_fetchers,omitempty"`
	// The number of parallel workers submitting entries to Trillian. Assumed
	// equal to 1 if not specified.
	NumSubmitters int32 `protobuf:"varint,10,opt,name=num_submitters,json=numSubmitters,proto3" json:"num_submitters,omitempty"`
	// Max number of batches in fetchers->submitters channel.
	ChannelSize int32 `protobuf:"varint,11,opt,name=channel_size,json=channelSize,proto3" json:"channel_size,omitempty"`
	// The function that computes LeafIdentityHash for Trillian log entries.
	IdentityFunction IdentityFunction `` /* 142-byte string literal not displayed */
	// If set to false (by default), then Migrillian verifies that the tree as
	// seen by Trillian is consistent with the current STH of the source CT log.
	// It invokes the get-sth-consistency endpoint (section 4.4 of RFC 6962) with
	// the corresponding tree sizes, and verifies the returned proof.
	NoConsistencyCheck bool `protobuf:"varint,13,opt,name=no_consistency_check,json=noConsistencyCheck,proto3" json:"no_consistency_check,omitempty"`
	// contains filtered or unexported fields
}

MigrationConfig describes the configuration options for a single CT log migration instance.

func (*MigrationConfig) Descriptor deprecated 

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

Deprecated: Use MigrationConfig.ProtoReflect.Descriptor instead.

func (*MigrationConfig) GetBatchSize 

func (x *MigrationConfig) GetBatchSize() int32

func (*MigrationConfig) GetChannelSize added in v1.2.1 

func (x *MigrationConfig) GetChannelSize() int32

func (*MigrationConfig) GetEndIndex 

func (x *MigrationConfig) GetEndIndex() int64

func (*MigrationConfig) GetIdentityFunction added in v1.2.1 

func (x *MigrationConfig) GetIdentityFunction() IdentityFunction

func (*MigrationConfig) GetIsContinuous 

func (x *MigrationConfig) GetIsContinuous() bool

func (*MigrationConfig) GetLogBackendName deprecated 

func (x *MigrationConfig) GetLogBackendName() string

Deprecated: Do not use.

func (*MigrationConfig) GetLogId 

func (x *MigrationConfig) GetLogId() int64

func (*MigrationConfig) GetNoConsistencyCheck added in v1.2.1 

func (x *MigrationConfig) GetNoConsistencyCheck() bool

func (*MigrationConfig) GetNumFetchers added in v1.2.1 

func (x *MigrationConfig) GetNumFetchers() int32

func (*MigrationConfig) GetNumSubmitters added in v1.2.1 

func (x *MigrationConfig) GetNumSubmitters() int32

func (*MigrationConfig) GetPublicKey 

func (x *MigrationConfig) GetPublicKey() *keyspb.PublicKey

func (*MigrationConfig) GetSourceUri 

func (x *MigrationConfig) GetSourceUri() string

func (*MigrationConfig) GetStartIndex 

func (x *MigrationConfig) GetStartIndex() int64

func (*MigrationConfig) ProtoMessage 

func (*MigrationConfig) ProtoMessage()

func (*MigrationConfig) ProtoReflect added in v1.2.1 

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

func (*MigrationConfig) Reset 

func (x *MigrationConfig) Reset()

func (*MigrationConfig) String 

func (x *MigrationConfig) String() string

type MigrationConfigSet 

type MigrationConfigSet struct {
	Config []*MigrationConfig `protobuf:"bytes,1,rep,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

MigrationConfigSet is a set of MigrationConfig messages.

func (*MigrationConfigSet) Descriptor deprecated 

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

Deprecated: Use MigrationConfigSet.ProtoReflect.Descriptor instead.

func (*MigrationConfigSet) GetConfig 

func (x *MigrationConfigSet) GetConfig() []*MigrationConfig

func (*MigrationConfigSet) ProtoMessage 

func (*MigrationConfigSet) ProtoMessage()

func (*MigrationConfigSet) ProtoReflect added in v1.2.1 

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

func (*MigrationConfigSet) Reset 

func (x *MigrationConfigSet) Reset()

func (*MigrationConfigSet) String 

func (x *MigrationConfigSet) String() string

type MigrillianConfig 

type MigrillianConfig struct {

	// The set of backends that this configuration will use to send requests to.
	// The names of the backends in the LogBackendSet must all be distinct.
	//
	// Deprecated. TODO(pavelkalinnikov): Remove it.
	//
	// Deprecated: Do not use.
	Backends *configpb.LogBackendSet `protobuf:"bytes,1,opt,name=backends,proto3" json:"backends,omitempty"`
	// The set of migrations that will use the above backends. All the protos in
	// it must set a valid log_backend_name for the config to be usable.
	MigrationConfigs *MigrationConfigSet `protobuf:"bytes,2,opt,name=migration_configs,json=migrationConfigs,proto3" json:"migration_configs,omitempty"`
	// contains filtered or unexported fields
}

MigrillianConfig holds configuration for multiple migration / mirroring jobs.

func (*MigrillianConfig) Descriptor deprecated 

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

Deprecated: Use MigrillianConfig.ProtoReflect.Descriptor instead.

func (*MigrillianConfig) GetBackends deprecated 

func (x *MigrillianConfig) GetBackends() *configpb.LogBackendSet

Deprecated: Do not use.

func (*MigrillianConfig) GetMigrationConfigs 

func (x *MigrillianConfig) GetMigrationConfigs() *MigrationConfigSet

func (*MigrillianConfig) ProtoMessage 

func (*MigrillianConfig) ProtoMessage()

func (*MigrillianConfig) ProtoReflect added in v1.2.1 

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

func (*MigrillianConfig) Reset 

func (x *MigrillianConfig) Reset()

func (*MigrillianConfig) String 

func (x *MigrillianConfig) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.