v1

package
v1.0.8 Latest Latest
Warning

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

Go to latest
Published: Sep 25, 2023 License: Apache-2.0 Imports: 23 Imported by: 2

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var File_coinbase_cloud_mpc_keys_v1_mpc_keys_proto protoreflect.FileDescriptor
View Source
var MPCKeyService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "coinbase.cloud.mpc_keys.v1.MPCKeyService",
	HandlerType: (*MPCKeyServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "RegisterDevice",
			Handler:    _MPCKeyService_RegisterDevice_Handler,
		},
		{
			MethodName: "GetDevice",
			Handler:    _MPCKeyService_GetDevice_Handler,
		},
		{
			MethodName: "CreateDeviceGroup",
			Handler:    _MPCKeyService_CreateDeviceGroup_Handler,
		},
		{
			MethodName: "GetDeviceGroup",
			Handler:    _MPCKeyService_GetDeviceGroup_Handler,
		},
		{
			MethodName: "ListMPCOperations",
			Handler:    _MPCKeyService_ListMPCOperations_Handler,
		},
		{
			MethodName: "CreateMPCKey",
			Handler:    _MPCKeyService_CreateMPCKey_Handler,
		},
		{
			MethodName: "GetMPCKey",
			Handler:    _MPCKeyService_GetMPCKey_Handler,
		},
		{
			MethodName: "CreateSignature",
			Handler:    _MPCKeyService_CreateSignature_Handler,
		},
		{
			MethodName: "PrepareDeviceArchive",
			Handler:    _MPCKeyService_PrepareDeviceArchive_Handler,
		},
		{
			MethodName: "PrepareDeviceBackup",
			Handler:    _MPCKeyService_PrepareDeviceBackup_Handler,
		},
		{
			MethodName: "AddDevice",
			Handler:    _MPCKeyService_AddDevice_Handler,
		},
		{
			MethodName: "RevokeDevice",
			Handler:    _MPCKeyService_RevokeDevice_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "coinbase/cloud/mpc_keys/v1/mpc_keys.proto",
}

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

Functions

func RegisterMPCKeyServiceHandler

func RegisterMPCKeyServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMPCKeyServiceHandler registers the http handlers for service MPCKeyService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMPCKeyServiceHandlerClient

func RegisterMPCKeyServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MPCKeyServiceClient) error

RegisterMPCKeyServiceHandlerClient registers the http handlers for service MPCKeyService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MPCKeyServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MPCKeyServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MPCKeyServiceClient" to call the correct interceptors.

func RegisterMPCKeyServiceHandlerFromEndpoint

func RegisterMPCKeyServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMPCKeyServiceHandlerFromEndpoint is same as RegisterMPCKeyServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMPCKeyServiceHandlerServer

func RegisterMPCKeyServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MPCKeyServiceServer) error

RegisterMPCKeyServiceHandlerServer registers the http handlers for service MPCKeyService to "mux". UnaryRPC :call MPCKeyServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMPCKeyServiceHandlerFromEndpoint instead.

func RegisterMPCKeyServiceServer

func RegisterMPCKeyServiceServer(s grpc.ServiceRegistrar, srv MPCKeyServiceServer)

Types

type AddDeviceMetadata

