configpb

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Sep 2, 2020 License: Apache-2.0 Imports: 5 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",
}
View Source
var IdentityFunction_value = map[string]int32{
	"UNKNOWN_IDENTITY_FUNCTION": 0,
	"SHA256_CERT_DATA":          1,
	"SHA256_LEAF_INDEX":         2,
}

Functions

This section is empty.

Types

type IdentityFunction added in v1.1.2

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) EnumDescriptor added in v1.1.2

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

func (IdentityFunction) String added in v1.1.2

func (x IdentityFunction) String() string

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.
	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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*MigrationConfig) Descriptor

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

func (*MigrationConfig) GetBatchSize

func (m *MigrationConfig) GetBatchSize() int32

func (*MigrationConfig) GetChannelSize added in v1.1.2

func (m *MigrationConfig) GetChannelSize() int32

func (*MigrationConfig) GetEndIndex

func (m *MigrationConfig) GetEndIndex() int64

func (*MigrationConfig) GetIdentityFunction added in v1.1.2

func (m *MigrationConfig) GetIdentityFunction() IdentityFunction

func (*MigrationConfig) GetIsContinuous

func (m *MigrationConfig) GetIsContinuous() bool

func (*MigrationConfig) GetLogBackendName

func (m *MigrationConfig) GetLogBackendName() string

func (*MigrationConfig) GetLogId

func (m *MigrationConfig) GetLogId() int64

func (*MigrationConfig) GetNoConsistencyCheck added in v1.1.2

func (m *MigrationConfig) GetNoConsistencyCheck() bool

func (*MigrationConfig) GetNumFetchers added in v1.1.2

func (m *MigrationConfig) GetNumFetchers() int32

func (*MigrationConfig) GetNumSubmitters added in v1.1.2

func (m *MigrationConfig) GetNumSubmitters() int32

func (*MigrationConfig) GetPublicKey

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

func (*MigrationConfig) GetSourceUri

func (m *MigrationConfig) GetSourceUri() string

func (*MigrationConfig) GetStartIndex

func (m *MigrationConfig) GetStartIndex() int64

func (*MigrationConfig) ProtoMessage

func (*MigrationConfig) ProtoMessage()

func (*MigrationConfig) Reset

func (m *MigrationConfig) Reset()

func (*MigrationConfig) String

func (m *MigrationConfig) String() string

func (*MigrationConfig) XXX_DiscardUnknown

func (m *MigrationConfig) XXX_DiscardUnknown()

func (*MigrationConfig) XXX_Marshal

func (m *MigrationConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MigrationConfig) XXX_Merge

func (m *MigrationConfig) XXX_Merge(src proto.Message)

func (*MigrationConfig) XXX_Size

func (m *MigrationConfig) XXX_Size() int

func (*MigrationConfig) XXX_Unmarshal

func (m *MigrationConfig) XXX_Unmarshal(b []byte) error

type MigrationConfigSet

type MigrationConfigSet struct {
	Config               []*MigrationConfig `protobuf:"bytes,1,rep,name=config,proto3" json:"config,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

MigrationConfigSet is a set of MigrationConfig messages.

func (*MigrationConfigSet) Descriptor

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

func (*MigrationConfigSet) GetConfig

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

func (*MigrationConfigSet) ProtoMessage

func (*MigrationConfigSet) ProtoMessage()

func (*MigrationConfigSet) Reset

func (m *MigrationConfigSet) Reset()

func (*MigrationConfigSet) String

func (m *MigrationConfigSet) String() string

func (*MigrationConfigSet) XXX_DiscardUnknown

func (m *MigrationConfigSet) XXX_DiscardUnknown()

func (*MigrationConfigSet) XXX_Marshal

func (m *MigrationConfigSet) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MigrationConfigSet) XXX_Merge

func (m *MigrationConfigSet) XXX_Merge(src proto.Message)

func (*MigrationConfigSet) XXX_Size

func (m *MigrationConfigSet) XXX_Size() int

func (*MigrationConfigSet) XXX_Unmarshal

func (m *MigrationConfigSet) XXX_Unmarshal(b []byte) error

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.
	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"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

MigrillianConfig holds configuration for multiple migration / mirroring jobs.

func (*MigrillianConfig) Descriptor

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

func (*MigrillianConfig) GetBackends

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

func (*MigrillianConfig) GetMigrationConfigs

func (m *MigrillianConfig) GetMigrationConfigs() *MigrationConfigSet

func (*MigrillianConfig) ProtoMessage

func (*MigrillianConfig) ProtoMessage()

func (*MigrillianConfig) Reset

func (m *MigrillianConfig) Reset()

func (*MigrillianConfig) String

func (m *MigrillianConfig) String() string

func (*MigrillianConfig) XXX_DiscardUnknown

func (m *MigrillianConfig) XXX_DiscardUnknown()

func (*MigrillianConfig) XXX_Marshal

func (m *MigrillianConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MigrillianConfig) XXX_Merge

func (m *MigrillianConfig) XXX_Merge(src proto.Message)

func (*MigrillianConfig) XXX_Size

func (m *MigrillianConfig) XXX_Size() int

func (*MigrillianConfig) XXX_Unmarshal

func (m *MigrillianConfig) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

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