diff --git a/classes/CMSError.html b/classes/CMSError.html index 6bc2be98..cb9a468d 100644 --- a/classes/CMSError.html +++ b/classes/CMSError.html @@ -1,5 +1,5 @@ CMSError | @relaycorp/relaynet-core

Error while processing CMS value.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

cause message stack? @@ -19,5 +19,5 @@

Type declaration

stackTraceLimit: number

Accessors

Methods

  • Create .stack property on a target object

    +
stackTraceLimit: number

Accessors

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • Parameters

    • err: Error

    Returns null | Error

  • Parameters

    • err: Error
    • func: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Type Parameters

    • T extends Error

    Parameters

    • errors: T[]

    Returns null | T | MultiError

  • Parameters

    • err: Error
    • name: string

    Returns null | Error

  • Parameters

    • err: Error

    Returns string

  • Parameters

    • err: Error
    • name: string

    Returns boolean

  • Parameters

    • err: Error

    Returns Info

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Cargo.html b/classes/Cargo.html index 84f922f4..d34c33c9 100644 --- a/classes/Cargo.html +++ b/classes/Cargo.html @@ -1,5 +1,5 @@ Cargo | @relaycorp/relaynet-core

Relaynet Abstract Message Format, version 1.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Constructors

Properties

creationDate: Date
id: string
payloadSerialized: Buffer
recipient: Recipient
senderCaCertificateChain: readonly Certificate[]
senderCertificate: Certificate
ttl: number

Accessors

Methods

  • Return certification path between sender's certificate and one certificate in +

Constructors

Properties

creationDate: Date
id: string
payloadSerialized: Buffer
recipient: Recipient
senderCaCertificateChain: readonly Certificate[]
senderCertificate: Certificate
ttl: number

Accessors

Methods

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CargoCollectionAuthorization.html b/classes/CargoCollectionAuthorization.html index 4a3f5fc5..1143dc23 100644 --- a/classes/CargoCollectionAuthorization.html +++ b/classes/CargoCollectionAuthorization.html @@ -1,5 +1,5 @@ CargoCollectionAuthorization | @relaycorp/relaynet-core

Relaynet Abstract Message Format, version 1.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Constructors

Properties

creationDate: Date
id: string
payloadSerialized: Buffer
recipient: Recipient
senderCaCertificateChain: readonly Certificate[]
senderCertificate: Certificate
ttl: number

Accessors

Methods

  • Return certification path between sender's certificate and one certificate in +

Constructors

Properties

creationDate: Date
id: string
payloadSerialized: Buffer
recipient: Recipient
senderCaCertificateChain: readonly Certificate[]
senderCertificate: Certificate
ttl: number

Accessors

Methods

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CargoCollectionRequest.html b/classes/CargoCollectionRequest.html index 7cce2828..d865496d 100644 --- a/classes/CargoCollectionRequest.html +++ b/classes/CargoCollectionRequest.html @@ -1,8 +1,8 @@ CargoCollectionRequest | @relaycorp/relaynet-core

Plaintext representation of a RAMF payload.

Not to be confused with the final RAMF payload; e.g., a CMS EnvelopedData value containing the ciphertext representation of the plaintext.

-

Implements

Constructors

Implements

Constructors

Properties

cargoDeliveryAuthorization: Certificate

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

cargoDeliveryAuthorization: Certificate

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CargoMessageSet.html b/classes/CargoMessageSet.html index 01877fa6..49072d39 100644 --- a/classes/CargoMessageSet.html +++ b/classes/CargoMessageSet.html @@ -1,16 +1,16 @@ CargoMessageSet | @relaycorp/relaynet-core

Plaintext representation of the payload in a cargo message.

That is, the set of RAMF messages the cargo contains.

-

Implements

Constructors

Implements

Constructors

Properties

messages: readonly ArrayBuffer[]
MAX_MESSAGE_LENGTH: number = ...

Maximum number of octets for any serialized message to be included in a cargo.

+

Constructors

Properties

messages: readonly ArrayBuffer[]
MAX_MESSAGE_LENGTH: number = ...

Maximum number of octets for any serialized message to be included in a cargo.

This is the result of subtracting the TLVs for the SET and OCTET STRING values from the maximum size of an SDU to be encrypted.

-

Methods

  • Parameters

    • messagesWithExpiryDate: AsyncIterable<MessageWithExpiryDate>

    Returns AsyncIterable<MessageWithExpiryDate>

Methods

  • Parameters

    • messagesWithExpiryDate: AsyncIterable<MessageWithExpiryDate>

    Returns AsyncIterable<MessageWithExpiryDate>

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Certificate.html b/classes/Certificate.html index e735ebc8..2c043644 100644 --- a/classes/Certificate.html +++ b/classes/Certificate.html @@ -1,7 +1,7 @@ Certificate | @relaycorp/relaynet-core

X.509 Certificate.

This is a high-level class on top of PKI.js Certificate, to make the use of Relaynet certificates easy and safe.

-

Accessors

Accessors

Methods

  • Return the certification path (aka "certificate chain") if this certificate can be trusted.

    +

Accessors

Methods

  • Return the certification path (aka "certificate chain") if this certificate can be trusted.

    Parameters

    • intermediateCaCertificates: readonly Certificate[]

      The alleged chain for the certificate

    • trustedCertificates: readonly Certificate[]

      The collection of certificates that are actually trusted

    Returns Promise<readonly Certificate[]>

    Throws

    CertificateError when this certificate is not on a certificate path from a CA in trustedCertificates

    -
  • Return serial number.

    This doesn't return a number or BigInt because the serial number could require more than 8 octets (which is the maximum number of octets required to represent a 64-bit unsigned integer).

    -

    Returns Buffer

Generated using TypeDoc

\ No newline at end of file +

Returns Certificate

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CertificateError.html b/classes/CertificateError.html index 9343a6a8..afde10fb 100644 --- a/classes/CertificateError.html +++ b/classes/CertificateError.html @@ -1,4 +1,4 @@ -CertificateError | @relaycorp/relaynet-core

Hierarchy (view full)

Constructors

constructor +CertificateError | @relaycorp/relaynet-core

Hierarchy (view full)

Constructors

Properties

cause message stack? @@ -18,5 +18,5 @@

Type declaration

stackTraceLimit: number

Accessors

Methods

  • Create .stack property on a target object

    +
stackTraceLimit: number

Accessors

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • Parameters

    • err: Error

    Returns null | Error

  • Parameters

    • err: Error
    • func: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Type Parameters

    • T extends Error

    Parameters

    • errors: T[]

    Returns null | T | MultiError

  • Parameters

    • err: Error
    • name: string

    Returns null | Error

  • Parameters

    • err: Error

    Returns string

  • Parameters

    • err: Error
    • name: string

    Returns boolean

  • Parameters

    • err: Error

    Returns Info

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CertificateRotation.html b/classes/CertificateRotation.html index 1350b7ce..ced24987 100644 --- a/classes/CertificateRotation.html +++ b/classes/CertificateRotation.html @@ -1,5 +1,5 @@ -CertificateRotation | @relaycorp/relaynet-core

Constructors

constructor +CertificateRotation | @relaycorp/relaynet-core

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

certificationPath: CertificationPath

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CertificateStore.html b/classes/CertificateStore.html index 2954e6ee..bcbbd5d5 100644 --- a/classes/CertificateStore.html +++ b/classes/CertificateStore.html @@ -1,12 +1,12 @@ CertificateStore | @relaycorp/relaynet-core

Class CertificateStoreAbstract

Store of certificates.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Methods

  • Store subjectCertificate as long as it's still valid.

    +

Constructors

Methods

  • Store subjectCertificate as long as it's still valid.

    Parameters

    • path: CertificationPath
    • issuerId: string

      Whilst we could take the {issuerId} from the leaf certificate in the {path}, we must not rely on it because we don't have enough information/context here to be certain that the value is legitimate. Additionally, the value has to be present in an X.509 extension, which could be absent if produced by a non-compliant implementation.

      -

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CertificationPath.html b/classes/CertificationPath.html index b5079e49..ea4cc11a 100644 --- a/classes/CertificationPath.html +++ b/classes/CertificationPath.html @@ -1,6 +1,6 @@ -CertificationPath | @relaycorp/relaynet-core

Constructors

constructor +CertificationPath | @relaycorp/relaynet-core

Constructors

Properties

certificateAuthorities: readonly Certificate[]
leafCertificate: Certificate

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

certificateAuthorities: readonly Certificate[]
leafCertificate: Certificate

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Channel.html b/classes/Channel.html index 91fa7dd6..165ae8b8 100644 --- a/classes/Channel.html +++ b/classes/Channel.html @@ -1,4 +1,4 @@ -Channel | @relaycorp/relaynet-core

Class Channel<Payload, PeerAddress>Abstract

Type Parameters

  • Payload extends Payload

  • PeerAddress extends PeerInternetAddress

Hierarchy (view full)

Constructors

constructor +Channel | @relaycorp/relaynet-core

Class Channel<Payload, PeerAddress>Abstract

Type Parameters

  • Payload extends Payload

  • PeerAddress extends PeerInternetAddress

Hierarchy (view full)

Constructors

Properties

cryptoOptions: Partial<NodeCryptoOptions> = {}
deliveryAuthPath: CertificationPath
keyStores: KeyStoreSet
node: Node<Payload, PeerAddress>
peer: Peer<PeerAddress>

Methods

  • Generate and serialise a message with the given payload.

    +

Constructors

Properties

cryptoOptions: Partial<NodeCryptoOptions> = {}
deliveryAuthPath: CertificationPath
keyStores: KeyStoreSet
node: Node<Payload, PeerAddress>
peer: Peer<PeerAddress>

Methods

  • Generate and serialise a message with the given payload.

    Parameters

    • payload: ArrayBuffer | Payload

      The payload to encrypt and encapsulate

    • messageConstructor: RAMFMessageConstructor<Payload>

      The message class constructor

      -
    • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}

    Returns Promise<ArrayBuffer>

Generated using TypeDoc

