package proto

import "github.com/theupdateframework/notary/proto"

Package proto is a generated protocol buffer package.

It is generated from these files: 

signer.proto

It has these top-level messages: 

CreateKeyRequest
KeyInfo
KeyID
Algorithm
GetKeyInfoResponse
PublicKey
Signature
SignatureRequest
Void

Index

Functions

func RegisterKeyManagementServer 

func RegisterKeyManagementServer(s *grpc.Server, srv KeyManagementServer)

func RegisterSignerServer 

func RegisterSignerServer(s *grpc.Server, srv SignerServer)

Types

type Algorithm 

type Algorithm struct {
	Algorithm string `protobuf:"bytes,1,opt,name=algorithm" json:"algorithm,omitempty"`
}

Type holds the type of crypto algorithm used

func (*Algorithm) Descriptor 

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

func (*Algorithm) GetAlgorithm 

func (m *Algorithm) GetAlgorithm() string

func (*Algorithm) ProtoMessage 

func (*Algorithm) ProtoMessage()

func (*Algorithm) Reset 

func (m *Algorithm) Reset()

func (*Algorithm) String 

func (m *Algorithm) String() string

type CreateKeyRequest 

type CreateKeyRequest struct {
	Algorithm string `protobuf:"bytes,1,opt,name=algorithm" json:"algorithm,omitempty"`
	Gun       string `protobuf:"bytes,2,opt,name=gun" json:"gun,omitempty"`
	Role      string `protobuf:"bytes,3,opt,name=role" json:"role,omitempty"`
}

func (*CreateKeyRequest) Descriptor 

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

func (*CreateKeyRequest) GetAlgorithm 

func (m *CreateKeyRequest) GetAlgorithm() string

func (*CreateKeyRequest) GetGun 

func (m *CreateKeyRequest) GetGun() string

func (*CreateKeyRequest) GetRole 

func (m *CreateKeyRequest) GetRole() string

func (*CreateKeyRequest) ProtoMessage 

func (*CreateKeyRequest) ProtoMessage()

func (*CreateKeyRequest) Reset 

func (m *CreateKeyRequest) Reset()

func (*CreateKeyRequest) String 

func (m *CreateKeyRequest) String() string

type GetKeyInfoResponse 

type GetKeyInfoResponse struct {
	KeyInfo   *KeyInfo `protobuf:"bytes,1,opt,name=keyInfo" json:"keyInfo,omitempty"`
	PublicKey []byte   `protobuf:"bytes,2,opt,name=publicKey,proto3" json:"publicKey,omitempty"`
	Role      string   `protobuf:"bytes,3,opt,name=role" json:"role,omitempty"`
}

GetKeyInfoResponse returns the public key, the role, and the algorithm and key ID. For backwards compatibility, it doesn't embed a PublicKey object

func (*GetKeyInfoResponse) Descriptor 

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

func (*GetKeyInfoResponse) GetKeyInfo 

func (m *GetKeyInfoResponse) GetKeyInfo() *KeyInfo

func (*GetKeyInfoResponse) GetPublicKey 

func (m *GetKeyInfoResponse) GetPublicKey() []byte

func (*GetKeyInfoResponse) GetRole 

func (m *GetKeyInfoResponse) GetRole() string

func (*GetKeyInfoResponse) ProtoMessage 

func (*GetKeyInfoResponse) ProtoMessage()

func (*GetKeyInfoResponse) Reset 

func (m *GetKeyInfoResponse) Reset()

func (*GetKeyInfoResponse) String 

func (m *GetKeyInfoResponse) String() string

type KeyID 

type KeyID struct {
	ID string `protobuf:"bytes,1,opt,name=ID" json:"ID,omitempty"`
}

KeyID holds an ID that is used to reference the key

func (*KeyID) Descriptor 

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

func (*KeyID) GetID 

func (m *KeyID) GetID() string

func (*KeyID) ProtoMessage 

func (*KeyID) ProtoMessage()

func (*KeyID) Reset 

func (m *KeyID) Reset()

func (*KeyID) String 

func (m *KeyID) String() string

type KeyInfo 

type KeyInfo struct {
	KeyID     *KeyID     `protobuf:"bytes,1,opt,name=keyID" json:"keyID,omitempty"`
	Algorithm *Algorithm `protobuf:"bytes,2,opt,name=algorithm" json:"algorithm,omitempty"`
}

KeyInfo holds a KeyID that is used to reference the key and it's algorithm

func (*KeyInfo) Descriptor 

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

func (*KeyInfo) GetAlgorithm 

func (m *KeyInfo) GetAlgorithm() *Algorithm

func (*KeyInfo) GetKeyID 

func (m *KeyInfo) GetKeyID() *KeyID

func (*KeyInfo) ProtoMessage 

func (*KeyInfo) ProtoMessage()

func (*KeyInfo) Reset 

func (m *KeyInfo) Reset()

func (*KeyInfo) String 

