Interface ServerOptions

Options for UCAN validation.

Hierarchy

ValidatorOptions
- ServerOptions
  - Server

Index

Properties

canIssue? codec id principal? resolve? validateAuthorization

Properties

`Optional` `Readonly` canIssue

canIssue?: ((capability, issuer) => boolean)

Type declaration

- (capability, issuer): boolean
- Informs validator whether given capability can be issued by a given DID or whether it needs to be delegated to the issuer.
  Parameters
  - capability: ParsedCapability<Ability, URI, {}>
  - issuer: `did:${string}:${string}`
  Returns boolean

`Readonly` codec

codec: InboundCodec

`Readonly` id

id: Signer<`did:${string}:${string}`, SigAlg>

Service DID which will be used to verify that received invocation audience matches it.

`Optional` `Readonly` principal

principal?: PrincipalParser

Takes principal parser that can be used to turn a UCAN.Principal into Ucanto.Principal.

`Optional` `Readonly` resolve

resolve?: ((proof) => Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>)

Type declaration

- (proof): Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>
- Parameters
  - proof: UCANLink<Capabilities, MulticodecCode<number, string>, SigAlg>
  Returns Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>

validateAuthorization

validateAuthorization: ((proofs) => Await<Schema.Result<Unit, Revoked>>)

Type declaration

- (proofs): Await<Schema.Result<Unit, Revoked>>
- Parameters
  - proofs: Authorization<ParsedCapability<Ability, URI, {}>>
  Returns Await<Schema.Result<Unit, Revoked>>

Generated using TypeDoc