package
0.1.8
Repository: https://github.com/trustbloc/edge-core.git
Documentation: pkg.go.dev

# Functions

CompressZCAP compresses capability into base64 encoded string.
DecompressZCAP uncompresses base64 encoded string into capability.
NewCapability constructs a new, signed Capability with the options provided.
NewDIDKeyResolver creates new DID resolver.
NewHTTPSigAuthHandler authenticates and authorizes a request before forwarding to 'next'.
NewVerifier returns a new Verifier.
ParseCapability parses a Capability.
WithAllowedActions sets the actions allowed by the Capability.
WithCapabilityChain specifies the capabilityChain on the proof for the Capability.
WithCaveats sets the caveats allowed by the Capability.
WithChallenge sets the challenge to include in the proof.
WithController identifies the controller of the Capability.
WithDelegator identifies the delegator of the Capability.
WithDomain sets the domain to include in the proof.
WithID overrides the default ID (urn:uuid:<uuid value>) used.
WithInvocationTarget sets the invocation target on the Capability.
WithInvoker identifies the invoker of the Capability.
WithLDDocumentLoaders sets the JSON-LD document loaders for the Verifier.
WithParent identifies the parent Capability.
WithSignatureSuites sets the signature suites supported by the Verifier.

# Constants

CapabilityInvocationHTTPHeader is the HTTP header expected on zcap'ed HTTP requests.
Caveat types.
ProofPurpose is the proofPurpose set on proofs in ZCAP-LD documents.
SecurityContextV2 is the JSON-LD context used in ZCAP-LD documents.

# Structs

AriesDIDKeySecrets is a secrets storage that can return did:key httpsignatures.Secrets.
AriesDIDKeySignatureHashAlgorithm is a custom httpsignatures.SignatureHashAlgorithm composed of the aries framework's KMS and Crypto apis, and designed to work with did:key.
Capability is a ZCAP.
CapabilityInvocation describes the parameters for invocation of a capability.
CapabilityOptions configures capabilities.
Caveat is a restriction on how capability may be used.
DIDKeyResolver resolves verification keys from did:key URLs: https://w3c-ccg.github.io/did-method-key/.
HTTPSigAuthConfig configures the HTTP auth handler.
InvocationExpectations are set by the application's context as parameters to expect for any given invocation.
InvocationTarget is the target on which the capability applies.
Proof describes the capability, the action, and the verification method of an invocation.
Signer signs the Capability.
VerificationMethod to use to verify an invocation.
VerificationOptions holds options for the Verifier.
Verifier verifies zcaps.

# Interfaces

CapabilityResolver resolves capabilities.
KeyResolver resolves verification keys.
VDRResolver represents VDR resolver.

# Type aliases

CapabilityOption configures CapabilityOptions.
SimpleCapabilityResolver enables in-memory capability resolvers based on maps.
SimpleKeyResolver enables in-memory key resolvers based on maps.
VerificationOption sets an option for the Verifier.