Class SignedInterestPolicy

Validation policy for SigInfo fields in signed Interest.

Index

Constructors

Methods

check makeSigner makeVerifier update wrapInterest

Constructors

constructor

new SignedInterestPolicy(
opts: SignedInterestPolicy.Options,
...rules: Rule[],
): SignedInterestPolicy
Constructor.
Parameters
- opts: SignedInterestPolicy.Options
  Options.
- ...rules: Rule[]
  One or more rules created from SignedInterestPolicy.Nonce, SignedInterestPolicy.Time, SignedInterestPolicy.SeqNum.
Returns SignedInterestPolicy
- Defined in packet/src/security/signed-interest-policy.ts:21
new SignedInterestPolicy(...rules: Rule[]): SignedInterestPolicy
Constructor.
Parameters
- ...rules: Rule[]
  One or more rules created from SignedInterestPolicy.Nonce, SignedInterestPolicy.Time, SignedInterestPolicy.SeqNum.
Returns SignedInterestPolicy
- Defined in packet/src/security/signed-interest-policy.ts:29

Methods

check

check(__namedParameters: Interest): () => void
Check SigInfo of an Interest.
Parameters
- __namedParameters: Interest
Returns () => void
A function to save state after the Interest has passed all verifications.
- Defined in packet/src/security/signed-interest-policy.ts:59

makeSigner

makeSigner(inner: Signer): Signer
Wrap a Signer to update SigInfo when signing an Interest.
Parameters
- inner: Signer
Returns Signer
Remarks
State is associated with the provided Signer.
- Defined in packet/src/security/signed-interest-policy.ts:124

makeVerifier

makeVerifier(inner: Verifier, __namedParameters?: WrapOptions): Verifier
Wrap a Verifier to check the policy when verifying an Interest.
Parameters
- inner: Verifier
- __namedParameters: WrapOptions = {}
Returns Verifier
- Defined in packet/src/security/signed-interest-policy.ts:136

update

update(interest: Interest, key?: object): void
Assign SigInfo fields on an Interest before signing.
Parameters
- interest: Interest
- key: object = ...
  Signing key object to associate state with; if omitted, use global state.
Returns void
- Defined in packet/src/security/signed-interest-policy.ts:48

wrapInterest

wrapInterest(interest: Interest): Signer.Signable & Verifier.Verifiable
Wrap an Interest to update/check SigInfo during signing/verification.
Parameters
- interest: Interest
Returns Signer.Signable & Verifier.Verifiable
Remarks
During signing, global state is being used because signer key cannot be detected.
- Defined in packet/src/security/signed-interest-policy.ts:95