key

Documentation

Index

• Constants
• type VDR
  • func New() *VDR
  • func (v *VDR) Accept(method string) bool
  • func (v *VDR) Close() error
  • func (v *VDR) Create(didDoc *did.Doc, opts ...vdrapi.DIDMethodOption) (*did.DocResolution, error)
  • func (v *VDR) Deactivate(didID string, opts ...vdrapi.DIDMethodOption) error
  • func (v *VDR) Read(didKey string, _ ...vdrapi.DIDMethodOption) (*did.DocResolution, error)
  • func (v *VDR) Update(didDoc *diddoc.Doc, opts ...vdrapi.DIDMethodOption) error

Constants

const (
	// DIDMethod did method.
	DIDMethod = "key"
	// EncryptionKey encryption key.
	EncryptionKey = "encryptionKey"
	// KeyType option to create a new kms key for DIDDocs with empty VerificationMethod.
	KeyType = "keyType"
)

Types

type VDR

type VDR struct{}

VDR implements did:key method support.

func New

func New() *VDR

New returns new instance of VDR that works with did:key method.

func (*VDR) Accept

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

Accept accepts did:key method.

func (*VDR) Close

func (v *VDR) Close() error

Close frees resources being maintained by VDR.

func (*VDR) Create

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

Create new DID document for didDoc. Either didDoc must contain non-empty VerificationMethod[] or opts must contain KeyType value of kms.KeyType to create a new key and a corresponding *VerificationMethod entry.

func (*VDR) Deactivate

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

Deactivate did doc.

func (*VDR) Read

func (v *VDR) Read(didKey string, _ ...vdrapi.DIDMethodOption) (*did.DocResolution, error)

Read expands did:key value to a DID document.

func (*VDR) Update

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

Update did doc.