\ No newline at end of file +
  • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}
  • Returns Promise<ArrayBuffer>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Endpoint.html b/classes/Endpoint.html index a3fd208d..f7a96f92 100644 --- a/classes/Endpoint.html +++ b/classes/Endpoint.html @@ -1,4 +1,4 @@ -Endpoint | @relaycorp/relaynet-core

    Class EndpointAbstract

    Hierarchy

    Constructors

    constructor +Endpoint | @relaycorp/relaynet-core

    Class EndpointAbstract

    Hierarchy

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions>
    id: string
    identityKeyPair: CryptoKeyPair
    keyStores: KeyStoreSet

    Methods

    • Generate and store a new session key.

      +

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions>
    id: string
    identityKeyPair: CryptoKeyPair
    keyStores: KeyStoreSet

    Methods

    • 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>

    • Type Parameters

      • S extends Signer<S>

      Parameters

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

            Returns S

      Returns Promise<null | S>

    • Decrypt and return the payload in the message.

      +

    Returns Promise<SessionKey>

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/EndpointManager.html b/classes/EndpointManager.html index 8d5c4f01..6afdfc03 100644 --- a/classes/EndpointManager.html +++ b/classes/EndpointManager.html @@ -1,6 +1,6 @@ -EndpointManager | @relaycorp/relaynet-core

    Class EndpointManagerAbstract

    Hierarchy

    Constructors

    constructor +EndpointManager | @relaycorp/relaynet-core

    Class EndpointManagerAbstract

    Hierarchy

    Constructors

    Properties

    Methods

    get -

    Constructors

    Properties

    keyStores: KeyStoreSet

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    keyStores: KeyStoreSet

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/EnvelopedData.html b/classes/EnvelopedData.html index 0d3b018f..126f91fe 100644 --- a/classes/EnvelopedData.html +++ b/classes/EnvelopedData.html @@ -1,18 +1,18 @@ -EnvelopedData | @relaycorp/relaynet-core

    Class EnvelopedDataAbstract

    Hierarchy (view full)

    Methods

    decrypt +EnvelopedData | @relaycorp/relaynet-core

    Class EnvelopedDataAbstract

    Hierarchy (view full)

    Methods

    • Return the plaintext for the ciphertext contained in the current EnvelopedData value.

      Parameters

      • privateKey: CryptoKey

        The private key to decrypt the ciphertext.

        -

      Returns Promise<ArrayBuffer>

    • Return the id of the recipient's key used to encrypt the content.

      +

    Returns Promise<ArrayBuffer>

    • Return the id of the recipient's key used to encrypt the content.

      This id will often be the recipient's certificate's serial number, in which case the issuer will be ignored: This method is meant to be used by the recipient so it can look up the corresponding private key to decrypt the content. We could certainly extract the issuer to verify it matches the expected one, but if the id doesn't match any key decryption won't even be attempted, so there's really no risk from ignoring the issuer.

      -

      Returns Buffer

    • Return the DER serialization of the current EnvelopedData value.

      It'll be wrapped around a ContentInfo value.

      -

      Returns ArrayBuffer

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns EnvelopedData

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Gateway.html b/classes/Gateway.html index fcaa87ef..48af1bda 100644 --- a/classes/Gateway.html +++ b/classes/Gateway.html @@ -1,4 +1,4 @@ -Gateway | @relaycorp/relaynet-core

    Class Gateway<PeerAddress>Abstract

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy (view full)

    Constructors

    constructor +Gateway | @relaycorp/relaynet-core

    Class Gateway<PeerAddress>Abstract

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy (view full)

    Constructors

    Properties

    cryptoOptions id identityKeyPair @@ -12,12 +12,12 @@

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions>
    id: string
    identityKeyPair: CryptoKeyPair
    keyStores: KeyStoreSet

    Methods

    Properties

    cryptoOptions: Partial<NodeCryptoOptions>
    id: string
    identityKeyPair: CryptoKeyPair
    keyStores: KeyStoreSet

    Methods

    • 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>

    • Type Parameters

      • S extends Signer<S>

      Parameters

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

            Returns S

      Returns Promise<null | S>

    • Type Parameters

      • V extends Verifier<V>

      Parameters

      • peerId: string
      • verifierClass: (new (trustedCertificates) => V)
          • new (trustedCertificates): V
          • Parameters

            Returns V

      Returns Promise<V>

    • Decrypt and return the payload in the message.

      +

    Returns Promise<SessionKey>

    • Type Parameters

      • S extends Signer<S>

      Parameters

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

            Returns S

      Returns Promise<null | S>

    • Type Parameters

      • V extends Verifier<V>

      Parameters

      • peerId: string
      • verifierClass: (new (trustedCertificates) => V)
          • new (trustedCertificates): V
          • Parameters

            Returns V

      Returns Promise<V>

    • Decrypt and return the payload in the message.

      Also store the session key from the sender.

      -

      Type Parameters

      • P extends GatewayPayload

      Parameters

      Returns Promise<P>

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

      +

      Type Parameters

      • P extends GatewayPayload

      Parameters

      Returns Promise<P>

    • 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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/GatewayChannel.html b/classes/GatewayChannel.html index 156e18f5..1f803965 100644 --- a/classes/GatewayChannel.html +++ b/classes/GatewayChannel.html @@ -1,5 +1,5 @@ GatewayChannel | @relaycorp/relaynet-core

    Class GatewayChannel<PeerAddress>Abstract

    Channel whose node is a gateway.

    -

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy (view full)

    Constructors

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy (view full)

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions> = {}
    deliveryAuthPath: CertificationPath
    keyStores: KeyStoreSet
    node: Node<GatewayPayload, PeerAddress>
    peer: Peer<PeerAddress>

    Methods

    • Generate and serialise a message with the given payload.

      +

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions> = {}
    deliveryAuthPath: CertificationPath
    keyStores: KeyStoreSet
    node: Node<GatewayPayload, PeerAddress>
    peer: Peer<PeerAddress>

    Methods

    • Generate and serialise a message with the given payload.

      Parameters

      • payload: ArrayBuffer | GatewayPayload

        The payload to encrypt and encapsulate

      • messageConstructor: RAMFMessageConstructor<GatewayPayload>

        The message class constructor

        -
      • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}

      Returns Promise<ArrayBuffer>

    Generated using TypeDoc

    \ No newline at end of file +
  • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}
  • Returns Promise<ArrayBuffer>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/GatewayManager.html b/classes/GatewayManager.html index f77ed213..260c01cc 100644 --- a/classes/GatewayManager.html +++ b/classes/GatewayManager.html @@ -1,9 +1,9 @@ -GatewayManager | @relaycorp/relaynet-core

    Class GatewayManager<PeerAddress>Abstract

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy (view full)

    Constructors

    constructor +GatewayManager | @relaycorp/relaynet-core

    Class GatewayManager<PeerAddress>Abstract

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy (view full)

    Constructors

    Properties

    Methods

    Constructors

    Properties

    keyStores: KeyStoreSet

    Methods

    Generated using TypeDoc

    \ No newline at end of file +>.constructor

    Properties

    keyStores: KeyStoreSet

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/HandshakeChallenge.html b/classes/HandshakeChallenge.html index 25029459..b10971c5 100644 --- a/classes/HandshakeChallenge.html +++ b/classes/HandshakeChallenge.html @@ -1,5 +1,5 @@ -HandshakeChallenge | @relaycorp/relaynet-core

    Constructors

    constructor +HandshakeChallenge | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    nonce: ArrayBuffer

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/HandshakeResponse.html b/classes/HandshakeResponse.html index 4f6db511..cf1eca1b 100644 --- a/classes/HandshakeResponse.html +++ b/classes/HandshakeResponse.html @@ -1,5 +1,5 @@ -HandshakeResponse | @relaycorp/relaynet-core

    Constructors

    constructor +HandshakeResponse | @relaycorp/relaynet-core

    Constructors

    Properties

    Methods

    Constructors

    Properties

    nonceSignatures: readonly ArrayBuffer[]

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    nonceSignatures: readonly ArrayBuffer[]

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/InternetAddressingError.html b/classes/InternetAddressingError.html index bf4246d5..a65f9780 100644 --- a/classes/InternetAddressingError.html +++ b/classes/InternetAddressingError.html @@ -1,4 +1,4 @@ -InternetAddressingError | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +InternetAddressingError | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -18,5 +18,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/InvalidMessageError.html b/classes/InvalidMessageError.html index dfecc6f7..dcb7e96d 100644 --- a/classes/InvalidMessageError.html +++ b/classes/InvalidMessageError.html @@ -1,5 +1,5 @@ InvalidMessageError | @relaycorp/relaynet-core

    Error while processing message.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -19,5 +19,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/InvalidNodeConnectionParams.html b/classes/InvalidNodeConnectionParams.html index 59faa2be..15250c82 100644 --- a/classes/InvalidNodeConnectionParams.html +++ b/classes/InvalidNodeConnectionParams.html @@ -1,4 +1,4 @@ -InvalidNodeConnectionParams | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +InvalidNodeConnectionParams | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -18,5 +18,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/KeyStoreError.html b/classes/KeyStoreError.html index 4b577e04..25839c74 100644 --- a/classes/KeyStoreError.html +++ b/classes/KeyStoreError.html @@ -1,5 +1,5 @@ KeyStoreError | @relaycorp/relaynet-core

    Error thrown when there was a failure in the communication with the backing service.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -19,5 +19,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MockCertificateStore.html b/classes/MockCertificateStore.html index f000b659..78778633 100644 --- a/classes/MockCertificateStore.html +++ b/classes/MockCertificateStore.html @@ -1,5 +1,5 @@ MockCertificateStore | @relaycorp/relaynet-core

    Store of certificates.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Methods

    Constructors

    Properties

    dataBySubjectId: {
        [nodeId: string]: MockStoredCertificateData[];
    } = {}

    Type declaration

    • [nodeId: string]: MockStoredCertificateData[]

    Methods

    • Store subjectCertificate as long as it's still valid.

      +

    Constructors

    Properties

    dataBySubjectId: {
        [nodeId: string]: MockStoredCertificateData[];
    } = {}

    Type declaration

    • [nodeId: string]: MockStoredCertificateData[]

    Methods

    • Store subjectCertificate as long as it's still valid.

      Parameters

      • path: CertificationPath
      • issuerId: string

        Whilst we could take the {issuerId} from the leaf certificate in the {path}, we must not rely on it because we don't have enough information/context here to be certain that the value is legitimate. Additionally, the value has to be present in an X.509 extension, which could be absent if produced by a non-compliant implementation.

        -

      Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MockKeyStoreSet.html b/classes/MockKeyStoreSet.html index da4daad4..a81b25e0 100644 --- a/classes/MockKeyStoreSet.html +++ b/classes/MockKeyStoreSet.html @@ -1,6 +1,6 @@ -MockKeyStoreSet | @relaycorp/relaynet-core

    Implements

    Constructors

    constructor +MockKeyStoreSet | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    certificateStore: MockCertificateStore = ...
    privateKeyStore: MockPrivateKeyStore = ...
    publicKeyStore: MockPublicKeyStore = ...

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MockPrivateKeyStore.html b/classes/MockPrivateKeyStore.html index 9653bc84..2d5530bb 100644 --- a/classes/MockPrivateKeyStore.html +++ b/classes/MockPrivateKeyStore.html @@ -1,4 +1,4 @@ -MockPrivateKeyStore | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +MockPrivateKeyStore | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    identityKeys: {
        [nodeId: string]: CryptoKey;
    } = {}

    Type declaration

    • [nodeId: string]: CryptoKey
    sessionKeys: {
        [keyId: string]: SessionPrivateKeyData;
    } = {}

    Type declaration

    Methods

    • Return the private component of a node key pair if it exists.

      +

    Constructors

    Properties

    identityKeys: {
        [nodeId: string]: CryptoKey;
    } = {}

    Type declaration

    • [nodeId: string]: CryptoKey
    sessionKeys: {
        [keyId: string]: SessionPrivateKeyData;
    } = {}

    Type declaration

    Methods

    • Retrieve private session key, regardless of whether it's an initial key or not.

      Parameters

      • keyId: Buffer

        The key pair id (typically the serial number)

      • nodeId: string

        The id of the node that owns the key

      • peerId: string

        The id of the recipient, in case the key is bound to a recipient

      Returns Promise<CryptoKey>

      Throws

      UnknownKeyError when the key does not exist

      Throws

      PrivateKeyStoreError when the look-up could not be done

      -
    • Return the private component of an initial session key pair.

      Parameters

      • keyId: Buffer

        The key pair id (typically the serial number)

      • nodeId: string

        The id of the node that owns the key

      Returns Promise<CryptoKey>

      Throws

      UnknownKeyError when the key does not exist

      Throws

      PrivateKeyStoreError when the look-up could not be done

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MockPublicKeyStore.html b/classes/MockPublicKeyStore.html index 121f7de5..3a69329a 100644 --- a/classes/MockPublicKeyStore.html +++ b/classes/MockPublicKeyStore.html @@ -1,4 +1,4 @@ -MockPublicKeyStore | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +MockPublicKeyStore | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    identityKeys: {
        [peerId: string]: Buffer;
    } = {}

    Type declaration

    • [peerId: string]: Buffer
    sessionKeys: {
        [peerId: string]: SessionPublicKeyData;
    } = {}

    Type declaration

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    identityKeys: {
        [peerId: string]: Buffer;
    } = {}

    Type declaration

    • [peerId: string]: Buffer
    sessionKeys: {
        [peerId: string]: SessionPublicKeyData;
    } = {}

    Type declaration

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/NodeConnectionParams.html b/classes/NodeConnectionParams.html index 69364c39..cb24cc71 100644 --- a/classes/NodeConnectionParams.html +++ b/classes/NodeConnectionParams.html @@ -1,7 +1,7 @@ -NodeConnectionParams | @relaycorp/relaynet-core

    Constructors

    constructor +NodeConnectionParams | @relaycorp/relaynet-core

    Constructors

    Properties

    identityKey: CryptoKey
    internetAddress: string
    sessionKey: SessionKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    identityKey: CryptoKey
    internetAddress: string
    sessionKey: SessionKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/NodeError.html b/classes/NodeError.html index 4998d6e7..75a4eebf 100644 --- a/classes/NodeError.html +++ b/classes/NodeError.html @@ -1,4 +1,4 @@ -NodeError | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +NodeError | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -18,5 +18,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Parcel.html b/classes/Parcel.html index a9a0e623..12afc216 100644 --- a/classes/Parcel.html +++ b/classes/Parcel.html @@ -1,5 +1,5 @@ Parcel | @relaycorp/relaynet-core

    Relaynet Abstract Message Format, version 1.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    creationDate: Date
    id: string
    payloadSerialized: Buffer
    recipient: Recipient
    senderCaCertificateChain: readonly Certificate[]
    senderCertificate: Certificate
    ttl: number

    Accessors

    Methods

    • Return certification path between sender's certificate and one certificate in +

    Constructors

    Properties

    creationDate: Date
    id: string
    payloadSerialized: Buffer
    recipient: Recipient
    senderCaCertificateChain: readonly Certificate[]
    senderCertificate: Certificate
    ttl: number

    Accessors

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelCollection.html b/classes/ParcelCollection.html index 796973d8..f41b7df7 100644 --- a/classes/ParcelCollection.html +++ b/classes/ParcelCollection.html @@ -1,6 +1,6 @@ -ParcelCollection | @relaycorp/relaynet-core

    Constructors

    constructor +ParcelCollection | @relaycorp/relaynet-core

    Constructors

    Properties

    parcelSerialized: ArrayBuffer
    trustedCertificates: readonly Certificate[]

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    parcelSerialized: ArrayBuffer
    trustedCertificates: readonly Certificate[]

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelCollectionAck.html b/classes/ParcelCollectionAck.html index 665a88b8..8767f139 100644 --- a/classes/ParcelCollectionAck.html +++ b/classes/ParcelCollectionAck.html @@ -1,8 +1,8 @@ -ParcelCollectionAck | @relaycorp/relaynet-core

    Constructors

    constructor +ParcelCollectionAck | @relaycorp/relaynet-core

    Constructors

    Properties

    parcelId: string
    recipientEndpointId: string
    senderEndpointId: string
    FORMAT_SIGNATURE: Uint8Array = ...

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    parcelId: string
    recipientEndpointId: string
    senderEndpointId: string
    FORMAT_SIGNATURE: Uint8Array = ...

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelCollectionHandshakeSigner.html b/classes/ParcelCollectionHandshakeSigner.html index 955487ad..87f02174 100644 --- a/classes/ParcelCollectionHandshakeSigner.html +++ b/classes/ParcelCollectionHandshakeSigner.html @@ -1,8 +1,8 @@ -ParcelCollectionHandshakeSigner | @relaycorp/relaynet-core

    Class ParcelCollectionHandshakeSigner

    Hierarchy

    • Signer
      • ParcelCollectionHandshakeSigner

    Constructors

    constructor +ParcelCollectionHandshakeSigner | @relaycorp/relaynet-core

    Class ParcelCollectionHandshakeSigner

    Hierarchy

    • Signer
      • ParcelCollectionHandshakeSigner

    Constructors

    Properties

    Methods

    Constructors

    Properties

    certificate: Certificate

    The certificate of the node

    -
    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ParcelCollectionHandshakeSigner

    Properties

    certificate: Certificate

    The certificate of the node

    +
    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelCollectionHandshakeVerifier.html b/classes/ParcelCollectionHandshakeVerifier.html index 03be4888..a7622bd3 100644 --- a/classes/ParcelCollectionHandshakeVerifier.html +++ b/classes/ParcelCollectionHandshakeVerifier.html @@ -1,7 +1,7 @@ -ParcelCollectionHandshakeVerifier | @relaycorp/relaynet-core

    Class ParcelCollectionHandshakeVerifier

    Hierarchy

    • Verifier
      • ParcelCollectionHandshakeVerifier

    Constructors

    constructor +ParcelCollectionHandshakeVerifier | @relaycorp/relaynet-core

    Class ParcelCollectionHandshakeVerifier

    Hierarchy

    • Verifier
      • ParcelCollectionHandshakeVerifier

    Constructors

    Properties

    Methods

    Constructors

    Properties

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    • Verify signatureSerialized and return the signer's certificate if valid.

      +

    Constructors

    Properties

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    • Verify signatureSerialized and return the signer's certificate if valid.

      Parameters

      • signatureSerialized: ArrayBuffer
      • expectedPlaintext: ArrayBuffer

      Returns Promise<Certificate>

      Throws

      CMSError if the signatureSerialized is invalid

      Throws

      CertificateError if the signer isn't trusted

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelDelivery.html b/classes/ParcelDelivery.html index 296af1c8..ee771749 100644 --- a/classes/ParcelDelivery.html +++ b/classes/ParcelDelivery.html @@ -1,6 +1,6 @@ -ParcelDelivery | @relaycorp/relaynet-core

    Constructors

    constructor +ParcelDelivery | @relaycorp/relaynet-core

    Constructors

    Properties

    deliveryId: string
    parcelSerialized: ArrayBuffer

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    deliveryId: string
    parcelSerialized: ArrayBuffer

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelDeliverySigner.html b/classes/ParcelDeliverySigner.html index 0e56020b..bc116582 100644 --- a/classes/ParcelDeliverySigner.html +++ b/classes/ParcelDeliverySigner.html @@ -1,8 +1,8 @@ -ParcelDeliverySigner | @relaycorp/relaynet-core

    Hierarchy

    • Signer
      • ParcelDeliverySigner

    Constructors

    constructor +ParcelDeliverySigner | @relaycorp/relaynet-core

    Hierarchy

    • Signer
      • ParcelDeliverySigner

    Constructors

    Properties

    Methods

    Constructors

    Properties

    certificate: Certificate

    The certificate of the node

    -
    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ParcelDeliverySigner

    Properties

    certificate: Certificate

    The certificate of the node

    +
    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelDeliveryVerifier.html b/classes/ParcelDeliveryVerifier.html index e4c54ed2..12a0ff0c 100644 --- a/classes/ParcelDeliveryVerifier.html +++ b/classes/ParcelDeliveryVerifier.html @@ -1,7 +1,7 @@ -ParcelDeliveryVerifier | @relaycorp/relaynet-core

    Hierarchy

    • Verifier
      • ParcelDeliveryVerifier

    Constructors

    constructor +ParcelDeliveryVerifier | @relaycorp/relaynet-core

    Hierarchy

    • Verifier
      • ParcelDeliveryVerifier

    Constructors

    Properties

    Methods

    Constructors

    Properties

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    • Verify signatureSerialized and return the signer's certificate if valid.

      +

    Constructors

    Properties

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    • Verify signatureSerialized and return the signer's certificate if valid.

      Parameters

      • signatureSerialized: ArrayBuffer
      • expectedPlaintext: ArrayBuffer

      Returns Promise<Certificate>

      Throws

      CMSError if the signatureSerialized is invalid

      Throws

      CertificateError if the signer isn't trusted

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateEndpointConnParams.html b/classes/PrivateEndpointConnParams.html index 4954cf70..5c718b54 100644 --- a/classes/PrivateEndpointConnParams.html +++ b/classes/PrivateEndpointConnParams.html @@ -1,8 +1,8 @@ -PrivateEndpointConnParams | @relaycorp/relaynet-core

    Constructors

    constructor +PrivateEndpointConnParams | @relaycorp/relaynet-core

    Constructors

    Properties

    deliveryAuth: CertificationPath
    identityKey: CryptoKey
    internetGatewayAddress: string
    sessionKey?: SessionKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    deliveryAuth: CertificationPath
    identityKey: CryptoKey
    internetGatewayAddress: string
    sessionKey?: SessionKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateGateway.html b/classes/PrivateGateway.html index 8d4be7c3..3c94c1ec 100644 --- a/classes/PrivateGateway.html +++ b/classes/PrivateGateway.html @@ -1,4 +1,4 @@ -PrivateGateway | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +PrivateGateway | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions>
    id: string
    identityKeyPair: CryptoKeyPair
    keyStores: KeyStoreSet

    Methods

    • Generate and store a new session key.

      +

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions>
    id: string
    identityKeyPair: CryptoKeyPair
    keyStores: KeyStoreSet

    Methods

    • Type Parameters

      • S extends Signer<S>

      Parameters

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

            Returns S

      Returns Promise<null | S>

    • Type Parameters

      • V extends Verifier<V>

      Parameters

      • peerId: string
      • verifierClass: (new (trustedCertificates) => V)
          • new (trustedCertificates): V
          • Parameters

            Returns V

      Returns Promise<V>

    • Produce a PrivateNodeRegistrationRequest to register with a Internet gateway.

      -

      Parameters

      • authorizationSerialized: ArrayBuffer

      Returns Promise<ArrayBuffer>

    • Create channel with Internet gateway using registration details.

      +

    Returns Promise<SessionKey>

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateGatewayManager.html b/classes/PrivateGatewayManager.html index 752bd1dc..706e7ba2 100644 --- a/classes/PrivateGatewayManager.html +++ b/classes/PrivateGatewayManager.html @@ -1,6 +1,6 @@ -PrivateGatewayManager | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +PrivateGatewayManager | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    Methods

    get -

    Constructors

    Properties

    keyStores: KeyStoreSet

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    keyStores: KeyStoreSet

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateInternetGatewayChannel.html b/classes/PrivateInternetGatewayChannel.html index 2269c42b..0e77a022 100644 --- a/classes/PrivateInternetGatewayChannel.html +++ b/classes/PrivateInternetGatewayChannel.html @@ -1,5 +1,5 @@ PrivateInternetGatewayChannel | @relaycorp/relaynet-core

    Channel between a private gateway (the node) and its Internet gateway (the peer).

    -

    Hierarchy

    • PrivateGatewayChannel<string>
      • PrivateInternetGatewayChannel

    Constructors

    Hierarchy

    • PrivateGatewayChannel<string>
      • PrivateInternetGatewayChannel

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions> = {}
    deliveryAuthPath: CertificationPath
    keyStores: KeyStoreSet
    node: Node<GatewayPayload, string>
    peer: Peer<string>

    Methods

    • Generate a PrivateNodeRegistrationAuthorization with the gatewayData and expiryDate.

      -

      Parameters

      • gatewayData: ArrayBuffer
      • expiryDate: Date

      Returns Promise<ArrayBuffer>

    • Generate and serialise a message with the given payload.

      +

    Constructors

    Properties

    cryptoOptions: Partial<NodeCryptoOptions> = {}
    deliveryAuthPath: CertificationPath
    keyStores: KeyStoreSet
    node: Node<GatewayPayload, string>
    peer: Peer<string>

    Methods

    • Generate a PrivateNodeRegistrationAuthorization with the gatewayData and expiryDate.

      +

      Parameters

      • gatewayData: ArrayBuffer
      • expiryDate: Date

      Returns Promise<ArrayBuffer>

    • Generate and serialise a message with the given payload.

      Parameters

      • payload: ArrayBuffer | GatewayPayload

        The payload to encrypt and encapsulate

      • messageConstructor: RAMFMessageConstructor<GatewayPayload>

        The message class constructor

        -
      • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}

      Returns Promise<ArrayBuffer>

    • Return a PrivateNodeRegistration including a new certificate for endpointPublicKey.

      +
    • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}

    Returns Promise<ArrayBuffer>

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateKey.html b/classes/PrivateKey.html index a8237d7c..0e901b39 100644 --- a/classes/PrivateKey.html +++ b/classes/PrivateKey.html @@ -1,4 +1,4 @@ -PrivateKey | @relaycorp/relaynet-core

    Hierarchy (view full)

    Implements

    • CryptoKeyWithProvider

    Constructors

    constructor +PrivateKey | @relaycorp/relaynet-core

    Hierarchy (view full)

    Implements

    • CryptoKeyWithProvider

    Constructors

    Properties

    Methods

    Constructors

    Properties

    algorithm: KeyAlgorithm
    extractable: true = true
    provider: ProviderCrypto
    type: KeyType = ...
    usages: KeyUsages

    Methods

    • Type Parameters

      • T extends CryptoKey$1<T>

      Parameters

      • this: (new () => T)
          • new (): T
          • Returns T

      • algorithm: KeyAlgorithm
      • type: KeyType
      • extractable: boolean
      • usages: KeyUsages

      Returns T

    • Parameters

      • data: any

      Returns data is KeyType

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    algorithm: KeyAlgorithm
    extractable: true = true
    provider: ProviderCrypto
    type: KeyType = ...
    usages: KeyUsages

    Methods

    • Type Parameters

      • T extends CryptoKey$1<T>

      Parameters

      • this: (new () => T)
          • new (): T
          • Returns T

      • algorithm: KeyAlgorithm
      • type: KeyType
      • extractable: boolean
      • usages: KeyUsages

      Returns T

    • Parameters

      • data: any

      Returns data is KeyType

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateKeyStore.html b/classes/PrivateKeyStore.html index c9fa5939..629c2d09 100644 --- a/classes/PrivateKeyStore.html +++ b/classes/PrivateKeyStore.html @@ -1,22 +1,22 @@ -PrivateKeyStore | @relaycorp/relaynet-core

    Class PrivateKeyStoreAbstract

    Hierarchy (view full)

    Constructors

    constructor +PrivateKeyStore | @relaycorp/relaynet-core

    Class PrivateKeyStoreAbstract

    Hierarchy (view full)

    Constructors

    Methods

    • Return the private component of a node key pair if it exists.

      +

    Constructors

    Methods

    • Return the private component of a node key pair if it exists.

      Parameters

      • nodeId: string

      Returns Promise<null | CryptoKey>

      Throws

      if the backend failed to retrieve the key due to an error

      -
    • Retrieve private session key, regardless of whether it's an initial key or not.

      Parameters

      • keyId: Buffer

        The key pair id (typically the serial number)

      • nodeId: string

        The id of the node that owns the key

      • peerId: string

        The id of the recipient, in case the key is bound to a recipient

      Returns Promise<CryptoKey>

      Throws

      UnknownKeyError when the key does not exist

      Throws

      PrivateKeyStoreError when the look-up could not be done

      -
    • Return the private component of an initial session key pair.

      Parameters

      • keyId: Buffer

        The key pair id (typically the serial number)

      • nodeId: string

        The id of the node that owns the key

      Returns Promise<CryptoKey>

      Throws

      UnknownKeyError when the key does not exist

      Throws

      PrivateKeyStoreError when the look-up could not be done

      -
    • Parameters

      • privateKey: CryptoKey
      • keyId: Buffer
      • nodeId: string
      • Optional peerId: string

      Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateNodeRegistration.html b/classes/PrivateNodeRegistration.html index 9af8ce51..70d80ed3 100644 --- a/classes/PrivateNodeRegistration.html +++ b/classes/PrivateNodeRegistration.html @@ -1,8 +1,8 @@ -PrivateNodeRegistration | @relaycorp/relaynet-core

    Constructors

    constructor +PrivateNodeRegistration | @relaycorp/relaynet-core

    Constructors

    Properties

    gatewayCertificate: Certificate
    internetGatewayInternetAddress: string
    privateNodeCertificate: Certificate
    sessionKey: null | SessionKey = null

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    gatewayCertificate: Certificate
    internetGatewayInternetAddress: string
    privateNodeCertificate: Certificate
    sessionKey: null | SessionKey = null

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateNodeRegistrationAuthorization.html b/classes/PrivateNodeRegistrationAuthorization.html index 19f86319..917eb3be 100644 --- a/classes/PrivateNodeRegistrationAuthorization.html +++ b/classes/PrivateNodeRegistrationAuthorization.html @@ -1,6 +1,6 @@ -PrivateNodeRegistrationAuthorization | @relaycorp/relaynet-core

    Class PrivateNodeRegistrationAuthorization

    Constructors

    constructor +PrivateNodeRegistrationAuthorization | @relaycorp/relaynet-core

    Class PrivateNodeRegistrationAuthorization

    Constructors

    Properties

    Methods

    Constructors

    Properties

    expiryDate: Date
    gatewayData: ArrayBuffer

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    expiryDate: Date
    gatewayData: ArrayBuffer

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PrivateNodeRegistrationRequest.html b/classes/PrivateNodeRegistrationRequest.html index a88b9b5f..8e7ccc33 100644 --- a/classes/PrivateNodeRegistrationRequest.html +++ b/classes/PrivateNodeRegistrationRequest.html @@ -1,6 +1,6 @@ -PrivateNodeRegistrationRequest | @relaycorp/relaynet-core

    Class PrivateNodeRegistrationRequest

    Constructors

    constructor +PrivateNodeRegistrationRequest | @relaycorp/relaynet-core

    Class PrivateNodeRegistrationRequest

    Constructors

    Properties

    pnraSerialized: ArrayBuffer
    privateNodePublicKey: CryptoKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    pnraSerialized: ArrayBuffer
    privateNodePublicKey: CryptoKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/PublicKeyStore.html b/classes/PublicKeyStore.html index cef4e5b7..f9f3972a 100644 --- a/classes/PublicKeyStore.html +++ b/classes/PublicKeyStore.html @@ -1,6 +1,6 @@ -PublicKeyStore | @relaycorp/relaynet-core

    Class PublicKeyStoreAbstract

    Hierarchy (view full)

    Constructors

    constructor +PublicKeyStore | @relaycorp/relaynet-core

    Class PublicKeyStoreAbstract

    Hierarchy (view full)

    Constructors

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RAMFError.html b/classes/RAMFError.html index affada8e..b994f585 100644 --- a/classes/RAMFError.html +++ b/classes/RAMFError.html @@ -1,5 +1,5 @@ RAMFError | @relaycorp/relaynet-core

    Error while processing RAMF message.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -19,5 +19,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RAMFMessage.html b/classes/RAMFMessage.html index cb3372a3..6a851ff9 100644 --- a/classes/RAMFMessage.html +++ b/classes/RAMFMessage.html @@ -1,5 +1,5 @@ RAMFMessage | @relaycorp/relaynet-core

    Class RAMFMessage<Payload>Abstract

    Relaynet Abstract Message Format, version 1.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    Type Parameters

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    creationDate: Date
    id: string
    payloadSerialized: Buffer
    recipient: Recipient
    senderCaCertificateChain: readonly Certificate[]
    senderCertificate: Certificate
    ttl: number

    Accessors

    Methods

    • Return certification path between sender's certificate and one certificate in +

    Constructors

    Properties

    creationDate: Date
    id: string
    payloadSerialized: Buffer
    recipient: Recipient
    senderCaCertificateChain: readonly Certificate[]
    senderCertificate: Certificate
    ttl: number

    Accessors

    Methods

    • Return RAMF serialization of message.

      -

      Parameters

      Returns Promise<ArrayBuffer>

    • Return RAMF serialization of message.

      +

      Parameters

      Returns Promise<ArrayBuffer>

    • Report whether the message is valid.

      This doesn't check whether the sender is authorised.

      -

      Returns Promise<null>

    • Report whether the message is valid and the sender was authorised by one of the +

      Returns Promise<null>

    • Report whether the message is valid and the sender was authorised by one of the trustedCertificates.

      Parameters

      Returns Promise<readonly Certificate[]>

      The certification path from the sender to one of the trustedCertificates

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RAMFSyntaxError.html b/classes/RAMFSyntaxError.html index 86d3cebe..da4d5ae9 100644 --- a/classes/RAMFSyntaxError.html +++ b/classes/RAMFSyntaxError.html @@ -1,5 +1,5 @@ RAMFSyntaxError | @relaycorp/relaynet-core

    Syntax error detected in value meant to comply with RAMF spec.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -19,5 +19,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RAMFValidationError.html b/classes/RAMFValidationError.html index 6f0823b1..ec1b3677 100644 --- a/classes/RAMFValidationError.html +++ b/classes/RAMFValidationError.html @@ -1,5 +1,5 @@ RAMFValidationError | @relaycorp/relaynet-core

    Error while validating RAMF message.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -19,5 +19,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RelaynetError.html b/classes/RelaynetError.html index a569b1d3..bbf3d46c 100644 --- a/classes/RelaynetError.html +++ b/classes/RelaynetError.html @@ -1,4 +1,4 @@ -RelaynetError | @relaycorp/relaynet-core

    Class RelaynetErrorAbstract

    Hierarchy (view full)

    Constructors

    constructor +RelaynetError | @relaycorp/relaynet-core

    Class RelaynetErrorAbstract

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -18,5 +18,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RsaPssPrivateKey.html b/classes/RsaPssPrivateKey.html index 88498090..4788ef4f 100644 --- a/classes/RsaPssPrivateKey.html +++ b/classes/RsaPssPrivateKey.html @@ -1,4 +1,4 @@ -RsaPssPrivateKey | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +RsaPssPrivateKey | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    Methods

    Constructors

    Properties

    algorithm: KeyAlgorithm
    extractable: true = true
    provider: ProviderCrypto
    type: KeyType = ...
    usages: KeyUsages = ...

    Methods

    • Type Parameters

      • T extends CryptoKey$1<T>

      Parameters

      • this: (new () => T)
          • new (): T
          • Returns T

      • algorithm: KeyAlgorithm
      • type: KeyType
      • extractable: boolean
      • usages: KeyUsages

      Returns T

    • Parameters

      • data: any

      Returns data is KeyType

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    algorithm: KeyAlgorithm
    extractable: true = true
    provider: ProviderCrypto
    type: KeyType = ...
    usages: KeyUsages = ...

    Methods

    • Type Parameters

      • T extends CryptoKey$1<T>

      Parameters

      • this: (new () => T)
          • new (): T
          • Returns T

      • algorithm: KeyAlgorithm
      • type: KeyType
      • extractable: boolean
      • usages: KeyUsages

      Returns T

    • Parameters

      • data: any

      Returns data is KeyType

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ServiceMessage.html b/classes/ServiceMessage.html index e2d62c0a..9391a03c 100644 --- a/classes/ServiceMessage.html +++ b/classes/ServiceMessage.html @@ -1,9 +1,9 @@ ServiceMessage | @relaycorp/relaynet-core

    Service message as encapsulated in a parcel.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    content: Buffer
    type: string

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    content: Buffer
    type: string

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/SessionEnvelopedData.html b/classes/SessionEnvelopedData.html index 4f9af5b3..9f76aaa2 100644 --- a/classes/SessionEnvelopedData.html +++ b/classes/SessionEnvelopedData.html @@ -1,6 +1,6 @@ SessionEnvelopedData | @relaycorp/relaynet-core

    CMS EnvelopedData representation using the Channel Session Protocol.

    Consequently, it uses the key agreement (KeyAgreeRecipientInfo) from CMS.

    -

    Hierarchy (view full)

    Methods

    Hierarchy (view full)

    Methods

    • Return the plaintext for the ciphertext contained in the current EnvelopedData value.

      Parameters

      • privateKey: CryptoKey

        The private key to decrypt the ciphertext.

        -

      Returns Promise<ArrayBuffer>

    • Return the id of the recipient's key used to encrypt the content.

      +

    Returns Promise<ArrayBuffer>

    • Return the id of the recipient's key used to encrypt the content.

      This id will often be the recipient's certificate's serial number, in which case the issuer will be ignored: This method is meant to be used by the recipient so it can look up the corresponding private key to decrypt the content. We could certainly extract the issuer to verify it matches the expected one, but if the id doesn't match any key decryption won't even be attempted, so there's really no risk from ignoring the issuer.

      -

      Returns Buffer

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<SessionEncryptionResult>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/SessionKeyPair.html b/classes/SessionKeyPair.html index e112fe56..74df10cf 100644 --- a/classes/SessionKeyPair.html +++ b/classes/SessionKeyPair.html @@ -1,6 +1,6 @@ -SessionKeyPair | @relaycorp/relaynet-core

    Constructors

    constructor +SessionKeyPair | @relaycorp/relaynet-core

    Constructors

    Properties

    Methods

    Constructors

    Properties

    privateKey: CryptoKey
    sessionKey: SessionKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    privateKey: CryptoKey
    sessionKey: SessionKey

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/SessionlessEnvelopedData.html b/classes/SessionlessEnvelopedData.html index 9f1a028b..b0b1d652 100644 --- a/classes/SessionlessEnvelopedData.html +++ b/classes/SessionlessEnvelopedData.html @@ -1,25 +1,25 @@ SessionlessEnvelopedData | @relaycorp/relaynet-core

    CMS EnvelopedData representation that doesn't use the Channel Session Protocol.

    Consequently, it uses the key transport choice (KeyTransRecipientInfo) from CMS.

    -

    Hierarchy (view full)

    Methods

    Hierarchy (view full)

    Methods

    • Return the plaintext for the ciphertext contained in the current EnvelopedData value.

      Parameters

      • privateKey: CryptoKey

        The private key to decrypt the ciphertext.

        -

      Returns Promise<ArrayBuffer>

    • Return the id of the recipient's key used to encrypt the content.

      +

    Returns Promise<ArrayBuffer>

    • Return the id of the recipient's key used to encrypt the content.

      This id will often be the recipient's certificate's serial number, in which case the issuer will be ignored: This method is meant to be used by the recipient so it can look up the corresponding private key to decrypt the content. We could certainly extract the issuer to verify it matches the expected one, but if the id doesn't match any key decryption won't even be attempted, so there's really no risk from ignoring the issuer.

      -

      Returns Buffer

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<SessionlessEnvelopedData>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/UnknownKeyError.html b/classes/UnknownKeyError.html index 5bff4235..8774de4d 100644 --- a/classes/UnknownKeyError.html +++ b/classes/UnknownKeyError.html @@ -1,5 +1,5 @@ UnknownKeyError | @relaycorp/relaynet-core

    Error thrown when a peer references an invalid key.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -19,5 +19,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/UnreachableResolverError.html b/classes/UnreachableResolverError.html index 9c2967cf..35416988 100644 --- a/classes/UnreachableResolverError.html +++ b/classes/UnreachableResolverError.html @@ -1,4 +1,4 @@ -UnreachableResolverError | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    constructor +UnreachableResolverError | @relaycorp/relaynet-core

    Hierarchy (view full)

    Constructors

    Properties

    cause message stack? @@ -18,5 +18,5 @@

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • Parameters

      • err: Error

      Returns null | Error

    • Parameters

      • err: Error
      • func: ((err) => void)
          • (err): void
          • Parameters

            • err: Error

            Returns void

      Returns void

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    • Parameters

      • err: Error

      Returns string

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    • Parameters

      • err: Error

      Returns Info

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/BindingType.html b/enums/BindingType.html index 1742b1f5..73cb3b7b 100644 --- a/enums/BindingType.html +++ b/enums/BindingType.html @@ -1,4 +1,4 @@ -BindingType | @relaycorp/relaynet-core

    Enumeration Members

    CRC +BindingType | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CRC: "awala-crc"
    GSC: "awala-gsc"
    PDC: "awala-pdc"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/StreamingMode.html b/enums/StreamingMode.html index 8fc20321..5b60af66 100644 --- a/enums/StreamingMode.html +++ b/enums/StreamingMode.html @@ -1,3 +1,3 @@ -StreamingMode | @relaycorp/relaynet-core

    Enumeration StreamingMode

    Enumeration Members

    CLOSE_UPON_COMPLETION +StreamingMode | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CLOSE_UPON_COMPLETION: "close-upon-completion"
    KEEP_ALIVE: "keep-alive"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeECDHPrivateKey.html b/functions/derDeserializeECDHPrivateKey.html index bfdf3491..5a7feda9 100644 --- a/functions/derDeserializeECDHPrivateKey.html +++ b/functions/derDeserializeECDHPrivateKey.html @@ -1,2 +1,2 @@ derDeserializeECDHPrivateKey | @relaycorp/relaynet-core

    Function derDeserializeECDHPrivateKey

    • Parse DER-serialized ECDH private key.

      -

      Parameters

      • privateKeyDer: Buffer
      • curveName: string = 'P-256'

      Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • privateKeyDer: Buffer
    • curveName: string = 'P-256'

    Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeECDHPublicKey.html b/functions/derDeserializeECDHPublicKey.html index 09beabc7..b498f724 100644 --- a/functions/derDeserializeECDHPublicKey.html +++ b/functions/derDeserializeECDHPublicKey.html @@ -1,2 +1,2 @@ derDeserializeECDHPublicKey | @relaycorp/relaynet-core

    Function derDeserializeECDHPublicKey

    • Parse DER-serialized ECDH public key.

      -

      Parameters

      • publicKeyDer: ArrayBuffer | Buffer
      • curveName: string = 'P-256'

      Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeRSAPrivateKey.html b/functions/derDeserializeRSAPrivateKey.html index 0b52cd37..b641cd19 100644 --- a/functions/derDeserializeRSAPrivateKey.html +++ b/functions/derDeserializeRSAPrivateKey.html @@ -1,2 +1,2 @@ derDeserializeRSAPrivateKey | @relaycorp/relaynet-core

    Function derDeserializeRSAPrivateKey

    • Parse DER-serialized RSA private key.

      -

      Parameters

      • privateKeyDer: Buffer
      • algorithmOptions: RsaHashedImportParams = DEFAULT_RSA_KEY_PARAMS

      Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeRSAPublicKey.html b/functions/derDeserializeRSAPublicKey.html index 2686dd56..c2cd2a37 100644 --- a/functions/derDeserializeRSAPublicKey.html +++ b/functions/derDeserializeRSAPublicKey.html @@ -1,2 +1,2 @@ derDeserializeRSAPublicKey | @relaycorp/relaynet-core

    Function derDeserializeRSAPublicKey

    • Parse DER-serialized RSA public key.

      -

      Parameters

      • publicKeyDer: ArrayBuffer | Buffer
      • algorithmOptions: RsaHashedImportParams = DEFAULT_RSA_KEY_PARAMS

      Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derSerializePrivateKey.html b/functions/derSerializePrivateKey.html index d8cb1e17..9e133b45 100644 --- a/functions/derSerializePrivateKey.html +++ b/functions/derSerializePrivateKey.html @@ -1,2 +1,2 @@ derSerializePrivateKey | @relaycorp/relaynet-core

    Function derSerializePrivateKey

    • Return DER serialization of private key.

      -

      Parameters

      • privateKey: CryptoKey

      Returns Promise<Buffer>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Buffer>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derSerializePublicKey.html b/functions/derSerializePublicKey.html index d5351262..d4411e46 100644 --- a/functions/derSerializePublicKey.html +++ b/functions/derSerializePublicKey.html @@ -1,2 +1,2 @@ derSerializePublicKey | @relaycorp/relaynet-core

    Function derSerializePublicKey

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Buffer>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/generateECDHKeyPair.html b/functions/generateECDHKeyPair.html index 88c180bc..4a1b263d 100644 --- a/functions/generateECDHKeyPair.html +++ b/functions/generateECDHKeyPair.html @@ -1,2 +1,2 @@ generateECDHKeyPair | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKeyPair>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/generateRSAKeyPair.html b/functions/generateRSAKeyPair.html index 321d19e5..26b5aa68 100644 --- a/functions/generateRSAKeyPair.html +++ b/functions/generateRSAKeyPair.html @@ -1,4 +1,4 @@ generateRSAKeyPair | @relaycorp/relaynet-core
    • Generate an RSA-PSS key pair.

      Parameters

      Returns Promise<CryptoKeyPair>

      Throws

      Error If the modulus or the hashing algorithm is disallowed by RS-018.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getIdFromIdentityKey.html b/functions/getIdFromIdentityKey.html index bbcbaca9..1e2e50a3 100644 --- a/functions/getIdFromIdentityKey.html +++ b/functions/getIdFromIdentityKey.html @@ -1 +1 @@ -getIdFromIdentityKey | @relaycorp/relaynet-core
    • Parameters

      • identityPublicKey: CryptoKey

      Returns Promise<string>

    Generated using TypeDoc

    \ No newline at end of file +getIdFromIdentityKey | @relaycorp/relaynet-core
    • Parameters

      • identityPublicKey: CryptoKey

      Returns Promise<string>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getPublicKeyDigest.html b/functions/getPublicKeyDigest.html index 85e32711..0ae371f9 100644 --- a/functions/getPublicKeyDigest.html +++ b/functions/getPublicKeyDigest.html @@ -1,2 +1,2 @@ getPublicKeyDigest | @relaycorp/relaynet-core
    • Return SHA-256 digest of public key.

      -

      Parameters

      • publicKey: CryptoKey

      Returns Promise<ArrayBuffer>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<ArrayBuffer>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getPublicKeyDigestHex.html b/functions/getPublicKeyDigestHex.html index a21fc6b6..1cc0ae24 100644 --- a/functions/getPublicKeyDigestHex.html +++ b/functions/getPublicKeyDigestHex.html @@ -1,2 +1,2 @@ getPublicKeyDigestHex | @relaycorp/relaynet-core

    Function getPublicKeyDigestHex

    • Return hexadecimal, SHA-256 digest of public key.

      -

      Parameters

      • publicKey: CryptoKey

      Returns Promise<string>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<string>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getRSAPublicKeyFromPrivate.html b/functions/getRSAPublicKeyFromPrivate.html index 9b47623c..6b462c3a 100644 --- a/functions/getRSAPublicKeyFromPrivate.html +++ b/functions/getRSAPublicKeyFromPrivate.html @@ -1 +1 @@ -getRSAPublicKeyFromPrivate | @relaycorp/relaynet-core

    Function getRSAPublicKeyFromPrivate

    Generated using TypeDoc

    \ No newline at end of file +getRSAPublicKeyFromPrivate | @relaycorp/relaynet-core

    Function getRSAPublicKeyFromPrivate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/issueDeliveryAuthorization.html b/functions/issueDeliveryAuthorization.html index 40873c61..b5a5396b 100644 --- a/functions/issueDeliveryAuthorization.html +++ b/functions/issueDeliveryAuthorization.html @@ -1,4 +1,4 @@ issueDeliveryAuthorization | @relaycorp/relaynet-core

    Function issueDeliveryAuthorization

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Certificate>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/issueEndpointCertificate.html b/functions/issueEndpointCertificate.html index bf7ef022..17327301 100644 --- a/functions/issueEndpointCertificate.html +++ b/functions/issueEndpointCertificate.html @@ -1,4 +1,4 @@ issueEndpointCertificate | @relaycorp/relaynet-core

    Function issueEndpointCertificate

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Certificate>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/issueGatewayCertificate.html b/functions/issueGatewayCertificate.html index 20b0bb9a..49033a41 100644 --- a/functions/issueGatewayCertificate.html +++ b/functions/issueGatewayCertificate.html @@ -1,3 +1,3 @@ issueGatewayCertificate | @relaycorp/relaynet-core

    Function issueGatewayCertificate

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Certificate>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/resolveInternetAddress.html b/functions/resolveInternetAddress.html index 61ca991a..0f68239a 100644 --- a/functions/resolveInternetAddress.html +++ b/functions/resolveInternetAddress.html @@ -7,4 +7,4 @@

    Throws

    If the DNS resolver was unreachable

    null is returned when hostName is an IP address or a non-existing SRV record for the service in bindingType.

    DNS resolution is done with DNS-over-HTTPS.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/CargoDeliveryRequest.html b/interfaces/CargoDeliveryRequest.html index 3cc2f837..95bdad70 100644 --- a/interfaces/CargoDeliveryRequest.html +++ b/interfaces/CargoDeliveryRequest.html @@ -1,4 +1,4 @@ CargoDeliveryRequest | @relaycorp/relaynet-core

    Interface CargoDeliveryRequest

    Request to deliver a cargo.

    -
    interface CargoDeliveryRequest {
        cargo: Buffer;
        localId: string;
    }

    Properties

    interface CargoDeliveryRequest {
        cargo: Buffer;
        localId: string;
    }

    Properties

    Properties

    cargo: Buffer
    localId: string

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    cargo: Buffer
    localId: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/CargoRelayClient.html b/interfaces/CargoRelayClient.html index 74620476..84bda19d 100644 --- a/interfaces/CargoRelayClient.html +++ b/interfaces/CargoRelayClient.html @@ -1,13 +1,13 @@ CargoRelayClient | @relaycorp/relaynet-core

    Interface for cargo relay clients

    -
    interface CargoRelayClient {
        close: (() => void);
        collectCargo: (() => readonly Buffer[]);
        deliverCargo: ((cargo) => IterableIterator<string>);
    }

    Properties

    interface CargoRelayClient {
        close: (() => void);
        collectCargo: (() => readonly Buffer[]);
        deliverCargo: ((cargo) => IterableIterator<string>);
    }

    Properties

    close: (() => void)

    Close the underlying connection, if applicable

    Type declaration

      • (): void
      • Close the underlying connection, if applicable

        -

        Returns void

    collectCargo: (() => readonly Buffer[])

    Collect and return cargo

    +

    Returns void

    collectCargo: (() => readonly Buffer[])

    Collect and return cargo

    Type declaration

      • (): readonly Buffer[]
      • Collect and return cargo

        -

        Returns readonly Buffer[]

    deliverCargo: ((cargo) => IterableIterator<string>)

    Deliver the cargo yielded by the input iterator and return the local ids of the acknowledged +

    Returns readonly Buffer[]

    deliverCargo: ((cargo) => IterableIterator<string>)

    Deliver the cargo yielded by the input iterator and return the local ids of the acknowledged deliveries

    Type declaration

      • (cargo): IterableIterator<string>
      • Deliver the cargo yielded by the input iterator and return the local ids of the acknowledged deliveries

        -

        Parameters

        Returns IterableIterator<string>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns IterableIterator<string>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/DeliveryAuthorizationIssuanceOptions.html b/interfaces/DeliveryAuthorizationIssuanceOptions.html index 50107e5c..b2d21949 100644 --- a/interfaces/DeliveryAuthorizationIssuanceOptions.html +++ b/interfaces/DeliveryAuthorizationIssuanceOptions.html @@ -1,6 +1,6 @@ -DeliveryAuthorizationIssuanceOptions | @relaycorp/relaynet-core

    Interface DeliveryAuthorizationIssuanceOptions

    interface DeliveryAuthorizationIssuanceOptions {
        issuerCertificate: Certificate;
        issuerPrivateKey: CryptoKey;
        subjectPublicKey: CryptoKey;
        validityEndDate: Date;
        validityStartDate?: Date;
    }

    Hierarchy

    • BasicCertificateIssuanceOptions
      • DeliveryAuthorizationIssuanceOptions

    Properties

    issuerCertificate +DeliveryAuthorizationIssuanceOptions | @relaycorp/relaynet-core

    Interface DeliveryAuthorizationIssuanceOptions

    interface DeliveryAuthorizationIssuanceOptions {
        issuerCertificate: Certificate;
        issuerPrivateKey: CryptoKey;
        subjectPublicKey: CryptoKey;
        validityEndDate: Date;
        validityStartDate?: Date;
    }

    Hierarchy

    • BasicCertificateIssuanceOptions
      • DeliveryAuthorizationIssuanceOptions

    Properties

    issuerCertificate: Certificate
    issuerPrivateKey: CryptoKey
    subjectPublicKey: CryptoKey
    validityEndDate: Date
    validityStartDate?: Date

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    issuerCertificate: Certificate
    issuerPrivateKey: CryptoKey
    subjectPublicKey: CryptoKey
    validityEndDate: Date
    validityStartDate?: Date

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/EncryptionOptions.html b/interfaces/EncryptionOptions.html index 391187dc..e307be17 100644 --- a/interfaces/EncryptionOptions.html +++ b/interfaces/EncryptionOptions.html @@ -1,3 +1,3 @@ -EncryptionOptions | @relaycorp/relaynet-core
    interface EncryptionOptions {
        aesKeySize: number;
    }

    Properties

    aesKeySize +EncryptionOptions | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/EndpointCertificateIssuanceOptions.html b/interfaces/EndpointCertificateIssuanceOptions.html index 79a3ea66..373f7189 100644 --- a/interfaces/EndpointCertificateIssuanceOptions.html +++ b/interfaces/EndpointCertificateIssuanceOptions.html @@ -1,6 +1,6 @@ -EndpointCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface EndpointCertificateIssuanceOptions

    interface EndpointCertificateIssuanceOptions {
        issuerCertificate?: Certificate;
        issuerPrivateKey: CryptoKey;
        subjectPublicKey: CryptoKey;
        validityEndDate: Date;
        validityStartDate?: Date;
    }

    Hierarchy

    • BasicCertificateIssuanceOptions
      • EndpointCertificateIssuanceOptions

    Properties

    issuerCertificate? +EndpointCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface EndpointCertificateIssuanceOptions

    interface EndpointCertificateIssuanceOptions {
        issuerCertificate?: Certificate;
        issuerPrivateKey: CryptoKey;
        subjectPublicKey: CryptoKey;
        validityEndDate: Date;
        validityStartDate?: Date;
    }

    Hierarchy

    • BasicCertificateIssuanceOptions
      • EndpointCertificateIssuanceOptions

    Properties

    issuerCertificate?: Certificate
    issuerPrivateKey: CryptoKey
    subjectPublicKey: CryptoKey
    validityEndDate: Date
    validityStartDate?: Date

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    issuerCertificate?: Certificate
    issuerPrivateKey: CryptoKey
    subjectPublicKey: CryptoKey
    validityEndDate: Date
    validityStartDate?: Date

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/GSCClient.html b/interfaces/GSCClient.html index 5a486ef5..e33a561d 100644 --- a/interfaces/GSCClient.html +++ b/interfaces/GSCClient.html @@ -1,5 +1,5 @@ -GSCClient | @relaycorp/relaynet-core
    interface GSCClient {
        collectParcels: ((nonceSigners, streamingMode, handshakeCallback?) => AsyncIterable<ParcelCollection>);
        deliverParcel: ((parcelSerialized, signer) => Promise<void>);
        preRegisterNode: ((nodePublicKey) => Promise<ArrayBuffer>);
        registerNode: ((pnrrSerialized) => Promise<PrivateNodeRegistration>);
    }

    Properties

    collectParcels +GSCClient | @relaycorp/relaynet-core
    interface GSCClient {
        collectParcels: ((nonceSigners, streamingMode, handshakeCallback?) => AsyncIterable<ParcelCollection>);
        deliverParcel: ((parcelSerialized, signer) => Promise<void>);
        preRegisterNode: ((nodePublicKey) => Promise<ArrayBuffer>);
        registerNode: ((pnrrSerialized) => Promise<PrivateNodeRegistration>);
    }

    Properties

    collectParcels: ((nonceSigners, streamingMode, handshakeCallback?) => AsyncIterable<ParcelCollection>)

    Type declaration

    deliverParcel: ((parcelSerialized, signer) => Promise<void>)

    Type declaration

      • (parcelSerialized, signer): Promise<void>
      • Parameters

        Returns Promise<void>

    preRegisterNode: ((nodePublicKey) => Promise<ArrayBuffer>)

    Type declaration

      • (nodePublicKey): Promise<ArrayBuffer>
      • Parameters

        • nodePublicKey: CryptoKey

        Returns Promise<ArrayBuffer>

    registerNode: ((pnrrSerialized) => Promise<PrivateNodeRegistration>)

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    collectParcels: ((nonceSigners, streamingMode, handshakeCallback?) => AsyncIterable<ParcelCollection>)

    Type declaration

    deliverParcel: ((parcelSerialized, signer) => Promise<void>)

    Type declaration

      • (parcelSerialized, signer): Promise<void>
      • Parameters

        Returns Promise<void>

    preRegisterNode: ((nodePublicKey) => Promise<ArrayBuffer>)

    Type declaration

      • (nodePublicKey): Promise<ArrayBuffer>
      • Parameters

        • nodePublicKey: CryptoKey

        Returns Promise<ArrayBuffer>

    registerNode: ((pnrrSerialized) => Promise<PrivateNodeRegistration>)

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/GatewayCertificateIssuanceOptions.html b/interfaces/GatewayCertificateIssuanceOptions.html index aada88cb..f0279bbe 100644 --- a/interfaces/GatewayCertificateIssuanceOptions.html +++ b/interfaces/GatewayCertificateIssuanceOptions.html @@ -1,6 +1,6 @@ -GatewayCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface GatewayCertificateIssuanceOptions

    interface GatewayCertificateIssuanceOptions {
        issuerCertificate?: Certificate;
        issuerPrivateKey: CryptoKey;
        subjectPublicKey: CryptoKey;
        validityEndDate: Date;
        validityStartDate?: Date;
    }

    Hierarchy

    • BasicCertificateIssuanceOptions
      • GatewayCertificateIssuanceOptions

    Properties

    issuerCertificate? +GatewayCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface GatewayCertificateIssuanceOptions

    interface GatewayCertificateIssuanceOptions {
        issuerCertificate?: Certificate;
        issuerPrivateKey: CryptoKey;
        subjectPublicKey: CryptoKey;
        validityEndDate: Date;
        validityStartDate?: Date;
    }

    Hierarchy

    • BasicCertificateIssuanceOptions
      • GatewayCertificateIssuanceOptions

    Properties

    issuerCertificate?: Certificate
    issuerPrivateKey: CryptoKey
    subjectPublicKey: CryptoKey
    validityEndDate: Date
    validityStartDate?: Date

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    issuerCertificate?: Certificate
    issuerPrivateKey: CryptoKey
    subjectPublicKey: CryptoKey
    validityEndDate: Date
    validityStartDate?: Date

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IdentityKeyPair.html b/interfaces/IdentityKeyPair.html index 251f3e4f..c5cef135 100644 --- a/interfaces/IdentityKeyPair.html +++ b/interfaces/IdentityKeyPair.html @@ -1,4 +1,4 @@ -IdentityKeyPair | @relaycorp/relaynet-core
    interface IdentityKeyPair {
        id: string;
        privateKey: CryptoKey;
        publicKey: CryptoKey;
    }

    Hierarchy

    • CryptoKeyPair
      • IdentityKeyPair

    Properties

    id +IdentityKeyPair | @relaycorp/relaynet-core
    interface IdentityKeyPair {
        id: string;
        privateKey: CryptoKey;
        publicKey: CryptoKey;
    }

    Hierarchy

    • CryptoKeyPair
      • IdentityKeyPair

    Properties

    Properties

    id: string
    privateKey: CryptoKey
    publicKey: CryptoKey

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id: string
    privateKey: CryptoKey
    publicKey: CryptoKey

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/KeyStoreSet.html b/interfaces/KeyStoreSet.html index a124f3d0..60f1b22e 100644 --- a/interfaces/KeyStoreSet.html +++ b/interfaces/KeyStoreSet.html @@ -1,4 +1,4 @@ -KeyStoreSet | @relaycorp/relaynet-core
    interface KeyStoreSet {
        certificateStore: CertificateStore;
        privateKeyStore: PrivateKeyStore;
        publicKeyStore: PublicKeyStore;
    }

    Implemented by

    Properties

    certificateStore +KeyStoreSet | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    certificateStore: CertificateStore
    privateKeyStore: PrivateKeyStore
    publicKeyStore: PublicKeyStore

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/NodeCryptoOptions.html b/interfaces/NodeCryptoOptions.html index a1c5a91d..86a88780 100644 --- a/interfaces/NodeCryptoOptions.html +++ b/interfaces/NodeCryptoOptions.html @@ -1,3 +1,3 @@ -NodeCryptoOptions | @relaycorp/relaynet-core
    interface NodeCryptoOptions {
        encryption: Partial<EncryptionOptions>;
        signature: Partial<SignatureOptions>;
    }

    Properties

    encryption +NodeCryptoOptions | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    encryption: Partial<EncryptionOptions>
    signature: Partial<SignatureOptions>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Payload.html b/interfaces/Payload.html index 86bc3119..e3b55ce3 100644 --- a/interfaces/Payload.html +++ b/interfaces/Payload.html @@ -1,5 +1,5 @@ Payload | @relaycorp/relaynet-core

    Plaintext representation of a RAMF payload.

    Not to be confused with the final RAMF payload; e.g., a CMS EnvelopedData value containing the ciphertext representation of the plaintext.

    -
    interface Payload {
        serialize: (() => ArrayBuffer);
    }

    Implemented by

    Properties

    Properties

    serialize: (() => ArrayBuffer)

    Type declaration

      • (): ArrayBuffer
      • Returns ArrayBuffer

    Generated using TypeDoc

    \ No newline at end of file +
    interface Payload {
        serialize: (() => ArrayBuffer);
    }

    Implemented by

    Properties

    Properties

    serialize: (() => ArrayBuffer)

    Type declaration

      • (): ArrayBuffer
      • Returns ArrayBuffer

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/PublicNodeAddress.html b/interfaces/PublicNodeAddress.html index 6911dad9..b2a48087 100644 --- a/interfaces/PublicNodeAddress.html +++ b/interfaces/PublicNodeAddress.html @@ -1,3 +1,3 @@ -PublicNodeAddress | @relaycorp/relaynet-core
    interface PublicNodeAddress {
        host: string;
        port: number;
    }

    Properties

    host +PublicNodeAddress | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    host: string
    port: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/RSAKeyGenOptions.html b/interfaces/RSAKeyGenOptions.html index 5f72d125..f6bff232 100644 --- a/interfaces/RSAKeyGenOptions.html +++ b/interfaces/RSAKeyGenOptions.html @@ -1,3 +1,3 @@ -RSAKeyGenOptions | @relaycorp/relaynet-core
    interface RSAKeyGenOptions {
        hashingAlgorithm: HashingAlgorithm;
        modulus: RSAModulus;
    }

    Properties

    hashingAlgorithm +RSAKeyGenOptions | @relaycorp/relaynet-core
    interface RSAKeyGenOptions {
        hashingAlgorithm: HashingAlgorithm;
        modulus: RSAModulus;
    }

    Properties

    hashingAlgorithm: HashingAlgorithm
    modulus: RSAModulus

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    hashingAlgorithm: HashingAlgorithm
    modulus: RSAModulus

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Recipient.html b/interfaces/Recipient.html index 91578cd6..a60febda 100644 --- a/interfaces/Recipient.html +++ b/interfaces/Recipient.html @@ -1,3 +1,3 @@ -Recipient | @relaycorp/relaynet-core
    interface Recipient {
        id: string;
        internetAddress?: string;
    }

    Properties

    id +Recipient | @relaycorp/relaynet-core

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id: string
    internetAddress?: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SessionEncryptionResult.html b/interfaces/SessionEncryptionResult.html index 23e88f63..d70866cd 100644 --- a/interfaces/SessionEncryptionResult.html +++ b/interfaces/SessionEncryptionResult.html @@ -1,8 +1,8 @@ SessionEncryptionResult | @relaycorp/relaynet-core

    Interface SessionEncryptionResult

    Result of producing an EnvelopedData value with the Channel Session Protocol.

    -
    interface SessionEncryptionResult {
        dhKeyId: ArrayBuffer;
        dhPrivateKey: CryptoKey;
        envelopedData: SessionEnvelopedData;
    }

    Properties

    interface SessionEncryptionResult {
        dhKeyId: ArrayBuffer;
        dhPrivateKey: CryptoKey;
        envelopedData: SessionEnvelopedData;
    }

    Properties

    dhKeyId: ArrayBuffer

    Id of ECDH key pair.

    -
    dhPrivateKey: CryptoKey

    Private key of the ECDH key pair

    -
    envelopedData: SessionEnvelopedData

    EnvelopedData value using the Channel Session Protocol.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    dhPrivateKey: CryptoKey

    Private key of the ECDH key pair

    +
    envelopedData: SessionEnvelopedData

    EnvelopedData value using the Channel Session Protocol.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SessionKey.html b/interfaces/SessionKey.html index c238fc9a..6a7dda09 100644 --- a/interfaces/SessionKey.html +++ b/interfaces/SessionKey.html @@ -1,4 +1,4 @@ SessionKey | @relaycorp/relaynet-core

    Key of the sender or recipient of the EnvelopedData value using the Channel Session Protocol

    -
    interface SessionKey {
        keyId: Buffer;
        publicKey: CryptoKey;
    }

    Properties

    interface SessionKey {
        keyId: Buffer;
        publicKey: CryptoKey;
    }

    Properties

    Properties

    keyId: Buffer
    publicKey: CryptoKey

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    keyId: Buffer
    publicKey: CryptoKey

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SessionPrivateKeyData.html b/interfaces/SessionPrivateKeyData.html index 682dcdb0..5b566374 100644 --- a/interfaces/SessionPrivateKeyData.html +++ b/interfaces/SessionPrivateKeyData.html @@ -1,5 +1,5 @@ SessionPrivateKeyData | @relaycorp/relaynet-core

    Interface SessionPrivateKeyData

    Data for a private key of a session key pair.

    -
    interface SessionPrivateKeyData {
        keySerialized: Buffer;
        nodeId: string;
        peerId?: string;
    }

    Properties

    interface SessionPrivateKeyData {
        keySerialized: Buffer;
        nodeId: string;
        peerId?: string;
    }

    Properties

    keySerialized: Buffer
    nodeId: string
    peerId?: string

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    keySerialized: Buffer
    nodeId: string
    peerId?: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SessionPublicKeyData.html b/interfaces/SessionPublicKeyData.html index e0befe56..6ff5b6da 100644 --- a/interfaces/SessionPublicKeyData.html +++ b/interfaces/SessionPublicKeyData.html @@ -1,4 +1,4 @@ -SessionPublicKeyData | @relaycorp/relaynet-core

    Interface SessionPublicKeyData

    interface SessionPublicKeyData {
        publicKeyCreationTime: Date;
        publicKeyDer: Buffer;
        publicKeyId: Buffer;
    }

    Properties

    publicKeyCreationTime +SessionPublicKeyData | @relaycorp/relaynet-core

    Interface SessionPublicKeyData

    interface SessionPublicKeyData {
        publicKeyCreationTime: Date;
        publicKeyDer: Buffer;
        publicKeyId: Buffer;
    }

    Properties

    publicKeyCreationTime: Date
    publicKeyDer: Buffer
    publicKeyId: Buffer

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    publicKeyCreationTime: Date
    publicKeyDer: Buffer
    publicKeyId: Buffer

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SignatureOptions.html b/interfaces/SignatureOptions.html index 5227ea79..a8b4304e 100644 --- a/interfaces/SignatureOptions.html +++ b/interfaces/SignatureOptions.html @@ -1,2 +1,2 @@ -SignatureOptions | @relaycorp/relaynet-core
    interface SignatureOptions {
        hashingAlgorithmName: HashingAlgorithm;
    }

    Properties

    hashingAlgorithmName: HashingAlgorithm

    Generated using TypeDoc

    \ No newline at end of file +SignatureOptions | @relaycorp/relaynet-core
    interface SignatureOptions {
        hashingAlgorithmName: HashingAlgorithm;
    }

    Properties

    hashingAlgorithmName: HashingAlgorithm

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CargoMessageSetItem.html b/types/CargoMessageSetItem.html index 4d4038d2..dbaa2d8e 100644 --- a/types/CargoMessageSetItem.html +++ b/types/CargoMessageSetItem.html @@ -1 +1 @@ -CargoMessageSetItem | @relaycorp/relaynet-core

    Type alias CargoMessageSetItem

    Generated using TypeDoc

    \ No newline at end of file +CargoMessageSetItem | @relaycorp/relaynet-core

    Type alias CargoMessageSetItem

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CargoMessageStream.html b/types/CargoMessageStream.html index b6248e0b..84f8d464 100644 --- a/types/CargoMessageStream.html +++ b/types/CargoMessageStream.html @@ -1 +1 @@ -CargoMessageStream | @relaycorp/relaynet-core

    Type alias CargoMessageStream

    CargoMessageStream: AsyncIterable<{
        expiryDate: Date;
        message: Buffer;
    }>

    Type declaration

    • Readonly expiryDate: Date
    • Readonly message: Buffer

    Generated using TypeDoc

    \ No newline at end of file +CargoMessageStream | @relaycorp/relaynet-core

    Type alias CargoMessageStream

    CargoMessageStream: AsyncIterable<{
        expiryDate: Date;
        message: Buffer;
    }>

    Type declaration

    • Readonly expiryDate: Date
    • Readonly message: Buffer

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ECDHCurveName.html b/types/ECDHCurveName.html index 5e29d2b1..66bddb43 100644 --- a/types/ECDHCurveName.html +++ b/types/ECDHCurveName.html @@ -1 +1 @@ -ECDHCurveName | @relaycorp/relaynet-core
    ECDHCurveName: "P-256" | "P-384" | "P-521"

    Generated using TypeDoc

    \ No newline at end of file +ECDHCurveName | @relaycorp/relaynet-core
    ECDHCurveName: "P-256" | "P-384" | "P-521"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/LocalCargoId.html b/types/LocalCargoId.html index 5cfb0337..174ef64f 100644 --- a/types/LocalCargoId.html +++ b/types/LocalCargoId.html @@ -1,3 +1,3 @@ LocalCargoId | @relaycorp/relaynet-core
    LocalCargoId: string

    The local id of the cargo to be delivered.

    It can be a file name or DB primary key, for example.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/MAX_RAMF_MESSAGE_LENGTH.html b/variables/MAX_RAMF_MESSAGE_LENGTH.html index 4d95427c..b9eb80b2 100644 --- a/variables/MAX_RAMF_MESSAGE_LENGTH.html +++ b/variables/MAX_RAMF_MESSAGE_LENGTH.html @@ -1,3 +1,3 @@ MAX_RAMF_MESSAGE_LENGTH | @relaycorp/relaynet-core

    Variable MAX_RAMF_MESSAGE_LENGTHConst

    MAX_RAMF_MESSAGE_LENGTH: 9437184 = 9437184

    Maximum length of any RAMF message per RS-001.

    https://specs.relaynet.network/RS-001

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/MAX_SDU_PLAINTEXT_LENGTH.html b/variables/MAX_SDU_PLAINTEXT_LENGTH.html index 9e557de2..1e4864e4 100644 --- a/variables/MAX_SDU_PLAINTEXT_LENGTH.html +++ b/variables/MAX_SDU_PLAINTEXT_LENGTH.html @@ -1,2 +1,2 @@ MAX_SDU_PLAINTEXT_LENGTH | @relaycorp/relaynet-core

    Variable MAX_SDU_PLAINTEXT_LENGTHConst

    MAX_SDU_PLAINTEXT_LENGTH: 8322048 = 8322048

    Maximum length of any SDU to be encapsulated in a CMS EnvelopedData value, per the RAMF spec.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file