Class PrivateGateway

constructor

• new PrivateGateway(id, identityKeyPair, keyStores, cryptoOptions): PrivateGateway

• Parameters

  • id: string

  • identityKeyPair: CryptoKeyPair

  • keyStores: KeyStoreSet

  • cryptoOptions: Partial<NodeCryptoOptions>

  Returns PrivateGateway

Readonly cryptoOptions

Readonly id

Readonly identityKeyPair

Readonly keyStores

generateSessionKey

• generateSessionKey(peerId?): Promise<SessionKey>

• Generate and store a new session key.

  Parameters

  • Optional peerId: string

    The peer to bind the key to, unless it's an initial key

  Returns Promise<SessionKey>

getChannel

• getChannel(peerId, peerInternetAddress): Promise<null | Channel<GatewayPayload, string>>

• Parameters

  • peerId: string

  • peerInternetAddress: string

  Returns Promise<null | Channel<GatewayPayload, string>>

getGSCSigner

• getGSCSigner<S>(peerId, signerClass): Promise<null | S>

• Type Parameters

  • S extends Signer<S>

  Parameters

  • peerId: string

  • signerClass: (new (certificate, privateKey) => S)

    • • new (certificate, privateKey): S

      • Parameters

        • certificate: Certificate

        • privateKey: CryptoKey

        Returns S

  Returns Promise<null | S>

getGSCVerifier

• getGSCVerifier<V>(peerId, verifierClass): Promise<V>

• Type Parameters

  • V extends Verifier<V>

  Parameters

  • peerId: string

  • verifierClass: (new (trustedCertificates) => V)

    • • new (trustedCertificates): V

      • Parameters

        • trustedCertificates: readonly Certificate[]

        Returns V

  Returns Promise<V>

unwrapMessagePayload

• unwrapMessagePayload<P>(message): Promise<P>

• Decrypt and return the payload in the message.

  Also store the session key from the sender.

  Type Parameters

  • P extends GatewayPayload

  Parameters

  • message: RAMFMessage<P>

  Returns Promise<P>

validateMessage

• validateMessage(message, trustedCertificates?): Promise<void>

• Validate the message and report whether it's correctly bound for this node.

  Parameters

  • message: RAMFMessage<GatewayPayload>

    The message to validate

  • Optional trustedCertificates: readonly Certificate[]

    If authorisation should be verified

  Returns Promise<void>

  Throws

  If the message is invalid