Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ndn/packet

Index

Type aliases

ComponentLike

ComponentLike: Component | string

LLDecrypt

LLDecrypt: (params: LLDecrypt.Params) => Promise<LLDecrypt.Result>

Type declaration

LLEncrypt

LLEncrypt: (params: LLEncrypt.Params) => Promise<LLEncrypt.Result>

Type declaration

LLSign

LLSign: (input: Uint8Array) => Promise<Uint8Array>

Type declaration

    • (input: Uint8Array): Promise<Uint8Array>
    • Low level signing function. It takes a buffer of signed portion, and returns a Promise of signature value.

      Parameters

      • input: Uint8Array

      Returns Promise<Uint8Array>

LLVerify

LLVerify: (input: Uint8Array, sig: Uint8Array) => Promise<void>

Type declaration

    • (input: Uint8Array, sig: Uint8Array): Promise<void>
    • Low level verification function. It takes a buffer of signed portion and the signature value, and returns a Promise that is resolved upon good signature or rejected upon bad signature.

      Parameters

      • input: Uint8Array
      • sig: Uint8Array

      Returns Promise<void>

NameLike

NameLike: Name | string

Variables

AltUri

AltUri: AltUriConverter = ...

Print Generic, ImplicitDigest, ParamsDigest in alternate URI syntax.

ImplicitDigest

ImplicitDigest: ImplicitDigestComp = ...

ImplicitSha256DigestComponent

NackReason

NackReason: { Congestion: number; Duplicate: number; NoRoute: number } = ...

Type declaration

  • Congestion: number
  • Duplicate: number
  • NoRoute: number

ParamsDigest

ParamsDigest: ParamsDigestComp = ...

ParametersSha256DigestComponent

SigType

SigType: { HmacWithSha256: number; Null: number; Sha256: number; Sha256WithEcdsa: number; Sha256WithRsa: number } = ...

Type declaration

  • HmacWithSha256: number
  • Null: number
  • Sha256: number
  • Sha256WithEcdsa: number
  • Sha256WithRsa: number

TT

TT: { AppParameters: number; CanBePrefix: number; Content: number; ContentType: number; DSigInfo: number; DSigValue: number; Data: number; Delegation: number; FinalBlock: number; ForwardingHint: number; FreshnessPeriod: number; GenericNameComponent: number; HopLimit: number; ISigInfo: number; ISigValue: number; ImplicitSha256DigestComponent: number; Interest: number; InterestLifetime: number; KeyDigest: number; KeyLocator: number; MetaInfo: number; MustBeFresh: number; Nack: number; NackReason: number; Name: number; Nonce: number; ParametersSha256DigestComponent: number; Preference: number; SigNonce: number; SigSeqNum: number; SigTime: number; SigType: number } = ...

Type declaration

  • AppParameters: number
  • CanBePrefix: number
  • Content: number
  • ContentType: number
  • DSigInfo: number
  • DSigValue: number
  • Data: number
  • Delegation: number
  • FinalBlock: number
  • ForwardingHint: number
  • FreshnessPeriod: number
  • GenericNameComponent: number
  • HopLimit: number
  • ISigInfo: number
  • ISigValue: number
  • ImplicitSha256DigestComponent: number
  • Interest: number
  • InterestLifetime: number
  • KeyDigest: number
  • KeyLocator: number
  • MetaInfo: number
  • MustBeFresh: number
  • Nack: number
  • NackReason: number
  • Name: number
  • Nonce: number
  • ParametersSha256DigestComponent: number
  • Preference: number
  • SigNonce: number
  • SigSeqNum: number
  • SigTime: number
  • SigType: number

digestSigning

digestSigning: Signer & Verifier = ...

Signer and Verifier for SigType.Sha256 digest.

noopEncryption

noopEncryption: Encrypter<any> & Decrypter<any> = ...

Encrypter and decrypter that do nothing.

noopSigning

noopSigning: Signer & Verifier = ...

Signer and Verifier that do nothing.

nullSigner

nullSigner: Signer = ...

Signer for SigType.Null, a packet that is not signed.

see

https://redmine.named-data.net/projects/ndn-tlv/wiki/NullSignature

Functions

lpm

  • lpm<Entry>(name: Name, get: (prefixHex: string) => undefined | Entry): Iterable<Entry>
  • Name longest prefix match algorithm.

    Type parameters

    • Entry

    Parameters

    • name: Name

      target name.

    • get: (prefixHex: string) => undefined | Entry

      callback function to retrieve entry by hexadecimal name prefix.

        • (prefixHex: string): undefined | Entry
        • Parameters

          • prefixHex: string

          Returns undefined | Entry

    Returns Iterable<Entry>

Generated using TypeDoc