Class RecapSessionCapabilityObject

Hierarchy

RecapSessionCapabilityObject

Implements

ISessionCapabilityObject

Index

Constructors

constructor

new RecapSessionCapabilityObject(att?: AttenuationsObject, prf?: string[]): RecapSessionCapabilityObject
Parameters
- att: AttenuationsObject = {}
- prf: string[] = []
Returns RecapSessionCapabilityObject
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:18

Properties

`Private` _inner

_inner: Recap

Accessors

attenuations

get attenuations(): AttenuationsObject
Returns AttenuationsObject
Implementation of ISessionCapabilityObject.attenuations
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:48

proofs

get proofs(): string[]
Returns string[]
Implementation of ISessionCapabilityObject.proofs
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:52

statement

get statement(): string
Returns string
Implementation of ISessionCapabilityObject.statement
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:56

Methods

`Private` _getResourceKeyToMatchAgainst

_getResourceKeyToMatchAgainst(litResource: ILitResource): string
Returns the attenuated resource key to match against. This supports matching against a wildcard resource key too.

Example
If the attenuations object contains the following:
```
{
  'lit-acc://*': {
   '*/*': {}
  }
}
```
Then, if the provided litResource is 'lit-acc://123', the method will return 'lit-acc://*'.
Parameters
- litResource: ILitResource
Returns string
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:174

addAllCapabilitiesForResource

addAllCapabilitiesForResource(litResource: ILitResource): void
Add a wildcard ability to the session capability object for the specified resource.
Parameters
- litResource: ILitResource
Returns void
Implementation of ISessionCapabilityObject.addAllCapabilitiesForResource
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:189

addAttenuation

addAttenuation(resource: string, namespace?: string, name?: string, restriction?: {
[key: string]: PlainJSON;
}): void
Add an arbitrary attenuation to the session capability object.

Description
We do NOT recommend using this unless with the LIT specific abilities. Use this ONLY if you know what you are doing.
Parameters
- resource: string
- namespace: string = '*'
- name: string = '*'
- restriction: {
  [key: string]: PlainJSON;
  } = {}
  - [key: string]: PlainJSON
Returns void
Implementation of ISessionCapabilityObject.addAttenuation
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:64

addCapabilityForResource

addCapabilityForResource(litResource: ILitResource, ability: LitAbility, data?: any): void
LIT specific methods
Parameters
- litResource: ILitResource
- ability: LitAbility
- data: any = {}
Returns void
Implementation of ISessionCapabilityObject.addCapabilityForResource
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:82

addProof

addProof(proof: string): void
Parameters
- proof: string
Returns void
Implementation of ISessionCapabilityObject.addProof
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:60

addRateLimitAuthSig

addRateLimitAuthSig(authSig: AuthSig): Promise<void>
Deprecated
- to be removed, as it's not used.
Parameters
- authSig: AuthSig
Returns Promise<void>
Implementation of ISessionCapabilityObject.addRateLimitAuthSig
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:28

addToSiweMessage

addToSiweMessage(siwe: SiweMessage): SiweMessage
Parameters
- siwe: SiweMessage
Returns SiweMessage
Implementation of ISessionCapabilityObject.addToSiweMessage
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:73

encodeAsSiweResource

encodeAsSiweResource(): string
Encode the session capability object as a SIWE resource.

Returns string
Implementation of ISessionCapabilityObject.encodeAsSiweResource
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:77

verifyCapabilitiesForResource

verifyCapabilitiesForResource(litResource: ILitResource, ability: LitAbility): boolean
Verify that the session capability object has the specified LIT-specific capability for the specified resource.
Parameters
- litResource: ILitResource
- ability: LitAbility
Returns boolean
Implementation of ISessionCapabilityObject.verifyCapabilitiesForResource
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:113

`Static` decode

decode(encoded: string): RecapSessionCapabilityObject
Parameters
- encoded: string
Returns RecapSessionCapabilityObject
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:32

`Static` extract

extract(siwe: SiweMessage): RecapSessionCapabilityObject
Parameters
- siwe: SiweMessage
Returns RecapSessionCapabilityObject
- Defined in packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts:40

Class RecapSessionCapabilityObject

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

att: AttenuationsObject = {}

prf: string[] = []

Returns RecapSessionCapabilityObject

Properties

Private _inner

Accessors

attenuations

Returns AttenuationsObject

proofs

Returns string[]

statement

Returns string

Methods

Private _getResourceKeyToMatchAgainst

Example

Parameters

litResource: ILitResource

Returns string

addAllCapabilitiesForResource

Parameters

litResource: ILitResource

Returns void

addAttenuation

Description

Parameters

resource: string

namespace: string = '*'

name: string = '*'

restriction: { [key: string]: PlainJSON; } = {}

[key: string]: PlainJSON

Returns void

addCapabilityForResource

Parameters

litResource: ILitResource

ability: LitAbility

data: any = {}

Returns void

addProof

Parameters

proof: string

Returns void

addRateLimitAuthSig

Deprecated

Parameters

authSig: AuthSig

Returns Promise<void>

addToSiweMessage

Parameters

siwe: SiweMessage

Returns SiweMessage

encodeAsSiweResource

Returns string

verifyCapabilitiesForResource

Parameters

litResource: ILitResource

ability: LitAbility

Returns boolean

Static decode

Parameters

encoded: string

Returns RecapSessionCapabilityObject

Static extract

Parameters

siwe: SiweMessage

Returns RecapSessionCapabilityObject

Settings

Member Visibility

Theme

`Private` _inner

`Private` _getResourceKeyToMatchAgainst

restriction: {
[key: string]: PlainJSON;
} = {}

`Static` decode

`Static` extract