trustbloc

Documentation

Overview

Package trustbloc implement trustbloc vdr

Index

• Constants
• type KeyRetriever
• type OperationType
• type Option
  • func EnableSignatureVerification(enable bool) Option
  • func UseGenesisFile(url, domain string, genesisFile []byte) Option
  • func WithAuthToken(authToken string) Option
  • func WithDocumentLoader(docLoader jsonld.DocumentLoader) Option
  • func WithDomain(domain string) Option
  • func WithResolverURL(resolverURL string) Option
  • func WithTLSConfig(tlsConfig *tls.Config) Option
• type VDR
  • func New(keyRetriever KeyRetriever, opts ...Option) (*VDR, error)
  • func (v *VDR) Accept(method string) bool
  • func (v *VDR) Close() error
  • func (v *VDR) Create(did *docdid.Doc, opts ...vdrapi.DIDMethodOption) (*docdid.DocResolution, error)
  • func (v *VDR) Deactivate(didID string, opts ...vdrapi.DIDMethodOption) error
  • func (v *VDR) Read(did string, opts ...vdrapi.DIDMethodOption) (*docdid.DocResolution, error)
  • func (v *VDR) Update(didDoc *docdid.Doc, opts ...vdrapi.DIDMethodOption) error
  • func (v *VDR) ValidateConsortium(consortiumDomain string) (*time.Duration, error)

Constants

const (
	// DIDMethod did method.
	DIDMethod = "trustbloc"
	// EndpointsOpt endpoints opt.
	EndpointsOpt = "endpoints"
	// UpdatePublicKeyOpt update public key opt.
	UpdatePublicKeyOpt = "updatePublicKey"
	// RecoveryPublicKeyOpt recovery public key opt.
	RecoveryPublicKeyOpt = "recoveryPublicKey"
	// RecoverOpt recover opt.
	RecoverOpt = "recover"
)

Types

type KeyRetriever

type KeyRetriever interface {
	GetNextRecoveryPublicKey(didID string) (crypto.PublicKey, error)
	GetNextUpdatePublicKey(didID string) (crypto.PublicKey, error)
	GetSigningKey(didID string, ot OperationType) (crypto.PrivateKey, error)
}

KeyRetriever key retriever.

type OperationType

type OperationType int

OperationType operation type.

const (
	// Update operation.
	Update OperationType = iota
	// Recover operation.
	Recover
)

type Option

type Option func(opts *VDR)

Option configures the bloc vdr.

func EnableSignatureVerification

func EnableSignatureVerification(enable bool) Option

EnableSignatureVerification enables signature verification.

func UseGenesisFile

func UseGenesisFile(url, domain string, genesisFile []byte) Option

UseGenesisFile adds a consortium genesis file to the VDR and enables consortium config update validation.

func WithAuthToken

func WithAuthToken(authToken string) Option

WithAuthToken add auth token.

func WithDocumentLoader

func WithDocumentLoader(docLoader jsonld.DocumentLoader) Option

WithDocumentLoader sets a JSON-LD document loader.

func WithDomain

func WithDomain(domain string) Option

WithDomain option is setting domain.

func WithResolverURL

func WithResolverURL(resolverURL string) Option

WithResolverURL option is setting resolver url.

func WithTLSConfig

func WithTLSConfig(tlsConfig *tls.Config) Option

WithTLSConfig option is for definition of secured HTTP transport using a tls.Config instance.

type VDR

type VDR struct {
	// contains filtered or unexported fields
}

VDR bloc.

func New

func New(keyRetriever KeyRetriever, opts ...Option) (*VDR, error)

New creates new bloc vdru.

func (*VDR) Accept

func (v *VDR) Accept(method string) bool

Accept did method.

func (*VDR) Close

func (v *VDR) Close() error

Close vdr.

func (*VDR) Create

func (v *VDR) Create(did *docdid.Doc,
	opts ...vdrapi.DIDMethodOption) (*docdid.DocResolution, error)

Create did doc. nolint: funlen,gocyclo

func (*VDR) Deactivate

func (v *VDR) Deactivate(didID string, opts ...vdrapi.DIDMethodOption) error

Deactivate did doc.

func (*VDR) Read

func (v *VDR) Read(did string, opts ...vdrapi.DIDMethodOption) (*docdid.DocResolution, error)

func (*VDR) Update

func (v *VDR) Update(didDoc *docdid.Doc, opts ...vdrapi.DIDMethodOption) error

Update did doc.

func (*VDR) ValidateConsortium

func (v *VDR) ValidateConsortium(consortiumDomain string) (*time.Duration, error)

ValidateConsortium validate the config and endorsement of a consortium and its stakeholders returns the duration after which the consortium config expires and needs re-validation.