func (m *KeyInfo) String() string

type KeyManagementClient 

type KeyManagementClient interface {
	// CreateKey creates as asymmetric key pair and returns the PublicKey
	CreateKey(ctx context.Context, in *CreateKeyRequest, opts ...grpc.CallOption) (*PublicKey, error)
	// DeleteKey deletes the key associated with a KeyID
	DeleteKey(ctx context.Context, in *KeyID, opts ...grpc.CallOption) (*Void, error)
	// GetKeyInfo returns the PublicKey associated with a KeyID
	GetKeyInfo(ctx context.Context, in *KeyID, opts ...grpc.CallOption) (*GetKeyInfoResponse, error)
}

func NewKeyManagementClient 

func NewKeyManagementClient(cc *grpc.ClientConn) KeyManagementClient

type KeyManagementServer 

type KeyManagementServer interface {
	// CreateKey creates as asymmetric key pair and returns the PublicKey
	CreateKey(context.Context, *CreateKeyRequest) (*PublicKey, error)
	// DeleteKey deletes the key associated with a KeyID
	DeleteKey(context.Context, *KeyID) (*Void, error)
	// GetKeyInfo returns the PublicKey associated with a KeyID
	GetKeyInfo(context.Context, *KeyID) (*GetKeyInfoResponse, error)
}

type PublicKey 

type PublicKey struct {
	KeyInfo   *KeyInfo `protobuf:"bytes,1,opt,name=keyInfo" json:"keyInfo,omitempty"`
	PublicKey []byte   `protobuf:"bytes,2,opt,name=publicKey,proto3" json:"publicKey,omitempty"`
}

PublicKey has a KeyInfo that is used to reference the key, and opaque bytes of a publicKey

func (*PublicKey) Descriptor 

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

func (*PublicKey) GetKeyInfo 

func (m *PublicKey) GetKeyInfo() *KeyInfo

func (*PublicKey) GetPublicKey 

func (m *PublicKey) GetPublicKey() []byte

func (*PublicKey) ProtoMessage 

func (*PublicKey) ProtoMessage()

func (*PublicKey) Reset 

func (m *PublicKey) Reset()

func (*PublicKey) String 

func (m *PublicKey) String() string

type Signature 

type Signature struct {
	KeyInfo   *KeyInfo   `protobuf:"bytes,1,opt,name=keyInfo" json:"keyInfo,omitempty"`
	Algorithm *Algorithm `protobuf:"bytes,2,opt,name=algorithm" json:"algorithm,omitempty"`
	Content   []byte     `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
}

Signature specifies a KeyInfo that was used for signing and signed content

func (*Signature) Descriptor 

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

func (*Signature) GetAlgorithm 

func (m *Signature) GetAlgorithm() *Algorithm

func (*Signature) GetContent 

func (m *Signature) GetContent() []byte

func (*Signature) GetKeyInfo 

func (m *Signature) GetKeyInfo() *KeyInfo

func (*Signature) ProtoMessage 

func (*Signature) ProtoMessage()

func (*Signature) Reset 

func (m *Signature) Reset()

func (*Signature) String 

func (m *Signature) String() string

type SignatureRequest 

type SignatureRequest struct {
	KeyID   *KeyID `protobuf:"bytes,1,opt,name=keyID" json:"keyID,omitempty"`
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
}

SignatureRequests specifies a KeyInfo, and content to be signed

func (*SignatureRequest) Descriptor 

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

func (*SignatureRequest) GetContent 

func (m *SignatureRequest) GetContent() []byte

func (*SignatureRequest) GetKeyID 

func (m *SignatureRequest) GetKeyID() *KeyID

func (*SignatureRequest) ProtoMessage 

func (*SignatureRequest) ProtoMessage()

func (*SignatureRequest) Reset 

func (m *SignatureRequest) Reset()

func (*SignatureRequest) String 

func (m *SignatureRequest) String() string

type SignerClient 

type SignerClient interface {
	// Sign calculates a cryptographic signature using the Key associated with a KeyID and returns the signature
	Sign(ctx context.Context, in *SignatureRequest, opts ...grpc.CallOption) (*Signature, error)
}

func NewSignerClient 

func NewSignerClient(cc *grpc.ClientConn) SignerClient

type SignerServer 

type SignerServer interface {
	// Sign calculates a cryptographic signature using the Key associated with a KeyID and returns the signature
	Sign(context.Context, *SignatureRequest) (*Signature, error)
}

type Void 

type Void struct {
}

Void represents an empty message type

func (*Void) Descriptor 

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

func (*Void) ProtoMessage 

func (*Void) ProtoMessage()

func (*Void) Reset 

func (m *Void) Reset()

func (*Void) String 

func (m *Void) String() string

Source Files

generator.go signer.pb.go

Version
v0.7.0 (latest)
Published
Jan 14, 2021
Platform
js/wasm
Imports
5 packages
Last checked
14 hours ago –

Tools for package owners.