@interop/zcap 10.0.2 → 11.0.0

package/types/lib/utils.d.ts

@@ -1,304 +0,0 @@
-/**
- * Creates a root capability from a root controller and a root invocation
- * target.
- *
- * @param {object} options - The options.
- * @param {string|string[]} options.controller - The root controller.
- * @param {string} options.invocationTarget - The root invocation target.
- *
- * @returns {IRootZcap} The root capability.
- */
-export function createRootCapability({ controller, invocationTarget }: {
-    controller: string | string[];
-    invocationTarget: string;
-}): IRootZcap;
-/**
- * Retrieves the controller(s) from a capability.
- *
- * @param {object} options - The options.
- * @param {IZcap} options.capability - The authorization capability (zcap).
- *
- * @returns {string[]} The controller(s) for the capability.
- */
-export function getControllers({ capability }: {
-    capability: IZcap;
-}): string[];
-/**
- * Returns true if the given verification method is a controller (or is
- * controlled by a controller) of the given capability.
- *
- * @param {object} options - The options.
- * @param {IZcap} options.capability - The authorization capability (zcap).
- * @param {object} options.verificationMethod - The verification method to
- *   check.
- *
- * @returns {boolean} `true` if the controller matches, `false` if not.
- */
-export function isController({ capability, verificationMethod }: {
-    capability: IZcap;
-    verificationMethod: object;
-}): boolean;
-/**
- * Retrieves the allowed actions from a capability.
- *
- * @param {object} options - The options.
- * @param {IZcap} options.capability - The authorization capability (zcap).
- *
- * @returns {string[]} Allowed actions.
- */
-export function getAllowedActions({ capability }: {
-    capability: IZcap;
-}): string[];
-/**
- * Retrieves the target from a capability.
- *
- * @param {object} options - The options.
- * @param {IZcap} options.capability - The authorization capability (zcap).
- *
- * @returns {string} - Capability target.
- */
-export function getTarget({ capability }: {
-    capability: IZcap;
-}): string;
-/**
- * Retrieves the delegation proof(s) for a capability that is associated with
- * its parent capability. A capability that has no parent or no associated
- * delegation proofs will cause this function to return an empty array.
- *
- * @param {object} options - The options.
- * @param {IZcap} options.capability - The authorization capability.
- *
- * @returns {ICapabilityDelegationProof[]} Any `capabilityDelegation` proof
- *   objects attached to the given capability.
- */
-export function getDelegationProofs({ capability }: {
-    capability: IZcap;
-}): ICapabilityDelegationProof[];
-/**
- * Gets the `capabilityChain` associated with the given capability.
- *
- * @param {object} options - The options.
- * @param {IZcap} options.capability - The authorization capability.
- *
- * @returns {Array<string|IDelegatedZcap>} The capability chain entries
- *   (root to parent), as stored in the delegation proof.
- */
-export function getCapabilityChain({ capability }: {
-    capability: IZcap;
-}): Array<string | IDelegatedZcap>;
-/**
- * Determines if the given `invocationTarget` is valid given a
- * `baseInvocationTarget`.
- *
- * To check for a proper delegation, `invocationTarget` must be the child
- * capability's `invocationTarget` and `baseInvocationTarget` must be the
- * parent capability's `invocationTarget`.
- *
- * To check for a proper invocation, `invocationTarget` must be the value from
- * the invocation proof and `baseInvocationTarget` must be the invoked
- * capability's `invocationTarget`.
- *
- * @param {object} options - The options.
- * @param {string} options.invocationTarget - The invocation target to check.
- * @param {string} options.baseInvocationTarget - The base invocation target.
- * @param {boolean} options.allowTargetAttenuation - `true` to allow target
- *   attenuation.
- *
- * @returns {boolean} `true` if the target is valid, `false` if not.
- */
-export function isValidTarget({ invocationTarget, baseInvocationTarget, allowTargetAttenuation }: {
-    invocationTarget: string;
-    baseInvocationTarget: string;
-    allowTargetAttenuation: boolean;
-}): boolean;
-/**
- * Creates a capability chain for delegating a capability from the
- * given `parentCapability`.
- *
- * @param {object} options - The options.
- * @param {string|IZcap} options.parentCapability - The parent capability from
- *   which to compute the capability chain (a root zcap ID string, or a full
- *   root or delegated zcap object).
- * @param {boolean} options._skipLocalValidationForTesting - Private.
- *
- * @returns {Array<string|IDelegatedZcap>} The computed capability chain to be
- *   included in a capability delegation proof.
- */
-export function computeCapabilityChain({ parentCapability, _skipLocalValidationForTesting }: {
-    parentCapability: string | IZcap;
-    _skipLocalValidationForTesting: boolean;
-}): Array<string | IDelegatedZcap>;
-/**
- * Dereferences the capability chain associated with the given capability,
- * ensuring it passes a number of validation checks.
- *
- * A delegated zcap's chain has a reference to a root zcap. A verifier must
- * provide a hook (`getRootCapability`) to dereference this root zcap since
- * the root zcap has no delegation proof and must therefore be trusted by
- * the verifier. If the root zcap can't be dereferenced by the trusted hook,
- * then an authorization error must be thrown by that hook.
- *
- * This function will dereference the root zcap and then dereference all of
- * the embedded delegated zcaps from the chain, combining them into a single
- * array containing full zcaps ordered from root => tail.
- *
- * The dereferenced chain (result of this function) should then compare the
- * root zcap's ID against a list of expected root capabilities, throwing
- * an error if none of them match. Otherwise, the dereferenced chain should
- * then be processed to ensure that all delegation rules have been followed.
- * If checking an invocation, it should also be ensured that a combination of
- * an expected target and a root zcap is permitted (note it is conceivable that
- * a verifier may accept more than one combination, e.g., a target of `x` could
- * work with both root zcap `a` and `b`).
- *
- * @param {object} options - The options.
- * @param {string|IDelegatedZcap} options.capability - The authorization
- *   capability to dereference the chain for. Pass a string (the root zcap ID)
- *   to dereference a root zcap directly, or a delegated zcap object.
- * @param {Function} options.getRootCapability - A function for dereferencing
- *   the root capability (the root zcap must be deref'd in a trusted way by the
- *   verifier, it must not be untrusted input).
- * @param {number} [options.maxChainLength=10] - The maximum length of the
- *   capability delegation chain (this is inclusive of `capability` itself).
- *
- * @returns {Promise<{dereferencedChain: IZcap[]}>} Resolves to an object
- *   containing the full dereferenced chain ordered root to tail.
- */
-export function dereferenceCapabilityChain({ capability, getRootCapability, maxChainLength }: {
-    capability: string | IDelegatedZcap;
-    getRootCapability: Function;
-    maxChainLength?: number;
-}): Promise<{
-    dereferencedChain: IZcap[];
-}>;
-export function checkProofContext({ proof }: {
-    proof: any;
-}): void;
-export function hasValidAllowedAction({ allowedAction, parentAllowedAction }: {
-    allowedAction: any;
-    parentAllowedAction: any;
-}): boolean;
-export function checkCapability({ capability, expectRoot }: {
-    capability: any;
-    expectRoot: any;
-}): void;
-export function compareTime({ t1, t2, maxClockSkew }: {
-    t1: any;
-    t2: any;
-    maxClockSkew: any;
-}): 0 | 1 | -1;
-/**
- * The zcap object shapes (`IRootZcap`, `IDelegatedZcap`,
- * `ICapabilityDelegationProof`, `IZcap`) live in `@digitalcredentials/ssi/zcap`
- * (the canonical home) and are re-imported here as typedefs for JSDoc use.
- */
-export type IRootZcap = import("@digitalcredentials/ssi/zcap").IRootZcap;
-/**
- * The zcap object shapes (`IRootZcap`, `IDelegatedZcap`,
- * `ICapabilityDelegationProof`, `IZcap`) live in `@digitalcredentials/ssi/zcap`
- * (the canonical home) and are re-imported here as typedefs for JSDoc use.
- */
-export type ICapabilityDelegationProof = import("@digitalcredentials/ssi/zcap").ICapabilityDelegationProof;
-/**
- * The zcap object shapes (`IRootZcap`, `IDelegatedZcap`,
- * `ICapabilityDelegationProof`, `IZcap`) live in `@digitalcredentials/ssi/zcap`
- * (the canonical home) and are re-imported here as typedefs for JSDoc use.
- */
-export type IDelegatedZcap = import("@digitalcredentials/ssi/zcap").IDelegatedZcap;
-/**
- * The zcap object shapes (`IRootZcap`, `IDelegatedZcap`,
- * `ICapabilityDelegationProof`, `IZcap`) live in `@digitalcredentials/ssi/zcap`
- * (the canonical home) and are re-imported here as typedefs for JSDoc use.
- */
-export type IZcap = import("@digitalcredentials/ssi/zcap").IZcap;
-/**
- * An inspection function result.
- */
-export type InspectResult = {
-    /**
-     * - `true` if the chain passed inspection.
-     */
-    valid?: boolean;
-    /**
-     * - Set if inspection failed.
-     */
-    error?: Error;
-};
-/**
- * A capability chain inspection function.
- */
-export type InspectCapabilityChain = Function;
-/**
- * A capability. The capability is compacted into the security
- * context. Only the required fields are shown here, a capability will contain
- * additional properties.
- */
-export type Capability = {
-    /**
-     * - The ID of the capability.
-     */
-    id: string;
-    /**
-     * - The controller of the capability.
-     */
-    controller: string;
-};
-export type CapabilityChainDetails = {
-    /**
-     * - The capabilities in the chain.
-     */
-    capabilityChain: Capability[];
-    /**
-     * - The results returned
-     * from jsonld-signatures verify for each capability in the chain. Each
-     * object contains `{verifyResult}` where each `verifyResult` is an
-     * `InspectChainResult`.
-     */
-    capabilityChainMeta: CapabilityMeta[];
-};
-/**
- * The metadata resulting from the verification of a delegated capability.
- */
-export type CapabilityMeta = {
-    /**
-     * - The capability verify result, which
-     * is `null` for the root capability.
-     */
-    verifyResult: VerifyResult;
-};
-/**
- * The result of running jsonld-signature's verify method.
- */
-export type VerifyResult = {
-    /**
-     * - `true` if all the checked proofs were
-     * successfully verified.
-     */
-    verified: boolean;
-    /**
-     * - The verify results for each
-     * delegation proof.
-     */
-    results: VerifyProofResult[];
-};
-/**
- * The result of verifying a capability delegation proof.
- */
-export type VerifyProofResult = {
-    /**
-     * - The result from
-     * verifying the capability delegation proof purpose.
-     */
-    proofPurposeResult: VerifyProofPurposeResult;
-};
-/**
- * The result of verifying a capability delegation proof purpose.
- */
-export type VerifyProofPurposeResult = {
-    /**
-     * - The party that created the capability
-     * delegation proof, i.e., the party that delegated the capability.
-     */
-    delegator: string;
-};
-//# sourceMappingURL=utils.d.ts.map