type AddDeviceMetadata struct {

	// The resource name of the DeviceGroup to poll using ListMPCOperations.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// The list of Device resource names that can compute the MPCOperation by invoking ComputeAddDeviceMPCOperation on the
	// WaaS SDK.
	// Format: devices/{device_id}
	ParticipatingDevices []string `protobuf:"bytes,2,rep,name=participating_devices,json=participatingDevices,proto3" json:"participating_devices,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with the AddDevice long-running operation.

func (*AddDeviceMetadata) Descriptor deprecated

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

Deprecated: Use AddDeviceMetadata.ProtoReflect.Descriptor instead.

func (*AddDeviceMetadata) GetDeviceGroup

func (x *AddDeviceMetadata) GetDeviceGroup() string

func (*AddDeviceMetadata) GetParticipatingDevices

func (x *AddDeviceMetadata) GetParticipatingDevices() []string

func (*AddDeviceMetadata) ProtoMessage

func (*AddDeviceMetadata) ProtoMessage()

func (*AddDeviceMetadata) ProtoReflect

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

func (*AddDeviceMetadata) Reset

func (x *AddDeviceMetadata) Reset()

func (*AddDeviceMetadata) String

func (x *AddDeviceMetadata) String() string

type AddDeviceRequest

type AddDeviceRequest struct {

	// The resource name of the DeviceGroup to which the Device is being added.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// The resource name of the Device that is being added to the DeviceGroup.
	// The Device must not be part of the DeviceGroup specified above.
	// Format: devices/{device_id}
	Device string `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for AddDevice.

func (*AddDeviceRequest) Descriptor deprecated

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

Deprecated: Use AddDeviceRequest.ProtoReflect.Descriptor instead.

func (*AddDeviceRequest) GetDevice

func (x *AddDeviceRequest) GetDevice() string

func (*AddDeviceRequest) GetDeviceGroup

func (x *AddDeviceRequest) GetDeviceGroup() string

func (*AddDeviceRequest) GetRequestId

func (x *AddDeviceRequest) GetRequestId() string

func (*AddDeviceRequest) ProtoMessage

func (*AddDeviceRequest) ProtoMessage()

func (*AddDeviceRequest) ProtoReflect

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

func (*AddDeviceRequest) Reset

func (x *AddDeviceRequest) Reset()

func (*AddDeviceRequest) String

func (x *AddDeviceRequest) String() string

type CreateDeviceGroupMetadata

type CreateDeviceGroupMetadata struct {

	// The resource name of the DeviceGroup to poll using ListMPCOperations.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with the CreateDeviceGroup long-running operation.

func (*CreateDeviceGroupMetadata) Descriptor deprecated

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

Deprecated: Use CreateDeviceGroupMetadata.ProtoReflect.Descriptor instead.

func (*CreateDeviceGroupMetadata) GetDeviceGroup

func (x *CreateDeviceGroupMetadata) GetDeviceGroup() string

func (*CreateDeviceGroupMetadata) ProtoMessage

func (*CreateDeviceGroupMetadata) ProtoMessage()

func (*CreateDeviceGroupMetadata) ProtoReflect

func (*CreateDeviceGroupMetadata) Reset

func (x *CreateDeviceGroupMetadata) Reset()

func (*CreateDeviceGroupMetadata) String

func (x *CreateDeviceGroupMetadata) String() string

type CreateDeviceGroupRequest

type CreateDeviceGroupRequest struct {

	// The resource name of the parent Pool.
	// Format: pools/{pool_id}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The DeviceGroup to be created. This must contain exactly one registered Device, and
	// the contained Seed must have at least one HardenedChild.
	DeviceGroup *DeviceGroup `protobuf:"bytes,2,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// Optional: the ID to use for the DeviceGroup, which will become the final component
	// of the DeviceGroup's resource name. If not provided, the server will assign a DeviceGroup ID
	// automatically.
	DeviceGroupId string `protobuf:"bytes,3,opt,name=device_group_id,json=deviceGroupId,proto3" json:"device_group_id,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for CreateDeviceGroup.

func (*CreateDeviceGroupRequest) Descriptor deprecated

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

Deprecated: Use CreateDeviceGroupRequest.ProtoReflect.Descriptor instead.

func (*CreateDeviceGroupRequest) GetDeviceGroup

func (x *CreateDeviceGroupRequest) GetDeviceGroup() *DeviceGroup

func (*CreateDeviceGroupRequest) GetDeviceGroupId

func (x *CreateDeviceGroupRequest) GetDeviceGroupId() string

func (*CreateDeviceGroupRequest) GetParent

func (x *CreateDeviceGroupRequest) GetParent() string

func (*CreateDeviceGroupRequest) GetRequestId

func (x *CreateDeviceGroupRequest) GetRequestId() string

func (*CreateDeviceGroupRequest) ProtoMessage

func (*CreateDeviceGroupRequest) ProtoMessage()

func (*CreateDeviceGroupRequest) ProtoReflect

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

func (*CreateDeviceGroupRequest) Reset

func (x *CreateDeviceGroupRequest) Reset()

func (*CreateDeviceGroupRequest) String

func (x *CreateDeviceGroupRequest) String() string

type CreateMPCKeyRequest

type CreateMPCKeyRequest struct {

	// The resource name of the parent DeviceGroup.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The MPCKey to be created.
	MpcKey *MPCKey `protobuf:"bytes,2,opt,name=mpc_key,json=mpcKey,proto3" json:"mpc_key,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for CreateMPCKey.

func (*CreateMPCKeyRequest) Descriptor deprecated

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

Deprecated: Use CreateMPCKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateMPCKeyRequest) GetMpcKey

func (x *CreateMPCKeyRequest) GetMpcKey() *MPCKey

func (*CreateMPCKeyRequest) GetParent

func (x *CreateMPCKeyRequest) GetParent() string

func (*CreateMPCKeyRequest) GetRequestId

func (x *CreateMPCKeyRequest) GetRequestId() string

func (*CreateMPCKeyRequest) ProtoMessage

func (*CreateMPCKeyRequest) ProtoMessage()

func (*CreateMPCKeyRequest) ProtoReflect

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

func (*CreateMPCKeyRequest) Reset

func (x *CreateMPCKeyRequest) Reset()

func (*CreateMPCKeyRequest) String

func (x *CreateMPCKeyRequest) String() string

type CreateSignatureMetadata

type CreateSignatureMetadata struct {

	// The resource name of the DeviceGroup to poll using ListMPCOperations.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// The payload that is about to be signed. Check this value to ensure that the
	// correct payload is being signed.
	Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with the CreateSignature long-running operation.

func (*CreateSignatureMetadata) Descriptor deprecated

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

Deprecated: Use CreateSignatureMetadata.ProtoReflect.Descriptor instead.

func (*CreateSignatureMetadata) GetDeviceGroup

func (x *CreateSignatureMetadata) GetDeviceGroup() string

func (*CreateSignatureMetadata) GetPayload

func (x *CreateSignatureMetadata) GetPayload() []byte

func (*CreateSignatureMetadata) ProtoMessage

func (*CreateSignatureMetadata) ProtoMessage()

func (*CreateSignatureMetadata) ProtoReflect

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

func (*CreateSignatureMetadata) Reset

func (x *CreateSignatureMetadata) Reset()

func (*CreateSignatureMetadata) String

func (x *CreateSignatureMetadata) String() string

type CreateSignatureRequest

type CreateSignatureRequest struct {

	// The resource name of the parent MPCKey.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}/mpcKeys/{mpc_key_id}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The Signature to be created.
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for CreateSignature.

func (*CreateSignatureRequest) Descriptor deprecated

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

Deprecated: Use CreateSignatureRequest.ProtoReflect.Descriptor instead.

func (*CreateSignatureRequest) GetParent

func (x *CreateSignatureRequest) GetParent() string

func (*CreateSignatureRequest) GetRequestId

func (x *CreateSignatureRequest) GetRequestId() string

func (*CreateSignatureRequest) GetSignature

func (x *CreateSignatureRequest) GetSignature() *Signature

func (*CreateSignatureRequest) ProtoMessage

func (*CreateSignatureRequest) ProtoMessage()

func (*CreateSignatureRequest) ProtoReflect

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

func (*CreateSignatureRequest) Reset

func (x *CreateSignatureRequest) Reset()

func (*CreateSignatureRequest) String

func (x *CreateSignatureRequest) String() string

type Device

type Device struct {

	// The resource name of the Device.
	// Format: devices/{device_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The Device resource, which represents a single participant in the MPC protocol.

func (*Device) Descriptor deprecated

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetName

func (x *Device) GetName() string

func (*Device) ProtoMessage

func (*Device) ProtoMessage()

func (*Device) ProtoReflect

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

func (*Device) Reset

func (x *Device) Reset()

func (*Device) String

func (x *Device) String() string

type DeviceGroup

type DeviceGroup struct {

	// The resource name of the DeviceGroup.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The list of Device resource names associated with this DeviceGroup. On creation,
	// this list must have exactly one Device set.
	// Format: devices/{device_id}
	Devices []string `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"`
	// The Seed that corresponds to the DeviceGroup. On creation, the Seed must
	// have at least one HardenedChild set.
	Seed *Seed `protobuf:"bytes,3,opt,name=seed,proto3" json:"seed,omitempty"`
	// contains filtered or unexported fields
}

The DeviceGroup resource, which represents a collection of Devices that have access to the same set of Seed resources.

func (*DeviceGroup) Descriptor deprecated

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

Deprecated: Use DeviceGroup.ProtoReflect.Descriptor instead.

func (*DeviceGroup) GetDevices

func (x *DeviceGroup) GetDevices() []string

func (*DeviceGroup) GetName

func (x *DeviceGroup) GetName() string

func (*DeviceGroup) GetSeed

func (x *DeviceGroup) GetSeed() *Seed

func (*DeviceGroup) ProtoMessage

func (*DeviceGroup) ProtoMessage()

func (*DeviceGroup) ProtoReflect

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

func (*DeviceGroup) Reset

func (x *DeviceGroup) Reset()

func (*DeviceGroup) String

func (x *DeviceGroup) String() string

type DeviceGroupResourceName

type DeviceGroupResourceName struct {
	PoolId        string
	DeviceGroupId string
}

func (DeviceGroupResourceName) ContainsWildcard

func (n DeviceGroupResourceName) ContainsWildcard() bool

func (DeviceGroupResourceName) MPCKeyResourceName

func (n DeviceGroupResourceName) MPCKeyResourceName(
	mpcKeyId string,
) MPCKeyResourceName

func (DeviceGroupResourceName) MPCOperationResourceName

func (n DeviceGroupResourceName) MPCOperationResourceName(
	mpcOperationId string,
) MPCOperationResourceName

func (DeviceGroupResourceName) MarshalString

func (n DeviceGroupResourceName) MarshalString() (string, error)

func (DeviceGroupResourceName) SignatureResourceName

func (n DeviceGroupResourceName) SignatureResourceName(
	mpcKeyId string,
	signatureId string,
) SignatureResourceName

func (DeviceGroupResourceName) String

func (n DeviceGroupResourceName) String() string

func (*DeviceGroupResourceName) UnmarshalString

func (n *DeviceGroupResourceName) UnmarshalString(name string) error

func (DeviceGroupResourceName) Validate

func (n DeviceGroupResourceName) Validate() error

type DeviceResourceName

type DeviceResourceName struct {
	DeviceId string
}

func (DeviceResourceName) ContainsWildcard

func (n DeviceResourceName) ContainsWildcard() bool

func (DeviceResourceName) MarshalString

func (n DeviceResourceName) MarshalString() (string, error)

func (DeviceResourceName) String

func (n DeviceResourceName) String() string

func (*DeviceResourceName) UnmarshalString

func (n *DeviceResourceName) UnmarshalString(name string) error

func (DeviceResourceName) Validate

func (n DeviceResourceName) Validate() error

type GetDeviceGroupRequest

type GetDeviceGroupRequest struct {

	// The resource name of the DeviceGroup.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request message for GetDeviceGroup.

func (*GetDeviceGroupRequest) Descriptor deprecated

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

Deprecated: Use GetDeviceGroupRequest.ProtoReflect.Descriptor instead.

func (*GetDeviceGroupRequest) GetName

func (x *GetDeviceGroupRequest) GetName() string

func (*GetDeviceGroupRequest) ProtoMessage

func (*GetDeviceGroupRequest) ProtoMessage()

func (*GetDeviceGroupRequest) ProtoReflect

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

func (*GetDeviceGroupRequest) Reset

func (x *GetDeviceGroupRequest) Reset()

func (*GetDeviceGroupRequest) String

func (x *GetDeviceGroupRequest) String() string

type GetDeviceRequest

type GetDeviceRequest struct {

	// The resource name of the Device.
	// Format: devices/{device_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request message for GetDevice.

func (*GetDeviceRequest) Descriptor deprecated

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

Deprecated: Use GetDeviceRequest.ProtoReflect.Descriptor instead.

func (*GetDeviceRequest) GetName

func (x *GetDeviceRequest) GetName() string

func (*GetDeviceRequest) ProtoMessage

func (*GetDeviceRequest) ProtoMessage()

func (*GetDeviceRequest) ProtoReflect

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

func (*GetDeviceRequest) Reset

func (x *GetDeviceRequest) Reset()

func (*GetDeviceRequest) String

func (x *GetDeviceRequest) String() string

type GetMPCKeyRequest

type GetMPCKeyRequest struct {

	// The resource name of the MPCKey.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}/mpcKeys/{mpc_key_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request message for GetMPCKey.

func (*GetMPCKeyRequest) Descriptor deprecated

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

Deprecated: Use GetMPCKeyRequest.ProtoReflect.Descriptor instead.

func (*GetMPCKeyRequest) GetName

func (x *GetMPCKeyRequest) GetName() string

func (*GetMPCKeyRequest) ProtoMessage

func (*GetMPCKeyRequest) ProtoMessage()

func (*GetMPCKeyRequest) ProtoReflect

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

func (*GetMPCKeyRequest) Reset

func (x *GetMPCKeyRequest) Reset()

func (*GetMPCKeyRequest) String

func (x *GetMPCKeyRequest) String() string

type HardenedChild

type HardenedChild struct {

	// The derivation path to reach the hardened child from the Seed (i.e., the root
	// of the HD tree). Each integer in the derivation path is interpreted according
	// to BIP-44: m / purpose’ / coin_type’ / account’ / change / address_index.
	DerivationPath []int32 `protobuf:"varint,1,rep,packed,name=derivation_path,json=derivationPath,proto3" json:"derivation_path,omitempty"`
	// contains filtered or unexported fields
}

A child of a Seed in an HD tree that was produced using hardened derivation, as defined in BIP-32. All MPCKeys descend from a HardenedChild.

func (*HardenedChild) Descriptor deprecated

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

Deprecated: Use HardenedChild.ProtoReflect.Descriptor instead.

func (*HardenedChild) GetDerivationPath

func (x *HardenedChild) GetDerivationPath() []int32

func (*HardenedChild) ProtoMessage

func (*HardenedChild) ProtoMessage()

func (*HardenedChild) ProtoReflect

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

func (*HardenedChild) Reset

func (x *HardenedChild) Reset()

func (*HardenedChild) String

func (x *HardenedChild) String() string

type ListMPCOperationsRequest

type ListMPCOperationsRequest struct {

	// The resource name of the parent DeviceGroup.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

The request message for ListMPCOperations.

func (*ListMPCOperationsRequest) Descriptor deprecated

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

Deprecated: Use ListMPCOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListMPCOperationsRequest) GetParent

func (x *ListMPCOperationsRequest) GetParent() string

func (*ListMPCOperationsRequest) ProtoMessage

func (*ListMPCOperationsRequest) ProtoMessage()

func (*ListMPCOperationsRequest) ProtoReflect

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

func (*ListMPCOperationsRequest) Reset

func (x *ListMPCOperationsRequest) Reset()

func (*ListMPCOperationsRequest) String

func (x *ListMPCOperationsRequest) String() string

type ListMPCOperationsResponse

type ListMPCOperationsResponse struct {

	// The list of MPCOperations.
	MpcOperations []*MPCOperation `protobuf:"bytes,1,rep,name=mpc_operations,json=mpcOperations,proto3" json:"mpc_operations,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListMPCOperations.

func (*ListMPCOperationsResponse) Descriptor deprecated

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

Deprecated: Use ListMPCOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListMPCOperationsResponse) GetMpcOperations

func (x *ListMPCOperationsResponse) GetMpcOperations() []*MPCOperation

func (*ListMPCOperationsResponse) ProtoMessage

func (*ListMPCOperationsResponse) ProtoMessage()

func (*ListMPCOperationsResponse) ProtoReflect

func (*ListMPCOperationsResponse) Reset

func (x *ListMPCOperationsResponse) Reset()

func (*ListMPCOperationsResponse) String

func (x *ListMPCOperationsResponse) String() string

type MPCKey

type MPCKey struct {

	// The resource name of the MPCKey.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}/mpcKeys/{mpc_key_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The derivation path to reach this MPCKey from the Seed (i.e., the root
	// of the HD tree). There must be a HardenedChild in the Seed of the parent
	// DeviceGroup which is a prefix of this derivation path.
	// Each integer in the derivation path is interpreted according
	// to BIP-44: m / purpose’ / coin_type’ / account’ / change / address_index.
	DerivationPath []int32 `protobuf:"varint,2,rep,packed,name=derivation_path,json=derivationPath,proto3" json:"derivation_path,omitempty"`
	// The public portion of the MPCKey.
	PublicKey *v1.PublicKey `protobuf:"bytes,3,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// contains filtered or unexported fields
}

The MPCKey resource. An MPCKey can be used to participate in distributed M-of-N signing via the WaaS SDK. An MPCKey is created from a Seed.

func (*MPCKey) Descriptor deprecated

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

Deprecated: Use MPCKey.ProtoReflect.Descriptor instead.

func (*MPCKey) GetDerivationPath

func (x *MPCKey) GetDerivationPath() []int32

func (*MPCKey) GetName

func (x *MPCKey) GetName() string

func (*MPCKey) GetPublicKey

func (x *MPCKey) GetPublicKey() *v1.PublicKey

func (*MPCKey) ProtoMessage

func (*MPCKey) ProtoMessage()

func (*MPCKey) ProtoReflect

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

func (*MPCKey) Reset

func (x *MPCKey) Reset()

func (*MPCKey) String

func (x *MPCKey) String() string

type MPCKeyResourceName

type MPCKeyResourceName struct {
	PoolId        string
	DeviceGroupId string
	MpcKeyId      string
}

func (MPCKeyResourceName) ContainsWildcard

func (n MPCKeyResourceName) ContainsWildcard() bool

func (MPCKeyResourceName) DeviceGroupResourceName

func (n MPCKeyResourceName) DeviceGroupResourceName() DeviceGroupResourceName

func (MPCKeyResourceName) MarshalString

func (n MPCKeyResourceName) MarshalString() (string, error)

func (MPCKeyResourceName) SignatureResourceName

func (n MPCKeyResourceName) SignatureResourceName(
	signatureId string,
) SignatureResourceName

func (MPCKeyResourceName) String

func (n MPCKeyResourceName) String() string

func (*MPCKeyResourceName) UnmarshalString

func (n *MPCKeyResourceName) UnmarshalString(name string) error

func (MPCKeyResourceName) Validate

func (n MPCKeyResourceName) Validate() error

type MPCKeyServiceClient

type MPCKeyServiceClient interface {
	// Registers a new Device. A Device must be registered before it can be added to a DeviceGroup.
	RegisterDevice(ctx context.Context, in *RegisterDeviceRequest, opts ...grpc.CallOption) (*Device, error)
	// Retrieves a Device by resource name.
	GetDevice(ctx context.Context, in *GetDeviceRequest, opts ...grpc.CallOption) (*Device, error)
	// Creates a DeviceGroup. The DeviceGroup must contain exactly one registered Device, and
	// the Seed in the DeviceGroup must have at least one HardenedChild. After calling this,
	// use ListMPCOperations to poll for the pending CreateDeviceGroup operation, and use the WaaS SDK's
	// ComputeMPCOperation to complete the operation.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	CreateDeviceGroup(ctx context.Context, in *CreateDeviceGroupRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Retrieves a DeviceGroup by resource name.
	GetDeviceGroup(ctx context.Context, in *GetDeviceGroupRequest, opts ...grpc.CallOption) (*DeviceGroup, error)
	// Lists the pending MPCOperations awaiting computation associated with the given
	// parent DeviceGroup. Use this API in combination with the WaaS SDK's computeMPCOperation
	// method to complete the operation.
	ListMPCOperations(ctx context.Context, in *ListMPCOperationsRequest, opts ...grpc.CallOption) (*ListMPCOperationsResponse, error)
	// Creates an MPCKey. There must be a HardenedChild in the Seed of the parent
	// DeviceGroup which is a prefix of the derivation path provided in the MPCKey.
	CreateMPCKey(ctx context.Context, in *CreateMPCKeyRequest, opts ...grpc.CallOption) (*MPCKey, error)
	// Retrieves an MPCKey by resource name.
	GetMPCKey(ctx context.Context, in *GetMPCKeyRequest, opts ...grpc.CallOption) (*MPCKey, error)
	// Creates a Signature using an MPCKey. After calling this, use ListMPCOperations
	// to poll for the pending CreateSignature operation, and use the WaaS SDK's
	// computeMPCOperation to complete the operation.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	CreateSignature(ctx context.Context, in *CreateSignatureRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Prepares an archive in the local storage of the given Device. The archive contains cryptographic materials
	// that can be used to export MPCKeys, which have the given DeviceGroup as their parent.
	// The Device specified in the request must be a member of this DeviceGroup and must participate
	// in the associated MPC operation for the archive to be prepared. After calling this,
	// use ListMPCOperations to poll for the pending PrepareDeviceArchive operation, and use the WaaS SDK's
	// ComputeMPCOperation to complete the operation. Once the operation completes, the Device can utilize the
	// WaaS SDK to export the private keys corresponding to each of the MPCKeys under this DeviceGroup.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	PrepareDeviceArchive(ctx context.Context, in *PrepareDeviceArchiveRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Prepares a backup in the given Device. The backup contains certain cryptographic materials
	// that can be used to restore MPCKeys, which have the given DeviceGroup as their parent, on a new Device.
	// The Device specified in the request must be a member of this DeviceGroup and must participate in the associated
	// MPC operation for the backup to be prepared.
	// After calling this RPC, use ListMPCOperations to poll for the pending PrepareDeviceBackup operation,
	// and use the WaaS SDK's ComputeMPCOperation to complete the operation. Once the operation completes,
	// the Device can utilize WaaS SDK to download the backup bundle. We recommend storing this backup bundle securely
	// in a storage provider of your choice. If the user loses access to their existing Device and wants to recover
	// MPCKeys in the given DeviceGroup on a new Device, use AddDevice RPC on the MPCKeyService.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	PrepareDeviceBackup(ctx context.Context, in *PrepareDeviceBackupRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Adds a Device to an existing DeviceGroup. Prior to this API being called, the Device must be registered using
	// RegisterDevice RPC. The Device must have access to the backup created with PrepareDeviceBackup RPC to compute this
	// operation. After calling this RPC, use ListMPCOperations to poll for the pending AddDevice operation,
	// and use the WaaS SDK's ComputeAddDeviceMPCOperation to complete the operation.
	// After the operation is computed on WaaS SDK, the Device will have access to cryptographic materials
	// required to process MPCOperations for this DeviceGroup.
	// Once the operation completes on MPCKeyService, the Device will be added to the given DeviceGroup as a new member
	// and all existing Devices in the DeviceGroup will stay functional.
	// Use the RevokeDevice RPC to remove any of the existing Devices from the DeviceGroup.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	AddDevice(ctx context.Context, in *AddDeviceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Revokes a registered Device. This operation removes the registered Device from all the DeviceGroups that it is a
	// part of. Once the Device is revoked, cryptographic materials in your physical Device are invalidated,
	// and the Device can no longer participate in any MPCOperations of the DeviceGroups it was a part of.
	// Use this API in scenarios such as losing the existing Device, switching to a new physical Device, etc.
	// Ensure that a new Device is successfully added to your DeviceGroups using the AddDevice RPC before invoking
	// the RevokeDevice RPC.
	RevokeDevice(ctx context.Context, in *RevokeDeviceRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

MPCKeyServiceClient is the client API for MPCKeyService 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 MPCKeyServiceServer

type MPCKeyServiceServer interface {
	// Registers a new Device. A Device must be registered before it can be added to a DeviceGroup.
	RegisterDevice(context.Context, *RegisterDeviceRequest) (*Device, error)
	// Retrieves a Device by resource name.
	GetDevice(context.Context, *GetDeviceRequest) (*Device, error)
	// Creates a DeviceGroup. The DeviceGroup must contain exactly one registered Device, and
	// the Seed in the DeviceGroup must have at least one HardenedChild. After calling this,
	// use ListMPCOperations to poll for the pending CreateDeviceGroup operation, and use the WaaS SDK's
	// ComputeMPCOperation to complete the operation.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	CreateDeviceGroup(context.Context, *CreateDeviceGroupRequest) (*longrunning.Operation, error)
	// Retrieves a DeviceGroup by resource name.
	GetDeviceGroup(context.Context, *GetDeviceGroupRequest) (*DeviceGroup, error)
	// Lists the pending MPCOperations awaiting computation associated with the given
	// parent DeviceGroup. Use this API in combination with the WaaS SDK's computeMPCOperation
	// method to complete the operation.
	ListMPCOperations(context.Context, *ListMPCOperationsRequest) (*ListMPCOperationsResponse, error)
	// Creates an MPCKey. There must be a HardenedChild in the Seed of the parent
	// DeviceGroup which is a prefix of the derivation path provided in the MPCKey.
	CreateMPCKey(context.Context, *CreateMPCKeyRequest) (*MPCKey, error)
	// Retrieves an MPCKey by resource name.
	GetMPCKey(context.Context, *GetMPCKeyRequest) (*MPCKey, error)
	// Creates a Signature using an MPCKey. After calling this, use ListMPCOperations
	// to poll for the pending CreateSignature operation, and use the WaaS SDK's
	// computeMPCOperation to complete the operation.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	CreateSignature(context.Context, *CreateSignatureRequest) (*longrunning.Operation, error)
	// Prepares an archive in the local storage of the given Device. The archive contains cryptographic materials
	// that can be used to export MPCKeys, which have the given DeviceGroup as their parent.
	// The Device specified in the request must be a member of this DeviceGroup and must participate
	// in the associated MPC operation for the archive to be prepared. After calling this,
	// use ListMPCOperations to poll for the pending PrepareDeviceArchive operation, and use the WaaS SDK's
	// ComputeMPCOperation to complete the operation. Once the operation completes, the Device can utilize the
	// WaaS SDK to export the private keys corresponding to each of the MPCKeys under this DeviceGroup.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	PrepareDeviceArchive(context.Context, *PrepareDeviceArchiveRequest) (*longrunning.Operation, error)
	// Prepares a backup in the given Device. The backup contains certain cryptographic materials
	// that can be used to restore MPCKeys, which have the given DeviceGroup as their parent, on a new Device.
	// The Device specified in the request must be a member of this DeviceGroup and must participate in the associated
	// MPC operation for the backup to be prepared.
	// After calling this RPC, use ListMPCOperations to poll for the pending PrepareDeviceBackup operation,
	// and use the WaaS SDK's ComputeMPCOperation to complete the operation. Once the operation completes,
	// the Device can utilize WaaS SDK to download the backup bundle. We recommend storing this backup bundle securely
	// in a storage provider of your choice. If the user loses access to their existing Device and wants to recover
	// MPCKeys in the given DeviceGroup on a new Device, use AddDevice RPC on the MPCKeyService.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	PrepareDeviceBackup(context.Context, *PrepareDeviceBackupRequest) (*longrunning.Operation, error)
	// Adds a Device to an existing DeviceGroup. Prior to this API being called, the Device must be registered using
	// RegisterDevice RPC. The Device must have access to the backup created with PrepareDeviceBackup RPC to compute this
	// operation. After calling this RPC, use ListMPCOperations to poll for the pending AddDevice operation,
	// and use the WaaS SDK's ComputeAddDeviceMPCOperation to complete the operation.
	// After the operation is computed on WaaS SDK, the Device will have access to cryptographic materials
	// required to process MPCOperations for this DeviceGroup.
	// Once the operation completes on MPCKeyService, the Device will be added to the given DeviceGroup as a new member
	// and all existing Devices in the DeviceGroup will stay functional.
	// Use the RevokeDevice RPC to remove any of the existing Devices from the DeviceGroup.
	// Note: because the creation of MPC operations is asynchronous, ListMPCOperations may return a
	// NOT_FOUND error immediately after calling this. To complete the operation, continue polling
	// ListMPCOperations even after it returns a NOT_FOUND error.
	AddDevice(context.Context, *AddDeviceRequest) (*longrunning.Operation, error)
	// Revokes a registered Device. This operation removes the registered Device from all the DeviceGroups that it is a
	// part of. Once the Device is revoked, cryptographic materials in your physical Device are invalidated,
	// and the Device can no longer participate in any MPCOperations of the DeviceGroups it was a part of.
	// Use this API in scenarios such as losing the existing Device, switching to a new physical Device, etc.
	// Ensure that a new Device is successfully added to your DeviceGroups using the AddDevice RPC before invoking
	// the RevokeDevice RPC.
	RevokeDevice(context.Context, *RevokeDeviceRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

MPCKeyServiceServer is the server API for MPCKeyService service. All implementations must embed UnimplementedMPCKeyServiceServer for forward compatibility

type MPCOperation

type MPCOperation struct {

	// The resource name of the MPCOperation.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}/mpcOperations/{mpc_operation_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Data that should be passed to the WaaS SDK's computeMPCOperation function
	// to complete the operation.
	MpcData []byte `protobuf:"bytes,2,opt,name=mpc_data,json=mpcData,proto3" json:"mpc_data,omitempty"`
	// Metadata related to the MPC operation.
	//
	// Types that are assignable to Metadata:
	//	*MPCOperation_CreateDeviceGroupMetadata
	//	*MPCOperation_CreateSignatureMetadata
	//	*MPCOperation_PrepareDeviceArchiveMetadata
	//	*MPCOperation_PrepareDeviceBackupMetadata
	//	*MPCOperation_AddDeviceMetadata
	Metadata isMPCOperation_Metadata `protobuf_oneof:"metadata"`
	// contains filtered or unexported fields
}

The MPCOperation resource, which represents a pending MPC operation of a DeviceGroup waiting for computation. Poll the ListMPCOperations method for these pending MPCOperations, and use the WaaS SDK's ComputeMPCOperation to complete the operation. The MPCOperation resource ID is guaranteed to be the same as that of the underlying long-running operation.

func (*MPCOperation) Descriptor deprecated

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

Deprecated: Use MPCOperation.ProtoReflect.Descriptor instead.

func (*MPCOperation) GetAddDeviceMetadata

func (x *MPCOperation) GetAddDeviceMetadata() *AddDeviceMetadata

func (*MPCOperation) GetCreateDeviceGroupMetadata

func (x *MPCOperation) GetCreateDeviceGroupMetadata() *CreateDeviceGroupMetadata

func (*MPCOperation) GetCreateSignatureMetadata

func (x *MPCOperation) GetCreateSignatureMetadata() *CreateSignatureMetadata

func (*MPCOperation) GetMetadata

func (m *MPCOperation) GetMetadata() isMPCOperation_Metadata

func (*MPCOperation) GetMpcData

func (x *MPCOperation) GetMpcData() []byte

func (*MPCOperation) GetName

func (x *MPCOperation) GetName() string

func (*MPCOperation) GetPrepareDeviceArchiveMetadata

func (x *MPCOperation) GetPrepareDeviceArchiveMetadata() *PrepareDeviceArchiveMetadata

func (*MPCOperation) GetPrepareDeviceBackupMetadata

func (x *MPCOperation) GetPrepareDeviceBackupMetadata() *PrepareDeviceBackupMetadata

func (*MPCOperation) ProtoMessage

func (*MPCOperation) ProtoMessage()

func (*MPCOperation) ProtoReflect

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

func (*MPCOperation) Reset

func (x *MPCOperation) Reset()

func (*MPCOperation) String

func (x *MPCOperation) String() string

type MPCOperationResourceName

type MPCOperationResourceName struct {
	PoolId         string
	DeviceGroupId  string
	MpcOperationId string
}

func (MPCOperationResourceName) ContainsWildcard

func (n MPCOperationResourceName) ContainsWildcard() bool

func (MPCOperationResourceName) DeviceGroupResourceName

func (n MPCOperationResourceName) DeviceGroupResourceName() DeviceGroupResourceName

func (MPCOperationResourceName) MarshalString

func (n MPCOperationResourceName) MarshalString() (string, error)

func (MPCOperationResourceName) String

func (n MPCOperationResourceName) String() string

func (*MPCOperationResourceName) UnmarshalString

func (n *MPCOperationResourceName) UnmarshalString(name string) error

func (MPCOperationResourceName) Validate

func (n MPCOperationResourceName) Validate() error

type MPCOperation_AddDeviceMetadata

type MPCOperation_AddDeviceMetadata struct {
	// Metadata associated with the AddDevice long-running operation.
	AddDeviceMetadata *AddDeviceMetadata `protobuf:"bytes,7,opt,name=add_device_metadata,json=addDeviceMetadata,proto3,oneof"`
}

type MPCOperation_CreateDeviceGroupMetadata

type MPCOperation_CreateDeviceGroupMetadata struct {
	// Metadata associated with the CreateDeviceGroup long-running operation.
	CreateDeviceGroupMetadata *CreateDeviceGroupMetadata `protobuf:"bytes,3,opt,name=create_device_group_metadata,json=createDeviceGroupMetadata,proto3,oneof"`
}

type MPCOperation_CreateSignatureMetadata

type MPCOperation_CreateSignatureMetadata struct {
	// Metadata associated with the CreateSignature long-running operation.
	CreateSignatureMetadata *CreateSignatureMetadata `protobuf:"bytes,4,opt,name=create_signature_metadata,json=createSignatureMetadata,proto3,oneof"`
}

type MPCOperation_PrepareDeviceArchiveMetadata

type MPCOperation_PrepareDeviceArchiveMetadata struct {
	// Metadata associated with the PrepareDeviceArchive long-running operation.
	PrepareDeviceArchiveMetadata *PrepareDeviceArchiveMetadata `protobuf:"bytes,5,opt,name=prepare_device_archive_metadata,json=prepareDeviceArchiveMetadata,proto3,oneof"`
}

type MPCOperation_PrepareDeviceBackupMetadata

type MPCOperation_PrepareDeviceBackupMetadata struct {
	// Metadata associated with the PrepareDeviceBackup long-running operation.
	PrepareDeviceBackupMetadata *PrepareDeviceBackupMetadata `protobuf:"bytes,6,opt,name=prepare_device_backup_metadata,json=prepareDeviceBackupMetadata,proto3,oneof"`
}

type PrepareDeviceArchiveMetadata

type PrepareDeviceArchiveMetadata struct {

	// The resource name of the DeviceGroup to poll using ListMPCOperations.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with the PrepareDeviceArchive long-running operation.

func (*PrepareDeviceArchiveMetadata) Descriptor deprecated

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

Deprecated: Use PrepareDeviceArchiveMetadata.ProtoReflect.Descriptor instead.

func (*PrepareDeviceArchiveMetadata) GetDeviceGroup

func (x *PrepareDeviceArchiveMetadata) GetDeviceGroup() string

func (*PrepareDeviceArchiveMetadata) ProtoMessage

func (*PrepareDeviceArchiveMetadata) ProtoMessage()

func (*PrepareDeviceArchiveMetadata) ProtoReflect

func (*PrepareDeviceArchiveMetadata) Reset

func (x *PrepareDeviceArchiveMetadata) Reset()

func (*PrepareDeviceArchiveMetadata) String

type PrepareDeviceArchiveRequest

type PrepareDeviceArchiveRequest struct {

	// The resource name of the DeviceGroup. The prepared archive will include cryptographic materials to export the
	// private keys corresponding to each of the MPCKey under this DeviceGroup.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// The resource name of the Device that prepares the archive in its local storage.
	// The Device must be part of the DeviceGroup specified above.
	// Format: devices/{device_id}
	Device string `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for PrepareDeviceArchive.

func (*PrepareDeviceArchiveRequest) Descriptor deprecated

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

Deprecated: Use PrepareDeviceArchiveRequest.ProtoReflect.Descriptor instead.

func (*PrepareDeviceArchiveRequest) GetDevice

func (x *PrepareDeviceArchiveRequest) GetDevice() string

func (*PrepareDeviceArchiveRequest) GetDeviceGroup

func (x *PrepareDeviceArchiveRequest) GetDeviceGroup() string

func (*PrepareDeviceArchiveRequest) GetRequestId

func (x *PrepareDeviceArchiveRequest) GetRequestId() string

func (*PrepareDeviceArchiveRequest) ProtoMessage

func (*PrepareDeviceArchiveRequest) ProtoMessage()

func (*PrepareDeviceArchiveRequest) ProtoReflect

func (*PrepareDeviceArchiveRequest) Reset

func (x *PrepareDeviceArchiveRequest) Reset()

func (*PrepareDeviceArchiveRequest) String

func (x *PrepareDeviceArchiveRequest) String() string

type PrepareDeviceBackupMetadata

type PrepareDeviceBackupMetadata struct {

	// The resource name of the DeviceGroup to poll using ListMPCOperations.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with the PrepareDeviceBackup long-running operation.

func (*PrepareDeviceBackupMetadata) Descriptor deprecated

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

Deprecated: Use PrepareDeviceBackupMetadata.ProtoReflect.Descriptor instead.

func (*PrepareDeviceBackupMetadata) GetDeviceGroup

func (x *PrepareDeviceBackupMetadata) GetDeviceGroup() string

func (*PrepareDeviceBackupMetadata) ProtoMessage

func (*PrepareDeviceBackupMetadata) ProtoMessage()

func (*PrepareDeviceBackupMetadata) ProtoReflect

func (*PrepareDeviceBackupMetadata) Reset

func (x *PrepareDeviceBackupMetadata) Reset()

func (*PrepareDeviceBackupMetadata) String

func (x *PrepareDeviceBackupMetadata) String() string

type PrepareDeviceBackupRequest

type PrepareDeviceBackupRequest struct {

	// The resource name of the DeviceGroup. The prepared backup will include cryptographic materials to recover the
	// MPCKeys under this DeviceGroup on a new Device.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}
	DeviceGroup string `protobuf:"bytes,1,opt,name=device_group,json=deviceGroup,proto3" json:"device_group,omitempty"`
	// The resource name of the Device that prepares the backup.
	// The Device must be part of the DeviceGroup specified above.
	// Format: devices/{device_id}
	Device string `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for PrepareDeviceBackup.

func (*PrepareDeviceBackupRequest) Descriptor deprecated

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

Deprecated: Use PrepareDeviceBackupRequest.ProtoReflect.Descriptor instead.

func (*PrepareDeviceBackupRequest) GetDevice

func (x *PrepareDeviceBackupRequest) GetDevice() string

func (*PrepareDeviceBackupRequest) GetDeviceGroup

func (x *PrepareDeviceBackupRequest) GetDeviceGroup() string

func (*PrepareDeviceBackupRequest) GetRequestId

func (x *PrepareDeviceBackupRequest) GetRequestId() string

func (*PrepareDeviceBackupRequest) ProtoMessage

func (*PrepareDeviceBackupRequest) ProtoMessage()

func (*PrepareDeviceBackupRequest) ProtoReflect

func (*PrepareDeviceBackupRequest) Reset

func (x *PrepareDeviceBackupRequest) Reset()

func (*PrepareDeviceBackupRequest) String

func (x *PrepareDeviceBackupRequest) String() string

type RegisterDeviceRequest

type RegisterDeviceRequest struct {

	// Data required to register the Device. This should be gotten from the WaaS SDK's
	// getRegistrationData method.
	RegistrationData []byte `protobuf:"bytes,1,opt,name=registration_data,json=registrationData,proto3" json:"registration_data,omitempty"`
	// A user-provided request ID to allow for idempotency. This should be a UUID.
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

The request message for RegisterDevice.

func (*RegisterDeviceRequest) Descriptor deprecated

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

Deprecated: Use RegisterDeviceRequest.ProtoReflect.Descriptor instead.

func (*RegisterDeviceRequest) GetRegistrationData

func (x *RegisterDeviceRequest) GetRegistrationData() []byte

func (*RegisterDeviceRequest) GetRequestId

func (x *RegisterDeviceRequest) GetRequestId() string

func (*RegisterDeviceRequest) ProtoMessage

func (*RegisterDeviceRequest) ProtoMessage()

func (*RegisterDeviceRequest) ProtoReflect

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

func (*RegisterDeviceRequest) Reset

func (x *RegisterDeviceRequest) Reset()

func (*RegisterDeviceRequest) String

func (x *RegisterDeviceRequest) String() string

type RevokeDeviceRequest

type RevokeDeviceRequest struct {

	// The resource name of the Device that is being revoked.
	// Format: devices/{device_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request message for RevokeDevice.

func (*RevokeDeviceRequest) Descriptor deprecated

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

Deprecated: Use RevokeDeviceRequest.ProtoReflect.Descriptor instead.

func (*RevokeDeviceRequest) GetName

func (x *RevokeDeviceRequest) GetName() string

func (*RevokeDeviceRequest) ProtoMessage

func (*RevokeDeviceRequest) ProtoMessage()

func (*RevokeDeviceRequest) ProtoReflect

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

func (*RevokeDeviceRequest) Reset

func (x *RevokeDeviceRequest) Reset()

func (*RevokeDeviceRequest) String

func (x *RevokeDeviceRequest) String() string

type Seed

type Seed struct {

	// The hardened children derived from the Seed. To create an MPCKey,
	// at least one hardened child must be derived.
	HardenedChildren []*HardenedChild `protobuf:"bytes,1,rep,name=hardened_children,json=hardenedChildren,proto3" json:"hardened_children,omitempty"`
	// The metadata to be used to export MPCKeys derived from this Seed. This metadata has to be passed to the
	// WaaS SDK's ExportPrivateKeys to export private keys corresponding to MPCKeys that are derived from this Seed's
	// HardenedChildren.
	MpcKeyExportMetadata []byte `protobuf:"bytes,2,opt,name=mpc_key_export_metadata,json=mpcKeyExportMetadata,proto3" json:"mpc_key_export_metadata,omitempty"`
	// contains filtered or unexported fields
}

A byte sequence at the root of a hierarchically deterministic (HD) wallet as defined in BIP-32. A DeviceGroup has exactly one Seed.

func (*Seed) Descriptor deprecated

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

Deprecated: Use Seed.ProtoReflect.Descriptor instead.

func (*Seed) GetHardenedChildren

func (x *Seed) GetHardenedChildren() []*HardenedChild

func (*Seed) GetMpcKeyExportMetadata

func (x *Seed) GetMpcKeyExportMetadata() []byte

func (*Seed) ProtoMessage

func (*Seed) ProtoMessage()

func (*Seed) ProtoReflect

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

func (*Seed) Reset

func (x *Seed) Reset()

func (*Seed) String

func (x *Seed) String() string

type Signature

type Signature struct {

	// The resource name of the Signature.
	// Format: pools/{pool_id}/deviceGroups/{device_group_id}/mpcKeys/{mpc_key_id}/signatures/{signature_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The payload to sign with the MPCKey.
	Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// The payload which has been signed with the MPCKey.
	Signature *v1.Signature `protobuf:"bytes,3,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

The Signature resource. Signatures can be created with distributed M-of-N signing using MPCKeys via the WaaS SDK.

func (*Signature) Descriptor deprecated

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

Deprecated: Use Signature.ProtoReflect.Descriptor instead.

func (*Signature) GetName

func (x *Signature) GetName() string

func (*Signature) GetPayload

func (x *Signature) GetPayload() []byte

func (*Signature) GetSignature

func (x *Signature) GetSignature() *v1.Signature

func (*Signature) ProtoMessage

func (*Signature) ProtoMessage()

func (*Signature) ProtoReflect

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

func (*Signature) Reset

func (x *Signature) Reset()

func (*Signature) String

func (x *Signature) String() string

type SignatureResourceName

type SignatureResourceName struct {
	PoolId        string
	DeviceGroupId string
	MpcKeyId      string
	SignatureId   string
}

func (SignatureResourceName) ContainsWildcard

func (n SignatureResourceName) ContainsWildcard() bool

func (SignatureResourceName) DeviceGroupResourceName

func (n SignatureResourceName) DeviceGroupResourceName() DeviceGroupResourceName

func (SignatureResourceName) MPCKeyResourceName

func (n SignatureResourceName) MPCKeyResourceName() MPCKeyResourceName

func (SignatureResourceName) MarshalString

func (n SignatureResourceName) MarshalString() (string, error)

func (SignatureResourceName) String

func (n SignatureResourceName) String() string

func (*SignatureResourceName) UnmarshalString

func (n *SignatureResourceName) UnmarshalString(name string) error

func (SignatureResourceName) Validate

func (n SignatureResourceName) Validate() error

type UnimplementedMPCKeyServiceServer

type UnimplementedMPCKeyServiceServer struct {
}

UnimplementedMPCKeyServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedMPCKeyServiceServer) AddDevice

func (UnimplementedMPCKeyServiceServer) CreateDeviceGroup

func (UnimplementedMPCKeyServiceServer) CreateMPCKey

func (UnimplementedMPCKeyServiceServer) CreateSignature

func (UnimplementedMPCKeyServiceServer) GetDevice

func (UnimplementedMPCKeyServiceServer) GetDeviceGroup

func (UnimplementedMPCKeyServiceServer) GetMPCKey

func (UnimplementedMPCKeyServiceServer) ListMPCOperations

func (UnimplementedMPCKeyServiceServer) PrepareDeviceArchive

func (UnimplementedMPCKeyServiceServer) PrepareDeviceBackup

func (UnimplementedMPCKeyServiceServer) RegisterDevice

func (UnimplementedMPCKeyServiceServer) RevokeDevice

type UnsafeMPCKeyServiceServer

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

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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