docs/signer/signer.go

47 lines
1.4 KiB
Go

package signer
import (
pb "github.com/docker/notary/proto"
"github.com/docker/notary/signer/keys"
)
// SigningService is the interface to implement a key management and signing service
type SigningService interface {
KeyManager
// Signer returns a Signer for a given keyID
Signer(keyID *pb.KeyID) (Signer, error)
}
// SigningServiceIndex represents a mapping between a service algorithm string
// and a signing service
type SigningServiceIndex map[string]SigningService
// KeyManager is the interface to implement key management (possibly a key database)
type KeyManager interface {
// CreateKey creates a new key and returns it's Information
CreateKey() (*pb.PublicKey, error)
// DeleteKey removes a key
DeleteKey(keyID *pb.KeyID) (*pb.Void, error)
// KeyInfo returns the public key of a particular key
KeyInfo(keyID *pb.KeyID) (*pb.PublicKey, error)
}
// Signer is the interface that allows the signing service to return signatures
type Signer interface {
Sign(request *pb.SignatureRequest) (*pb.Signature, error)
}
// KeyDatabase is the interface that allows the implementation of multiple database backends
type KeyDatabase interface {
KeyManager
// GetKey returns the private key to do signing operations
GetKey(keyID *pb.KeyID) (*keys.Key, error)
// AddKey allows the direct addition and removal of keys from the database
AddKey(key *keys.Key) error
}