package/types/lib/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AAOA;;;;;;;;;GASG;AACH,uEALG;IAAiC,UAAU,EAAnC,MAAM,GAAC,MAAM,EAAE;IACC,gBAAgB,EAAhC,MAAM;CAEd,GAAU,SAAS,CASrB;AAED;;;;;;;GAOG;AACH,+CAJG;IAAuB,UAAU,EAAzB,KAAK;CAEb,GAAU,MAAM,EAAE,CAQpB;AAED;;;;;;;;;;GAUG;AACH,iEANG;IAAuB,UAAU,EAAzB,KAAK;IACW,kBAAkB,EAAlC,MAAM;CAGd,GAAU,OAAO,CAMnB;AAED;;;;;;;GAOG;AACH,kDAJG;IAAuB,UAAU,EAAzB,KAAK;CAEb,GAAU,MAAM,EAAE,CAWpB;AAED;;;;;;;GAOG;AACH,0CAJG;IAAuB,UAAU,EAAzB,KAAK;CAEb,GAAU,MAAM,CAKlB;AAED;;;;;;;;;;GAUG;AACH,oDALG;IAAuB,UAAU,EAAzB,KAAK;CAEb,GAAU,0BAA0B,EAAE,CAcxC;AAED;;;;;;;;GAQG;AACH,mDALG;IAAuB,UAAU,EAAzB,KAAK;CAEb,GAAU,KAAK,CAAC,MAAM,GAAC,cAAc,CAAC,CAwBxC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,kGAPG;IAAwB,gBAAgB,EAAhC,MAAM;IACU,oBAAoB,EAApC,MAAM;IACW,sBAAsB,EAAvC,OAAO;CAGf,GAAU,OAAO,CAkCnB;AAED;;;;;;;;;;;;GAYG;AACH,6FARG;IAA8B,gBAAgB,EAAtC,MAAM,GAAC,KAAK;IAGK,8BAA8B,EAA/C,OAAO;CAEf,GAAU,KAAK,CAAC,MAAM,GAAC,cAAc,CAAC,CA0ExC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,8FAZG;IAAuC,UAAU,EAAzC,MAAM,GAAC,cAAc;IAGH,iBAAiB;IAGlB,cAAc,GAA/B,MAAM;CAGd,GAAU,OAAO,CAAC;IAAC,iBAAiB,EAAE,KAAK,EAAE,CAAA;CAAC,CAAC,CAkKjD;AAED;;SAQC;AAED;;;YAiBC;AAED;;;SAqEC;AAED;;;;eAOC;;;;;;wBAOY,OAAO,8BAA8B,EAAE,SAAS;;;;;;yCAChD,OAAO,8BAA8B,EAAE,0BAA0B;;;;;;6BACjE,OAAO,8BAA8B,EAAE,cAAc;;;;;;oBACrD,OAAO,8BAA8B,EAAE,KAAK;;;;;;;;YAO3C,OAAO;;;;YACP,KAAK;;;;;;;;;;;;;;;QAiBL,MAAM;;;;gBACN,MAAM;;;;;;qBAKN,UAAU,EAAE;;;;;;;yBACZ,cAAc,EAAE;;;;;;;;;;kBAUhB,YAAY;;;;;;;;;;cAQZ,OAAO;;;;;aAEP,iBAAiB,EAAE;;;;;;;;;;wBAQnB,wBAAwB;;;;;;;;;;eAQxB,MAAM"}