package
5.4.9+incompatible
Repository: https://github.com/nuts-foundation/nuts-node.git
Documentation: pkg.go.dev
# Functions
NewMockDocCreator creates a new mock instance.
NewMockDocFinder creates a new mock instance.
NewMockDocManipulator creates a new mock instance.
NewMockDocResolver creates a new mock instance.
NewMockDocumentOwner creates a new mock instance.
NewMockDocUpdater creates a new mock instance.
NewMockDocWriter creates a new mock instance.
NewMockKeyResolver creates a new mock instance.
NewMockPredicate creates a new mock instance.
NewMockServiceResolver creates a new mock instance.
NewMockVDR creates a new mock instance.
# Constants
No description provided by the author
AssertionMethodUsage indicates if the generated key pair can be used for assertions.
No description provided by the author
AuthenticationUsage indicates if the generated key pair can be used for authentication.
BaseURLServiceType is type of the DID service which holds the base URL of the node's HTTP services, exposed to other Nuts nodes.
No description provided by the author
CapabilityDelegationUsage indicates if the generated key pair can be used for altering DID Documents.
No description provided by the author
CapabilityInvocationUsage indicates if the generated key pair can be used for capability invocations.
No description provided by the author
KeyAgreementUsage indicates if the generated key pair can be used for Key agreements.
# Variables
ErrDeactivated signals rejection due to document deactivation.
ErrDIDAlreadyExists is returned when a DID already exists.
ErrDIDNotManagedByThisNode is returned when an operation needs the private key and if is not found on this host.
ErrDuplicateService is returned when a DID Document contains a multiple services with the same type.
ErrKeyNotFound is returned when a particular key or type of key is not found.
ErrNoActiveController The DID supplied to the DID resolution does not have any active controllers.
ErrNotFound The DID resolver was unable to find the DID document resulting from this resolution request.
ErrServiceNotFound is returned when the service is not found on a DID.
ErrServiceReferenceToDeep is returned when a service reference is chain is nested too deeply.
# Structs
DIDCreationOptions defines options for creating a DID Document.
DocumentMetadata holds the metadata of a DID document.
MockDocCreator is a mock of DocCreator interface.
MockDocCreatorMockRecorder is the mock recorder for MockDocCreator.
MockDocFinder is a mock of DocFinder interface.
MockDocFinderMockRecorder is the mock recorder for MockDocFinder.
MockDocManipulator is a mock of DocManipulator interface.
MockDocManipulatorMockRecorder is the mock recorder for MockDocManipulator.
MockDocResolver is a mock of DocResolver interface.
MockDocResolverMockRecorder is the mock recorder for MockDocResolver.
MockDocumentOwner is a mock of DocumentOwner interface.
MockDocumentOwnerMockRecorder is the mock recorder for MockDocumentOwner.
MockDocUpdater is a mock of DocUpdater interface.
MockDocUpdaterMockRecorder is the mock recorder for MockDocUpdater.
MockDocWriter is a mock of DocWriter interface.
MockDocWriterMockRecorder is the mock recorder for MockDocWriter.
MockKeyResolver is a mock of KeyResolver interface.
MockKeyResolverMockRecorder is the mock recorder for MockKeyResolver.
MockPredicate is a mock of Predicate interface.
MockPredicateMockRecorder is the mock recorder for MockPredicate.
MockServiceResolver is a mock of ServiceResolver interface.
MockServiceResolverMockRecorder is the mock recorder for MockServiceResolver.
MockVDR is a mock of VDR interface.
MockVDRMockRecorder is the mock recorder for MockVDR.
ResolveMetadata contains metadata for the resolver.
# Interfaces
DocCreator is the interface that wraps the Create method.
DocFinder is the interface that groups all methods for finding DID documents based on search conditions.
DocManipulator groups several higher level methods to alter the state of a DID document.
DocResolver is the interface that groups all the DID Document read methods.
DocumentOwner is the interface for checking DID document ownership (presence of private keys).
DocUpdater is the interface that defines functions that alter the state of a DID document.
DocWriter is the interface that groups al the DID Document write methods.
KeyResolver is the interface for resolving keys.
Predicate is an interface for abstracting search options on DID documents.
ServiceResolver allows looking up DID document services, following references.
VDR defines the public end facing methods for the Verifiable Data Registry.
# Type aliases
CompoundService is a service type that can be used as target for github.com/nuts-foundation/go-did/did/document.go#UnmarshalServiceEndpoint.
DIDKeyFlags is a bitmask used for specifying for what purposes a key in a DID document can be used (a.k.a.
DocIterator is the function type for iterating over the all current DID Documents in the store.
RelationType is the type that contains the different possible relationships between a DID Document and a VerificationMethod They are defined in the DID spec: https://www.w3.org/TR/did-core/#verification-relationships.